invantive documentation
Invantive Support ForumsLog In / Sign Up

DeliveryNotes: Robaws Delivery Notes

insert update delete REST

  • Catalog: Robaws
  • Schema: DeliveryNotes
  • Primary Keys: id
  • Label: Delivery Notes

Search

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

API Source

  • Endpoint: /api/v2/delivery-notes
  • Operation: get /api/v2/delivery-notes

Performance Characteristics

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

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
projectId ``
salesOrderId ``
searchText ``
sort ``
supplierId ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table DeliveryNotes 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
date datetime Date filters on the platform, writable, date
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
deliveryDate datetime Delivery Date filters on the platform, writable, deliveryDate
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
projectId varchar2 Project ID filters on the platform, writable, projectId
receivedDate datetime Received Date filters on the platform, writable, receivedDate
remarks varchar2 Remarks filters on the platform, writable, remarks
salesOrderId varchar2 Sales Order ID filters on the platform, writable, salesOrderId
status varchar2 Status filters on the platform, writable, status
supplierId varchar2 Supplier ID filters on the platform, writable, supplierId
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat
totalInclVat decimal Total including VAT filters on the platform, writable, totalInclVat
updatedAt datetime Updated at filters on the platform, writable, updatedAt

Keys

Key Column Refers to Kind Description
DeliveryNotes_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.
DeliveryNotes_clientContactId_fk clientContactId Contacts.id Key
DeliveryNotes_clientId_fk clientId Clients.id Key
DeliveryNotes_companyId_fk companyId Companies.id Key
DeliveryNotes_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.
DeliveryNotes_salesOrderId_txt salesOrderId SalesOrders.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.
DeliveryNotes_supplierId_fk supplierId Suppliers.id Key

Referenced By

Release Notes

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