invantive documentation
Invantive Support ForumsLog In / Sign Up

SalesInvoiceLineItems: Robaws Sales Invoice Line Items

read only REST

  • Catalog: Robaws
  • Schema: SalesInvoiceLineItems
  • Label: Sales Invoice Line Items

Search

Can only retrieve data.

API Source

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

Performance Characteristics

Characteristic Value
Average access latency (ms) 157
Full scan rows per minute 13,430
Point query rows per minute 993
Write rows per minute 539

The result can be cached on the client.

Parameters

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

Table Columns

The columns of the table SalesInvoiceLineItems 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
extendedDescription varchar2 Extended Description filters on the platform, writable, extendedDescription
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
generalLedgerAccountId varchar2 General Ledger Account ID filters on the platform, writable, generalLedgerAccountId
id varchar2 ID filters on the platform, writable, id
installationId varchar2 Installation ID filters on the platform, writable, installationId Deprecated: an installation has no meaning on an invoice line. Returns the line's material, the same as materialId.
lineNumber varchar2 Line Number filters on the platform, writable, lineNumber
lockedAt datetime Locked at filters on the platform, writable, lockedAt
materialId varchar2 Material ID filters on the platform, writable, materialId
orderId varchar2 Order ID filters on the platform, writable, orderId
postId varchar2 Post ID filters on the platform, writable, postId
price decimal Price filters on the platform, writable, price
projectId varchar2 Project ID filters on the platform, writable, projectId
quantity decimal Quantity filters on the platform, writable, quantity The line's quantity as stored: never negative on a credit note, unlike the line's money. To count sold quantities net of credit notes, filter or group on links.salesInvoice.attributes.type. In /aggregate, SUM, AVG, MIN and MAX skip the lines that are not part of the invoice total (chapters, titles, text, variants and options); COUNT still counts them.
rentalTicketId varchar2 Rental Ticket ID filters on the platform, writable, rentalTicketId
salesInvoiceId varchar2 Sales Invoice ID filters on the platform, writable, salesInvoiceId Only present when obtained via bulk endpoint
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 sales invoice's currency (links.salesInvoice.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 count a credit note's line negative; /query returns the value as stored. In /aggregate, SUM, AVG, MIN and MAX skip the lines that are not part of the invoice total (chapters, titles, text, variants and options); COUNT still counts them. On the line of an advance or final invoice, SUM, AVG, MIN and MAX in /aggregate count the share that invoice bills (its advance percentage, or the rest on the final invoice), as the invoice's own totals do; /query returns the full amount as stored.
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 sales invoice's exchange rate. Use it to add up lines across invoices in different currencies; totalExclVat holds the same total in the invoice's own currency. In /aggregate, SUM, AVG, MIN and MAX count a credit note's line negative; /query returns the value as stored. In /aggregate, SUM, AVG, MIN and MAX skip the lines that are not part of the invoice total (chapters, titles, text, variants and options); COUNT still counts them. On the line of an advance or final invoice, SUM, AVG, MIN and MAX in /aggregate count the share that invoice bills (its advance percentage, or the rest on the final invoice), as the invoice's own totals do; /query returns the full amount as stored.
transportId varchar2 Transport ID filters on the platform, writable, transportId
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
workOrderId varchar2 Work Order ID filters on the platform, writable, workOrderId

Keys

Key Column Refers to Kind Description
SalesInvoiceLineItems_activityId_fk activityId Activities.id Key
SalesInvoiceLineItems_installationId_fk installationId Installations.id Key
SalesInvoiceLineItems_projectId_txt projectId Projects.id Textual The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it.
SalesInvoiceLineItems_vatTariffId_fk vatTariffId VatTariffs.id Key
SalesInvoiceLineItems_workOrderId_fk workOrderId WorkOrders.id Key

Release Notes

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