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 |
|---|---|---|---|---|
project |
`` | |||
sales |
`` | |||
search |
`` | |||
sort |
`` | |||
supplier |
`` | |||
updated |
`` | |||
with |
`` |
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_ |
varchar2 |
Address Line 1 | filters on the platform, writable, address. |
||
address_ |
varchar2 |
Address Line 2 | filters on the platform, writable, address. |
||
address_ |
varchar2 |
City | filters on the platform, writable, address. |
||
address_ |
varchar2 |
Country | filters on the platform, writable, address. |
||
address_ |
double |
Address Latitude | filters on the platform, writable, address. |
||
address_ |
double |
Address Longitude | filters on the platform, writable, address. |
||
address_ |
varchar2 |
Address Postal Code | filters on the platform, writable, address. |
||
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
assigned |
varchar2 |
Assigned User ID | filters on the platform, writable, assigned |
||
client |
varchar2 |
Client Contact ID | filters on the platform, writable, client |
||
client |
varchar2 |
Client ID | filters on the platform, writable, client |
||
client |
varchar2 |
Customer Reference | filters on the platform, writable, client |
||
company |
varchar2 |
Company ID | filters on the platform, writable, company |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
date |
datetime |
Date | filters on the platform, writable, date |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
delivery |
datetime |
Delivery Date | filters on the platform, writable, delivery |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
id |
varchar2 |
ID | filters on the platform, writable, id |
||
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
logic |
varchar2 |
Logical ID | filters on the platform, writable, logic |
||
project |
varchar2 |
Project ID | filters on the platform, writable, project |
||
received |
datetime |
Received Date | filters on the platform, writable, received |
||
remarks |
varchar2 |
Remarks | filters on the platform, writable, remarks |
||
sales |
varchar2 |
Sales Order ID | filters on the platform, writable, sales |
||
status |
varchar2 |
Status | filters on the platform, writable, status |
||
supplier |
varchar2 |
Supplier ID | filters on the platform, writable, supplier |
||
total |
decimal |
Total excluding VAT | filters on the platform, writable, total |
||
total |
decimal |
Total including VAT | filters on the platform, writable, total |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Delivery |
assigned |
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. |
Delivery |
client |
Contacts.id |
Key | |
Delivery |
client |
Clients.id |
Key | |
Delivery |
company |
Companies.id |
Key | |
Delivery |
project |
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. |
Delivery |
sales |
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. |
Delivery |
supplier |
Suppliers.id |
Key |
Referenced By
- SalesInvoices
deliveryNoteId(Key) - StockChanges
deliveryNoteId(Key)
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: