Please enable JavaScript to view this site.

Visma.net Financials Forums

Visma.net Financials API Data Model

Navigation: Schema: InventoryReceipt > Tables

InventoryReceiptByNumber: Visma.net Financials Inventory Receipt by Number

Get a specific Inventory Receipt document

Catalog: VismaNet

Schema: InventoryReceipt

Label: Inventory Receipt 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.

Parameters of Table Function

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

COMPANY_CODE

string

☐

 

Partition to retrieve data from.

erp-api-background

string

☐

 

If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.

inventoryReceiptNumber

string

☑

 

Identifies the Inventory Issue document

 

Columns of Table Function

The columns of the table function InventoryReceiptByNumber 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

string

Branch Name

☐

Click the magnifier. > The name.

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.

controlCost

double

Control Cost

☐

The total cost of the inventory items to be received. Control Cost is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. The user enters this value manually to confirm the total cost as calculated automatically for the document. If the Control Cost and Total Cost values do not match, the system generates a warning message and the document 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

string

Description

☐

A brief description of the inventory issue or its transactions.

errorInfo

string

Error Message

☐

 

externalReference

string

External Reference

☐

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

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.

lastModifiedDateTime

datetime

Last Modified

☐

The date when the document was last modified.

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.

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.

totalCost

double

 

☐

The top part > Total cost > The total cost of the inventory items received. The system automatically calculates this value as a sum of all extended cost values of all received inventory items listed in the Transaction Details tab of this form.

totalQuantity

double

Total Quantity

☐

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

transferNumber

string

Transfer Number

☐

The top part > Transfer no. > The transfer number for the receipt operation. (Enter this number only if the two-step transfer operation is performed.)

 

22-12-2022 21:03 Version 22.1.101-BETA+3681

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer