itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of DeferralCodes - ScreenId=DR2020PLRequest page size must be 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
Catalog: VismaNet
Schema: DeferralCode
Label: Deferral Codes
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/deferralCode
Insert Visma.net Financials API URL: /controller/api/v1/deferralCode
Update Visma.net Financials API URL: /controller/api/v1/deferralCode
Delete Visma.net Financials API URL: /controller/api/v1/deferralCode
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/deferralCode
Table Function Parameters
The following parameters can be used to control the behaviour of the table function DeferralCodeDeferralCodes. 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. |
pageNumber |
int32 |
☐ |
|
Pagination parameter. Page number. |
pageSize |
int32 |
☐ |
|
Pagination parameter. Number of items to be collected. |
Table Function Columns
The columns of the table function DeferralCodeDeferralCodes are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
codeType |
string |
|
☐ |
Code type > The type of the deferral code. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
deferralAccount_description |
string |
|
☐ |
Click on the magnifier. > The description. |
deferralAccount_id |
string |
|
☐ |
Click on the magnifier. > The identifier. |
deferralCode |
string |
|
☐ |
Mandatory field: Deferral code* > The unique code for the deferral type. |
deferralSub_description |
string |
|
☐ |
Click on the magnifier. > The description. |
deferralSub_id |
string |
|
☐ |
Click on the magnifier. > The identifier. |
deferredRevenueFromItem |
boolean |
|
☐ |
Deferred revenue from item > When this check box is selected, the deferred revenue of the code will be retrieved from the connected item. |
description |
string |
Description |
☐ |
Description > The description of the deferral code. |
errorInfo |
string |
Error Message |
☐ |
|
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
recognitionMethod |
string |
|
☐ |
Recognition method > The method used to distribute the document amount over the periods. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
