Navigation: Catalog: VismaNet > Schemas > Schema: PurchaseOrder > Tables

PurchaseOrderReceiptsByPurchaseOrderNumber

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

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 PurchaseOrderReceiptsByPurchaseOrderNumber. 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		☐		Optional parameter to request custom free fields.
purchaseOrderNumber		☑		Identifies the Purchase Order

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
branch_name	varchar2	Branch Name	☐	Click the magnifier. > The name.
branch_number	varchar2	Branch Number	☐	Click the magnifier. > The identifier.
COMPANY_CODE	varchar2(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	varchar2(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		☐	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_2	varchar2		☐	The top part > Currency > The currency the purchase order will be paid in.
currency	varchar2	Currency	☐	The top part > Currency > The currency the supplier uses for invoicing.
customDateTimeUTC1	datetime		☐	A free custom colum of type DateTime - in UTC timezone
customDec1	double		☐	A free custom colum of type decimal with max 4 decimals.
customDec2	double		☐	A free custom colum of type decimal with max 4 decimals.
customInt1	int32		☐	A free custom colum of type int
customInt2	int32		☐	A free custom colum of type int
customStr1	varchar2		☐	A free custom colum of type string with max length 100.
customStr2	varchar2		☐	A free custom colum of type string with max length 100.
customStr3	varchar2		☐	A free custom colum of type string with max length 100.
customStr4	varchar2		☐	A free custom colum of type string with max length 100.
customStr5	varchar2		☐	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	varchar2	Description	☐	The top part > Description > A brief description of the purchase order.
dontEmail	char	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	char	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	char	Emailed	☐	Other information > Emailed > A check box that indicates (if selected) indicates that the current purchase order was emailed.
errorInfo	varchar2	Error Message	☐
exchangeRate	double	Exchange Rate	☐
fobPoint	varchar2		☐	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	char	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		☐	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	varchar2	Location Name	☐	Click the magnifier > The displayed name
metadata_maxPageSize	int64	Metadata Max Pagesize	☐
metadata_totalCount	int64	Total Count	☐
note	varchar2	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		☐	Other information > Open Quantity > The difference between the quantities of ordered and received items.
orderNbr	varchar2	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		☐	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	varchar2	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	varchar2	Owner Name	☐	Click the magnifier > The displayed name
paymentRefNbr	varchar2	Payment Reference Number	☐	Other information tab > Prepayment ref. no. > The reference number of the prepayment request linked to this purchase order, if any.
printed	char	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.
receiptNumber	varchar2	Receipt Number	☐	The top part > Receipt no. > The unique reference number of the purchase receipt, transfer receipt, or return, which the system automatically assigns according to its number series.
remitAddress_addressId	int32		☐
remitAddress_addressLine1	varchar2		☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
remitAddress_addressLine2	varchar2		☐	Address 2 > The second line of the address.
remitAddress_addressLine3	varchar2		☐	Address 3 > The third line of the address.
remitAddress_city	varchar2		☐	City > The city.
remitAddress_country_errorInfo	varchar2		☐
remitAddress_country_id	varchar2		☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
remitAddress_country_metadata_maxPageSize	int64		☐
remitAddress_country_metadata_totalCount	int64		☐
remitAddress_country_name	varchar2		☐	Mandatory field: Country name* > The complete name of the country.
remitAddress_county_id	varchar2		☐	Click the magnifier > The identifier
remitAddress_county_name	varchar2		☐	Click the magnifier > The displayed name
remitAddress_overrideAddress	char		☐	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	varchar2		☐	Postcode > The postcode.
remitContact_attention	varchar2		☐	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		☐
remitContact_email	varchar2		☐	Email > The email address of the customer/supplier/company as a business entity.
remitContact_fax	varchar2		☐	Fax > The fax number.
remitContact_name	varchar2		☐	Name > The legal name of to appear on the documents.
remitContact_overrideContact	char		☐	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	varchar2		☐	Phone 1 > The default phone number.
remitContact_phone2	varchar2		☐	Phone 2 > An additional phone number.
remitContact_web	varchar2		☐	Web > The website of the company, if one exists.
requisitionRefNbr	varchar2		☐	Other information tab > Requisition ref. no. > The reference number of the requisition document associated with the purchase order, if any.
salesOrderNbr	varchar2		☐	Other information tab > Sales order no. > The ID of the sales order associated with the purchase order.
salesOrderType	varchar2		☐	Other information tab > Sales order type > The type of the sales order associated with the purchase order.
shippingAddress_addressId	int32		☐
shippingAddress_addressLine1	varchar2		☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
shippingAddress_addressLine2	varchar2		☐	Address 2 > The second line of the address.
shippingAddress_addressLine3	varchar2		☐	Address 3 > The third line of the address.
shippingAddress_city	varchar2		☐	City > The city.
shippingAddress_country_errorInfo	varchar2		☐
shippingAddress_country_id	varchar2		☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
shippingAddress_country_metadata_maxPageSize	int64		☐
shippingAddress_country_metadata_totalCount	int64		☐
shippingAddress_country_name	varchar2		☐	Mandatory field: Country name* > The complete name of the country.
shippingAddress_county_id	varchar2		☐	Click the magnifier > The identifier
shippingAddress_county_name	varchar2		☐	Click the magnifier > The displayed name
shippingAddress_overrideAddress	char		☐	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	varchar2		☐	Postcode > The postcode.
shippingContact_attention	varchar2		☐	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		☐
shippingContact_email	varchar2		☐	Email > The email address of the customer/supplier/company as a business entity.
shippingContact_fax	varchar2		☐	Fax > The fax number.
shippingContact_name	varchar2		☐	Name > The legal name of to appear on the documents.
shippingContact_overrideContact	char		☐	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	varchar2		☐	Phone 1 > The default phone number.
shippingContact_phone2	varchar2		☐	Phone 2 > An additional phone number.
shippingContact_web	varchar2		☐	Web > The website of the company, if one exists.
shippingDestinationType	varchar2		☐	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	varchar2	Shipping Location Name	☐	Click the magnifier > The displayed name
shipTerms	varchar2		☐	Delivery instructions tab > The Delivery instructions section > Shipping terms > The shipping terms for the purchase order.
shipTo_internalId	int32		☐
shipTo_name	varchar2		☐	The name of the particular destination of the selected type.
shipTo_number	varchar2		☐	The identifier of the particular destination of the selected type.
shipVia	varchar2	Ship Via	☐	Delivery instructions tab > The Delivery instructions section > Ship via > The carrier selected to ship the goods for the purchase order.
status_2	varchar2		☐	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.
status	varchar2	Status	☐	The top part > Status > The current status of the purchase or transfer receipt, or return, which the system assigns automatically.
supplier_internalId	int32	Supplier Internal ID	☐
supplier_name	varchar2	Supplier Name	☐	The name of the particular destination of the selected type.
supplier_number	varchar2	Supplier Number	☐	The identifier of the particular destination of the selected type.
supplierName	varchar2		☐	The top part > Supplier > The supplier from which the items have been received or to which they will be returned.
supplierRef	varchar2	Supplier Reference	☐	The top part > Supplier ref. > The reference number of the supplier document related to this purchase order.
supplierVatZone_defaultTaxCategory_description	varchar2		☐	Name of item/description
supplierVatZone_defaultTaxCategory_number	varchar2		☐	Number of item
supplierVatZone_defaultVatCategory	varchar2		☐	Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window.
supplierVatZone_description	varchar2		☐	Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.
supplierVatZone_errorInfo	varchar2		☐
supplierVatZone_id	varchar2		☐	Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.
supplierVatZone_metadata_maxPageSize	int64		☐
supplierVatZone_metadata_totalCount	int64		☐
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		☐	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	varchar2	Terms Description	☐	Click on the magnifier. > The description.
terms_id	varchar2	Terms ID	☐	Click on the magnifier. > The identifier.
timeStamp	blob	Timestamp	☐
totalAmt	double	Total Amount	☐	The top part > Total amt. > The total amount calculated for items received from or returned to the supplier; the sum of all amounts of all stock items listed on the Document details tab.
totalQty	double	Total Quantity	☐	The top part > Total qty. > The total quantity of items received from or returned to the supplier; the sum of all quantities of all stock items listed on the Document details tab.
type	varchar2	Type	☐	The top part > Type > The type of the document, which can be Receipt, Return, or Transfer receipt.
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		☐	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	varchar2	Warehouse Description	☐	Click on the magnifier. > The description.
warehouse_id	varchar2	Warehouse ID	☐	Click on the magnifier. > The identifier.
workgroupID	int32		☐	Other information tab > Work group ID > The work group to which the purchase order was assigned for processing.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

PurchaseOrderReceiptsByPurchaseOrderNumber

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information