itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a specific Financial Period - ScreenId=GL201000
Catalog: VismaNet
Schema: FinancialPeriod
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/financialPeriod/{financialPeriodId}
Insert Visma.net Financials API URL: /controller/api/v1/financialPeriod/{financialPeriodId}
Update Visma.net Financials API URL: /controller/api/v1/financialPeriod/{financialPeriodId}
Delete Visma.net Financials API URL: /controller/api/v1/financialPeriod/{financialPeriodId}
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/financialPeriod/{financialPeriodId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function FinancialPeriodById. 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 |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
financialPeriodId |
string |
☑ |
|
Returns the financial period for the specified FinancialPeriodId, format YYYYPP |
Table Function Columns
The columns of the table function FinancialPeriodById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
active |
boolean |
Active |
☐ |
The table > Active > A check box that indicates (if selected) that the period can be used for posting transactions. |
closedInCashManagement |
boolean |
|
☐ |
The table > Closed in Cash management > A read-only check box that indicates (if selected) that the financial period is closed in the Cash management; if this check box is cleared, the period is active in this workspace. |
closedInCustomerLedger |
boolean |
|
☐ |
The table > Closed in Customer ledger > A read-only check box that indicates (if selected) that the financial period is closed in the Customer ledger workspace; if this check box is cleared, the period is active in this workspace. |
closedInFixedAssets |
boolean |
|
☐ |
The table > Closed in Fixed assets > A read-only check box that indicates (if selected) that the financial period is closed in the Fixed assets workspace; if this check box is cleared, the period is active in the this workspace. |
closedInGeneralLedger |
boolean |
|
☐ |
The table > Closed in General ledger > A read-only check box that indicates (if selected) that the financial period is closed in the General ledger workspace; if this check box is cleared, the period is active in the this workspace. |
closedInInventoryManagement |
boolean |
|
☐ |
The table > Closed in Inventory management > Inventory managementA read-only check box that indicates (if selected) that the financial period is closed in the Inventory workspace; if this check box is cleared, the period is active in the workspace. |
closedInSupplierLedger |
boolean |
|
☐ |
The table > Closed in Supplier ledger > A read-only check box that indicates (if selected) that the financial period is closed in the Supplier ledger workspace; if this check box is cleared, the period is active in the this workspace. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
description |
string |
Description |
☐ |
The table > Description > The description of the financial period (such as the name of the month or the number of the quarter). |
endDate |
datetime |
End Date |
☐ |
The table > End date > The date when the financial period ends. |
period |
string |
Period |
☐ |
The table > Period > The period no and the year. |
startDate |
datetime |
Start Date |
☐ |
The table > Start date > The date when the financial period starts. |
year |
int32 |
Year |
☐ |
Mandatory field: The top part > Financial year* > The financial year. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
