Visma.net Financials 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: PurchaseReceiptBasic > Tables

PurchaseReceiptLinesBasicByReceiptNumber

Get a specific Purchase Receipt

Catalog: VismaNet

Schema: PurchaseReceiptBasic

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net API may not support changing the data or the Invantive SQL driver for Visma.net does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net API.

Select Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic/{receiptNbr}

Insert Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic/{receiptNbr}

Update Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic/{receiptNbr}

Delete Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic/{receiptNbr}

Field Selection Method: NotRequired

Base Path: lines[*]

Select Visma.net API Operation: get /controller/api/v1/PurchaseReceiptBasic/{receiptNbr}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function PurchaseReceiptLinesBasicByReceiptNumber. 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.
receiptNbr	string	☑		Identifies the Purchase Receipt

Table Function Columns

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

Name	Data Type	Label	Required	Documentation
account_description	string	Account Description	☐	Name of item/description
account_number	string	Account Number	☐	Number of item
account_type	string	Account Type	☐
accountDescription	string	General Ledger Account Description	☐	Document details tab > Description > The description of this account.
actualAccount_description	string		☐	Name of item/description
actualAccount_number	string		☐	Number of item
actualAccount_type	string		☐
actualSub_description	string		☐	Click on the magnifier. > The description.
actualSub_id	string		☐	Click on the magnifier. > The identifier.
amount	double	Amount	☐	Document details tab > Amount > The amount calculated (after discount has been taken) for the item.
branch_name	string	Branch Name	☐	Click the magnifier. > The name.
branch_number	string	Branch Number	☐	Click the magnifier. > The identifier.
branchNumber_name	string	Branch Name	☐	Click the magnifier. > The name.
branchNumber_name_1	string		☐	Click the magnifier. > The name.
branchNumber_number	string	Branch Number	☐	Click the magnifier. > The identifier.
branchNumber_number_1	string		☐	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.
completePoLine	boolean		☐	Document details tab > Complelete purchase line > A check box that indicates to the system (if selected) that the purchase order line added to this receipt line should be considered completed upon release of this purchase receipt.
controlQty	double		☐	The top part > Control qty. > The total quantity of goods on the receipt or return
controlTotal	double	Total for Control	☐	The top part > Control amt. > The total amount of the receipt or return, which you manually enter.
createBill	boolean	Create Bill	☐	The top part > Create invoice > A check box that you select if the system must create an appropriate invoice (or adjustment) automatically when the purchase receipt is released.
currency	string	Currency	☐	The top part > Currency > The currency the supplier uses for invoicing.
date	datetime	Date	☐	Mandatory field: The top part > Date* > The date when the receipt document was created.
discountAmount	double		☐	Document details tab > Discount amount > If the Supplier and customer discounts functionality is enabled, the amount of the discount that has been specified manually or calculated based on the discount percent entered manually.
discountCode_description	string	Discount Code Description	☐	Name of item/description
discountCode_number	string	Discount Code Number	☐	Number of item
discountPercent	double	Discount Percent	☐	Document details tab > Discount percent > If the Supplier and customer discounts functionality is enabled, the percent of the discount that has been entered manually or calculated based on the discount amount entered manually for this line item.
errorInfo	string	Error Message	☐
exchangeRate	double	Exchange Rate	☐
expirationDate	datetime	Expiration Date	☐	Document details tab > Expiration date > The expiration date of the received item.
extCost	double		☐	Document details tab > Cost > The cost of the item, which is the unit price multiplied by the quantity.
hold	boolean	Hold	☐	The top part > Hold > A check box that indicates (if selected) that the document has the On hold status.
inventory_description	string	Inventory Description	☐	Name of item/description
inventory_number	string	Inventory Number	☐	Number of item
lastModifiedDateTime	datetime	Last Modified	☐	System generated information.
lineNbr	int32		☐	The line number
lineType	string	Line Type	☐	Document details tab > Line type > The type of the purchase order line.
location_countryId	string	Location Country ID	☐	Location*.
location_countryId_1	string		☐	Location*.
location_id	string	Location ID	☐	Click the magnifier > The identifier
location_id_1	string		☐	Click the magnifier > The identifier
location_name	string	Location Name	☐	Click the magnifier > The displayed name
location_name_1	string		☐	Click the magnifier > The displayed name
lotSerialNumber	string		☐	Document details tab > Lot/serial no. > The lot or serial number assigned to the received quantity of the purchased item.
manualDiscount	boolean		☐	Document details tab > Manual discount > A check box that indicates (if selected) that the discount has been applied manually.
metadata_maxPageSize	int64		☐
metadata_totalCount	int64	Total Count	☐
openQty	double	Open Quantity	☐	Document details tab > Open qty. > The quantity of the stock item yet to be received on the purchase order.
orderQty	double	Order Quantity	☐	Document details tab > Ordered qty. > The quantity of the purchased item (in the specified UoM).
poOrderLineNbr	int32		☐	Document details tab > Purchase order line no. > The line number of the purchase order related to this line of the purchase receipt.
poOrderNbr	string		☐	Document details tab > Purchase order no. > The reference number of the purchase order related to this purchase receipt.
poOrderType	string		☐	Document details tab > Purchase order type > The type of the purchase order related to this purchase receipt.
postPeriod	string	Post Period	☐	Mandatory field: The top part > 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.
receiptNbr	string	Receipt Number	☐	The top part > Receipt no. > The unique reference number of the purchase receipt.
receiptQty	double		☐	Document details tab > Receipts qty. > The quantity of the item (with the specified subitem code) in the specified UoM that has been received (listed on released receipts).
receiptType	string	Receipt Type	☐	The top part > Type > The type of the document, which can be one of the following options: Receipt, Return, Transfer receipt.
status	string	Status	☐	The top part > Status > The current status of the purchase or transfer receipt, or return, which the system assigns automatically. On hold, Balanced, Released.
sub_description	string		☐	Click on the magnifier. > The description.
sub_id	string		☐	Click on the magnifier. > The identifier.
supplier_internalId	int32	Supplier Internal ID	☐
supplier_name	string	Supplier Name	☐	The name of the particular destination of the selected type.
supplier_number	string	Supplier Number	☐	The identifier of the particular destination of the selected type.
supplierRef	string	Supplier Reference	☐	The top part > Supplier ref. > The reference number of the supplier document this receipt or return is based on.
taxCategory_description	string		☐	Name of item/description
taxCategory_number	string		☐	Number of item
totalAmt	double		☐	The top part > Total amt. > The total amount calculated for items received from or returned to the supplier.
totalQty	double		☐	The top part > Total qty. > The total quantity of items received from or returned to the supplier.
transactionDescription	string		☐	Document details tab > Transaction descr. > The description of the receipt or return transaction.
transferOrderLineNbr	int32		☐	Document details tab > Transfer line no > The line number in the transfer order to which this receipt is linked.
transferOrderNbr	string		☐	Document details tab > Transfer order no. > The reference number of the transfer order to which this receipt is linked.
transferOrderType	string		☐	Document details tab > Transfer order type > The type of the transfer order to which this receipt is linked.
unitCost	double	Unit Cost	☐	Document details tab > Unit cost > The cost of a unit of the purchased item.
uom	string	Unit of Measure	☐	Document details tab > UoM > The unit of measure (UoM) used for the purchased or transferred item.
vatExemptTotal	double	VAT Exempt Total	☐	The top part > VAT exempt total > The document total that is exempt from VAT.
vatTaxableTotal	double	VAT Taxable Total	☐	The top part > VAT taxable total > The document total that is subjected to VAT.
warehouse_description	string	Warehouse Description	☐	Click on the magnifier. > The description.
warehouse_description_1	string		☐	Click on the magnifier. > The description.
warehouse_id	string	Warehouse ID	☐	Click on the magnifier. > The identifier.
warehouse_id_1	string		☐	Click on the magnifier. > The identifier.

12-12-2020 18:42 Version 20.1.301-BETA+3023

Please enable JavaScript to view this site.

Visma.net Financials Data Model

Table Function Parameters

Table Function Columns