BasicPurchaseReceiptLineAllocations: Visma.net Financials Basic Purchase Receipt Line Allocations |
Get a range of Purchase Receipts - ScreenId=PO302000Please use a page size lower or equal to the allowed max page size which is 500
Catalog: VismaNet
Schema: PurchaseReceipt
Label: Basic Purchase Receipt Line Allocations
This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL 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 BasicPurchaseReceiptLineAllocations. 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 |
|---|---|---|---|---|
branch |
string |
☐ |
|
|
dueDate |
string |
☐ |
|
This value indicates the date the document is due. Use it to retrieve all records that have the due date since that time, up to the future.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd HH:mm:ss```* ```yyyy-MM-dd HH:mm:ss.FFF```* ```yyyy-MM-ddTHH:mm:ss```* ```yyyy-MM-ddTHH:mm:ss.FFF```_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__. |
dueDateCondition |
string |
☐ |
|
This value represents the condition to be applied to the Due Date when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__. |
finPeriod |
string |
☐ |
|
Filter by financial period, format YYYYPP |
greaterThanValue |
string |
☐ |
|
|
includeCustomFreeFields |
boolean |
☐ |
|
Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result setWorks only with PurchaseRecieptBasic and v2 of PurchaseReceipts. |
lastModifiedDateTime |
string |
☐ |
|
This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd HH:mm:ss```* ```yyyy-MM-dd HH:mm:ss.FFF```* ```yyyy-MM-ddTHH:mm:ss```* ```yyyy-MM-ddTHH:mm:ss.FFF```_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__. |
lastModifiedDateTimeCondition |
string |
☐ |
|
This value represents the condition to be applied when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__. |
poOrderNbr |
string |
☐ |
|
|
receiptDate |
string |
☐ |
|
|
receiptDateCondition |
string |
☐ |
|
This value represents the condition to be applied to the order date when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__. |
receiptType |
string |
☐ |
|
Values: PoReceipt, PoReturn, TransferReceipt. |
status |
string |
☐ |
|
Values: Hold, Balanced, Released. |
supplier |
string |
☐ |
|
|
Columns of Table Function
The columns of the table function BasicPurchaseReceiptLineAllocations 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 |
{res:itgen_vnet_actualaccount_description} |
☐ |
Name of item/description |
actualAccount_number |
string |
{res:itgen_vnet_actualaccount_number} |
☐ |
Number of item |
actualAccount_type |
string |
{res:itgen_vnet_actualaccount_type} |
☐ |
|
actualSub_active |
boolean |
{res:itgen_vnet_actualsub_active} |
☐ |
|
actualSub_description |
string |
{res:itgen_vnet_actualsub_description} |
☐ |
Click on the magnifier. > The description. |
actualSub_id |
string |
{res:itgen_vnet_actualsub_id} |
☐ |
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_2 |
string |
Branch Number Name 2 |
☐ |
Click the magnifier. > The name. |
branchNumber_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
branchNumber_number_2 |
string |
Branch Number 2 |
☐ |
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. |
completePoLine |
boolean |
{res:itgen_vnet_completepoline} |
☐ |
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 |
{res:itgen_vnet_controlqty} |
☐ |
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. |
customDateTimeUTC1_2 |
datetime |
{res:itgen_vnet_customdatetimeutc1_2} |
☐ |
A free custom colum of type DateTime - in UTC timezone |
customDateTimeUTC1 |
datetime |
{res:itgen_vnet_customdatetimeutc1} |
☐ |
A free custom colum of type DateTime - in UTC timezone |
customDec1_2 |
double |
{res:itgen_vnet_customdec1_2} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customDec1 |
double |
{res:itgen_vnet_customdec1} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customDec2_2 |
double |
{res:itgen_vnet_customdec2_2} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customDec2 |
double |
{res:itgen_vnet_customdec2} |
☐ |
A free custom colum of type decimal with max 4 decimals. |
customInt1_2 |
int32 |
{res:itgen_vnet_customint1_2} |
☐ |
A free custom colum of type int |
customInt1 |
int32 |
{res:itgen_vnet_customint1} |
☐ |
A free custom colum of type int |
customInt2_2 |
int32 |
{res:itgen_vnet_customint2_2} |
☐ |
A free custom colum of type int |
customInt2 |
int32 |
{res:itgen_vnet_customint2} |
☐ |
A free custom colum of type int |
customStr1_2 |
string |
{res:itgen_vnet_customstr1_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr1 |
string |
{res:itgen_vnet_customstr1} |
☐ |
A free custom colum of type string with max length 100. |
customStr2_2 |
string |
{res:itgen_vnet_customstr2_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr2 |
string |
{res:itgen_vnet_customstr2} |
☐ |
A free custom colum of type string with max length 100. |
customStr3_2 |
string |
{res:itgen_vnet_customstr3_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr3 |
string |
{res:itgen_vnet_customstr3} |
☐ |
A free custom colum of type string with max length 100. |
customStr4_2 |
string |
{res:itgen_vnet_customstr4_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr4 |
string |
{res:itgen_vnet_customstr4} |
☐ |
A free custom colum of type string with max length 100. |
customStr5_2 |
string |
{res:itgen_vnet_customstr5_2} |
☐ |
A free custom colum of type string with max length 100. |
customStr5 |
string |
{res:itgen_vnet_customstr5} |
☐ |
A free custom colum of type string with max length 100. |
date |
datetime |
Date |
☐ |
Mandatory field: The top part > Date* > The date when the receipt document was created. |
description |
string |
Description |
☐ |
Description > The description of the stock item. |
discountAmount |
double |
{res:itgen_vnet_discountamount} |
☐ |
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. |
dueDate |
datetime |
Due Date |
☐ |
This value indicates the date the document is due |
errorInfo |
string |
Error Message |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
|
expirationDate_2 |
datetime |
{res:itgen_vnet_expirationdate_2} |
☐ |
Document details tab > Expiration date > The expiration date of the received item. |
expirationDate |
datetime |
Expiration Date |
☐ |
Expiration date > The expiration date of the specified quantity of the stock item. |
extCost |
double |
Extended Cost |
☐ |
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 |
itemId |
string |
Item ID |
☐ |
ItemId > The id of the item. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
lineNbr_2 |
int32 |
{res:itgen_vnet_linenbr_2} |
☐ |
The line number |
lineNbr |
int32 |
{res:itgen_vnet_linenbr} |
☐ |
Line no. > The line of the purchase order that contains the selected item. |
lineType |
string |
Line Type |
☐ |
Document details tab > Line type > The type of the purchase order line. |
location_countryId_2 |
string |
Location Country ID 2 |
☐ |
Location*. |
location_countryId_3 |
string |
{res:itgen_vnet_location_countryid_3} |
☐ |
Location*. |
location_countryId |
string |
Location Country ID |
☐ |
Location*. |
location_id_2 |
string |
Location ID 2 |
☐ |
Click the magnifier > The identifier |
location_id_3 |
string |
{res:itgen_vnet_location_id_3} |
☐ |
Click the magnifier > The identifier |
location_id |
string |
Location ID |
☐ |
Click the magnifier > The identifier |
location_name_2 |
string |
Location Name 2 |
☐ |
Click the magnifier > The displayed name |
location_name_3 |
string |
{res:itgen_vnet_location_name_3} |
☐ |
Click the magnifier > The displayed name |
location_name |
string |
Location Name |
☐ |
Click the magnifier > The displayed name |
lotSerialNumber_2 |
string |
{res:itgen_vnet_lotserialnumber_2} |
☐ |
Document details tab > Lot/serial no. > The lot or serial number assigned to the received quantity of the purchased item. |
lotSerialNumber |
string |
Lot Serial Number |
☐ |
Lot/Serial no. > The lot or serial number of the item. |
manualDiscount |
boolean |
Manual Discount |
☐ |
Document details tab > Manual discount > A check box that indicates (if selected) that the discount has been applied manually. |
metadata_maxPageSize |
int64 |
Metadata Max Pagesize |
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
note_2 |
string |
Note 2 |
☐ |
|
note |
string |
Note |
☐ |
|
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 |
{res:itgen_vnet_poorderlinenbr} |
☐ |
Document details tab > Purchase order line no. > The line number of the purchase order related to this line of the purchase receipt. |
poOrderNbr |
string |
{res:itgen_vnet_poordernbr} |
☐ |
Document details tab > Purchase order no. > The reference number of the purchase order related to this purchase receipt. |
poOrderType |
string |
{res:itgen_vnet_poordertype} |
☐ |
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. |
quantity |
double |
Quantity |
☐ |
Quantity > The quantity of the stock item with the same lot number. It is 1 for items with serial numbers. |
receiptNbr |
string |
Receipt Number |
☐ |
The top part > Receipt no. > The unique reference number of the purchase receipt. |
receiptQty |
double |
{res:itgen_vnet_receiptqty} |
☐ |
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_active |
boolean |
{res:itgen_vnet_sub_active} |
☐ |
|
sub_description |
string |
{res:itgen_vnet_sub_description} |
☐ |
Click on the magnifier. > The description. |
sub_id |
string |
{res:itgen_vnet_sub_id} |
☐ |
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 |
{res:itgen_vnet_taxcategory_description} |
☐ |
Name of item/description |
taxCategory_number |
string |
{res:itgen_vnet_taxcategory_number} |
☐ |
Number of item |
timeStamp |
byte[] |
Timestamp |
☐ |
The top part > Tstamp > The timestamp of the purchase receipt. |
totalAmt |
double |
Total Amount |
☐ |
The top part > Total amt. > The total amount calculated for items received from or returned to the supplier. |
totalQty |
double |
Total Quantity |
☐ |
The top part > Total qty. > The total quantity of items received from or returned to the supplier. |
transactionDescription |
string |
{res:itgen_vnet_transactiondescription} |
☐ |
Document details tab > Transaction descr. > The description of the receipt or return transaction. |
transferOrderLineNbr |
int32 |
{res:itgen_vnet_transferorderlinenbr} |
☐ |
Document details tab > Transfer line no > The line number in the transfer order to which this receipt is linked. |
transferOrderNbr |
string |
{res:itgen_vnet_transferordernbr} |
☐ |
Document details tab > Transfer order no. > The reference number of the transfer order to which this receipt is linked. |
transferOrderType |
string |
{res:itgen_vnet_transferordertype} |
☐ |
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_2 |
string |
{res:itgen_vnet_uom_2} |
☐ |
Document details tab > UoM > The unit of measure (UoM) used for the purchased or transferred item. |
uom |
string |
Unit of Measure |
☐ |
UoM > The unit of measure for the specified quantity of the inventory 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_2 |
string |
{res:itgen_vnet_warehouse_description_2} |
☐ |
Click on the magnifier. > The description. |
warehouse_description |
string |
Warehouse Description |
☐ |
Click on the magnifier. > The description. |
warehouse_id_2 |
string |
{res:itgen_vnet_warehouse_id_2} |
☐ |
Click on the magnifier. > The identifier. |
warehouse_id |
string |
Warehouse ID |
☐ |
Click on the magnifier. > The identifier. |
23-06-2025 19:16 Version 24.1.116-BETA+5455
Visma.net Financials API Data Model