itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet 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
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.
Select Visma.net Financials API URL: /controller/api/v2/generalLedgerBalance
Insert Visma.net Financials API URL: /controller/api/v2/generalLedgerBalance
Update Visma.net Financials API URL: /controller/api/v2/generalLedgerBalance
Delete Visma.net Financials API URL: /controller/api/v2/generalLedgerBalance
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v2/generalLedgerBalance
Table Function Parameters
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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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 (Values: Actual, Report, Statistical, Budget) |
branch |
string |
☐ |
|
Branch to retrieve balance for |
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
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. |
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 |
Table Function Columns
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. |
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 |
|
☐ |
|
06-04-2021 14:55 Version 20.1.393-BETA+3152
