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 |
|---|---|---|---|---|
article |
`` | |||
sales |
`` | |||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
with |
`` |
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 |
|---|---|---|---|---|---|
activity |
varchar2 |
Activity ID | filters on the platform, writable, activity |
||
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
article |
varchar2 |
Article ID | filters on the platform, writable, article |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
description |
varchar2 |
Description | filters on the platform, writable, description |
||
discount |
decimal |
Discount | filters on the platform, writable, discount |
||
extended |
varchar2 |
Extended Description | filters on the platform, writable, extended |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
general |
varchar2 |
General Ledger Account ID | filters on the platform, writable, general |
||
id |
varchar2 |
ID | filters on the platform, writable, id |
||
installation |
varchar2 |
Installation ID | filters on the platform, writable, installation |
Deprecated: an installation has no meaning on an invoice line. Returns the line's material, the same as materialId. | |
line |
varchar2 |
Line Number | filters on the platform, writable, line |
||
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
material |
varchar2 |
Material ID | filters on the platform, writable, material |
||
order |
varchar2 |
Order ID | filters on the platform, writable, order |
||
postId |
varchar2 |
Post ID | filters on the platform, writable, postId |
||
price |
decimal |
Price | filters on the platform, writable, price |
||
project |
varchar2 |
Project ID | filters on the platform, writable, project |
||
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. | |
rental |
varchar2 |
Rental Ticket ID | filters on the platform, writable, rental |
||
sales |
varchar2 |
Sales Invoice ID | filters on the platform, writable, sales |
Only present when obtained via bulk endpoint | |
style |
varchar2 |
Style Name | filters on the platform, writable, style |
||
total |
decimal |
Total excluding VAT | filters on the platform, writable, total |
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. | |
total |
decimal |
Total Excluding VAT in Default Currency | filters on the platform, writable, total |
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. | |
transport |
varchar2 |
Transport ID | filters on the platform, writable, transport |
||
type |
varchar2 |
Type | filters on the platform, writable, type |
||
unit |
varchar2 |
Unit Type | filters on the platform, writable, unit |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
||
vat |
varchar2 |
VAT Tariff ID | filters on the platform, writable, vat |
||
work |
varchar2 |
Work Order ID | filters on the platform, writable, work |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Sales |
activity |
Activities.id |
Key | |
Sales |
installation |
Installations.id |
Key | |
Sales |
project |
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. |
Sales |
vat |
VatTariffs.id |
Key | |
Sales |
work |
WorkOrders.id |
Key |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: