PurchaseOrderByNumber: Visma.net Financials Purchase Order by Number |
Get a specific Purchase OrderData for a single Purchase Order. The response headers include an ETag after a successful GET operation.
Catalog: VismaNet
Schema: PurchaseOrder
Label: Purchase Order by 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 PurchaseOrderByNumber. 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 |
---|---|---|---|---|
includeCustomFreeFields |
boolean |
☐ |
|
Optional parameter to request custom free fields. |
purchaseOrderNumber |
string |
☑ |
|
Identifies the Purchase Order |
Columns of Table Function
The columns of the table function PurchaseOrderByNumber are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
branch_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
branch_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. |
controlTotal |
double |
Total for Control |
☐ |
The top part > Control total > The order's total amount (including VAT), which you must enter manually when you attempt to save the order with the Balanced status. |
controlTotalInBaseCurrency |
double |
{res:itgen_vnet_controltotalinbasecurrency} |
☐ |
The top part > View base > A button that recalculates the Control total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency. |
currency |
string |
Currency |
☐ |
The top part > Currency > The currency the purchase order will be paid in. |
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 purchase order was created. |
description |
string |
Description |
☐ |
The top part > Description > A brief description of the purchase order. |
dontEmail |
boolean |
Don't Email |
☐ |
Other information > Do not email > A check box that indicates (if selected) indicates that the purchase order should not be emailed. |
dontPrint |
boolean |
Don't Print |
☐ |
Other information > Do not print > A check box that indicates (if selected) that the current purchase order should not be printed. |
emailed |
boolean |
Emailed |
☐ |
Other information > Emailed > A check box that indicates (if selected) indicates that the current purchase order was emailed. |
errorInfo |
string |
Error Message |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
|
fobPoint |
string |
{res:itgen_vnet_fobpoint} |
☐ |
Delivery instructions tab > The Delivery instructions section > FOB point > The FOB point where the title of goods (listed on this purchase order) is transferred from the supplier to the company. |
hold |
boolean |
Hold |
☐ |
The top part > Hold > A check box that you select to give the purchase order the On hold status. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
lineTotal |
double |
Line Total |
☐ |
The top part > Line total > The total sum of the Extended amount entries for all lines in the current purchase order. This value is calculated by the system and users cannot manually change it. |
lineTotalInBaseCurrency |
double |
{res:itgen_vnet_linetotalinbasecurrency} |
☐ |
The top part > View base > A button that recalculates the Line total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency. |
location_id |
int32 |
Location ID |
☐ |
Click the magnifier > The identifier |
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 |
☐ |
Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document. |
openBalance |
double |
Open Balance |
☐ |
Other information > Open amount > The amount of these items that are ordered but not received. |
openQuantity |
double |
{res:itgen_vnet_openquantity} |
☐ |
Other information > Open Quantity > The difference between the quantities of ordered and received items. |
orderNbr |
string |
Order Number |
☐ |
The top part > Order no. > The unique reference number of the purchase order, which the system assigns based on the number series assigned to purchase orders of this type, as specified in the PO101000 window. |
orderTotal |
double |
Order Total |
☐ |
The Top part > Order total > The total sum for the purchase order, including VAT. This read-only value is the sum of the Line total and VAT total values. |
orderTotalInBaseCurrency |
double |
{res:itgen_vnet_ordertotalinbasecurrency} |
☐ |
The top part > View base > A button that recalculates the Order total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency. |
orderType |
string |
Order Type |
☐ |
The top part > Type > The type of the purchase order, which can be one of these options: Normal, Drop-ship, Blanket, Default |
owner_id |
guid |
Owner ID |
☐ |
Click the magnifier > The identifier |
owner_name |
string |
Owner Name |
☐ |
Click the magnifier > The displayed name |
paymentRefNbr |
string |
Payment Reference Number |
☐ |
Other information tab > Prepayment ref. no. > The reference number of the prepayment request linked to this purchase order, if any. |
printed |
boolean |
Printed |
☐ |
Other information > Printed > A check box that indicates (if selected) that the current purchase order was printed. |
promisedOn |
datetime |
Promised on |
☐ |
The top part > Delivery date > The date when the supplier promised that the items listed in the order will be received at their destination location. |
remitAddress_addressId |
int32 |
{res:itgen_vnet_remitaddress_addressid} |
☐ |
|
remitAddress_addressLine1 |
string |
{res:itgen_vnet_remitaddress_addressline1} |
☐ |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. |
remitAddress_addressLine2 |
string |
{res:itgen_vnet_remitaddress_addressline2} |
☐ |
Address 2 > The second line of the address. |
remitAddress_addressLine3 |
string |
{res:itgen_vnet_remitaddress_addressline3} |
☐ |
Address 3 > The third line of the address. |
remitAddress_city |
string |
{res:itgen_vnet_remitaddress_city} |
☐ |
City > The city. |
remitAddress_country_errorInfo |
string |
{res:itgen_vnet_remitaddress_country_errorinfo} |
☐ |
|
remitAddress_country_id |
string |
{res:itgen_vnet_remitaddress_country_id} |
☐ |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. |
remitAddress_country_metadata_maxPageSize |
int64 |
{res:itgen_vnet_remitaddress_country_metadata_maxpagesize} |
☐ |
|
remitAddress_country_metadata_totalCount |
int64 |
{res:itgen_vnet_remitaddress_country_metadata_totalcount} |
☐ |
|
remitAddress_country_name |
string |
{res:itgen_vnet_remitaddress_country_name} |
☐ |
Mandatory field: Country name* > The complete name of the country. |
remitAddress_county_id |
string |
{res:itgen_vnet_remitaddress_county_id} |
☐ |
Click the magnifier > The identifier |
remitAddress_county_name |
string |
{res:itgen_vnet_remitaddress_county_name} |
☐ |
Click the magnifier > The displayed name |
remitAddress_overrideAddress |
boolean |
{res:itgen_vnet_remitaddress_overrideaddress} |
☐ |
The Supplier info tab > The Supplier address section > Override > A check box that you select to override (that is, to edit ) the default shipping address for the supplier. |
remitAddress_postalCode |
string |
{res:itgen_vnet_remitaddress_postalcode} |
☐ |
Postcode > The postcode. |
remitContact_attention |
string |
{res:itgen_vnet_remitcontact_attention} |
☐ |
Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person. |
remitContact_contactId |
int32 |
{res:itgen_vnet_remitcontact_contactid} |
☐ |
|
remitContact_email |
string |
{res:itgen_vnet_remitcontact_email} |
☐ |
Email > The email address of the customer/supplier/company as a business entity. |
remitContact_fax |
string |
{res:itgen_vnet_remitcontact_fax} |
☐ |
Fax > The fax number. |
remitContact_name |
string |
{res:itgen_vnet_remitcontact_name} |
☐ |
Name > The legal name of to appear on the documents. |
remitContact_overrideContact |
boolean |
{res:itgen_vnet_remitcontact_overridecontact} |
☐ |
The Supplier information tab > The Supplier contact section > Override > A check box that you select to override (edit) the default contact settings for the supplier. |
remitContact_phone1 |
string |
{res:itgen_vnet_remitcontact_phone1} |
☐ |
Phone 1 > The default phone number. |
remitContact_phone2 |
string |
{res:itgen_vnet_remitcontact_phone2} |
☐ |
Phone 2 > An additional phone number. |
remitContact_web |
string |
{res:itgen_vnet_remitcontact_web} |
☐ |
Web > The website of the company, if one exists. |
requisitionRefNbr |
string |
{res:itgen_vnet_requisitionrefnbr} |
☐ |
Other information tab > Requisition ref. no. > The reference number of the requisition document associated with the purchase order, if any. |
salesOrderNbr |
string |
{res:itgen_vnet_salesordernbr} |
☐ |
Other information tab > Sales order no. > The ID of the sales order associated with the purchase order. |
salesOrderType |
string |
{res:itgen_vnet_salesordertype} |
☐ |
Other information tab > Sales order type > The type of the sales order associated with the purchase order. |
shippingAddress_addressId |
int32 |
{res:itgen_vnet_shippingaddress_addressid} |
☐ |
|
shippingAddress_addressLine1 |
string |
{res:itgen_vnet_shippingaddress_addressline1} |
☐ |
Address 1 > The first line of the customer's/supplier's/company's/employee's contact address. |
shippingAddress_addressLine2 |
string |
{res:itgen_vnet_shippingaddress_addressline2} |
☐ |
Address 2 > The second line of the address. |
shippingAddress_addressLine3 |
string |
{res:itgen_vnet_shippingaddress_addressline3} |
☐ |
Address 3 > The third line of the address. |
shippingAddress_city |
string |
{res:itgen_vnet_shippingaddress_city} |
☐ |
City > The city. |
shippingAddress_country_errorInfo |
string |
{res:itgen_vnet_shippingaddress_country_errorinfo} |
☐ |
|
shippingAddress_country_id |
string |
{res:itgen_vnet_shippingaddress_country_id} |
☐ |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. |
shippingAddress_country_metadata_maxPageSize |
int64 |
{res:itgen_vnet_shippingaddress_country_metadata_maxpagesize} |
☐ |
|
shippingAddress_country_metadata_totalCount |
int64 |
{res:itgen_vnet_shippingaddress_country_metadata_totalcount} |
☐ |
|
shippingAddress_country_name |
string |
{res:itgen_vnet_shippingaddress_country_name} |
☐ |
Mandatory field: Country name* > The complete name of the country. |
shippingAddress_county_id |
string |
{res:itgen_vnet_shippingaddress_county_id} |
☐ |
Click the magnifier > The identifier |
shippingAddress_county_name |
string |
{res:itgen_vnet_shippingaddress_county_name} |
☐ |
Click the magnifier > The displayed name |
shippingAddress_overrideAddress |
boolean |
{res:itgen_vnet_shippingaddress_overrideaddress} |
☐ |
The Supplier info tab > The Supplier address section > Override > A check box that you select to override (that is, to edit ) the default shipping address for the supplier. |
shippingAddress_postalCode |
string |
{res:itgen_vnet_shippingaddress_postalcode} |
☐ |
Postcode > The postcode. |
shippingContact_attention |
string |
{res:itgen_vnet_shippingcontact_attention} |
☐ |
Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person. |
shippingContact_contactId |
int32 |
{res:itgen_vnet_shippingcontact_contactid} |
☐ |
|
shippingContact_email |
string |
{res:itgen_vnet_shippingcontact_email} |
☐ |
Email > The email address of the customer/supplier/company as a business entity. |
shippingContact_fax |
string |
{res:itgen_vnet_shippingcontact_fax} |
☐ |
Fax > The fax number. |
shippingContact_name |
string |
{res:itgen_vnet_shippingcontact_name} |
☐ |
Name > The legal name of to appear on the documents. |
shippingContact_overrideContact |
boolean |
{res:itgen_vnet_shippingcontact_overridecontact} |
☐ |
The Supplier information tab > The Supplier contact section > Override > A check box that you select to override (edit) the default contact settings for the supplier. |
shippingContact_phone1 |
string |
{res:itgen_vnet_shippingcontact_phone1} |
☐ |
Phone 1 > The default phone number. |
shippingContact_phone2 |
string |
{res:itgen_vnet_shippingcontact_phone2} |
☐ |
Phone 2 > An additional phone number. |
shippingContact_web |
string |
{res:itgen_vnet_shippingcontact_web} |
☐ |
Web > The website of the company, if one exists. |
shippingDestinationType |
string |
{res:itgen_vnet_shippingdestinationtype} |
☐ |
Shipping instructions tab > The Delivery address section > Shipping destination type > The type of the shipping destination, which is one of the following options: Branch location (meaning a branch of your company), Customer, Supplier, and Warehouse. |
shippingLocation_id |
int32 |
Shipping Location ID |
☐ |
Click the magnifier > The identifier |
shippingLocation_name |
string |
Shipping Location Name |
☐ |
Click the magnifier > The displayed name |
shipTerms |
string |
{res:itgen_vnet_shipterms} |
☐ |
Delivery instructions tab > The Delivery instructions section > Shipping terms > The shipping terms for the purchase order. |
shipTo_internalId |
int32 |
{res:itgen_vnet_shipto_internalid} |
☐ |
|
shipTo_name |
string |
{res:itgen_vnet_shipto_name} |
☐ |
The name of the particular destination of the selected type. |
shipTo_number |
string |
{res:itgen_vnet_shipto_number} |
☐ |
The identifier of the particular destination of the selected type. |
shipVia |
string |
Ship Via |
☐ |
Delivery instructions tab > The Delivery instructions section > Ship via > The carrier selected to ship the goods for the purchase order. |
status |
string |
Status |
☐ |
The top part > Status > The system-generated status of the purchase order, which can be one of the following options: On hold, Open, Pending approval, Rejected, Pending printing, Pending e-mail, Closed, Cancelled. |
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 related to this purchase order. |
supplierVatZone_defaultTaxCategory_description |
string |
{res:itgen_vnet_suppliervatzone_defaulttaxcategory_description} |
☐ |
Name of item/description |
supplierVatZone_defaultTaxCategory_number |
string |
{res:itgen_vnet_suppliervatzone_defaulttaxcategory_number} |
☐ |
Number of item |
supplierVatZone_defaultVatCategory |
string |
{res:itgen_vnet_suppliervatzone_defaultvatcategory} |
☐ |
Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window. |
supplierVatZone_description |
string |
{res:itgen_vnet_suppliervatzone_description} |
☐ |
Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window. |
supplierVatZone_errorInfo |
string |
{res:itgen_vnet_suppliervatzone_errorinfo} |
☐ |
|
supplierVatZone_id |
string |
{res:itgen_vnet_suppliervatzone_id} |
☐ |
Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window. |
supplierVatZone_metadata_maxPageSize |
int64 |
{res:itgen_vnet_suppliervatzone_metadata_maxpagesize} |
☐ |
|
supplierVatZone_metadata_totalCount |
int64 |
{res:itgen_vnet_suppliervatzone_metadata_totalcount} |
☐ |
|
taxTotal |
double |
Tax Total |
☐ |
The Top part > VAT total > The total VAT amount for all lines added to the current purchase order. This value, also calculated by the system, is the sum of the VAT amounts for each line. |
taxTotalInBaseCurrency |
double |
{res:itgen_vnet_taxtotalinbasecurrency} |
☐ |
The top part > View base > A button that recalculates the VAT total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency. |
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 |
☐ |
|
vatExemptTotal |
double |
VAT Exempt Total |
☐ |
The Top part > VAT exempt total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the VAT with the Include in VAT exempt total check box selected in the TX205000 window. |
vatExemptTotalInBaseCurrency |
double |
{res:itgen_vnet_vatexempttotalinbasecurrency} |
☐ |
The top part > View base > A button that recalculates the VAT exempt total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency. |
warehouse_description |
string |
Warehouse Description |
☐ |
Click on the magnifier. > The description. |
warehouse_id |
string |
Warehouse ID |
☐ |
Click on the magnifier. > The identifier. |
workgroupID |
int32 |
{res:itgen_vnet_workgroupid} |
☐ |
Other information tab > Work group ID > The work group to which the purchase order was assigned for processing. |
23-06-2025 19:16 Version 24.1.116-BETA+5455