Please enable JavaScript to view this site.

Made in EU
Visma.net Financials Forums

Visma.net Financials API Data Model

Navigation: Catalog: VismaNet > Schemas > Schema: Dimension > Tables

DimensionSegmentValuesById: Visma.net Financials Dimension Segment Values by ID

Get a specific Dimension

Catalog: VismaNet

Schema: Dimension

Label: Dimension Segment Values by ID

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL 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 DimensionSegmentValuesById. 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

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

☐

 

This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd HH:mm:ss```* ```yyyy-MM-dd HH:mm:ss.FFF```* ```yyyy-MM-ddTHH:mm:ss```* ```yyyy-MM-ddTHH:mm:ss.FFF```_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.

lastModifiedDateTimeCondition

string

☐

 

This value represents the condition to be applied when retrieving records.Accepted values (without the single quotes):* '>' for greater than* '<' for less than* '>=' for greater than or equal* '<=' for less than or equal_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.

orderBy

string

☐

 

This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.

 

Columns of Table Function

The columns of the table function DimensionSegmentValuesById 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 value is active.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

consolNumChar

int32

{res:itgen_vnet_consolnumchar}

☐

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

{res:itgen_vnet_consolorder}

☐

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_2

string

Description 2

☐

Mandatory field: Description > The user-defined segment description.

description_3

string

{res:itgen_vnet_description_3}

☐

Mandatory field: The top part > Description* > A detailed description of the segmented key.

description

string

Description

☐

The table > 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

internalId_2

guid

{res:itgen_vnet_internalid_2}

☐

Unique identifier for the segment.

internalId

guid

Internal ID

☐

Unique identifier for the segment value

isAutoNumber

boolean

{res:itgen_vnet_isautonumber}

☐

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_2

datetime

{res:itgen_vnet_lastmodified_2}

☐

System generated information.

lastModified

datetime

Last Modified

☐

 

length_2

int32

{res:itgen_vnet_length_2}

☐

The top part > Length > The total length of the key.

length

int32

Length

☐

Length > The maximum length of the segment.

mappedSegValue

string

{res:itgen_vnet_mappedsegvalue}

☐

 

publicId_2

guid

{res:itgen_vnet_publicid_2}

☐

 

publicId

guid

Public ID

☐

 

segmentId_2

int32

{res:itgen_vnet_segmentid_2}

☐

Segment ID > The system-generated number representing the order of the segment in the segmented key.

segmentId

int32

Segment ID

☐

The top part > Segment ID > The system-generated number representing the order of the segment in the segmented key.

timeStamp_2

string

{res:itgen_vnet_timestamp_2}

☐

 

timeStamp

string

Timestamp

☐

 

validate

boolean

{res:itgen_vnet_validate}

☐

Validate > A check box that indicates (if selected) that validation of segment values is turned on.

valueId

string

Value ID

☐

The table > Value > The string that is the value of the selected segment.

 

23-06-2025 19:16 Version 24.1.116-BETA+5455

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer