Create usage

post

https://api.instellix.io/v2/usages

Body Params

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

contractId

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.

debtorId

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.

description

string | null

The usage's description.

endDate

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.

operatingSiteIdent

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.

productIdent

string

required

length between 1 and 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

serviceCountry

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.

startDate

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 should be taxed. Note that if usage pooling is enabled, only usages where all tax location fields match will be aggregated together.

unitQuantities

array of objects | null

unitQuantities

usageIdent

string

required

length between 1 and 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

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX