Cancel line items

post https://api.nbx-stage-westeurope.nitrobox.io/v2/orders/{orderIdent}/lineItems/actions/cancel

Cancel line items with given idents. Processed items will be credited, for unprocessed items the item will never be processed. Cancellation cant be reverted.

Responses

Response body

object

originalItems

array of objects

Debit BillableItems from the given idents

originalItems

object

billableItemIdent

string

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}'.

extras

array of objects

extras

object

billableItemExtraId

int64

Unique Id.

externalIdent

string

length between 1 and 100

Unique external reference.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

name

string

Name of the extra.

description

string

Description.

type

string

required

Type of the extra. Will be one of:.
Must not be null.

VOUCHER DISCOUNT SINGLE_PURPOSE_VOUCHER

refundabilityType

string

Describes whether the item extra is refundable.

REFUNDABLE NON_REFUNDABLE

taxInformation

array of objects

required

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*

object

taxRate

number

required

≥ 0

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

taxName

string

Name of the tax.

taxCode

string

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

originalRowTotalTax

object

Total tax amount before application of item.extras.
A monetary amount along with a currency.

rowTotalTax

object

Total tax amount after application of item.extras.
A monetary amount along with a currency.

unitPriceTax

object

Tax amount for one unit.
A monetary amount along with a currency.

valueExclusiveVat

number

required

Net amount excluding vat that will be discounted.

valueCumulatedTaxPrice

number

Cumulated tax amount

valueInclusiveVat

number

required

Gross amount including vat that will be discounted.
Must not be null.

leftoverAmountGross

number

The amount of money that is left over on the voucher that has been applied.

currency

string

required

The currency. Must be one of:.
Must not be null.

UNDEFINED AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BYR BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LYD MAD MDL MGA MKD MMK MNT MOP MRO MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RUR RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD SSP STD STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN USS UYI UYU UZS VEF VES VND VUV WST XAF XAG XAU XBA XBB XBC XBD XCD XDR XOF XPD XPF XPT XSU XTS XUA XXX YER ZAR ZMW ZWL

billablePostTaxItemExtras

array of objects

billablePostTaxItemExtras

object

int64

Unique Id.

ident

string

length between 1 and 100

Unique external reference.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

externalReference

string

Additional reference for third party system, like voucher management system.

name

string

Name of the extra.

description

string

Description.

type

string

required

Type of the extra. Will be one of:.
Must not be null.

MULTI_PURPOSE_VOUCHER

refundabilityType

string

Describes whether the item extra is refundable.

REFUNDABLE NON_REFUNDABLE

value

number

required

The amount that will be discounted.
Must not be null.

leftoverAmountGross

number

The amount of money that is left over on the voucher that has been applied.

currency

string

required

The currency. Must be one of:.
Must not be null.

properties

array of objects

properties

object

propertyIdent

string

required

Key of the property.
Must not be blank.

propertyValue

string

required

Value of the property.
Must not be null.

articleNumber

string

length between 0 and 32

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

description

string

The billable item's description.

processingError

string

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

type

string

required

Must be one of:.
Must not be null.

DEBIT CREDIT

currency

string

The currency. Must be one of:

processingDate

date-time

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

processedDate

date-time

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

itemPeriodStart

date-time

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

itemPeriodEnd

date-time

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

itemPeriodDuration

int64

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

itemPeriodDurationType

string

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

SECOND	DEPRECATED: duration of seconds
MINUTE	DEPRECATED: duration of minutes
HOUR	DEPRECATED: duration of hours
DAY	DEPRECATED: duration of days
WEEK	DEPRECATED: duration of weeks
MONTH	DEPRECATED: duration of months
QUARTER_YEAR	DEPRECATED: duration of a quarter of a year
YEAR	DEPRECATED: duration of a year
SECONDS	duration of seconds
MINUTES	duration of minutes
HOURS	duration of hours
DAYS	duration of days
WEEKS	duration of weeks
MONTHS	duration of months
QUARTER_YEARS	duration of a quarter of a year
YEARS	duration of a year
FOREVER	duration of forever

name

string

required

Name of the billable item.
Must not be blank.

operatingSiteIdent

string

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

planName

string

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

productIdent

string

The product ident of the billable item.

optionDescription

string

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

usageDescription

string

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

taxInformation

array of objects

required

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*

object

taxRate

number

required

≥ 0

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

taxName

string

Name of the tax.

taxCode

string

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

originalRowTotalTax

object

required

Total tax amount before application of item.extras.
A monetary amount along with a currency.

rowTotalTax

object

required

Total tax amount after application of item.extras.
A monetary amount along with a currency.

unitPriceTax

object

required

Tax amount for one unit.
A monetary amount along with a currency.

taxScheme

string

It defines tax trading procedure of an item.

OSS DEFAULT

originalRowTotalCumulatedTaxPrice

number

Cumulated tax price of original gross total of all items

originalRowTotalExclusiveVat

number

required

Net total of all items without vat before application of item.extras (unitQuantity * unitPriceExclusiveVat).
Must not be null.

originalRowTotalInclusiveVat

number

required

Gross total of all items with vat before application of item.extras (unitQuantity * unitPriceInclusiveVat).
Must not be null.

rowTotalExclusiveVat

number

required

Net total of all items without vat after application of item.extras.
Must not be null.

rowTotalInclusiveVat

number

required

Gross total of all items with vat after application of item.extras.
Must not be null.

rowTotalCumulatedTaxPrice

number

Cumulated tax price of gross total of all items

unitPriceExclusiveVat

number

required

Net price of one unit without vat.
Must not be null.

unitCumulatedTaxPrice

number

Cumulated tax price of gross total of one unit

unitPriceInclusiveVat

number

required

Gross price of one unit with vat.
Must not be null.

unitQuantity

number

required

Number of units.
Must not be null.

unitQuantityType

string

required

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

PC KWH SECOND MINUTE HOUR DAY WEEK MONTH YEAR

invoiceIdent

string

Invoice number. Is set by Nitrobox system when billable item is invoiced.

serviceCountry

string

deprecated

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

UNDEFINED AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

serviceLocation

object

deprecated

The location where the product or service was sold.

taxLocation

object

deprecated

The location where the product or service was sold.

performanceLocation

object

deprecated

The location where the product or service was sold.

deliveryDate

date-time

The planned delivery date.

targetDocumentType

string

Must be one of:

INVOICE DEPOSITINVOICE NONE

documentNumber

string

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

documentDate

date-time

deprecated

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

relatedItemIdent

string

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

category

string

Defaults to PHYSICAL_PRODUCT

The category of an item. Must be one of:

DIGITAL_PRODUCT DIGITAL_PRODUCT_RENTAL LABOR_COST LOGISTIC_COST PHYSICAL_PRODUCT PHYSICAL_PRODUCT_RENTAL SERVICE VOUCHER VOUCHER_PURCHASE VOUCHER_APPLICATION DISCOUNT DISCOUNT_USE MULTI_PURPOSE_VOUCHER_USE GOVERNMENT_GRANT TRADE_IN ELECTRICITY ELECTRICITY_RESALE

itemGroup

string

length between 0 and 64

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

processingStatus

string

Status of processing.

NOT_STARTED PENDING_RETRY STARTED IN_PROGRESS RELATED_ITEM_PENDING COMPLETED ERROR TERMINATED CONFIG_ERROR RECALCULATION_PENDING

contractId

int64

Reference to the contract of the billable item.

contractIdent

string

Reference ident to the contract of the billable item.

referenceType

string

Reference to the contract or order of the billable item.

businessSegmentId

int64

Reference to the business segment of the billable item.

businessCase

string

The action type that created this billable item.

PURCHASE DEPOSIT DEPOSIT_CANCELLATION CANCELLATION CORRECTION_CREATION CORRECTION_CANCELLATION SELF_BILLED SELF_BILLED_CANCELLATION SELF_BILLED_CORRECTION_CREATION SELF_BILLED_CORRECTION_CANCELLATION

billableItemId

int64

creditNoteIdent

string

Credit note number. It is set by Nitrobox system when credit note is generated for this credit billable item.

tenantId

int64

The id of the current tenant

taxInformationSource

string

The tax information source of the billable item.

NITROBOX AVALARA FINANCE_ENABLER CUSTOMER_PROVIDED

taxCalculationBasis

string

The tax calculation basis of the billable item. May be null.
Must be one of:

NET

GROSS

UNKNOWN

creationDate

date-time

deprecated

DEPRECATED: use 'createdAt'. The creation date

lastModified

date-time

deprecated

DEPRECATED: use 'lastModifiedAt'. The date of the last modification

createdAt

date-time

Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

lastModifiedAt

date-time

Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

statusReason

string

The reason why the billable item is in a given state, e.g. due to processing errors.

billingPeriod

object

The start and end date of the billing period.

creditItemsForOriginalItems

array of objects

Credit BillableItems created for cancelling the original Debit BillableItems

creditItemsForOriginalItems

object

billableItemIdent

string

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}'.

extras

array of objects

extras

object

billableItemExtraId

int64

Unique Id.

externalIdent

string

length between 1 and 100

Unique external reference.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

name

string

Name of the extra.

description

string

Description.

type

string

required

Type of the extra. Will be one of:.
Must not be null.

VOUCHER DISCOUNT SINGLE_PURPOSE_VOUCHER

refundabilityType

string

Describes whether the item extra is refundable.

REFUNDABLE NON_REFUNDABLE

taxInformation

array of objects

required

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*

object

taxRate

number

required

≥ 0

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

taxName

string

Name of the tax.

taxCode

string

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

originalRowTotalTax

object

Total tax amount before application of item.extras.
A monetary amount along with a currency.

rowTotalTax

object

Total tax amount after application of item.extras.
A monetary amount along with a currency.

unitPriceTax

object

Tax amount for one unit.
A monetary amount along with a currency.

valueExclusiveVat

number

required

Net amount excluding vat that will be discounted.

valueCumulatedTaxPrice

number

Cumulated tax amount

valueInclusiveVat

number

required

Gross amount including vat that will be discounted.
Must not be null.

leftoverAmountGross

number

The amount of money that is left over on the voucher that has been applied.

currency

string

required

The currency. Must be one of:.
Must not be null.

billablePostTaxItemExtras

array of objects

billablePostTaxItemExtras

object

int64

Unique Id.

ident

string

length between 1 and 100

Unique external reference.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

externalReference

string

Additional reference for third party system, like voucher management system.

name

string

Name of the extra.

description

string

Description.

type

string

required

Type of the extra. Will be one of:.
Must not be null.

MULTI_PURPOSE_VOUCHER

refundabilityType

string

Describes whether the item extra is refundable.

REFUNDABLE NON_REFUNDABLE

value

number

required

The amount that will be discounted.
Must not be null.

leftoverAmountGross

number

The amount of money that is left over on the voucher that has been applied.

currency

string

required

The currency. Must be one of:.
Must not be null.

properties

array of objects

properties

object

propertyIdent

string

required

Key of the property.
Must not be blank.

propertyValue

string

required

Value of the property.
Must not be null.

articleNumber

string

length between 0 and 32

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

description

string

The billable item's description.

processingError

string

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

type

string

required

Must be one of:.
Must not be null.

DEBIT CREDIT

currency

string

The currency. Must be one of:

processingDate

date-time

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

processedDate

date-time

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

itemPeriodStart

date-time

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

itemPeriodEnd

date-time

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

itemPeriodDuration

int64

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

itemPeriodDurationType

string

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

SECOND	DEPRECATED: duration of seconds
MINUTE	DEPRECATED: duration of minutes
HOUR	DEPRECATED: duration of hours
DAY	DEPRECATED: duration of days
WEEK	DEPRECATED: duration of weeks
MONTH	DEPRECATED: duration of months
QUARTER_YEAR	DEPRECATED: duration of a quarter of a year
YEAR	DEPRECATED: duration of a year
SECONDS	duration of seconds
MINUTES	duration of minutes
HOURS	duration of hours
DAYS	duration of days
WEEKS	duration of weeks
MONTHS	duration of months
QUARTER_YEARS	duration of a quarter of a year
YEARS	duration of a year
FOREVER	duration of forever

name

string

required

Name of the billable item.
Must not be blank.

operatingSiteIdent

string

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

planName

string

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

productIdent

string

The product ident of the billable item.

optionDescription

string

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

usageDescription

string

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

taxInformation

array of objects

required

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*

object

taxRate

number

required

≥ 0

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

taxName

string

Name of the tax.

taxCode

string

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

originalRowTotalTax

object

required

Total tax amount before application of item.extras.
A monetary amount along with a currency.

rowTotalTax

object

required

Total tax amount after application of item.extras.
A monetary amount along with a currency.

unitPriceTax

object

required

Tax amount for one unit.
A monetary amount along with a currency.

taxScheme

string

It defines tax trading procedure of an item.

OSS DEFAULT

originalRowTotalCumulatedTaxPrice

number

Cumulated tax price of original gross total of all items

originalRowTotalExclusiveVat

number

required

Net total of all items without vat before application of item.extras (unitQuantity * unitPriceExclusiveVat).
Must not be null.

originalRowTotalInclusiveVat

number

required

Gross total of all items with vat before application of item.extras (unitQuantity * unitPriceInclusiveVat).
Must not be null.

rowTotalExclusiveVat

number

required

Net total of all items without vat after application of item.extras.
Must not be null.

rowTotalInclusiveVat

number

required

Gross total of all items with vat after application of item.extras.
Must not be null.

rowTotalCumulatedTaxPrice

number

Cumulated tax price of gross total of all items

unitPriceExclusiveVat

number

required

Net price of one unit without vat.
Must not be null.

unitCumulatedTaxPrice

number

Cumulated tax price of gross total of one unit

unitPriceInclusiveVat

number

required

Gross price of one unit with vat.
Must not be null.

unitQuantity

number

required

Number of units.
Must not be null.

unitQuantityType

string

required

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

PC KWH SECOND MINUTE HOUR DAY WEEK MONTH YEAR

invoiceIdent

string

Invoice number. Is set by Nitrobox system when billable item is invoiced.

serviceCountry

string

deprecated

DEPRECATED.
Deprecated: Use taxLocation and performanceLocation 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

deprecated

The location where the product or service was sold.

taxLocation

object

deprecated

The location where the product or service was sold.

performanceLocation

object

deprecated

The location where the product or service was sold.

deliveryDate

date-time

The planned delivery date.

targetDocumentType

string

Must be one of:

INVOICE DEPOSITINVOICE NONE

documentNumber

string

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

documentDate

date-time

deprecated

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

relatedItemIdent

string

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

200Standard response for successful HTTP requests.

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

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