HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Edit line item

put
https://api.instellix.io/v2/orders//lineItems/

A request to edit an existing line item within an order.

Path Params
string
required
length between 1 and 100
[a-zA-Z0-9_.~-]+

The ident of the order to edit a line item

string
required
Body Params

A request to update a line item. All the fields are optional - if provided, they will overwrite the value(with the exception of properties) Item properties will be merged based on property key(ident).

string | null

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

string
enum
required

Category of the line item, might be used for different tax rates.
Must not be null.

string
enum
required

Determines if the given item has a debit or credit impact on your business.
Must not be null.

Allowed:
date-time | null

The planned delivery date.

string | null

Any additional description, might be printed on the document.
Size must be between 0 and 255.

string | null

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

string
required
length ≤ 255

Name of the item.
Must not be blank.
Size must be between 0 and 255.

string | null

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

originalRowTotalGross
object | null

Gross total of all items before application of item.extras (unitQuantity * unitPriceNet). Mandatory, depending on tenant configuration.

originalRowTotalNet
object | null

Net total of all items without vat before application of item.extras (unitQuantity * unitPriceNet).

performanceLocation
object | null

The location where the product or service was performed.

date-time | null

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

date-time | null

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

postTaxExtras
array of objects | null

Price reductions (e.g. voucher) applied to this line item. These extras don't reduce the tax amount.

postTaxExtras
preTaxExtras
array | null

Price reductions (e.g. voucher) applied to this line item that also reduce the tax amount.

preTaxExtras
properties
array of objects | null

Additional item properties

properties
rowTotalGross
object | null

Gross total of all items after application of item.extras. Mandatory, depending on tenant configuration.

rowTotalNet
object | null

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

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.

serviceLocation
object | null
deprecated

Deprecated: Use tax location and performance location instead. The location where the product or service was sold.

taxInformation
array of objects | null

All tax information for this order item.

taxInformation
taxLocation
object | null

The location where the product or service is taxed.

string | null
enum

It defines tax trading procedure of an item.

Allowed:
string | null
enum

Type of the line item. Determines if this item was a service rendered to your customer (sales) or by your customer (self-billing)

Allowed:
unitPriceGross
object | null

Gross price of one unit. Mandatory, depending on tenant configuration.

unitPriceNet
object
required

Net price of one unit without vat.

number
required

Number of units.
Must not be null.

string
enum
required

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

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago

Did this page help you?