Navigation: Schema: CashTransaction > Tables

CashTransactionByReferenceNumber: Visma.net Financials Cash Transaction by Reference Number

Get a specific Transaction - ScreenID=CA304000

Catalog: VismaNet

Schema: CashTransaction

Label: Cash Transaction by Reference Number

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL 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 CashTransactionByReferenceNumber. 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
COMPANY_CODE	string	☐	Partition to retrieve data from.
erp-api-background	string	☐	If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.
referenceNbr	string	☑	Returns data for the selected Cash transaction

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
amount	double	Amount	☐	The top part > Amount > The amount of the transaction.
cashAccount_description	string	Cash Account Description	☐	Name of item/description
cashAccount_number	string	Cash Account Number	☐	Number of item
cashAccount_type	string	Cash Account Type	☐
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	☐	Mandatory field: The top part > Control total > The control total of the transaction.
currency	string	Currency	☐	The top part > Currency > The currency of the cash account.
description	string	Description	☐	The top part > Description > A detailed description of the transaction.
disbReceipt	string		☐	The top part > Disb./receipt > The basic type of the transaction.
documentRef	string	Document Reference	☐	The top part > Document ref. > The external document reference number.
entryType_description	string	Entry Type Description	☐	Click on the magnifier. > The description.
entryType_id	string	Entry Type ID	☐	Click on the magnifier. > The identifier.
financialPeriod	string	Financial Period	☐	Mandatory field: The top part > Period* > The financial period to which the transaction should be posted.
financialsDetail_batchNumber	string	Financials Detail Batch Number	☐	Link to general ledger section > Batch number > The number of the batch generated to implement the cash transaction.
financialsDetail_branch_name	string	Branch Name	☐	Click the magnifier. > The name.
financialsDetail_branch_number	string	Branch Number	☐	Click the magnifier. > The identifier.
financialsDetail_clearDate	datetime	Clear Date	☐	Link to general ledger section > Clear date > The date when the transaction was cleared.
financialsDetail_cleared	boolean	Cleared?	☐	Link to general ledger section > Cleared > A check box that indicates (if selected) that the transaction was cleared.
financialsDetail_taxCalcMode	string	Tax Calculation Mode	☐	VAT settings section > VAT calculation > The VAT calculation mode, which defines which amounts (VAT-inclusive or VAT-exclusive) should be entered in the detail lines of a document.
financialsDetail_taxZone_defaultTaxCategory_description	string	Tax Zone Default Tax Category Description	☐	Name of item/description
financialsDetail_taxZone_defaultTaxCategory_number	string	Tax Zone Default Tax Category Number	☐	Number of item
financialsDetail_taxZone_defaultVatCategory	string	Tax Zone Default VAT Category	☐	Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window.
financialsDetail_taxZone_description	string	Tax Zone Description	☐	Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.
financialsDetail_taxZone_errorInfo	string		☐
financialsDetail_taxZone_id	string	Tax Zone ID	☐	Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.
financialsDetail_taxZone_metadata_maxPageSize	int64		☐
financialsDetail_taxZone_metadata_totalCount	int64		☐
finPeriod	string	Financial Period	☐	The property is now considered obsolete. Use Financial Period instead
hold	boolean	Hold	☐	The top part > Hold > A check box that, if selected, indicates that the transaction is on hold, which means it may be edited but cannot be released.
lastModifiedDateTime	datetime	Last Modified	☐	System generated information.
owner_internalId	string	Owner Internal ID	☐
owner_name	string	Owner Name	☐	The name of the particular destination of the selected type.
owner_number	string	Owner Number	☐	The identifier of the particular destination of the selected type.
referenceNbr	string	Reference Number	☐	The top part > Ref. no. > The unique identifier assigned to the cash transaction in accordance with the numbering sequence.
status	string	Status	☐	The top part > Status > The status of the transaction, which is automatically assigned by the system.
taxAmount	double	Tax Amount	☐	The top part > VAT amount > The VAT amount to be paid for the document. A user enters this amount manually.
taxTotal	double	Tax Total	☐	The top part > VAT total > The total amount of tax paid in the document.
tranDate	datetime	Transaction Date	☐	Mandatory field: The top part > Trans. date* > The date of the transaction.
tranType	string	Transaction Type	☐	The top part > Trans type > The type of cash transaction.
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.

22-12-2022 21:03 Version 22.1.101-BETA+3681

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

CashTransactionByReferenceNumber: Visma.net Financials Cash Transaction by Reference Number

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information