invantive documentation
Invantive Support ForumsLog In / Sign Up

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
articleId ``
purchaseInvoiceId ``
searchText ``
sort ``
updatedFrom ``
withArchived ``

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
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
dateFrom datetime Date From filters on the platform, writable, dateFrom
dateTo datetime Date To filters on the platform, writable, dateTo
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
excludeFromPostCalculation char Exclude From Post Calculation filters on the platform, writable, excludeFromPostCalculation
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
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
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
purchaseInvoiceId varchar2 Purchase Invoice ID filters on the platform, writable, purchaseInvoiceId 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.
salesOrderId varchar2 Sales Order ID filters on the platform, writable, salesOrderId
styleName varchar2 Style Name filters on the platform, writable, styleName
supplyOrderId varchar2 Supply Order ID filters on the platform, writable, supplyOrderId
supplyOrder_archivedAt datetime Supply Order Archived At filters on the platform, writable, supplyOrder.archivedAt
supplyOrder_assignedUserId varchar2 Supply Order Assigned User ID filters on the platform, writable, supplyOrder.assignedUserId
supplyOrder_companyId varchar2 Supply Order Company ID filters on the platform, writable, supplyOrder.companyId
supplyOrder_completed char Supply Order Completed filters on the platform, writable, supplyOrder.completed
supplyOrder_completionPercentage decimal Supply Order Completion Percentage filters on the platform, writable, supplyOrder.completionPercentage
supplyOrder_createdAt datetime Supply Order Created At filters on the platform, writable, supplyOrder.createdAt
supplyOrder_deletedAt datetime Supply Order Deleted At filters on the platform, writable, supplyOrder.deletedAt
supplyOrder_extraFields varchar2 Supply Order Extra Fields writable The JSON text of the nested object.
supplyOrder_footerText varchar2 Supply Order Footer Text filters on the platform, writable, supplyOrder.footerText 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 with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. When writing, omit it or send null to keep the current text; send an empty string to clear it.
supplyOrder_id varchar2 Supply Order ID filters on the platform, writable, supplyOrder.id
supplyOrder_introText varchar2 Supply Order Intro Text filters on the platform, writable, supplyOrder.introText 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 with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. When writing, omit it or send null to keep the current text; send an empty string to clear it.
supplyOrder_lockedAt datetime Supply Order Locked At filters on the platform, writable, supplyOrder.lockedAt
supplyOrder_logicId varchar2 Supply Order Logic ID filters on the platform, writable, supplyOrder.logicId
supplyOrder_reference varchar2 Supply Order Reference filters on the platform, writable, supplyOrder.reference
supplyOrder_remark varchar2 Supply Order Remark filters on the platform, writable, supplyOrder.remark
supplyOrder_status varchar2 Supply Order Status filters on the platform, writable, supplyOrder.status
supplyOrder_totalExclVat decimal Supply Order Total Excluding VAT filters on the platform, writable, supplyOrder.totalExclVat
supplyOrder_totalInclVat decimal Supply Order Total Including VAT filters on the platform, writable, supplyOrder.totalInclVat
supplyOrder_type varchar2 Supply Order Type filters on the platform, writable, supplyOrder.type
supplyOrder_updatedAt datetime Supply Order Updated At filters on the platform, writable, supplyOrder.updatedAt
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat 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.
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 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
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

Release Notes

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