Navigation: Schema: GeneralLedgerTransactions > Tables

GeneralLedgerTransactions: Visma.net Financials General Ledger Transactions

Get a range of General Ledger Transactions - ScreenId=GL404000Please use a page size lower or equal to the allowed max page size which is returned under metadata. If pagesize is greater than the max page size, it will be limited to max page size.

Catalog: VismaNet

Schema: GeneralLedgerTransactions

Label: General Ledger Transactions

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 GeneralLedgerTransactions. 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
account	string	☐	The account CD for which you want to view activities in the selected financial period.
branch	string	☐	The branch CD
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.
expandAccountInfo	boolean	☐	By default, if no value is provided, False and the account information will include only Number, Description, Type and GlConsolAccountCD.If True, each transaction returned will include extended information about account.
expandBranchInfo	boolean	☐	By default, if no value is provided, False and branch information will include only branch number.If True, each transaction returned will include extended information about Branch (number and name).
fromDate	string	☐	The first date of the interval within the period. Format YYYY-MM-DD
fromPeriod	string	☑	Mandatory. The financial period that begins the date range of the batches you want to view. Format YYYYPP
includeTransactionBalance	boolean	☐	By default, if no value is provided, False and the transactions returned will not include their balances (fields BegBalance, EndingBalance, CurrBegBalance, CurrEndingBalance)If True, each transaction returned will include its balance.
includeUnposted	boolean	☐	Checkmark indicating if unposted batches are included.
includeUnreleased	boolean	☐	Checkmark indicating if unreleased (balanced) batches are included.
lastModifiedDateTime	string	☐	System retrieved information for last modified date and time. Valid date/time format is yyyy-MM-dd, yyyy-MM-dd HH:mm:ss or yyyy-MM-dd HH:mm:ss.FFF. FFF stands for milliseconds.
lastModifiedDateTimeCondition	string	☐	Value to be used for filtering lastModifiedDateTime value.
ledger	string	☑	Mandatory. The ledger in which you want to view the account balances.
numberToRead	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
pageNumber	int32	☐	Pagination parameter. Page number.
pageSize	int32	☐	Pagination parameter. Number of items to be collected.Please use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page size.
skipRecords	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
subaccountId	string	☐	The Subaccount
toDate	string	☐	The last date of the interval within the selected period. Format YYYY-MM-DD
toPeriod	string	☑	Mandatory. The financial period that ends the date range of the batches you want to view. Format YYYYPP

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
account_description	string	Account Description	☐	Name of item/description
account_externalCode1	string	Account External Code 1	☐	ExternalCode1 is deprecated, please use ExternalCode1Info instead.
account_externalCode1Info_description	string		☐	Name of item/description
account_externalCode1Info_number	string		☐	Number of item
account_externalCode2	string	Account External Code 2	☐	ExternalCode2 is deprecated, please use ExternalCode2Info instead.
account_externalCode2Info_description	string		☐	Name of item/description
account_externalCode2Info_number	string		☐	Number of item
account_glConsolAccountCD	string		☐
account_number	string	Account Number	☐	Number of item
account_type	string	Account Type	☐
batchNumber	string	Batch Number	☐	Batch number > The reference number of the batch (generated for the transaction) that updated the balance of the selected account.
begBalance	double	Begin Balance	☐	Beg. balance > The running total of the account's beginning balance calculated in the order of transactions displayed in the table.
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.
creditAmount	double	Credit Amount	☐	Credit amount > The transaction credit amount charged to the account during the selected financial period.
currBegBalance	double		☐	Beg. balance (currency) > The account balance in the selected currency at the start of the selected period.
currCreditAmount	double		☐	Credit amount (currency) > The credit amount in the selected currency for the specified account over the selected period.
currDebitAmount	double		☐	Debit amount (currency) > The debit amount in the selected currency for the specified account over the selected period.
currency	string	Currency	☐	Click the Show currency details check box to view the below fields in the window.Currency > The currency of transactions in the account. If it is not specified, the balance is in the base currency.
currEndingBalance	double		☐	Ending balance (currency) > The account balance in the selected currency at the start of the selected period.
debitAmount	double	Debit Amount	☐	Debit amount > The transaction debit amount charged to the account during the selected financial period.
description	string	Description	☐	Description > The user-defined description of the transaction.
endingBalance	double	End Balance	☐	Ending balance > The running total of the account's ending balance calculated in the order of transactions displayed in the table.
errorInfo	string	Error Message	☐
lastModifiedDateTime	datetime	Last Modified	☐	System generated information reflecting when the last change was done.
ledger_description	string	Ledger Description	☐	Click on the magnifier. > The description.
ledger_id	string	Ledger ID	☐	Click on the magnifier. > The identifier.
lineNumber	int32	Line Number	☐
metadata_maxPageSize	int64		☐
metadata_totalCount	int64	Total Count	☐
module	string	Module	☐	Workspace > The workspace where the transaction originated.
period	string	Period	☐	Period > The financial period of the transaction.
refNumber	string	Reference Number	☐	Ref. number > The reference number of the external document on which this transaction is based.
subaccount	string	Sub Account	☐	Subaccount > The subaccount used in the batch.
tranDate	datetime	Transaction Date	☐	Trans date > The date of the transaction.

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

GeneralLedgerTransactions: Visma.net Financials General Ledger Transactions

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information