# InventoryAvailabilityLotSerials
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
## Documentation
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
- Catalog: `NgSalesOrders`
- Schema: `Inventory`
This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API.
## Parameters of Table Function
The following parameters can be used to control the behaviour of the table function `InventoryAvailabilityLotSerials`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
| Name | Data Type | Required | Default Value | Documentation |
|---|:---:|:---:|:---:|---|
| `modifiedSinceCondition` | `` | ☐ | | Condition used in filtering when an inventory item's warehouse or location availability last changed |
| `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. |
## Columns of Table Function
The columns of the table function `InventoryAvailabilityLotSerials` are shown below. Each column has an SQL data type.
| Name | Data Type | Label | Required | Documentation |
|---|:---:|---|:---:|---|
| `COMPANY_CODE` | `varchar2(30)` | Company Code | ☑ | Partition code, segmenting the data. |
| `COMPANY_NAME` | `varchar2(240)` | Company Name | ☑ | Name of the partition. |
| `attributes` | `varchar2` | | ☐ | Attributes applied to the inventory item The JSON text of the nested object. |
| `baseUnit` | `varchar2` | Base Unit | ☐ | The base unit for the inventory item |
| `description_2` | `varchar2` | Description 2 | ☐ | The description of the inventory item |
| `description` | `varchar2` | Description | ☐ | The description of the warehouse |
| `estimatedTotalCost` | `double` | Estimated Total Cost | ☐ | The total cost for the QuantityOnHand |
| `estimatedUnitCost` | `double` | Estimated Unit Cost | ☐ | The estimated cost per unit, calculated as EstimatedTotalCost/QuantityOnHand |
| `expirationDate` | `datetime` | Expiration Date | ☐ | Expiration date of the LOT/Serial |
| `internalId` | `int32` | Internal ID | ☐ | The internal Id used by the system to identify the inventory item |
| `internalWarehouseId` | `int32` | | ☐ | The internal id used by the system for the warehouse |
| `inventoryId` | `varchar2` | Inventory ID | ☐ | The inventory id (InventoryCd) |
| `lastModified` | `datetime` | Last Modified | ☐ | 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. |
| `lotSerialNumber` | `varchar2` | Lot Serial Number | ☐ | Id/number of the LOT/Serial |
| `quantityAvailableForShipment_2` | `double` | | ☐ | 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 |
| `quantityAvailableForShipment` | `double` | | ☐ | Quantity of item LOT/Serial id available for shipping |
| `quantityAvailable_2` | `double` | | ☐ | 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 |
| `quantityAvailable` | `double` | | ☐ | Quantity available of item LOT/Serial id according to set availability calculation rules |
| `quantityNotAvailable_2` | `double` | | ☐ | 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. |
| `quantityNotAvailable` | `double` | | ☐ | Quantity of item LOT/Serial id not included in the availability calculation |
| `quantityOnHand_2` | `double` | | ☐ | Physical quantity on-hand of items in the specific warehouse |
| `quantityOnHand` | `double` | | ☐ | Physical quantity on-hand of item LOT/Serial id |
| `quantityPurchaseOrders` | `double` | | ☐ | The quantity of the inventory item included in open purchase orders. |
| `warehouseId` | `varchar2` | Warehouse ID | ☐ | The id (SiteCd) of the warehouse |