Please enable JavaScript to view this site.

Visma.net Financials API Data Model Visma.net Financials Forums

Navigation: Schema: GeneralLedgerBalanceV2 > Tables

GeneralLedgerBalancesV2: Visma.net Financials General Ledger Balances

Get a range of General Ledger Balances. Complete documentation can be found under 8.21 release notes. Please 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: GeneralLedgerBalanceV2

Label: General Ledger Balances

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 GeneralLedgerBalancesV2. 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

account

string

☐

 

Account to retrieve balance for

balanceType

string

☐

 

Balance Type of the ledger to be exported (Waarden: Actual, Report, Statistical, Budget)

branch

string

☐

 

Branch to retrieve balance for

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.

lastModifiedDateTime

datetime

☐

 

When setting this parameter there will be exported only the balances that were changed since the provided date and time.Mandatory if 'PeriodId' is not provided.Format: 'yyyy-MM-dd HH:mm:ss'

ledger

string

☐

 

Ledger to retrieve balance for

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.

periodId

string

☐

 

Period to retrieve balance for. Mandatory if 'LastModifiedDateTime' not provided. Format: 'yyyyMM'

toggleBalanceSigns

boolean

☐

 

Parameter can be used in order to change the balance sign for liability and income accounts

 

Columns of Table Function

The columns of the table function GeneralLedgerBalancesV2 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

☐

 

balanceType

string

Balance Type

☐

 

beginningBalance

double

 

☐

 

beginningBalanceInCurrency

double

 

☐

 

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.

currencyId

string

Currency ID

☐

 

errorInfo

string

Error Message

☐

 

financialPeriod

string

Financial Period

☐

The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.

lastModifiedDateTime

datetime

Last Modified

☐

 

ledger_description

string

Ledger Description

☐

Click on the magnifier. > The description.

ledger_id

string

Ledger ID

☐

Click on the magnifier. > The identifier.

metadata_maxPageSize

int64

 

☐

 

metadata_totalCount

int64

Total Count

☐

 

periodToDateCredit

double

 

☐

 

periodToDateCreditInCurrency

double

 

☐

 

periodToDateDebit

double

 

☐

 

periodToDateDebitInCurrency

double

 

☐

 

subAccountCd

string

 

☐

 

subaccountId

string

 

☐

 

yearClosed

boolean

 

☐

 

yearToDateBalance

double

 

☐

 

yearToDateBalanceInCurrency

double

 

☐

 

 

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

X

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.
  
Disclaimer