Please enable JavaScript to view this site.

itgendoc001X

xMsg javascript has not been loaded.

Visma.net Financials API Data Model

Navigation: Schema: Inventory > Tables

InventoryWarehouseDetailsByInventoryNumber

 Contents Previous Home Next More

Get a specific Inventory item

Catalog: VismaNet

Schema: Inventory

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/inventory/{inventoryNumber}

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

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

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

Field Selection Method: NotRequired

Base Path: warehouseDetails[*]

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

Table Function Parameters

The following parameters can be used to control the behaviour of the table function InventoryWarehouseDetailsByInventoryNumber. 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

Default Value

Documentation

COMPANY_CODE

string

☐

 

Partition to retrieve data from.

inventoryNumber

string

☑

 

Identifies the Inventory item

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

accountInformation_cogsAccount_description

string

 

☐

Name of item/description

accountInformation_cogsAccount_number

string

 

☐

Number of item

accountInformation_cogsAccount_type

string

 

☐

 

accountInformation_cogsSubaccount_description

string

 

☐

Click on the magnifier. > The description.

accountInformation_cogsSubaccount_id

string

 

☐

Click on the magnifier. > The identifier.

accountInformation_expenseAccount_description

string

 

☐

Name of item/description

accountInformation_expenseAccount_number

string

 

☐

Number of item

accountInformation_expenseAccount_type

string

 

☐

 

accountInformation_expenseAccrualAccount_description

string

 

☐

Name of item/description

accountInformation_expenseAccrualAccount_number

string

 

☐

Number of item

accountInformation_expenseAccrualAccount_type

string

 

☐

 

accountInformation_expenseEuAccount_description

string

 

☐

Name of item/description

accountInformation_expenseEuAccount_number

string

 

☐

Number of item

accountInformation_expenseEuAccount_type

string

 

☐

 

accountInformation_expenseImportAccount_description

string

 

☐

Name of item/description

accountInformation_expenseImportAccount_number

string

 

☐

Number of item

accountInformation_expenseImportAccount_type

string

 

☐

 

accountInformation_expenseNonTaxableAccount_description

string

 

☐

Name of item/description

accountInformation_expenseNonTaxableAccount_number

string

 

☐

Number of item

accountInformation_expenseNonTaxableAccount_type

string

 

☐

 

accountInformation_expenseSubaccount_description

string

 

☐

Click on the magnifier. > The description.

accountInformation_expenseSubaccount_id

string

 

☐

Click on the magnifier. > The identifier.

accountInformation_inventoryAccount_description

string

 

☐

Name of item/description

accountInformation_inventoryAccount_number

string

 

☐

Number of item

accountInformation_inventoryAccount_type

string

 

☐

 

accountInformation_salesAccount_description

string

 

☐

Name of item/description

accountInformation_salesAccount_number

string

 

☐

Number of item

accountInformation_salesAccount_type

string

 

☐

 

accountInformation_salesEuAccount_description

string

 

☐

Name of item/description

accountInformation_salesEuAccount_number

string

 

☐

Number of item

accountInformation_salesEuAccount_type

string

 

☐

 

accountInformation_salesExportAccount_description

string

 

☐

Name of item/description

accountInformation_salesExportAccount_number

string

 

☐

Number of item

accountInformation_salesExportAccount_type

string

 

☐

 

accountInformation_salesNonTaxableAccount_description

string

 

☐

Name of item/description

accountInformation_salesNonTaxableAccount_number

string

 

☐

Number of item

accountInformation_salesNonTaxableAccount_type

string

 

☐

 

accountInformation_salesSubaccount_description

string

 

☐

Click on the magnifier. > The description.

accountInformation_salesSubaccount_id

string

 

☐

Click on the magnifier. > The identifier.

available

double

Available

☐

 

availableForShipment

double

 

☐

 

baseUnit

string

Base Unit

☐

Mandatory field: General information tab > Unit of measurement section > Base unit* > The UoM used as the base unit for this stock item.

body

string

 

☐

The top part > Body *> A brief description of the stock item.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

costPriceStatistics_averageCost

double

 

☐

Cost price statistics section > Average cost > The average cost for the stock item.

costPriceStatistics_lastCost

double

 

☐

Cost price statistics section > Last cost > The last standard cost used for the stock item.

costPriceStatistics_maxCost

double

 

☐

Cost price statistics section > Max. cost > The maximum cost for the stock item.

costPriceStatistics_minCost

double

 

☐

Cost price statistics section > Min. cost > The minimum cost for the stock item.

currentCost

double

 

☐

Price/cost information tab > Standard cost section > Current cost > Read-only. This field displays the current standard cost for the stock item.

defaultIssueFrom_description

string

 

☐

Click on the magnifier. > The description.

defaultIssueFrom_id

string

 

☐

Click on the magnifier. > The identifier.

defaultPrice

double

Default Price

☐

Price/cost information tab > Price management section > Default price > The price of the stock item.

defaultReceiptTo_description

string

 

☐

Click on the magnifier. > The description.

defaultReceiptTo_id

string

 

☐

Click on the magnifier. > The identifier.

defaultWarehouse_description

string

 

☐

Click on the magnifier. > The description.

defaultWarehouse_id

string

 

☐

Click on the magnifier. > The identifier.

description

string

Description

☐

The top part > Description *> A brief description of the stock item.

effectiveDate

datetime

Effective Date

☐

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.

errorInfo

string

Error Message

☐

 

intrastat_cN8

string

 

☐

Represents the 8 digit level Combine Nomenclature commodity code specific for the yearfor which the creating / actualizations Intrastat declarations is drafted.

intrastat_countryOfOrigin

string

 

☐

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_supplementaryMeasureUnit

string

 

☐

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.

inventoryId

int32

Inventory ID

☐

The unique internal identifier of the item as is stored in the database. This Id is not visible in the window.

inventoryNumber

string

Inventory Number

☐

Mandatory field: The top part > Item Id* > The unique alphanumeric identifier of the stock item.

isDefault

boolean

Is Default

☐

 

itemClass_description

string

Item Class Description

☐

Click on the magnifier. > The description.

itemClass_id

string

Item Class ID

☐

Click on the magnifier. > The identifier.

itemClass_type

string

Item Class Type

☐

 

lastCost

double

Last Cost

☐

Price/cost information tab > Standard cost section > Last cost > Read-only. This field showing the last standard cost defined for the stock item.

lastModifiedDateTime_1

datetime

 

☐

Information collected from system.

lastModifiedDateTime

datetime

Last Modified

☐

 

metadata_maxPageSize

int64

 

☐

 

metadata_totalCount

int64

Total Count

☐

 

packaging_baseItemVolume

double

 

☐

The volume of the <see cref="!:BaseUnit">Base Unit</see> of the item.

packaging_baseItemWeight

double

 

☐

The weight of the <see cref="!:BaseUnit">Base Unit</see> of the item.

packaging_volumeUOM

string

 

☐

The <see cref="!:INUnit">Unit of Measure</see> used for the <see cref="P:Visma.net.ERP.Web.Api.Model.V1.IN.PackagingDto.BaseItemVolume">Volume</see> of the item.

packaging_weightUOM

string

 

☐

The <see cref="!:INUnit">Unit of Measure</see> used for the <see cref="P:Visma.net.ERP.Web.Api.Model.V1.IN.PackagingDto.BaseItemWeight">Weight</see> of the item.

pendingCost

double

Pending Cost

☐

Price/cost information tab &gt; Standard cost section &gt; Pending cost &gt; The pending standard cost for the stock item.

pendingCostDate

datetime

Pending Cost Date

☐

Price/cost information tab &gt; Standard cost section &gt; Pending cost date &gt; The date when the pending standard cost becomes effective.

postingClass_description

string

 

☐

Click on the magnifier. &gt; The description.

postingClass_id

string

 

☐

Click on the magnifier. &gt; The identifier.

priceClass_description

string

Price Class Description

☐

Click on the magnifier. &gt; The description.

priceClass_id

string

Price Class ID

☐

Click on the magnifier. &gt; The identifier.

priceClassID

string

 

☐

The Price/cost information tab &gt; Price management section &gt; Price class &gt; The price class of the item.

priceManager_id

string

 

☐

 

priceManager_name

string

 

☐

 

priceManagerID

string

 

☐

The Price/cost information tab &gt; Price management section &gt; Price manager &gt; The ID of the manager responsible for the product pricing.

priceWorkgroupID

int32

 

☐

The Price/cost information tab &gt; Price management section &gt; Price work group &gt; The work group responsible for product pricing. Select the pricing work group for the stock item.

purchaseUnit

string

 

☐

Mandatory field: General information tab &gt; Unit of measurement section &gt; Purchase unit *&gt; The UoM to be used as the purchase unit for the stock item.

quantityOnHand

double

 

☐

Qty. on hand &gt; The quantity of this item available (on hand) at the warehouse.

recommendedPrice

double

 

☐

The Price/cost information tab &gt; Price management section &gt; List price &gt; The manufacturer's suggested retail price (MSRP) of the stock item.

salesUnit

string

Sales Unit

☐

Mandatory field: General information tab &gt; Unit of measurement section &gt; Sales unit *&gt; The UoM to be used as the sales unit for the stock item.

status

string

Status

☐

The top part &gt; Item status &gt; The status of the stock item. The alternatives are: Active, No sales, No purchases, No request, Inactive, Marked for deletion.

stockItem

boolean

Stock Item

☐

 

type

string

Type

☐

General information tab &gt; Item defaults section &gt; Type &gt; The type of stock item.

vatCode_description

string

VAT Code Description

☐

Click on the magnifier. &gt; The description.

vatCode_id

string

VAT Code ID

☐

Click on the magnifier. &gt; The identifier.

warehouse

string

Warehouse

☐

Warehouse &gt; The warehouse where the stock item is available.

 

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