Please enable JavaScript to view this site.

itgendoc001X

xMsg javascript has not been loaded.

Visma.net Financials API Data Model

Navigation: Schema: InventoryIssue > Tables

InventoryIssue_IssueLinesAllocations

Contents Previous Home Next More

Get a range of Inventory items - ScreenId=IN302000Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page size

Catalog: VismaNet

Schema: InventoryIssue

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/inventoryissue

Insert Visma.net Financials API URL: /controller/api/v1/inventoryissue

Update Visma.net Financials API URL: /controller/api/v1/inventoryissue

Delete Visma.net Financials API URL: /controller/api/v1/inventoryissue

Field Selection Method: NotRequired

Base Path: issueLines[*].allocations[*]

Select Visma.net Financials API Operation: get /controller/api/v1/inventoryissue

Table Function Parameters

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

greaterThanValue

string

 

 

lastModifiedDateTime

string

 

 

lastModifiedDateTimeCondition

string

 

 

numberToRead

int32

 

This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.

orderBy

string

 

This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.

pageNumber

int32

 

Pagination parameter. Page number.

pageSize

int32

 

Pagination parameter. Number of items to be collected.

skipRecords

int32

 

This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.

status

string

 

Values: Hold, Balanced, Released.

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

batchNumber

string

Batch Number

The reference number of the batch generated for the receipt. Click the number to open the Journal Transactions (GL.30.10.00) form and view the details of the transactions.

branchNumber_name_1

string

 

Click the magnifier. > The name.

branchNumber_name

string

Branch Name

Click the magnifier. > The name.

branchNumber_number_1

string

 

Click the magnifier. > The identifier.

branchNumber_number

string

Branch Number

Click the magnifier. > The identifier.

COMPANY_CODE

string(30)

Company Code

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

Name of the partition.

controlAmount

double

 

The top part > Control amount > The manually entered summary amount for all specified inventory items. Control Amount is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Amount and Total Amount values do not match, the system generates a warning message and the issue cannot be saved.

controlQuantity

double

Control Quantity

The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved.

date

datetime

Date

The date when the receipt was created. All transactions included in this document will have this transaction date.

description_1

string

 

A brief description of the inventory issue or its transactions.

description

string

Description

Description > A brief description of the goods transfer transaction.

errorInfo

string

Error Message

 

expirationDate_1

datetime

 

 

expirationDate

datetime

Expiration Date

 

extCost

double

 

Ext. cost > The extended cost of the specified stock item. An extended cost is calculated automatically as the unit cost multiplied by the quantity of units involved in this transaction.

externalReference

string

External Reference

The external reference number of the inventory issue document (for example, the vendor’s reference code).

extPrice

double

 

Ext. price > The extended price of the specified stock item, calculated automatically as the unit price multiplied by the quantity of the stock item involved in the inventory issue operation.

hold

boolean

Hold

A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status.

inventoryItem_description

string

 

Name of item/description

inventoryItem_number

string

 

Number of item

lastModifiedDateTime

datetime

Last Modified

The date when the document was last modified.

lineNbr

int32

 

 

lineNumber

int32

Line Number

 

location_countryId_1

string

 

Location*.

location_countryId

string

Location Country ID

Location*.

location_id_1

string

 

Click the magnifier > The identifier

location_id

string

Location ID

Click the magnifier > The identifier

location_name_1

string

 

Click the magnifier > The displayed name

location_name

string

Location Name

Click the magnifier > The displayed name

lotSerialNumber_1

string

 

 

lotSerialNumber

string

 

 

metadata_maxPageSize

int64

 

 

metadata_totalCount

int64

Total Count

 

postPeriod

string

Post Period

The financial period to which the transactions recorded in the document should be posted. Format MMYYYY.

project_description

string

Project Description

Click on the magnifier. > The description.

project_id

string

Project ID

Click on the magnifier. > The identifier.

projectTask_description

string

Project Task Description

Click on the magnifier. > The description.

projectTask_id

string

Project Task ID

Click on the magnifier. > The identifier.

quantity_1

double

 

Quantity > The quantity of the transferred goods (in the units indicated below).

quantity

double

Quantity

 

reasonCode_description

string

Reason Code Description

Click on the magnifier. > The description.

reasonCode_id

string

Reason Code ID

Click on the magnifier. > The identifier.

referenceNumber

string

Reference Number

The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form.

status

string

Status

The current status of the receipt. The following options are available: On Hold:The receipt/issue is a draft and can be edited. Receipts with this status cannot be released.Balanced: The receipt/issue data has been validated by the system and the receipt can be released. It also can be modified or deleted, but changes can be saved only if the receipt is balanced.Released: The receipt/issue has been released and cannot be edited or deleted.

totalAmount

double

Total Amount

The top part > Total amount > The total amount, calculated as a sum of amounts for all inventory issue operations included in this issue document.

totalQuantity

double

Total Quantity

The total quantity of inventory items, which the system calculates automatically, for the document.

transactionType

string

 

Trans. type > The type of inventory issue transaction. Select one of the following types: Issue, Return, Invoice, Debit note, Credit note.

unitCost

double

Unit Cost

Unit cost > The cost of the specified unit of this stock item.

unitPrice

double

 

Unit price > The price of the specified unit of this stock item.

uom_1

string

 

Mandatory field: UoM* > The unit of measure (UoM) used for the goods to be transferred.

uom

string

Unit of Measure

 

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