OfferLineItems: Robaws Offer Line Items
read only REST
- Catalog:
Robaws - Schema:
OfferLineItems - Label: Offer Line Items
Search
Can only retrieve data.
API Source
- Endpoint:
/api/v2/offer-line-items - Operation:
get /api/v2/offer-line-items
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 290 |
| Full scan rows per minute | 10,315 |
| Point query rows per minute | 698 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
article |
`` | |||
offer |
`` | |||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
with |
`` |
Table Columns
The columns of the table OfferLineItems 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 |
|---|---|---|---|---|---|
agreement |
varchar2 |
Agreement Type | filters on the platform, writable, agreement |
||
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
article |
varchar2 |
Article ID | filters on the platform, writable, article |
||
chapter |
varchar2 |
Chapter | filters on the platform, writable, chapter |
||
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 |
||
extended |
varchar2 |
Extended Description Rendered | filters on the platform, writable, extended |
When reading, only present if requested via 'include' query parameter, otherwise null. | |
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
id |
varchar2 |
ID | filters on the platform, writable, id |
||
image |
varchar2 |
Image ID | filters on the platform, writable, image |
||
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 |
||
number |
varchar2 |
Number | filters on the platform, writable, number |
||
offer |
varchar2 |
Offer ID | filters on the platform, writable, offer |
Only present when obtained via /api/v2/offer-line-items or its bulk alias | |
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. | |
quantity |
varchar2 |
Quantity Formula | filters on the platform, writable, quantity |
||
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 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. | |
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 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 |
||
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: