BasicPurchaseReceiptLandedCostsByReceiptNumber: Visma.net Financials Basic Purchase Receipt Landed Costs by Receipt Number |
Get a specific Purchase ReceiptData for a single Purchase Receipt. The response headers include an ETag after a successful GET operation.
Catalog: VismaNet
Schema: PurchaseReceipt
Label: Basic Purchase Receipt Landed Costs by Receipt Number
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 BasicPurchaseReceiptLandedCostsByReceiptNumber. 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 |
|---|---|---|---|---|
receiptNumber |
string |
☑ |
|
Identifies the Purchase Receipt |
Columns of Table Function
The columns of the table function BasicPurchaseReceiptLandedCostsByReceiptNumber are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
amount |
double |
Amount |
☐ |
Landed costs tab > Amount > A non-zero amount of the landed cost. |
apBillDate |
datetime |
{res:itgen_vnet_apbilldate} |
☐ |
Landed costs tab > Purchase invoice date > The date of the purchase invoice for the landed cost. |
apDocType |
string |
{res:itgen_vnet_apdoctype} |
☐ |
Landed costs tab > Supplier document type > The type of the supplier document generated for the landed cost. |
apRefNbr |
string |
{res:itgen_vnet_aprefnbr} |
☐ |
Landed costs tab > Supplier ref. > The reference number of the supplier document generated for the landed cost. |
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. |
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_2 |
string |
{res:itgen_vnet_currency_2} |
☐ |
The top part > Currency > The currency the supplier uses for invoicing. |
currency |
string |
Currency |
☐ |
Landed costs tab > Currency > The currency used for the landed cost. |
customDateTimeUTC1 |
datetime |
{res:itgen_vnet_customdatetimeutc1} |
☐ |
A free custom colum of type DateTime - in UTC timezone |
customDec1 |
double |
{res:itgen_vnet_customdec1} |
☐ |
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 |
int32 |
{res:itgen_vnet_customint1} |
☐ |
A free custom colum of type int |
customInt2 |
int32 |
{res:itgen_vnet_customint2} |
☐ |
A free custom colum of type int |
customStr1 |
string |
{res:itgen_vnet_customstr1} |
☐ |
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 |
string |
{res:itgen_vnet_customstr3} |
☐ |
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 |
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 |
☐ |
Mandatory field: Landed costs tab > Description* > The description of the landed cost code. |
dueDate |
datetime |
Due Date |
☐ |
This value indicates the date the document is due |
errorInfo |
string |
Error Message |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
|
hold |
boolean |
Hold |
☐ |
The top part > Hold > A check box that indicates (if selected) that the document has the On hold status. |
inDocType |
string |
{res:itgen_vnet_indoctype} |
☐ |
Landed costs tab > Inventory doc. type > The type of the document generated in the Inventory workspace for this landed cost. |
inRefNbr |
string |
{res:itgen_vnet_inrefnbr} |
☐ |
Landed costs tab > Inventory ref. no. > The reference number of the document generated in the Inventory workspace for this landed cost. |
inventory_description |
string |
Inventory Description |
☐ |
Name of item/description |
inventory_number |
string |
Inventory Number |
☐ |
Number of item |
landedCostCode |
string |
{res:itgen_vnet_landedcostcode} |
☐ |
Mandatory field: Landed costs tab > Landed costs* > Landed cost code > The landed cost code associated with the landed costs incurred for this purchase or transfer receipt. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
lineNbr |
int32 |
{res:itgen_vnet_linenbr} |
☐ |
Landed costs tab > Line number |
location_countryId_2 |
string |
Location Country ID 2 |
☐ |
Location*. |
location_countryId |
string |
Location Country ID |
☐ |
Location*. |
location_id_2 |
string |
Location ID 2 |
☐ |
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 |
string |
Location Name |
☐ |
Click the magnifier > The displayed name |
metadata_maxPageSize |
int64 |
Metadata Max Pagesize |
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
note |
string |
Note |
☐ |
|
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. |
postponePurchaseInvoiceCreation |
boolean |
{res:itgen_vnet_postponepurchaseinvoicecreation} |
☐ |
Landed costs tab > Postpone creation of purchase invoice > A check box that indicates (if selected) that a related supplier ledger invoice for the incurred landed costs must be created later. |
purchaseInvoiceNbr |
string |
{res:itgen_vnet_purchaseinvoicenbr} |
☐ |
|
receiptNbr |
string |
Receipt Number |
☐ |
The top part > Receipt no. > The unique reference number of the purchase receipt. |
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. |
supplier_internalId_2 |
int32 |
{res:itgen_vnet_supplier_internalid_2} |
☐ |
|
supplier_internalId |
int32 |
Supplier Internal ID |
☐ |
|
supplier_name_2 |
string |
{res:itgen_vnet_supplier_name_2} |
☐ |
The name of the particular destination of the selected type. |
supplier_name |
string |
Supplier Name |
☐ |
The name of the particular destination of the selected type. |
supplier_number_2 |
string |
{res:itgen_vnet_supplier_number_2} |
☐ |
The identifier 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 |
terms_description |
string |
Terms Description |
☐ |
Click on the magnifier. > The description. |
terms_id |
string |
Terms ID |
☐ |
Click on the magnifier. > The identifier. |
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. |
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_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