Update allowances

put

https://api.instellix.io/v2/orders/{orderIdent}/allowances/{allowanceIdent}

A request to update a existing allowance.

Path Params

orderIdent

string

required

length between 1 and 100

[a-zA-Z0-9_.~-]{1,100}

The unique identifier of an order, given by the Tenant.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

allowanceIdent

string

required

length between 1 and 100

[a-zA-Z0-9_.~-]{1,100}

The ident of the allowance to update.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

Body Params

A request to update an allowance. An allowance is assigned to a specific order. It represents a purchased product with its description, price and quantity. A order item is created when a new order is created. Order items automatically generate matching billable items. If additional items need to be assigned to a order, a new billable item must be generated. Please see Billable Item Model for more details.

articleNumber

string | null

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

description

string | null

Description.

itemGroup

string | null

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

itemType

string

enum

required

Type of the allowance.
Must not be null.

Allowed:

name

string

required

length ≥ 1

Name of the item.
Must not be blank.

operatingSiteIdent

string | null

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

performanceLocation

object | null

The location where the product or service was performed.

properties

array of objects | null

Additional allowance properties

properties

rowTotalGross

object

required

Gross total of all items after application of item.extras.

rowTotalNet

object

required

Net total of all items without vat after application of item.extras.

serviceCountry

string | null

enum

deprecated

DEPRECATED.
Deprecated: Use tax location and performance location instead. The country where the product or service was sold. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.

taxInformation

array of objects | null

All tax information for this allowance.
Size must be between 1 and 1.

taxInformation

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

rowTotalTax

object

required

Total tax amount after application of item.extras.

taxCategoryCode

string | null

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

taxCode

string | null

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

taxExemptionReasonCode

string | null

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

taxExemptionReasonText

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.

taxName

string | null

Name of the tax.

taxRate

number

required

≥ 0

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

taxLocation

object | null

The location where the product or service is taxed.

taxScheme

string | null

enum

It defines tax trading procedure of an allowance.

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

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