HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create billing group

post
https://api.instellix.io/v2/billing-groups

Create a completely new billing group. Billing groups can be used to differentiate within your tenant for different business strategies. A business segment can be used to differentiate between different locales and to implement specific templates for these regions later on. If this is your only business segment then it will be set as default automatically.

Body Params

A billing group configures which items can go together on a document.

string | null
enum

Configure if the billing should be handled internal or external

Allowed:
string
required
length between 1 and 100

Ident for the Billing Group, must be unique. If none is provided a random UUID will be generated automatically. This ident can later be used to determine the document template. Must not be blank. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

businessSegments
array of objects
required
length ≥ 1

List of Business Segments. Must not be empty.

businessSegments*

Request to create a business segment. If it is the only segment in the system, it will be set as default automatically.

string | null

Description of the business segment. Size must be between 0 and 255.

string
required
length ≤ 255

Name of the business segment. Must not be blank. Size must be between 0 and 255.

string
required
length between 1 and 100

Ident of the business segment to create. Must be unique. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string | null
enum

Determines which date will be set as document date. Use "DOCUMENT_CREATION" when the document date will be the date the actual document is being processed. Use "BILLING_PERIOD" when the date should be according to in the plan configured Billing Timing

Allowed:
currencyRoundingOverrides
array of objects
required

Specifies the number of decimal places to which a currency should be rounded, overriding the ISO 4217 standard. Must be equal to or less than the standard specified by ISO and cannot be negative. A zero value indicates rounding to whole units. Must not be null.

currencyRoundingOverrides*
string | null
enum

Configure if a deposit invoice should be created and if in which case it will be created

Allowed:
boolean
Defaults to false

Determines if a deposit invoice should be treated as a receivables opening document or not

string
Defaults to ITEM_BASED

Defines how document corrections should be applied. Either on an item level or as a complete document. Must be one of:

ITEM_BASED
DOCUMENT_BASED
documentNumberConfiguration
array of objects | null

Optional configuration to overwrite the document number configuration on tenant level for certain target document types.

documentNumberConfiguration
localeConfiguration
array of objects
required
length ≥ 1

Mandatory configuration that defines country, region, and language configuration for billing group. Must not be empty.

localeConfiguration*

A request to configure regions for a particular service country.

string
enum
required

Country code in ISO 3166-1 alpha-3 or alpha-2 standard. Must not be null.

string | null

Name of the default region. Optional, if only one region defined for country.

regions
array of objects
required
length ≥ 1

Regions configured for given country. If that country has no specific regions, the region can be the country itself. Must not be empty.

regions*

A request to create a region with its language settings.

string
enum
required

Default language is chosen when the language sent in contract is not valid for invoice service country. One of valid languages codes in ISO 639-1 to be used as a default language. Must not be null.

string
enum
required

Fallback language is chosen when language sent in contract is missing. One of valid languages codes in ISO 639-1 to be used as a fallback language. Must not be null.

string | null

Name of the region.

validLanguages
array of strings
required
length ≥ 1

List of valid language codes in ISO 639-1 standard, appropriate for given country. Must not be empty.

validLanguages*
string
required
length ≤ 255

Name of the Billing Group. Must not be blank. Size must be between 0 and 255.

string
required
Defaults to TAX_LOCATION

Determines what location should be used for option price determination: Either TAX_LOCATION or PERFORMANCE_LOCATION. Must not be null. Must be one of:

TAX_LOCATION
PERFORMANCE_LOCATION
taxCalculationConfig
object | null
deprecated

Always returns default values in response. NBX_TAX_CALCULATION, NET_VALUE. For Removal after 2026-03-01

Responses

Updated 23 days ago

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 23 days ago