Create usage

Body Params

Please see Usage Model below for more information regarding required values and input type.

int64 | null

The contract to which this usage should belong to. When no contract is given, a debtor id is mandatory. When a contract id is given, the debtor id will be ignored.

int64 | null

The debtor to which this usage belongs to. When a contract is already provided, then this field is ignored. Otherwise the newest matching contract for this debtor is used.

string | null

The usage's description.

date-time
required

The end date of the contract. Can be the same as the start date. Supports ISO 8601 offset information.
Must not be null.

string | null

Operating site is used for tax calculation. Only predefined operating site identifiers are allowed.
Size must be between 0 and 255.

performanceLocation
object | null

The location where the product or service was performed.

string
required
length between 1 and 100
[a-zA-Z0-9_.~-]{1,100}

The productIdent links the usage to the appropriate option from a specific plan.
Must not be blank.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

properties
array of objects | null
properties
string | null
enum
deprecated

DEPRECATED.
Deprecated: Use taxLocation and performanceLocation instead. The usage's service country. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.

date-time
required

The start date of the usage. Supports ISO 8601 offset information.
Must not be null.

taxLocation
object | null

The location where the product or service needs to be taxed. Has to be provided unless the deprecated "serviceCountry" is still being used. Important: If you pool usages then usages with different tax locations will be pooled separately.

unitQuantities
array of objects | null
unitQuantities
string
required
length between 1 and 100
[a-zA-Z0-9_.~-]{1,100}

Must be a unique external reference. Cannot be amended after the initial POST.
Must not be blank.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

Responses

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