HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create credit billable item

post deprecated
https://api.instellix.io/v2/contracts//creditbillableitems
⚠ This operation has been deprecated and will be removed in the future! ⚠
Reason: Credit billable item have been replaced by new endpoint.
There is no replacement for this operation.
Deprecated since: 2025-07-15

Sunset at the latest: 2026-07-14

Please refer to our "API Lifecycle Management" and our "API Migration Guide" to find out more.
This endpoint can be used to credit part of an existing debit billable item. Doing so will ensure the internal references between the billable items are correct. Only to be used to correct option based items. For Line Item corrections please use the Line Item functionalities.
Path Params
int64
required
Body Params

Please see Credit Billable Item Model below for more information regarding required values and input type.

string | null

e.g. article number, SKU, ISBN, not unique. Max 32 chars. Size must be between 0 and 32.

string
required
length between 1 and 100

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

billablePostTaxItemExtras
array of objects | null

The item extras that don't reduce the taxAmount that has to be paid for this item.

billablePostTaxItemExtras
string | null
enum

The action type that created this billable item.

int64 | null

Reference to the business segment of the billable item.

string | null
enum
Defaults to PHYSICAL_PRODUCT

The category of an item. Must be one of:

int64 | null

Reference to the contract of the billable item.

string | null

Reference ident to the contract of the billable item.

string | null
enum

The currency. Must be one of:

date-time | null

The planned delivery date.

string | null

The billable item's description.

detailedPerformanceLocation
object | null

The detailed location where the product or service was performed.

detailedTaxLocation
object | null

The detailed location where the product or service should be taxed.

date-time | null
deprecated

DEPRECATED. Deprecated: The custom document creation date for external document creation.

string | null

Field to be used depending on tenant and business segment document generation strategy. Mandatory if CLIENT_PROVIDED strategy is active, not allowed otherwise.

extras
array of objects | null

The billable item extras contain representations of vouchers for discounts or discounts applied to an item. Those item extras reduce the taxAmount that has to be paid for this item

extras
string
required

Invoice number of referenced invoice by this credit note.

string | null

The group to which an item belongs. Max 64 chars. Size must be between 0 and 64.

int64 | null

Duration for billable items that span a certain period of time.

string | null

The type of duration for billable items that span a certain period of time. Must be one of:. Must be one of:

SECONDDEPRECATED: duration of seconds
MINUTEDEPRECATED: duration of minutes
HOURDEPRECATED: duration of hours
DAYDEPRECATED: duration of days
WEEKDEPRECATED: duration of weeks
MONTHDEPRECATED: duration of months
QUARTER_YEARDEPRECATED: duration of a quarter of a year
YEARDEPRECATED: duration of a year
SECONDSduration of seconds
MINUTESduration of minutes
HOURSduration of hours
DAYSduration of days
WEEKSduration of weeks
MONTHSduration of months
QUARTER_YEARSduration of a quarter of a year
YEARSduration of a year
FOREVERduration of forever
date-time | null

End date for billable items that span a certain period of time. Supports ISO 8601 offset information.

date-time | null

Start date for billable items that span a certain period of time. Supports ISO 8601 offset information.

string
required
length ≥ 1

Name of the billable item. Must not be blank.

string | null

Operating site of the item. Only predefined operating site identifiers are allowed.

string | null

The description of the option that belongs to the billable item.

number | null

Cumulated tax price of original gross total of all items

number
required
≤ 0

Net total of all items without vat before application of item.extras (unitQuantity * unitPriceExclusiveVat). Must not be null. Must be less than or equal to 0.

number
required
≤ 0

Gross total of all items with vat before application of item.extras (unitQuantity * unitPriceInclusiveVat). Must not be null. Must be less than or equal to 0.

performanceLocation
object | null
deprecated

Deprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The location where the product or service was sold.

string | null

Name of the plan, where the billabe item belongs to.

date-time | null

Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.

date-time | null

The ISO 8601 date at which the billable item will be processed for billing.

string | null

The reason why the billable item is not processed and has the status error.

string | null

The product ident of the billable item.

properties
array of objects | null

The key-value pairs that can be used to extend the entity with additional custom data as needed.

properties
string | null

Reference to the contract or order of the billable item.

string | null

Ident of related debit billable item. It should be provided to correctly match to debit counterpart

number | null

Cumulated tax price of gross total of all items

number
required
≤ 0

Net total of all items without vat after application of item.extras. Must not be null. Must be less than or equal to 0.

number
required
≤ 0

Gross total of all items with vat after application of item.extras. Must not be null. Must be less than or equal to 0.

string | null
enum
deprecated

DEPRECATED. Deprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The country where the product or service was sold. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.

serviceLocation
object | null
deprecated

Deprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The location where the product or service was sold.

string | null
enum

Must be one of:

Allowed:
taxInformation
array of objects
required
length ≥ 1

All tax information for this item covering multi tax cases and single tax cases as well within that list. Tax information replaces deprecated attributes below for single tax cases. Due to backward compatibility, the following applies:

  • when sending billable items using taxInformation is the preferred way; either tax information can be used or the single tax attributes, but not both
  • when fetching billable items, both tax information and single tax attributes are populated until all deprecated attributes will be removed

Must not be empty.

taxInformation*

A request to create a new tax information object. Represents the details of associated tax information

originalRowTotalTax
object
required

A monetary amount along with a currency.

rowTotalTax
object
required

A monetary amount along with a currency.

string | null

Tax category code, usually from UNCL5305. Size must be between 0 and 255.

taxClassifications
array of objects | null

Tax classifications, used for filtering the correct tax rule.

taxClassifications
string | null

Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.

string | null

Tax exemption reason code, e.g. VATEX code. Size must be between 0 and 255.

string | null

A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged. Size must be between 0 and 255.

string | null

Name of the tax.

number
required
≥ 0

Tax rate. Must not be null. Must be greater than or equal to 0.

unitPriceTax
object
required

A monetary amount along with a currency.

taxLocation
object | null
deprecated

Deprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The location where the product or service was sold.

string | null
enum

It defines tax trading procedure of an item.

Allowed:
string
enum
required

Must be one of:. Must not be null.

Allowed:
number | null

Cumulated tax price of gross total of one unit

number
required
≤ 0

Net price of one unit without vat. Must not be null. Must be less than or equal to 0.

number
required
≤ 0

Gross price of one unit with vat. Must not be null. Must be less than or equal to 0.

number
required

Number of units. Must not be null.

string
enum
required

The type of quantity that units are measured in. Must be one of:. Must not be null.

string | null

The description of the usage that belongs to the billable item.

Responses

Updated 14 days ago

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

Updated 14 days ago