InventoryAvailabilityLotSerials: Visma.net Financials itgen_vnet_inventoryavailabilitylotserials_plural
read only REST
- Catalog:
NgSalesOrders - Schema:
Inventory - Label: itgen_vnet_inventoryavailabilitylotserials_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 InventoryAvailabilityLotSerials 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, ::ancestor. |
The base unit for the inventory item | |
description |
varchar2 |
Description | writable, ::ancestor. |
The description of the warehouse | |
description_ |
varchar2 |
Description 2 | filters on the platform, writable, ::ancestor. |
The description of the inventory item | |
estimated |
double |
Estimated Total Cost | writable, ::ancestor. |
The total cost for the QuantityOnHand | |
estimated |
double |
Estimated Unit Cost | writable, ::ancestor. |
The estimated cost per unit, calculated as EstimatedTotalCost/QuantityOnHand | |
expiration |
datetime |
Expiration Date | writable, expiration |
Expiration date of the LOT/Serial | |
internal |
int32 |
Internal ID | filters on the platform, writable, ::ancestor. |
The internal Id used by the system to identify the inventory item | |
internal |
int32 |
itgen_vnet_internalwarehouseid | writable, ::ancestor. |
The internal id used by the system for the warehouse | |
inventory |
varchar2 |
Inventory ID | filters on the platform, writable, ::ancestor. |
The inventory id (InventoryCd) | |
last |
datetime |
Last Modified | writable, ::ancestor. |
The date and time the entry for this warehouse was modified 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. | |
lot |
varchar2 |
Lot Serial Number | writable, lot |
Id/number of the LOT/Serial | |
quantity |
double |
itgen_vnet_quantityavailable | writable, quantity |
Quantity available of item LOT/Serial id according to set availability calculation rules | |
quantity |
double |
itgen_vnet_quantityavailableforshipment | writable, quantity |
Quantity of item LOT/Serial id available for shipping | |
quantity |
double |
itgen_vnet_quantityavailableforshipment_2 | writable, ::ancestor. |
Estimated quantity calculated by using the following formula: the QuantityOnHand minus the quantity on unreleased inventory issues, minus the quantity allocated for shipping. Thus, the QuantityAvailableForShipment can be less than the QuantityOnHand | |
quantity |
double |
itgen_vnet_quantityavailable_2 | writable, ::ancestor. |
You can configure the way this estimated quantity is calculated by using availability calculation rules. The available quantity may include anticipated transactions and therefore may be less than or greater than the QuantityOnHand. Anticipated transactions correspond to the documents and transactions that have been entered in the system but not yet processed to the end. In the availability calculation settings of an item class, you specify which anticipated transactions affect the available quantity. Thus, the available quantity may include goods on purchase orders and exclude the goods allocated for sales orders. You can use the available quantity as an indicator of demand | |
quantity |
double |
itgen_vnet_quantitynotavailable | writable, quantity |
Quantity of item LOT/Serial id not included in the availability calculation | |
quantity |
double |
itgen_vnet_quantitynotavailable_2 | writable, ::ancestor. |
The quantity stored at locations not included in the availability calculation. For each warehouse location, the 'Include in Qty. Available' check box on the Warehouses(IN204000) screen defines whether the quantity of items stored at this location is included in the quantity of available items. | |
quantity |
double |
itgen_vnet_quantityonhand | writable, quantity |
Physical quantity on-hand of item LOT/Serial id | |
quantity |
double |
itgen_vnet_quantityonhand_2 | writable, ::ancestor. |
Physical quantity on-hand of items in the specific warehouse | |
quantity |
double |
itgen_vnet_quantitypurchaseorders | writable, ::ancestor. |
The quantity of the inventory item included in open purchase orders. | |
warehouse |
varchar2 |
Warehouse ID | writable, ::ancestor. |
The id (SiteCd) of the warehouse |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: