invantive documentation
Invantive Support ForumsLog In / Sign Up

SupplyOrders: Robaws Supply Orders

insert update delete REST

  • Catalog: Robaws
  • Schema: SupplyOrders
  • Primary Keys: id
  • Label: Supply Orders

Search

Can retrieve data and change data using insert, update and delete.

API Source

  • Endpoint: /api/v2/supply-orders
  • Operation: get /api/v2/supply-orders

Performance Characteristics

Characteristic Value
Average access latency (ms) 154
Full scan rows per minute 16,530
Point query rows per minute 645
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
articleId ``
assignedUserId ``
clientId ``
completed ``
materialId ``
projectId ``
purchaseInvoiceId ``
salesOrderId ``
searchText ``
sort ``
supplierId ``
supplyOrderId ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table SupplyOrders 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
archivedAt datetime Archived at filters on the platform, writable, archivedAt
assignedUserId varchar2 Assigned User ID filters on the platform, writable, assignedUserId
clientContactId varchar2 Client Contact ID filters on the platform, writable, clientContactId
clientContact_archivedAt datetime Client Contact Archived At filters on the platform, writable, clientContact.archivedAt
clientContact_createdAt datetime Client Contact Created At filters on the platform, writable, clientContact.createdAt
clientContact_deletedAt datetime Client Contact Deleted At filters on the platform, writable, clientContact.deletedAt
clientContact_email varchar2 Client Contact Email filters on the platform, writable, clientContact.email
clientContact_extraFields varchar2 Client Contact Extra Fields writable The JSON text of the nested object.
clientContact_gsm varchar2 Client Contact Mobile filters on the platform, writable, clientContact.gsm
clientContact_id varchar2 Client Contact ID filters on the platform, writable, clientContact.id
clientContact_lockedAt datetime Client Contact Locked At filters on the platform, writable, clientContact.lockedAt
clientContact_name varchar2 Client Contact Name filters on the platform, writable, clientContact.name
clientContact_position varchar2 Client Contact Position filters on the platform, writable, clientContact.position
clientContact_surname varchar2 Client Contact Surname filters on the platform, writable, clientContact.surname
clientContact_tel varchar2 Client Contact Phone filters on the platform, writable, clientContact.tel
clientContact_title varchar2 Client Contact Title filters on the platform, writable, clientContact.title
clientContact_updatedAt datetime Client Contact Updated At filters on the platform, writable, clientContact.updatedAt
clientId varchar2 Client ID filters on the platform, writable, clientId
client_archivedAt datetime Client Archived At filters on the platform, writable, client.archivedAt
client_assignedUserId varchar2 Client Assigned User ID filters on the platform, writable, client.assignedUserId
client_belgianCompanyNumber varchar2 Client Belgian Company Number filters on the platform, writable, client.belgianCompanyNumber
client_clientSince datetime Client Since filters on the platform, writable, client.clientSince
client_contactMedium varchar2 Client Contact Medium filters on the platform, writable, client.contactMedium
client_counterAccountCode int32 Client Counter Account Code filters on the platform, writable, client.counterAccountCode
client_createdAt datetime Client Created At filters on the platform, writable, client.createdAt
client_creditLimit decimal Client Credit Limit filters on the platform, writable, client.creditLimit
client_creditStatus varchar2 Client Credit Status filters on the platform, writable, client.creditStatus
client_currency varchar2 Client Currency filters on the platform, writable, client.currency
client_deletedAt datetime Client Deleted At filters on the platform, writable, client.deletedAt
client_email varchar2 Client Email filters on the platform, writable, client.email
client_externalId varchar2 Client External ID filters on the platform, writable, client.externalId
client_extraFields varchar2 Client Extra Fields writable The JSON text of the nested object.
client_fax varchar2 Client Fax filters on the platform, writable, client.fax
client_followUpDate datetime Client Follow-Up Date filters on the platform, writable, client.followUpDate
client_generalLedgerAccountId varchar2 Client General Ledger Account ID filters on the platform, writable, client.generalLedgerAccountId
client_globalLocationNumber varchar2 Client Global Location Number filters on the platform, writable, client.globalLocationNumber
client_gsm varchar2 Client Mobile filters on the platform, writable, client.gsm
client_id varchar2 Client ID filters on the platform, writable, client.id
client_invoiceEmail varchar2 Client Invoice Email filters on the platform, writable, client.invoiceEmail
client_invoiceRemarks varchar2 Client Invoice Remarks filters on the platform, writable, client.invoiceRemarks
client_kvk varchar2 Client Chamber of Commerce filters on the platform, writable, client.kvk
client_language varchar2 Client Language filters on the platform, writable, client.language
client_legalFormId varchar2 Client Legal Form ID filters on the platform, writable, client.legalFormId
client_leitwegId varchar2 Client Leitweg ID filters on the platform, writable, client.leitwegId
client_lockedAt datetime Client Locked At filters on the platform, writable, client.lockedAt
client_name varchar2 Client Name filters on the platform, writable, client.name
client_onPeppolNetwork char Client on Peppol Network filters on the platform, writable, client.onPeppolNetwork
client_paymentConditionId varchar2 Client Payment Condition ID filters on the platform, writable, client.paymentConditionId
client_preferredPeppolParticipantId varchar2 Client Preferred Peppol Participant ID filters on the platform, writable, client.preferredPeppolParticipantId
client_priceGroupId varchar2 Client Price Group ID filters on the platform, writable, client.priceGroupId
client_status varchar2 Client Status filters on the platform, writable, client.status
client_steuernummer varchar2 Client German Tax Number filters on the platform, writable, client.steuernummer
client_tel varchar2 Client Phone filters on the platform, writable, client.tel
client_title varchar2 Client Title filters on the platform, writable, client.title
client_updatedAt datetime Client Updated At filters on the platform, writable, client.updatedAt
client_useInvoiceAddress char Client Use Invoice Address filters on the platform, writable, client.useInvoiceAddress
client_vatIdNumber varchar2 Client VAT ID Number filters on the platform, writable, client.vatIdNumber
client_vatTariffId varchar2 Client VAT Tariff ID filters on the platform, writable, client.vatTariffId
client_website varchar2 Client Website filters on the platform, writable, client.website
client_withRespectTo varchar2 Client With Respect To filters on the platform, writable, client.withRespectTo
companyId varchar2 Company ID filters on the platform, writable, companyId
completed char Completed filters on the platform, writable, completed
completionPercentage decimal Completion Percentage filters on the platform, writable, completionPercentage
createdAt datetime Created at filters on the platform, writable, createdAt
date datetime Date filters on the platform, writable, date
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
deliveryAddress varchar2 Delivery Address filters on the platform, writable, deliveryAddress
deliveryContact varchar2 Delivery Contact filters on the platform, writable, deliveryContact
deliveryDate datetime Delivery Date filters on the platform, writable, deliveryDate
expectedDeliveryDate datetime Expected Delivery Date filters on the platform, writable, expectedDeliveryDate
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
footerText varchar2 Footer Text filters on the platform, writable, 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.
fromAddress varchar2 From Address filters on the platform, writable, fromAddress
hireEndDate datetime Hire End Date filters on the platform, writable, hireEndDate
hireStartDate datetime Hire Start Date filters on the platform, writable, hireStartDate
id varchar2 ID filters on the platform, writable, id
introText varchar2 Intro Text filters on the platform, writable, 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.
latestDeliveryDate datetime Latest Delivery Date filters on the platform, writable, latestDeliveryDate
loadAddress varchar2 Loading Address filters on the platform, writable, loadAddress
loadContact varchar2 Load Contact filters on the platform, writable, loadContact
loadDate datetime Load Date filters on the platform, writable, loadDate
lockedAt datetime Locked at filters on the platform, writable, lockedAt
logicId varchar2 Logical ID filters on the platform, writable, logicId
moveToLocation char Move to Location filters on the platform, writable, moveToLocation
openInvoiceAmount decimal Open Invoice Amount filters on the platform, writable, openInvoiceAmount
readyOnDate datetime Ready on Date filters on the platform, writable, readyOnDate
reference varchar2 Reference filters on the platform, writable, reference
remark varchar2 Remark filters on the platform, writable, remark
returnAddress varchar2 Return Address filters on the platform, writable, returnAddress
returnContact varchar2 Return Contact filters on the platform, writable, returnContact
returnDate datetime Return Date filters on the platform, writable, returnDate
sentViaWebshop datetime Sent via Webshop filters on the platform, writable, sentViaWebshop
status varchar2 Status filters on the platform, writable, status
statusDetails_color varchar2 Status Details Color filters on the platform, writable, statusDetails.color
statusDetails_name varchar2 Status Details Name filters on the platform, writable, statusDetails.name
supplierContactId varchar2 Supplier Contact ID filters on the platform, writable, supplierContactId
supplierContact_archivedAt datetime Supplier Contact Archived At filters on the platform, writable, supplierContact.archivedAt
supplierContact_createdAt datetime Supplier Contact Created At filters on the platform, writable, supplierContact.createdAt
supplierContact_deletedAt datetime Supplier Contact Deleted At filters on the platform, writable, supplierContact.deletedAt
supplierContact_email varchar2 Supplier Contact Email filters on the platform, writable, supplierContact.email
supplierContact_extraFields varchar2 Supplier Contact Extra Fields writable The JSON text of the nested object.
supplierContact_gsm varchar2 Supplier Contact Mobile filters on the platform, writable, supplierContact.gsm
supplierContact_id varchar2 Supplier Contact ID filters on the platform, writable, supplierContact.id
supplierContact_lockedAt datetime Supplier Contact Locked At filters on the platform, writable, supplierContact.lockedAt
supplierContact_name varchar2 Supplier Contact Name filters on the platform, writable, supplierContact.name
supplierContact_position varchar2 Supplier Contact Position filters on the platform, writable, supplierContact.position
supplierContact_surname varchar2 Supplier Contact Surname filters on the platform, writable, supplierContact.surname
supplierContact_tel varchar2 Supplier Contact Phone filters on the platform, writable, supplierContact.tel
supplierContact_title varchar2 Supplier Contact Title filters on the platform, writable, supplierContact.title
supplierContact_updatedAt datetime Supplier Contact Updated At filters on the platform, writable, supplierContact.updatedAt
supplierId varchar2 Supplier ID filters on the platform, writable, supplierId
supplier_archivedAt datetime Supplier Archived At filters on the platform, writable, supplier.archivedAt
supplier_confidential char Supplier Confidential filters on the platform, writable, supplier.confidential
supplier_counterAccountCode int32 Supplier Counter Account Code filters on the platform, writable, supplier.counterAccountCode
supplier_createdAt datetime Supplier Created At filters on the platform, writable, supplier.createdAt
supplier_currency varchar2 Supplier Currency filters on the platform, writable, supplier.currency
supplier_deletedAt datetime Supplier Deleted At filters on the platform, writable, supplier.deletedAt
supplier_email varchar2 Supplier Email filters on the platform, writable, supplier.email
supplier_extraFields varchar2 Supplier Extra Fields writable The JSON text of the nested object.
supplier_fax varchar2 Supplier Fax filters on the platform, writable, supplier.fax
supplier_generalLedgerAccountId varchar2 Supplier General Ledger Account ID filters on the platform, writable, supplier.generalLedgerAccountId
supplier_gln varchar2 Supplier GLN filters on the platform, writable, supplier.gln
supplier_gsm varchar2 Supplier Mobile filters on the platform, writable, supplier.gsm
supplier_iban varchar2 Supplier IBAN filters on the platform, writable, supplier.iban
supplier_id varchar2 Supplier ID filters on the platform, writable, supplier.id
supplier_incomingInvoiceAcceptanceFlowRuleId varchar2 Supplier Incoming Invoice Acceptance Flow Rule ID filters on the platform, writable, supplier.incomingInvoiceAcceptanceFlowRuleId
supplier_invoiceRemarks varchar2 Supplier Invoice Remarks filters on the platform, writable, supplier.invoiceRemarks
supplier_kvk varchar2 Supplier Chamber of Commerce filters on the platform, writable, supplier.kvk
supplier_language varchar2 Supplier Language filters on the platform, writable, supplier.language
supplier_legalFormId varchar2 Supplier Legal Form ID filters on the platform, writable, supplier.legalFormId
supplier_lockedAt datetime Supplier Locked At filters on the platform, writable, supplier.lockedAt
supplier_logicId varchar2 Supplier Logic ID filters on the platform, writable, supplier.logicId
supplier_name varchar2 Supplier Name filters on the platform, writable, supplier.name
supplier_paymentConditionId varchar2 Supplier Payment Condition ID filters on the platform, writable, supplier.paymentConditionId
supplier_planningEmail varchar2 Supplier Planning Email filters on the platform, writable, supplier.planningEmail
supplier_purchaseSupplyOrderAcceptanceFlowRuleId varchar2 Supplier Purchase Supply Order Acceptance Flow Rule ID filters on the platform, writable, supplier.purchaseSupplyOrderAcceptanceFlowRuleId
supplier_status varchar2 Supplier Status filters on the platform, writable, supplier.status
supplier_steuernummer varchar2 Supplier German Tax Number filters on the platform, writable, supplier.steuernummer
supplier_supplyOrderRemarks varchar2 Supplier Supply Order Remarks filters on the platform, writable, supplier.supplyOrderRemarks
supplier_tel varchar2 Supplier Phone filters on the platform, writable, supplier.tel
supplier_type varchar2 Supplier Type filters on the platform, writable, supplier.type
supplier_updatedAt datetime Supplier Updated At filters on the platform, writable, supplier.updatedAt
supplier_vatIdNumber varchar2 Supplier VAT ID Number filters on the platform, writable, supplier.vatIdNumber
supplier_vatTariffId varchar2 Supplier VAT Tariff ID filters on the platform, writable, supplier.vatTariffId
supplier_website varchar2 Supplier Website filters on the platform, writable, supplier.website
toAddress varchar2 To Address filters on the platform, writable, toAddress
toLocationId varchar2 To Location ID filters on the platform, writable, toLocationId
toLocation_archivedAt datetime To Location Archived At filters on the platform, writable, toLocation.archivedAt
toLocation_countAsAvailable char To Location Count as Available filters on the platform, writable, toLocation.countAsAvailable
toLocation_createdAt datetime To Location Created At filters on the platform, writable, toLocation.createdAt
toLocation_deletedAt datetime To Location Deleted At filters on the platform, writable, toLocation.deletedAt
toLocation_extraFields varchar2 To Location Extra Fields writable The JSON text of the nested object.
toLocation_id varchar2 To Location ID filters on the platform, writable, toLocation.id
toLocation_lockedAt datetime To Location Locked At filters on the platform, writable, toLocation.lockedAt
toLocation_name varchar2 To Location Name filters on the platform, writable, toLocation.name
toLocation_updatedAt datetime To Location Updated At filters on the platform, writable, toLocation.updatedAt
totalAmountInvoiced decimal Total Amount Invoiced filters on the platform, writable, totalAmountInvoiced
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat
totalInclVat decimal Total including VAT filters on the platform, writable, totalInclVat
transportType varchar2 Transport Type filters on the platform, writable, transportType
type varchar2 Type filters on the platform, writable, type
updatedAt datetime Updated at filters on the platform, writable, updatedAt

Release Notes

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