itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data Model|
GeneralLedgerTransactions: Visma.net Financials General Ledger Transactions |
Contents Previous Home Next More |
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.
Select Visma.net Financials API URL: /controller/api/v1/GeneralLedgerTransactions
Insert Visma.net Financials API URL: /controller/api/v1/GeneralLedgerTransactions
Update Visma.net Financials API URL: /controller/api/v1/GeneralLedgerTransactions
Delete Visma.net Financials API URL: /controller/api/v1/GeneralLedgerTransactions
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/GeneralLedgerTransactions
Table Function Parameters
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 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 |
☐ |
|
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. |
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 |
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. |
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 |
Table Function Columns
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. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
