# SettlementLineItems: ROBAWS Settlement Line Items Search - Catalog: `Robaws` - Schema: `SettlementLineItems` - Label: Settlement Line Items This is a read-only table function. The ROBAWS API may not support changing the data or the Invantive UniversalSQL driver for ROBAWS does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the ROBAWS API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `SettlementLineItems`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `articleId` | `` | ☐ | | | | `searchText` | `` | ☐ | | | | `settlementId` | `` | ☐ | | | | `sort` | `` | ☐ | | | | `updatedFrom` | `` | ☐ | | | | `withArchived` | `` | ☐ | | | ## Columns of Table Function The columns of the table function `SettlementLineItems` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `agreementType` | `varchar2` | Agreement Type | ☐ | | | `archivedAt` | `datetime` | Archived at | ☐ | | | `articleId` | `varchar2` | Article ID | ☐ | | | `chapter` | `varchar2` | Chapter | ☐ | | | `createdAt` | `datetime` | Created at | ☐ | | | `deletedAt` | `datetime` | Deleted at | ☐ | | | `description` | `varchar2` | Description | ☐ | | | `discount` | `decimal` | Discount | ☐ | | | `extendedDescriptionRendered` | `varchar2` | Extended Description Rendered | ☐ | When reading, only present if requested via 'include' query parameter, otherwise null. | | `extendedDescription` | `varchar2` | Extended Description | ☐ | | | `extraFields` | `varchar2` | Extra Fields | ☐ | The JSON text of the nested object. | | `id` | `varchar2` | ID | ☐ | | | `imageId` | `varchar2` | | ☐ | | | `lineNumber` | `varchar2` | Line Number | ☐ | | | `lockedAt` | `datetime` | Locked at | ☐ | | | `materialId` | `varchar2` | Material ID | ☐ | | | `number` | `varchar2` | Number | ☐ | | | `price` | `decimal` | Price | ☐ | | | `quantityFormula` | `varchar2` | Quantity Formula | ☐ | | | `quantity` | `decimal` | 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. | | `settlementId` | `varchar2` | Settlement ID | ☐ | Only present when obtained via /api/v2/settlement-line-items or its bulk alias | | `styleName` | `varchar2` | Style Name | ☐ | | | `totalExclVatInDefaultCurrency` | `decimal` | | ☐ | 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. | | `totalExclVat` | `decimal` | Total excluding VAT | ☐ | 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. | | `type` | `varchar2` | Type | ☐ | | | `unitType` | `varchar2` | Unit Type | ☐ | | | `updatedAt` | `datetime` | Updated at | ☐ | | | `vatTariffId` | `varchar2` | VAT Tariff ID | ☐ | | ## Foreign Keys The values of these columns refer to a row of another table. | Columns | Referenced Table | Referenced Columns | Guarantee | |---|---|---|---| | `materialId` | [[Materials-Materials\|Materials.Materials]] | `id` | Declared by the connector, not enforced by the platform | | `settlementId` | [[Settlements-Settlements\|Settlements.Settlements]] | `id` | Declared by the connector, not enforced by the platform | | `vatTariffId` | [[VatTariffs-VatTariffs\|VatTariffs.VatTariffs]] | `id` | In words only: 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. |