invantive documentation
Invantive Support ForumsLog In / Sign Up

SalesOrderLineItems: Robaws Sales Order Line Items

read only REST

  • Catalog: Robaws
  • Schema: SalesOrderLineItems
  • Label: Sales Order Line Items

Search

Can only retrieve data.

API Source

  • Endpoint: /api/v2/sales-order-line-items
  • Operation: get /api/v2/sales-order-line-items

Performance Characteristics

Characteristic Value
Average access latency (ms) 116
Full scan rows per minute 12,998
Point query rows per minute 1,216
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
articleId ``
salesOrderId ``
searchText ``
sort ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table SalesOrderLineItems are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
activityId varchar2 Activity ID filters on the platform, writable, activityId
archivedAt datetime Archived at filters on the platform, writable, archivedAt
articleId varchar2 Article ID filters on the platform, writable, articleId
createdAt datetime Created at filters on the platform, writable, createdAt
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
description varchar2 Description filters on the platform, writable, description
discount decimal Discount filters on the platform, writable, discount Percentage represented on a scale from 0 to 100
executedQuantity decimal Executed Quantity filters on the platform, writable, executedQuantity
executionStatus varchar2 Execution Status filters on the platform, writable, executionStatus
extendedDescription varchar2 Extended Description filters on the platform, writable, extendedDescription
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
id varchar2 ID filters on the platform, writable, id
lineNumber varchar2 Line Number filters on the platform, writable, lineNumber
lockedAt datetime Locked at filters on the platform, writable, lockedAt
price decimal Price filters on the platform, writable, price
quantity decimal Quantity filters on the platform, writable, quantity The line's quantity as stored. In /aggregate, SUM, AVG, MIN and MAX skip the lines that are not part of the document's total (chapters, titles, text, variants and options); COUNT still counts them.
salesOrderId varchar2 Sales Order ID filters on the platform, writable, salesOrderId Only present when obtained via /api/v2/sales-order-line-items or its bulk alias
styleName varchar2 Style Name filters on the platform, writable, styleName
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat The line's total excluding VAT, in its document's currency (the document's attributes.currency); the exchange rate is not applied. For the line's total in the company's default currency, use totalExclVatInDefaultCurrency. In /aggregate, SUM, AVG, MIN and MAX skip the lines that are not part of the document's total (chapters, titles, text, variants and options); COUNT still counts them.
totalExclVatInDefaultCurrency decimal Total Excluding VAT in Default Currency filters on the platform, writable, totalExclVatInDefaultCurrency The line's total excluding VAT, converted to the company's default currency at its document's exchange rate. Use it to add up lines of documents in different currencies; totalExclVat holds the same total in the document's own currency. In /aggregate, SUM, AVG, MIN and MAX skip the lines that are not part of the document's total (chapters, titles, text, variants and options); COUNT still counts them.
type varchar2 Type filters on the platform, writable, type
unitType varchar2 Unit Type filters on the platform, writable, unitType
updatedAt datetime Updated at filters on the platform, writable, updatedAt
vatTariffId varchar2 VAT Tariff ID filters on the platform, writable, vatTariffId

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: