Visma.net Financials API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: InventorySummary > Tables

InventorySummaryByNumber: Visma.net Financials Inventory Summary by Number

Contents Previous Home Next More

Get a range of InventorySummary - ScreenId=IN401000

Catalog: VismaNet

Schema: InventorySummary

Label: Inventory Summary by Number

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL 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.

Select Visma.net Financials API URL: /controller/api/v1/inventorysummary/{inventoryNumber}

Insert Visma.net Financials API URL: /controller/api/v1/inventorysummary/{inventoryNumber}

Update Visma.net Financials API URL: /controller/api/v1/inventorysummary/{inventoryNumber}

Delete Visma.net Financials API URL: /controller/api/v1/inventorysummary/{inventoryNumber}

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: get /controller/api/v1/inventorysummary/{inventoryNumber}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function InventorySummaryByNumber. 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 treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `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	Documentation
COMPANY_CODE	string	☐	Partition to retrieve data from.
inventoryNumber	string	☑
location	string	☐
warehouse	string	☐

Table Function Columns

The columns of the table function InventorySummaryByNumber are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
available	double	Available	☐	The table > Available > The quantity of the stock items available at the specific warehouse and location.
availableForShipment	double		☐	The table > Available for shipment > The quantity of the stock items available at the specific warehouse and location calculated based on the quantity on hand with the quantities shipped and on shipping deducted.
baseUnit	string	Base Unit	☐	The table > Base unit > The unit of measure (UoM) selected as the base unit for the stock items in the Stock items (IN202500) window.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
dropShipForSO	double		☐	The table > Drop-ship for sales order > The quantity of the stock items listed on open drop-ship orders. This value is not included in the quantity available.
dropShipForSOPrepared	double		☐	The table > Drop-ship for sales order, prepared > The quantity of the stock items listed on drop-ship sales orders with a status of On hold or Pending approval; this value is not included in the quantity available.
dropShipForSOReceipts	double		☐	The table > Drop-ship for sales order, receipts > The quantity of the stock items listed on receipts for drop-ship sales orders; this value is not included in the quantity available.
errorInfo	string	Error Message	☐
estimatedTotalCost	double	Estimated Total Cost	☐	The table > Estimated total cost > The estimated total cost of the stock items available at the specified warehouse and location.
estimatedUnitCost	double	Estimated Unit Cost	☐	The table > Estimated unit cost > The estimated unit cost of the selected stock items.
expired	double	Expired	☐	The table > Expired > The quantity of the stock items that has reached its expiration date.
inAssemblyDemand	double		☐	The table > In assembly demand > The quantity of the stock items included in unreleased kit assembly documents as components or kits, depending on whether the item is a kit or a kit component.
inAssemblySupply	double		☐	The table > In assembly supply > The quantity of the stock items listed on unreleased kit assembly documents.
inIssues	double		☐	The table > Inventory issues > The quantity of the stock items included in the inventory issue documents that have not yet been released.
inReceipts	double		☐	The table > Invnetory receipts > The quantity of the stock items included in the inventory receipt documents that have not yet been released.
inTransit	double	Intransit	☐	The table > In transit > The quantity of the stock items included as in transit quantities in the inventory transfer documents that have not yet been released.
inventory_description	string	Inventory Description	☐	Name of item/description
inventory_number	string	Inventory Number	☐	Number of item
location_id	int32	Location ID	☐	Click the magnifier > The identifier
location_name	string	Location Name	☐	Click the magnifier > The displayed name
metadata_maxPageSize	int64		☐
metadata_totalCount	int64	Total Count	☐
notAvailable	double	Not Available	☐	The table > Not available > The quantity of the stock items on locations for which the Include in qty. available option is not selected.
onHand	double	On Hand	☐	The table > On hand > The quantity of the stock items available on hand at the specified warehouse and location.
poReceipts	double		☐	The table > Purchase order receipts > The quantity of the stock items included in the purchase receipts that have not yet been released. To view the purchase receipts, open the Purchase receipts (PO302000) window.
purchaseForSO	double		☐	The table > Purchase for sales order. > The quantity of the stock items listed on open purchase orders created for sales orders.
purchaseForSOPrepared	double		☐	The table > Purchase for sales order prepared > The quantity of the stock items listed on purchase orders yet on hold or pending approval and created for back orders.
purchaseForSOReceipts	double		☐	The table > Purchase for sales order receipts > The quantity of the stock items listed on purchase receipts for orders that were created for sales orders.
purchaseOrders	double		☐	The table > Purchase orders > The quantity of the stock items included in open purchase orders. To view the purchase orders, open the Purchase orders (PO301000) window.
purchasePrepared	double		☐	The table > Purchase prepared > The quantity of the stock items listed on purchase orders pending approval and on hold.
soAllocated	double		☐	The table > Sales order allocated > The quantity of stock items set aside according to sales orders.
soBackOrdered	double		☐	The table > Back orders > The quantity of the stock items on sales orders with the Back order status.
soBooked	double		☐	The table > Sales order booked > The quantity of the stock items booked according to sales orders.
soShipped	double		☐	The table > Sales orders shipped > The quantity of the stock items shipped according to the confirmed shipments.
soToDropShip	double		☐	The table > Sales order to drop-ship > The quantity of the stock items included in open purchase orders created for drop-ship orders.
soToPurchase	double		☐	The table > Sales order to purchase > The quantity of the stock items included in unreleased sales orders requiring creating purchase orders.
warehouse_description	string	Warehouse Description	☐	Click on the magnifier. > The description.
warehouse_id	string	Warehouse ID	☐	Click on the magnifier. > The identifier.

06-04-2021 14:55 Version 20.1.393-BETA+3152

Please enable JavaScript to view this site.

itgendoc001X

Visma.net Financials API Data Model

Table Function Parameters

Table Function Columns