invantive documentation
Invantive Support ForumsLog In / Sign Up

InventoryAvailabilities: Visma.net Financials itgen_vnet_inventoryavailabilities_plural

read only REST

  • Catalog: NgSalesOrders
  • Schema: Inventory
  • Label: itgen_vnet_inventoryavailabilities_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
modifiedSince `` 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.
modifiedSinceCondition `` Condition used in filtering when an inventory item's warehouse or location availability last changed

Table Columns

The columns of the table InventoryAvailabilities 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_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) 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.
baseUnit varchar2 Base Unit filters on the platform, writable, ::ancestor.baseUnit The base unit for the inventory item
description varchar2 Description writable, description The description of the warehouse
description_2 varchar2 Description 2 filters on the platform, writable, ::ancestor.description The description of the inventory item
estimatedTotalCost double Estimated Total Cost writable, estimatedTotalCost The total cost for the QuantityOnHand
estimatedUnitCost double Estimated Unit Cost writable, estimatedUnitCost The estimated cost per unit, calculated as EstimatedTotalCost/QuantityOnHand
internalId int32 Internal ID filters on the platform, writable, ::ancestor.internalId The internal Id used by the system to identify the inventory item
internalWarehouseId int32 itgen_vnet_internalwarehouseid writable, internalWarehouseId The internal id used by the system for the warehouse
inventoryId varchar2 Inventory ID filters on the platform, writable, ::ancestor.inventoryId The inventory id (InventoryCd)
lastModified datetime Last Modified writable, lastModified 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.
quantityAvailable double itgen_vnet_quantityavailable writable, quantityAvailable 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
quantityAvailableForShipment double itgen_vnet_quantityavailableforshipment writable, quantityAvailableForShipment 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
quantityNotAvailable double itgen_vnet_quantitynotavailable writable, quantityNotAvailable 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.
quantityOnHand double itgen_vnet_quantityonhand writable, quantityOnHand Physical quantity on-hand of items in the specific warehouse
quantityPurchaseOrders double itgen_vnet_quantitypurchaseorders writable, quantityPurchaseOrders The quantity of the inventory item included in open purchase orders.
warehouseId varchar2 Warehouse ID writable, warehouseId The id (SiteCd) of the warehouse

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: