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: InventoryAdjustment > Tables

InventoryAdjustmentLineAttachmentsByNumber

Contents Previous Home Next More

Get a specific Inventory Adjustment document

Catalog: VismaNet

Schema: InventoryAdjustment

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/inventoryadjustment/{inventoryAdjustmentNumber}

Insert Visma.net Financials API URL: /controller/api/v1/inventoryadjustment/{inventoryAdjustmentNumber}

Update Visma.net Financials API URL: /controller/api/v1/inventoryadjustment/{inventoryAdjustmentNumber}

Delete Visma.net Financials API URL: /controller/api/v1/inventoryadjustment/{inventoryAdjustmentNumber}

Field Selection Method: NotRequired

Base Path: adjusmentLines[*].attachments[*]

Select Visma.net Financials API Operation: get /controller/api/v1/inventoryadjustment/{inventoryAdjustmentNumber}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function InventoryAdjustmentLineAttachmentsByNumber. 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.
inventoryAdjustmentNumber	string	☑		Identifies the Inventory Adjustment document

Table Function Columns

The columns of the table function InventoryAdjustmentLineAttachmentsByNumber 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.
controlCost	double	Control Cost	☐	The top part > Control cost > The manually entered cost of stock items listed in the adjustment. Control cost is available only if the Validate document totals on Entry option is selected on the Inventory preferences window. 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_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	☐
extCost	double		☐	Cost > The cost of the item.
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.
id	string	ID	☐	The ID of the attachment
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.
lineNumber	int32	Line Number	☐
location_countryId	string	Location Country ID	☐	Location*.
location_id	string	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	☐
name	string	Name	☐	The name of the attachment.
postPeriod	string	Post Period	☐	The financial period to which the transactions recorded in the document should be posted. Format MMYYYY.
quantity	double	Quantity	☐	Quantity > The quantity of the transferred goods (in the units indicated below).
reasonCode_description	string	Reason Code Description	☐	Click on the magnifier. > The description.
reasonCode_id	string	Reason Code ID	☐	Click on the magnifier. > The identifier.
receiptNumber	string	Receipt Number	☐	Receipt no. > Reference number for the receipt for the stock item.
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.
revision	int32	Revision	☐	The version of the attachment.
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.
unitCost	double	Unit Cost	☐	Unit cost > The cost of the unit used as base unit for the stock item.
uom	string	Unit of Measure	☐	Mandatory field: UoM* > The unit of measure (UoM) used for the goods to be transferred.
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