invantive documentation
Invantive Support ForumsLog In / Sign Up

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
articleId ``
assignedEmployeeId ``
deliveryNoteId ``
isBookedOnly ``
materialId ``
orderId ``
projectId ``
salesOrderId ``
searchText ``
sort ``
supplyOrderId ``
updatedFrom ``
withArchived ``
workOrderId ``

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
archivedAt datetime Archived at filters on the platform, writable, archivedAt
assignedEmployeeId varchar2 Assigned Employee ID filters on the platform, writable, assignedEmployeeId
assignedSupplierId varchar2 Assigned Supplier ID filters on the platform, writable, assignedSupplierId
assignedUserId varchar2 Assigned User ID filters on the platform, writable, assignedUserId
booked char Booked filters on the platform, writable, booked
bookedAt datetime Booked at filters on the platform, writable, bookedAt 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.
bookingDate datetime Booking Date filters on the platform, writable, bookingDate
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
deliveryNoteId varchar2 Delivery Note ID filters on the platform, writable, deliveryNoteId
description varchar2 Description filters on the platform, writable, description
enumeration char Enumeration filters on the platform, writable, enumeration
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
fromLocationId varchar2 From Location ID filters on the platform, writable, fromLocationId
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
salesOrderId varchar2 Sales Order ID filters on the platform, writable, salesOrderId
status varchar2 Status filters on the platform, writable, status
supplyOrderId varchar2 Supply Order ID filters on the platform, writable, supplyOrderId
supplyOrder_archivedAt datetime Supply Order Archived At filters on the platform, writable, supplyOrder.archivedAt
supplyOrder_assignedUserId varchar2 Supply Order Assigned User ID filters on the platform, writable, supplyOrder.assignedUserId
supplyOrder_companyId varchar2 Supply Order Company ID filters on the platform, writable, supplyOrder.companyId
supplyOrder_completed char Supply Order Completed filters on the platform, writable, supplyOrder.completed
supplyOrder_completionPercentage decimal Supply Order Completion Percentage filters on the platform, writable, supplyOrder.completionPercentage
supplyOrder_createdAt datetime Supply Order Created At filters on the platform, writable, supplyOrder.createdAt
supplyOrder_deletedAt datetime Supply Order Deleted At filters on the platform, writable, supplyOrder.deletedAt
supplyOrder_extraFields varchar2 Supply Order Extra Fields writable The JSON text of the nested object.
supplyOrder_footerText varchar2 Supply Order Footer Text filters on the platform, writable, supplyOrder.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.
supplyOrder_id varchar2 Supply Order ID filters on the platform, writable, supplyOrder.id
supplyOrder_introText varchar2 Supply Order Intro Text filters on the platform, writable, supplyOrder.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.
supplyOrder_lockedAt datetime Supply Order Locked At filters on the platform, writable, supplyOrder.lockedAt
supplyOrder_logicId varchar2 Supply Order Logic ID filters on the platform, writable, supplyOrder.logicId
supplyOrder_reference varchar2 Supply Order Reference filters on the platform, writable, supplyOrder.reference
supplyOrder_remark varchar2 Supply Order Remark filters on the platform, writable, supplyOrder.remark
supplyOrder_status varchar2 Supply Order Status filters on the platform, writable, supplyOrder.status
supplyOrder_totalExclVat decimal Supply Order Total Excluding VAT filters on the platform, writable, supplyOrder.totalExclVat
supplyOrder_totalInclVat decimal Supply Order Total Including VAT filters on the platform, writable, supplyOrder.totalInclVat
supplyOrder_type varchar2 Supply Order Type filters on the platform, writable, supplyOrder.type
supplyOrder_updatedAt datetime Supply Order Updated At filters on the platform, writable, supplyOrder.updatedAt
toClientId varchar2 To Client ID filters on the platform, writable, toClientId
toLocationId varchar2 To Location ID filters on the platform, writable, toLocationId
updatedAt datetime Updated at filters on the platform, writable, updatedAt
workOrderId varchar2 Work Order ID filters on the platform, writable, workOrderId

Keys

Key Column Refers to Kind Description
StockChanges_assignedEmployeeId_fk assignedEmployeeId Employees.id Key
StockChanges_assignedSupplierId_fk assignedSupplierId Suppliers.id Key
StockChanges_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.
StockChanges_deliveryNoteId_fk deliveryNoteId DeliveryNotes.id Key
StockChanges_fromLocationId_fk fromLocationId StockLocations.id Key
StockChanges_salesOrderId_fk salesOrderId SalesOrders.id Key
StockChanges_toClientId_txt toClientId 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.
StockChanges_toLocationId_fk toLocationId StockLocations.id Key
StockChanges_workOrderId_txt workOrderId 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: