itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data Model|
JournalTransactionJournalTransactions_JournalTransactionLinesSubaccountSegments |
Contents Previous Home Next More |
Get a range of Journal Transactions - ScreenId=GL301000When using pagination, the transactions for one specific batch can be split into several responses.When using pagination, pagesize (totalcount) denotes number of JournalTransaction lines. Method is deprecated and will be removed in September 2020 - start using new method on journalTransactionV2
Catalog: VismaNet
Schema: JournalTransaction
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/journaltransaction
Insert Visma.net Financials API URL: /controller/api/v1/journaltransaction
Update Visma.net Financials API URL: /controller/api/v1/journaltransaction
Delete Visma.net Financials API URL: /controller/api/v1/journaltransaction
Field Selection Method: NotRequired
Base Path: journalTransactionLines[*].subaccount.segments[*]
Select Visma.net Financials API Operation: get /controller/api/v1/journaltransaction
Table Function Parameters
The following parameters can be used to control the behaviour of the table function JournalTransactionJournalTransactions_JournalTransactionLinesSubaccountSegments. 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 |
|---|---|---|---|---|
branch |
string |
☐ |
|
Branch to query data for. |
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
customerSupplierEnd |
string |
☐ |
|
|
customerSupplierStart |
string |
☐ |
|
|
expandAttachments |
boolean |
☐ |
|
Set to true if you want to see all attachments regarding batch. |
greaterThanValue |
string |
☐ |
|
|
lastModifiedDateTime |
string |
☐ |
|
System retrieved information for last modified date and time. |
lastModifiedDateTimeCondition |
string |
☐ |
|
System retrieved information for date, time and state/condition. |
pageNumber |
int32 |
☐ |
|
Pagination parameter. Page number. |
pageSize |
int32 |
☐ |
|
Pagination parameter. Number of items to be collected. |
released |
int32 |
☐ |
|
Filter by the date when the batch was released. |
Table Function Columns
The columns of the table function JournalTransactionJournalTransactions_JournalTransactionLinesSubaccountSegments are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
accountNumber |
string |
General Ledger Account Number |
☐ |
Mandatory field: The table > Account* > The account (associated with the specified branch) whose balance will be updated by the journal entry. |
active |
boolean |
Active |
☐ |
Active > The status of the identifier. |
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_1 |
string |
|
☐ |
The top part > Branch > The branch to which this batch is related. This field is available if your company is set up with branches. |
branch |
string |
Branch |
☐ |
The table > Branch > The branch associated with this journal entry. |
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. |
creditAmount |
double |
Credit Amount |
☐ |
The table > Credit amount > The credit amount of the journal entry. |
creditAmountInCurrency |
double |
|
☐ |
Background calculation giving you the Credit amount in your default currency. This field is applicable if the amount is given in another currency than your default. |
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. |
customerSupplier |
string |
|
☐ |
The table > Customer/Supplier > The customer or supplier associated with the entry. |
debitAmount |
double |
Debit Amount |
☐ |
The table > Debit amount > The debit amount of the journal entry. |
debitAmountInCurrency |
double |
|
☐ |
Background calculation giving you the debit amount in your default currency. This field is applicable if the amount is given in another currency than your default. |
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_1 |
string |
|
☐ |
The table > Description > A detailed description provided by a user or generated by the system. |
description_2 |
string |
|
☐ |
The top part > Description > A description of the batch. |
description |
string |
Description |
☐ |
Description > The description of the identifier. |
errorInfo_1 |
string |
|
☐ |
|
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. |
inventoryNumber |
string |
Inventory Number |
☐ |
Item ID > The item ID of the line item, if applicable. |
lastModifiedDateTime_1 |
datetime |
|
☐ |
System generated information. |
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. |
lineNumber |
int32 |
Line Number |
☐ |
The table > Number at the left indicating the line number of the table. |
metadata_maxPageSize_1 |
int64 |
|
☐ |
|
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount_1 |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
module_1 |
string |
|
☐ |
The top part > Workspace > The workspace where the batch originates. New batches can be created only for General ledger. |
module |
string |
Module |
☐ |
The workspace where the batch originates. See module in the Top part > Workspace |
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. |
project_description |
string |
Project Description |
☐ |
Click on the magnifier. > The description. |
project_id |
string |
Project ID |
☐ |
Click on the magnifier. > The identifier. |
projectTask_description |
string |
Project Task Description |
☐ |
Click on the magnifier. > The description. |
projectTask_id |
string |
Project Task ID |
☐ |
Click on the magnifier. > The identifier. |
quantity |
double |
Quantity |
☐ |
The table > Quantity > The quantity of items associated with the transaction, if relevant. |
referenceNumber |
string |
Reference Number |
☐ |
The table > Ref. no. > The reference number of the external or internal document associated with the journal transaction. |
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. |
segmentDescription |
string |
|
☐ |
The Segment values window > The Top part > The description of the segment. |
segmentId |
int32 |
Segment ID |
☐ |
The Segment values window > The Top part > The ID of the segment. |
segmentValue |
string |
Segment Value |
☐ |
The Segment values window > The table > The value of the segment, alphanumeric. |
segmentValueDescription |
string |
Segment Value Description |
☐ |
The Segment values window > The table > The description of the segment value. |
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. |
subaccountId |
int32 |
|
☐ |
SubID > The identifier of the subaccount. |
subaccountNumber |
string |
|
☐ |
Mandatory field: Subaccount* > The subaccount number. Format 9-XX. |
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. |
transactionDescription |
string |
|
☐ |
The table > Transaction Description > A description of the transaction or any comments relevant to the transaction. |
transactionType |
string |
|
☐ |
The top part > Type > The type of this general ledger batch, which is specified by the system automatically. |
uom |
string |
Unit of Measure |
☐ |
The table > UoM > The quantity of items associated with the transaction, if relevant. |
vat_description |
string |
|
☐ |
Click on the magnifier. > The description. |
vat_id |
string |
VAT ID |
☐ |
Click on the magnifier. > The identifier. |
vatCode_description |
string |
VAT Code Description |
☐ |
Click on the magnifier. > The description. |
vatCode_id |
string |
VAT Code ID |
☐ |
Click on the magnifier. > The identifier. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
