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

BasicPurchaseReceipts: Visma.net Financials Basic Purchase Receipts

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 Receipts

Retrieve: true

Insert: true

Update: false

Delete: false

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function BasicPurchaseReceipts. 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	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 BasicPurchaseReceipts are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name	Data Type	Label	Required	Documentation
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	string	Currency	☐	The top part > Currency > The currency the supplier uses for invoicing.
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.
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.
lastModifiedDateTime	datetime	Last Modified	☐	System generated information.
location_countryId	string	Location Country ID	☐	Location*.
location_id	string	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	☐
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.
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	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.
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

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

BasicPurchaseReceipts: Visma.net Financials Basic Purchase Receipts

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information