Visma.net Financials API Data Model
JournalTransactionsByPeriodOrDateV2: Visma.net Financials Journal Transaction Line Subaccount Segments by Period or Date |
Get a range of Journal Transactions - ScreenId=GL301000. On this particular endpoint, pagesize and totalcount denotes number of journaltransaction lines. When using pagination, the transactions for one specific batch can be split into several responses. 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: JournalTransactionV2
Label: Journal Transaction Line Subaccount Segments by Period or Date
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 JournalTransactionsByPeriodOrDateV2. 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 |
|---|---|---|---|---|
branch |
string |
☐ |
|
Branch to query data 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. |
expandAttachments |
boolean |
☐ |
|
If true there will be included all attachments regarding batch. Default on false |
lastModifiedDateTime |
string |
☐ |
|
When setting this parameter there will be exported only the batches changed or created since the provided date and time. Mandatory if 'PeriodId' is not provided. Format: yyyy-MM-dd HH:mm:ss |
module |
string |
☐ |
|
Module to query data for. Allowed values: GL, AP, AR, CM, CA, IN, DR, FA, PM |
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 |
☐ |
|
Financial Period to query data for. Mandatory if 'LastModifiedDateTime' not provided. Format: YYYYPP |
releasedBatch |
boolean |
☐ |
|
If true there will be exported the batches having Released flag on true. If false there will be exported the batches having Released flag on false. If not set no filtering based on Released flag is applied |
Columns of Table Function
The columns of the table function JournalTransactionsByPeriodOrDateV2 are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
autoReversing |
boolean |
|
☐ |
The top part > Automatic reversing > A check box that indicates (if selected) that the batch is auto-reversing. |
batchNumber |
string |
Batch Number |
☐ |
The top part > Batch number > The unique ID of the batch, which is generated by the numbering sequence assigned to batches in the GL102000 window. |
branch |
string |
Branch |
☐ |
The top part > Branch > The branch to which this batch is related. This field is available if your company is set up with branches. |
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 |
☐ |
The top part > Control total > The control total of the batch, which is used for batch status validation. |
controlTotalInCurrency |
double |
|
☐ |
Background calculation giving you the Control total in your default currency. This field is applicable if the amount is given in another currency than your default. |
createVatTransaction |
boolean |
|
☐ |
The top part > Create VAT transactions > A check box that indicates (if selected) that a VAT-related transaction can be created manually; select this check box when you begin to create the transaction. |
creditTotal |
double |
|
☐ |
The top part > Credit total > The total of transaction credit amounts for the batch; the value is calculated automatically. |
creditTotalInCurrency |
double |
|
☐ |
Background calculation giving you the Credit total in your default currency. This field is applicable if the amount is given in a another currency than your default. |
currencyId |
string |
Currency ID |
☐ |
The top part > Currency > The currency used for all the journal transactions in the selected batch. |
debitTotal |
double |
Debit Total |
☐ |
The top part > Debit total > The total of transaction debit amounts for the batch; the value is calculated automatically. |
debitTotalInCurrency |
double |
|
☐ |
Background calculation giving you the Debit total in your default currency. This field is applicable if the amount is given in another currency than your default. |
description |
string |
Description |
☐ |
The top part > Description > A description of the batch. |
errorInfo |
string |
Error Message |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
Ingformation collected from the system to calculate currency amount. |
financialPeriod |
string |
Financial Period |
☐ |
Mandatory field: The top part Post period* > The financial period to which the transactions should be posted. Format YYYYMM. |
hold |
boolean |
Hold |
☐ |
The top part > Hold > A check box that indicates (if selected) that the batch has the On hold status and cannot be released or posted. You can clear the check box only if the batch has total debits equal to total credits. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
ledger |
string |
Ledger |
☐ |
Mandatory field: The top part > Ledger* > The unique ID of the ledger to which batch transactions are posted. By default, it is the default posting ledger specified for the branch in the GL101010 window, but another posting ledger can be selected. |
ledgerDescription |
string |
Ledger Description |
☐ |
Mandatory field: The top part > Ledger* > Click the magnifier > The description of the ledger to which batch transactions are posted. By default, it is the default posting ledger specified for the branch in the GL101010 window, but another posting ledger can be selected. |
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
module |
string |
Module |
☐ |
The top part > Workspace > The workspace where the batch originates. New batches can be created only for General ledger. |
originalBatchNumber |
string |
|
☐ |
The top part > Orig. batch number > For a scheduled or auto-reversing batch, the reference number of the batch used as a template. |
postPeriod |
string |
Post Period |
☐ |
Mandatory field: The top part > Post period* > The financial period to which the transactions recorded in the document should be posted. Format MMYYYY. |
reversingEntry |
boolean |
|
☐ |
The top part > Reversing entry > A check box that indicates (if selected) that the batch is a reversing batch. The Orig.batch number field displays the ID of the batch that was reversed by this batch. |
skipVatAmountValidation |
boolean |
|
☐ |
The top part > Skip VAT amount validation > A check box that (if selected) causes automatic validation of a VAT-related transaction that you create manually to be skipped. |
status |
string |
Status |
☐ |
The top part > Status > The current status of the batch. The status defines what processing can be applied to the batch. The following options are available: On hold, Balanced, Scheduled, Unposted, Posted, Void. |
transactionCode |
string |
|
☐ |
|
transactionCodeDescription |
string |
|
☐ |
The Table part > Transaction description > A description of the transaction or any comments relevant to the transaction. |
transactionDate |
datetime |
|
☐ |
Mandatory field: The top part > Transaction date* > The date when the batch was created, which relates to the transaction dates of the journal entries. |
22-12-2022 21:03 Version 22.1.101-BETA+3681
