Inventories: Visma.net Financials itgen_vnet_inventories_plural
read only REST
- Catalog:
NgSalesOrders - Schema:
Inventory - Label: itgen_vnet_inventories_plural
Gets an inventory summary for inventory items. Sample request:
GET /inventory?inventoryId=Item1
GET /inventory?warehouseId=MAIN&modifiedSince=2021-08-01T12:00:00&modifiedSinceCondition=>&pageSize=1000
If modifiedSinceCondition is not specified, it defaults to >=. If modifiedSince is not specified, it defaults to 1900-01-01.
If expand with lotSerial, only the lotSerial numbers that has quantity will be included in the response.
GET /inventory?inventoryId=Item1&InventoryId=Item2&expand=location,attribute,lotSerial
GET /inventory?expand=location&attributeFilter=WEBSHOP:1
Can only retrieve data.
Summary
Sample request:
GET /inventory?inventoryId=Item1
GET /inventory?warehouseId=MAIN&modifiedSince=2021-08-01T12:00:00&modifiedSinceCondition=>&pageSize=1000
If modifiedSinceCondition is not specified, it defaults to >=. If modifiedSince is not specified, it defaults to 1900-01-01.
If expand with lotSerial, only the lotSerial numbers that has quantity will be included in the response.
GET /inventory?inventoryId=Item1&InventoryId=Item2&expand=location,attribute,lotSerial
GET /inventory?expand=location&attributeFilter=WEBSHOP:1
API Source
- Endpoint:
/api/v3/Inventory - Operation:
get /api/v3/Inventory
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 155 |
| Full scan rows per minute | 29,100 |
| Point query rows per minute | 387 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
modified |
`` | A date/time value for filtering when an inventory item's warehouse or location availability last changed Unless a specific time zone offset is included (e.g. '2012-12-24T12:15:14+02:00'), the date is considered to be in the UTC time zone. | ||
modified |
`` | Condition used in filtering when an inventory item's warehouse or location availability last changed |
Table Columns
The columns of the table Inventories 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 |
|---|---|---|---|---|---|
COMPANY_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
attributes |
varchar2 |
itgen_vnet_attributes | writable | Attributes applied to the inventory item The JSON text of the nested object. | |
base |
varchar2 |
Base Unit | filters on the platform, writable, base |
The base unit for the inventory item | |
description |
varchar2 |
Description | filters on the platform, writable, description |
The description of the inventory item | |
internal |
int32 |
Internal ID | filters on the platform, writable, internal |
The internal Id used by the system to identify the inventory item | |
inventory |
varchar2 |
Inventory ID | filters on the platform, writable, inventory |
The inventory id (InventoryCd) |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: