StockChanges: Robaws Stock Changes
insert update delete REST
- Catalog:
Robaws - Schema:
StockChanges - Primary Keys:
id - Label: Stock Changes
Search
Can retrieve data and change data using insert, update and delete.
API Source
- Endpoint:
/api/v2/stock-changes - Operation:
get /api/v2/stock-changes
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 100 |
| Full scan rows per minute | 37,848 |
| Point query rows per minute | 792 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
article |
`` | |||
assigned |
`` | |||
delivery |
`` | |||
is |
`` | |||
material |
`` | |||
order |
`` | |||
project |
`` | |||
sales |
`` | |||
search |
`` | |||
sort |
`` | |||
supply |
`` | |||
updated |
`` | |||
with |
`` | |||
work |
`` |
Table Columns
The columns of the table StockChanges 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 |
|---|---|---|---|---|---|
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
assigned |
varchar2 |
Assigned Employee ID | filters on the platform, writable, assigned |
||
assigned |
varchar2 |
Assigned Supplier ID | filters on the platform, writable, assigned |
||
assigned |
varchar2 |
Assigned User ID | filters on the platform, writable, assigned |
||
booked |
char |
Booked | filters on the platform, writable, booked |
||
booked |
datetime |
Booked at | filters on the platform, writable, booked |
The exact moment the stock change was booked, with the time of day (bookingDate holds only the date). Empty while the stock change is not booked. It is set while the booking is processed, before the booking is saved and the stock is revalued, so a booking only becomes visible some time after this moment; on a large stock that delay can be several minutes or more. Use it to order bookings within one day. To fetch changes incrementally, let each window overlap the previous one generously and skip ids you already have. | |
booking |
datetime |
Booking Date | filters on the platform, writable, booking |
||
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 |
varchar2 |
Delivery Note ID | filters on the platform, writable, delivery |
||
description |
varchar2 |
Description | filters on the platform, writable, description |
||
enumeration |
char |
Enumeration | filters on the platform, writable, enumeration |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
from |
varchar2 |
From Location ID | filters on the platform, writable, from |
||
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 |
||
sales |
varchar2 |
Sales Order ID | filters on the platform, writable, sales |
||
status |
varchar2 |
Status | filters on the platform, writable, status |
||
supply |
varchar2 |
Supply Order ID | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Archived At | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Assigned User ID | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Company ID | filters on the platform, writable, supply |
||
supply |
char |
Supply Order Completed | filters on the platform, writable, supply |
||
supply |
decimal |
Supply Order Completion Percentage | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Created At | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Deleted At | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Extra Fields | writable | The JSON text of the nested object. | |
supply |
varchar2 |
Supply Order Footer Text | filters on the platform, writable, supply |
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 |
|
supply |
varchar2 |
Supply Order ID | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Intro Text | filters on the platform, writable, supply |
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 |
|
supply |
datetime |
Supply Order Locked At | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Logic ID | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Reference | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Remark | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Status | filters on the platform, writable, supply |
||
supply |
decimal |
Supply Order Total Excluding VAT | filters on the platform, writable, supply |
||
supply |
decimal |
Supply Order Total Including VAT | filters on the platform, writable, supply |
||
supply |
varchar2 |
Supply Order Type | filters on the platform, writable, supply |
||
supply |
datetime |
Supply Order Updated At | filters on the platform, writable, supply |
||
to |
varchar2 |
To Client ID | filters on the platform, writable, to |
||
to |
varchar2 |
To Location ID | filters on the platform, writable, to |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
||
work |
varchar2 |
Work Order ID | filters on the platform, writable, work |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Stock |
assigned |
Employees.id |
Key | |
Stock |
assigned |
Suppliers.id |
Key | |
Stock |
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. |
Stock |
delivery |
DeliveryNotes.id |
Key | |
Stock |
from |
StockLocations.id |
Key | |
Stock |
sales |
SalesOrders.id |
Key | |
Stock |
to |
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. |
Stock |
to |
StockLocations.id |
Key | |
Stock |
work |
WorkOrders.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. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: