itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a specific Dimension
Catalog: VismaNet
Schema: Dimension
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/dimension/{dimensionId}
Insert Visma.net Financials API URL: /controller/api/v1/dimension/{dimensionId}
Update Visma.net Financials API URL: /controller/api/v1/dimension/{dimensionId}
Delete Visma.net Financials API URL: /controller/api/v1/dimension/{dimensionId}
Field Selection Method: NotRequired
Base Path: segments[*]
Select Visma.net Financials API Operation: get /controller/api/v1/dimension/{dimensionId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function DimensionSegmentsById. 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. |
dimensionId |
string |
☑ |
|
Identifies the dimension |
expandSegmentsValues |
boolean |
☐ |
|
Flag can be used to return data without the segment values. |
greaterThanValue |
string |
☐ |
|
Greater-than value. The item which is the object for this, varies from API to API. |
lastModifiedDateTime |
string |
☐ |
|
System-generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present. |
lastModifiedDateTimeCondition |
string |
☐ |
|
System-retrieved information for state/condition. |
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. |
orderBy |
string |
☐ |
|
This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result. |
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. /// |
Table Function Columns
The columns of the table function DimensionSegmentsById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
consolNumChar |
int32 |
|
☐ |
Select segment and click View segment > Number of characters > The length (in characters) of the string in the parent's subaccount to which the segment value is mapped; this column is displayed for only the SUBACCOUNT key. |
consolOrder |
int32 |
|
☐ |
Select segment and click View segment > Consol. order > The number that represents the order of this string among other strings in the parent company's subaccount; this column is displayed for only the SUBACCOUNT key. |
description_1 |
string |
|
☐ |
Mandatory field: The top part > Description* > A detailed description of the segmented key. |
description |
string |
Description |
☐ |
Mandatory field: Description > The user-defined segment description. |
id |
string |
ID |
☐ |
Mandatory field: The top part > Segment key ID* > The ID of the segmented key. ACCGROUP, ACCOUNT, BIZACCT, CASHACCOUNT, CONTRACT, CONTRACTITEM, CUSTOMER, EMPLOYEE, INLOCATION, INSITE, INSUBITEM, INVENTORY, LOCATION, MLISTCD, PROJECT, PROTASK, SALESPER, SUBACCOUNT, TMCONTRACT, SUPLLIER |
isAutoNumber |
boolean |
|
☐ |
Select segment and click View segment > Auto number > A check box that indicates (if selected) that the number series selected in the Number series ID field will be used to generate values for this segment in IDs. |
lastModified |
datetime |
Last Modified |
☐ |
System generated information. |
length_1 |
int32 |
|
☐ |
The top part > Length > The total length of the key. |
length |
int32 |
Length |
☐ |
Length > The maximum length of the segment. |
publicId |
string |
Public ID |
☐ |
|
segmentId |
int32 |
Segment ID |
☐ |
Segment ID > The system-generated number representing the order of the segment in the segmented key. |
timeStamp |
string |
Timestamp |
☐ |
|
validate |
boolean |
|
☐ |
Validate > A check box that indicates (if selected) that validation of segment values is turned on. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
