invantive documentation
Invantive Support ForumsLog In / Sign Up

SalesOrders: Robaws Sales Orders

insert update delete REST

  • Catalog: Robaws
  • Schema: SalesOrders
  • Primary Keys: id
  • Label: Sales Orders

Search

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

API Source

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

Performance Characteristics

Characteristic Value
Average access latency (ms) 116
Full scan rows per minute 16,408
Point query rows per minute 917
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
clientId ``
materialId ``
offerId ``
projectId ``
purchaseInvoiceId ``
salesInvoiceId ``
searchText ``
sort ``
subscriptionId ``
supplyOrderId ``
updatedFrom ``
withArchived ``
workOrderId ``

Table Columns

The columns of the table SalesOrders 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
address_addressLine1 varchar2 Address Line 1 filters on the platform, writable, address.addressLine1
address_addressLine2 varchar2 Address Line 2 filters on the platform, writable, address.addressLine2
address_city varchar2 City filters on the platform, writable, address.city
address_country varchar2 Country filters on the platform, writable, address.country
address_latitude double Address Latitude filters on the platform, writable, address.latitude
address_longitude double Address Longitude filters on the platform, writable, address.longitude
address_postalCode varchar2 Address Postal Code filters on the platform, writable, address.postalCode
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
clientId varchar2 Client ID filters on the platform, writable, clientId
clientReference varchar2 Customer Reference filters on the platform, writable, clientReference
companyId varchar2 Company ID filters on the platform, writable, companyId
createdAt datetime Created at filters on the platform, writable, createdAt
currency varchar2 Currency filters on the platform, writable, currency
date datetime Date filters on the platform, writable, date
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
endClientContactId varchar2 End Client Contact ID filters on the platform, writable, endClientContactId
endClientId varchar2 End Client ID filters on the platform, writable, endClientId
executionPercentage decimal Execution Percentage filters on the platform, writable, executionPercentage
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
id varchar2 ID filters on the platform, writable, id
lockedAt datetime Locked at filters on the platform, writable, lockedAt
logicId varchar2 Logical ID filters on the platform, writable, logicId
offerId varchar2 Offer ID filters on the platform, writable, offerId
projectId varchar2 Project ID filters on the platform, writable, projectId
remark varchar2 Remark filters on the platform, writable, remark
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
subscriptionId varchar2 Subscription ID filters on the platform, writable, subscriptionId
title varchar2 Title filters on the platform, writable, title
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat
totalInclVat decimal Total including VAT filters on the platform, writable, totalInclVat
type varchar2 Type filters on the platform, writable, type
updatedAt datetime Updated at filters on the platform, writable, updatedAt
workOrderInfo varchar2 Work Order Information filters on the platform, writable, workOrderInfo 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.

Keys

Key Column Refers to Kind Description
SalesOrders_assignedUserId_txt assignedUserId Users.id Textual 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.
SalesOrders_clientContactId_txt clientContactId Contacts.id Textual 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.
SalesOrders_clientId_txt clientId Clients.id Textual 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.
SalesOrders_companyId_fk companyId Companies.id Key
SalesOrders_endClientContactId_fk endClientContactId Contacts.id Key
SalesOrders_endClientId_fk endClientId Clients.id Key
SalesOrders_projectId_txt projectId Projects.id Textual 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.
SalesOrders_subscriptionId_fk subscriptionId Subscriptions.id Key

Referenced By

Release Notes

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