PurchaseInvoiceLineItems: Robaws Purchase Invoice Line Items
read only REST
- Catalog:
Robaws - Schema:
PurchaseInvoiceLineItems - Label: Purchase Invoice Line Items
Search
Can only retrieve data.
API Source
- Endpoint:
/api/v2/purchase-invoice-line-items - Operation:
get /api/v2/purchase-invoice-line-items
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 189 |
| Full scan rows per minute | 11,508 |
| Point query rows per minute | 471 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
article |
`` | |||
purchase |
`` | |||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
with |
`` |
Table Columns
The columns of the table PurchaseInvoiceLineItems 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 |
||
date |
datetime |
Date From | filters on the platform, writable, date |
||
dateTo |
datetime |
Date To | filters on the platform, writable, dateTo |
||
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 |
||
exclude |
char |
Exclude From Post Calculation | filters on the platform, writable, exclude |
||
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 |
||
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 |
||
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 |
||
purchase |
varchar2 |
Purchase Invoice ID | filters on the platform, writable, purchase |
Only present when obtained via /api/v2/purchase-invoice-line-items or its bulk alias | |
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 bought quantities net of credit notes, filter or group on links.purchaseInvoice.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. | |
sales |
varchar2 |
Sales Order ID | filters on the platform, writable, sales |
||
style |
varchar2 |
Style Name | filters on the platform, writable, style |
||
supply |
varchar2 |
Supply Order ID | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Archived At | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Assigned User ID | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Company ID | filters on the platform, writable, supply |
||
supply |
char |
Supply Order Completed | filters on the platform, writable, supply |
||
supply |
decimal |
Supply Order Completion Percentage | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Created At | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Deleted At | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Extra Fields | writable | The JSON text of the nested object. | |
supply |
varchar2 |
Supply Order Footer Text | filters on the platform, writable, supply |
When reading, only present if requested via 'include' query parameter, otherwise null. HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an |
|
supply |
varchar2 |
Supply Order ID | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Intro Text | filters on the platform, writable, supply |
When reading, only present if requested via 'include' query parameter, otherwise null. HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an |
|
supply |
datetime |
Supply Order Locked At | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Logic ID | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Reference | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Remark | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Status | filters on the platform, writable, supply |
||
supply |
decimal |
Supply Order Total Excluding VAT | filters on the platform, writable, supply |
||
supply |
decimal |
Supply Order Total Including VAT | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Type | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Updated At | filters on the platform, writable, supply |
||
total |
decimal |
Total excluding VAT | filters on the platform, writable, total |
The line's total excluding VAT, in its purchase invoice's currency (links.purchaseInvoice.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. | |
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 purchase 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. | |
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 |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: