InventoryUnits: Visma.net Financials Inventory Units
popular read only REST
- Catalog:
VismaNet - Schema:
Inventory - Label: Inventory Units
Get a range of Inventory items - ScreenId=IN202000 and IN202500 Data for Inventory
Can only retrieve data.
Summary
Data for Inventory
API Source
- Endpoint:
/v1/inventory - Operation:
get /v1/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 |
|---|---|---|---|---|
add |
`` | This filter can be used only for stock items, from the Price/cost information tab. | ||
alternate |
`` | Applies for both Stock and Non-stock items. Some fields in this filter applies only for one of these. | ||
attachment |
`` | System retrieved information for last modified date and time for attachment. | ||
attachment |
`` | System retrieved information for state/condition for attachment. | ||
attributes |
`` | Attributes (additional information) connected to the entity. Examples: {{base}}/inventory?attributes={"AttributeID":"ValueID","AttributeID":"ValueID"} {{base}}/inventory?attributes={"AttributeID":"ValueID1,ValueID2"} | ||
availability |
`` | System retrieved information. | ||
availability |
`` | System retrieved information for state/condition. | ||
created |
`` | This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present. Accepted format: * yyyy- * yyyy- * yyyy- * yyyy- * yyyy- Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive. |
||
created |
`` | This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: CreatedDateTime and CreatedDateTimeCondition are mutually inclusive. | ||
description |
`` | A brief description of the stock item from the Top part of the window. | ||
expand |
`` | Set to true to retrieve information about the account information connected to the item. | ||
expand |
`` | Set to true to retrieve information about the attachments connected to the item. | ||
expand |
`` | Set to true to retrieve the attribute descriptions used for the item. | ||
expand |
`` | These expand fields are by default set to true, but will be changed in the future. Set to true to retrieve information about the cross-references (item ID and suppliers/customers ID for the item connected to the item. | ||
expand |
`` | Set to true to retrieve information about the units of measure connected to the item. | ||
expand |
`` | Set to true to retrieve the note value connected to the item. | ||
expand |
`` | Set to true to retrieve details about the sales categories connected to the item. | ||
expand |
`` | Set to true to retrieve details about the supplier connected to the item. | ||
expand |
`` | Set to true to retrieve information about the warehouse connected to the item. | ||
greater |
`` | Greater than value. The item which is the object for this, varies from API to API. | ||
inventory |
`` | The Item ID. | ||
last |
`` | This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present. Accepted format: * yyyy- * yyyy- * yyyy- * yyyy- * yyyy- Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive. |
||
last |
`` | This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive. | ||
sales |
`` | The Category ID for the sales category, found on the Attributes tab. | ||
status |
`` | The inventory item status (Values: Active, NoSales, NoPurchases, NoRequest, Inactive, MarkedForDeletion) |
Table Columns
The columns of the table InventoryUnits 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. | |
account |
varchar2 |
itgen_vnet_accountinformation_cogsaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_cogsaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_cogsaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
char |
itgen_vnet_accountinformation_cogssubaccount_active | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_cogssubaccount_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
account |
varchar2 |
itgen_vnet_accountinformation_cogssubaccount_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_expenseaccrualaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseaccrualaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseaccrualaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_expenseeuaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseeuaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseeuaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_expenseimportaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseimportaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_expenseimportaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_expensenontaxableaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_expensenontaxableaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_expensenontaxableaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
char |
itgen_vnet_accountinformation_expensesubaccount_active | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_expensesubaccount_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
account |
varchar2 |
itgen_vnet_accountinformation_expensesubaccount_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
account |
varchar2 |
itgen_vnet_accountinformation_inventoryaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_inventoryaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_inventoryaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_salesaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_salesaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_salesaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_saleseuaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_saleseuaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_saleseuaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_salesexportaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_salesexportaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_salesexportaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_salesnontaxableaccount_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
account |
varchar2 |
itgen_vnet_accountinformation_salesnontaxableaccount_number | filters on the platform, writable, ::ancestor. |
Number of item | |
account |
varchar2 |
itgen_vnet_accountinformation_salesnontaxableaccount_type | filters on the platform, writable, ::ancestor. |
||
account |
char |
itgen_vnet_accountinformation_salessubaccount_active | filters on the platform, writable, ::ancestor. |
||
account |
varchar2 |
itgen_vnet_accountinformation_salessubaccount_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
account |
varchar2 |
itgen_vnet_accountinformation_salessubaccount_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
base |
varchar2 |
Base Unit | filters on the platform, writable, ::ancestor. |
Mandatory field: General information tab > Unit of measurement section > Base unit* > The UoM used as the base unit for this stock item. | |
body |
varchar2 |
itgen_vnet_body | filters on the platform, writable, ::ancestor. |
The top part > Body *> A brief description of the stock item. | |
cost |
double |
itgen_vnet_costpricestatistics_averagecost | filters on the platform, writable, ::ancestor. |
Cost price statistics section > Average cost > The average cost for the stock item. | |
cost |
double |
itgen_vnet_costpricestatistics_lastcost | filters on the platform, writable, ::ancestor. |
Cost price statistics section > Last cost > The last standard cost used for the stock item. | |
cost |
double |
itgen_vnet_costpricestatistics_maxcost | filters on the platform, writable, ::ancestor. |
Cost price statistics section > Max. cost > The maximum cost for the stock item. | |
cost |
double |
itgen_vnet_costpricestatistics_mincost | filters on the platform, writable, ::ancestor. |
Cost price statistics section > Min. cost > The minimum cost for the stock item. | |
current |
double |
itgen_vnet_currentcost | filters on the platform, writable, ::ancestor. |
Price/cost information tab > Standard cost section > Current cost > Read-only. This field displays the current standard cost for the stock item. | |
default |
varchar2 |
itgen_vnet_defaultissuefrom_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
default |
varchar2 |
itgen_vnet_defaultissuefrom_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
default |
double |
Default Price | filters on the platform, writable, ::ancestor. |
Price/cost information tab > Price management section > Default price > The price of the stock item. | |
default |
varchar2 |
itgen_vnet_defaultreceiptto_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
default |
varchar2 |
itgen_vnet_defaultreceiptto_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
default |
varchar2 |
itgen_vnet_defaultwarehouse_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
default |
varchar2 |
itgen_vnet_defaultwarehouse_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
description |
varchar2 |
Description | filters on the platform, writable, ::ancestor. |
The top part > Description *> A brief description of the stock item. | |
effective |
datetime |
Effective Date | filters on the platform, writable, ::ancestor. |
Price/cost information tab > Standard cost section > Effective date > Read-only. This field shows the effective date for the current standard cost of the stock item. | |
error |
varchar2 |
Error Message | filters on the platform, writable, ::ancestor. |
||
from |
varchar2 |
itgen_vnet_fromunit | writable, from |
Mandatory field: From unit > The unit of measure for which the conversion parameters are specified. | |
intrastat_ |
varchar2 |
itgen_vnet_intrastat_cn8 | filters on the platform, writable, ::ancestor. |
Represents the 8 digit level Combine Nomenclature commodity code specific for the year for which the creating / actualizations Intrastat declarations is drafted. | |
intrastat_ |
varchar2 |
itgen_vnet_intrastat_countryoforigin | filters on the platform, writable, ::ancestor. |
The country of origin of the commodity will be selected, that country where the good has been produced or had the last substantial transformation. | |
intrastat_ |
varchar2 |
itgen_vnet_intrastat_supplementarymeasureunit | filters on the platform, writable, ::ancestor. |
The requirement for Supplementary Measure Units applies only to certain classes of goods(NC8 Positions) that may be expressed from quantitative point of view in other measurement units but kilo also. | |
inventory |
int32 |
Inventory ID | writable, inventory |
The top part > Item ID > The unique alphanumeric identifier of the stock item. | |
inventory |
int32 |
itgen_vnet_inventoryid_2 | filters on the platform, writable, ::ancestor. |
The unique internal identifier of the item as is stored in the database. This Id is not visible in the window. | |
inventory |
varchar2 |
Inventory Number | filters on the platform, writable, ::ancestor. |
Mandatory field: The top part > Item Id* > The unique alphanumeric identifier of the stock item. | |
item |
varchar2 |
Item Class Description | writable, item |
The description. | |
item |
varchar2 |
itgen_vnet_itemclass_description_2 | filters on the platform, writable, ::ancestor. |
The description. | |
item |
varchar2 |
Item Class Error Information | writable, item |
||
item |
varchar2 |
itgen_vnet_itemclass_errorinfo_2 | filters on the platform, writable, ::ancestor. |
||
item |
varchar2 |
Item Class ID | writable, item |
The identifier. | |
item |
varchar2 |
itgen_vnet_itemclass_id_2 | filters on the platform, writable, ::ancestor. |
The identifier. | |
item |
int64 |
Item Class Metadata Max Pagesize | writable, item |
||
item |
int64 |
itgen_vnet_itemclass_metadata_maxpagesize_2 | filters on the platform, writable, ::ancestor. |
||
item |
int64 |
Item Class Metadata Total Count | writable, item |
||
item |
int64 |
itgen_vnet_itemclass_metadata_totalcount_2 | filters on the platform, writable, ::ancestor. |
||
item |
varchar2 |
Item Class Type | writable, item |
||
item |
varchar2 |
itgen_vnet_itemclass_type_2 | filters on the platform, writable, ::ancestor. |
||
kit |
char |
itgen_vnet_kititem | filters on the platform, writable, ::ancestor. |
||
last |
double |
Last Cost | filters on the platform, writable, ::ancestor. |
Price/cost information tab > Standard cost section > Last cost > Read-only. This field showing the last standard cost defined for the stock item. | |
last |
datetime |
Last Modified | filters on the platform, writable, ::ancestor. |
Information collected from system. | |
lot |
varchar2 |
itgen_vnet_lotserialclass_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
lot |
varchar2 |
itgen_vnet_lotserialclass_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
metadata_ |
int64 |
Metadata Max Pagesize | filters on the platform, writable, ::ancestor. |
||
metadata_ |
int64 |
Total Count | filters on the platform, writable, ::ancestor. |
||
note |
varchar2 |
Note | filters on the platform, writable, ::ancestor. |
Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the inventory item. | |
packaging_ |
double |
itgen_vnet_packaging_baseitemvolume | filters on the platform, writable, ::ancestor. |
The volume of the Base Unit of the item. | |
packaging_ |
double |
itgen_vnet_packaging_baseitemweight | filters on the platform, writable, ::ancestor. |
The weight of the Base Unit of the item. | |
packaging_ |
varchar2 |
itgen_vnet_packaging_volumeuom | filters on the platform, writable, ::ancestor. |
The Unit of Measure used for the Volume of the item. | |
packaging_ |
varchar2 |
itgen_vnet_packaging_weightuom | filters on the platform, writable, ::ancestor. |
The Unit of Measure used for the Weight of the item. | |
pending |
double |
Pending Cost | filters on the platform, writable, ::ancestor. |
Price/cost information tab > Standard cost section > Pending cost > The pending standard cost for the stock item. | |
pending |
datetime |
Pending Cost Date | filters on the platform, writable, ::ancestor. |
Price/cost information tab > Standard cost section > Pending cost date > The date when the pending standard cost becomes effective. | |
posting |
varchar2 |
itgen_vnet_postingclass_description | filters on the platform, writable, ::ancestor. |
The description. | |
posting |
varchar2 |
itgen_vnet_postingclass_id | filters on the platform, writable, ::ancestor. |
The identifier. | |
posting |
int64 |
itgen_vnet_postingclass_metadata_maxpagesize | filters on the platform, writable, ::ancestor. |
||
posting |
int64 |
itgen_vnet_postingclass_metadata_totalcount | filters on the platform, writable, ::ancestor. |
||
price |
double |
itgen_vnet_priceadjustmentmultiplier | writable, price |
Price adjustment multiplier > Changes the price automatically if you change the UoM. | |
price |
varchar2 |
itgen_vnet_priceclassid | filters on the platform, writable, ::ancestor. |
The Price/cost information tab > Price management section > Price class > The price class of the item. | |
price |
varchar2 |
Price Class Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
price |
varchar2 |
Price Class ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
price |
guid |
itgen_vnet_pricemanagerid | filters on the platform, writable, ::ancestor. |
The Price/cost information tab > Price management section > Price manager > The ID of the manager responsible for the product pricing. | |
price |
varchar2 |
itgen_vnet_pricemanager_id | filters on the platform, writable, ::ancestor. |
||
price |
varchar2 |
itgen_vnet_pricemanager_name | filters on the platform, writable, ::ancestor. |
||
price |
int32 |
itgen_vnet_priceworkgroupid | filters on the platform, writable, ::ancestor. |
The Price/cost information tab > Price management section > Price work group > The work group responsible for product pricing. Select the pricing work group for the stock item. | |
purchase |
varchar2 |
itgen_vnet_purchaseunit | filters on the platform, writable, ::ancestor. |
Mandatory field: General information tab > Unit of measurement section > Purchase unit *> The UoM to be used as the purchase unit for the stock item. | |
recommended |
double |
itgen_vnet_recommendedprice | filters on the platform, writable, ::ancestor. |
The Price/cost information tab > Price management section > List price > The manufacturer's suggested retail price (MSRP) of the stock item. | |
record |
int64 |
Record ID | writable, record |
||
sales |
varchar2 |
Sales Unit | filters on the platform, writable, ::ancestor. |
Mandatory field: General information tab > Unit of measurement section > Sales unit *> The UoM to be used as the sales unit for the stock item. | |
sample |
varchar2 |
itgen_vnet_sampletounit | writable, sample |
||
status |
varchar2 |
Status | filters on the platform, writable, ::ancestor. |
The top part > Item status > The status of the stock item. The alternatives are: Active, No sales, No purchases, No request, Inactive, Marked for deletion. | |
stock |
char |
Stock Item | filters on the platform, writable, ::ancestor. |
||
timestamp |
varchar2 |
Timestamp | filters on the platform, writable, ::ancestor. |
Timestamp of the inventory item record | |
toUnit |
varchar2 |
itgen_vnet_tounit | writable, toUnit |
To unit > The unit of measure selected as the base unit for the item. | |
type |
varchar2 |
Type | filters on the platform, writable, ::ancestor. |
General information tab > Item defaults section > Type > The type of stock item. | |
unit |
varchar2 |
itgen_vnet_unitmultdiv | writable, unit |
Multiply/divide > The operation to be performed for unit conversion. | |
unit |
double |
itgen_vnet_unitrate | writable, unit |
||
unit |
int32 |
itgen_vnet_unittype | writable, unit |
||
unspsc |
varchar2 |
itgen_vnet_unspsc | filters on the platform, writable, ::ancestor. |
General information tab > UNSPSC Code > The UNSPSC code for the stock item. | |
vat |
varchar2 |
VAT Code Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
vat |
varchar2 |
VAT Code ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: