Core Objects
  • 4 Minutes to read
  • Dark
    Light
  • PDF

Core Objects

  • Dark
    Light
  • PDF

Article summary

Segment1

Segment1 represents the data values of a financial account type segment. The following table provides a list of properties for the Segment1 object.

Property Name

Property Description

Memberid

String IDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

AccountGroup

AccountGroup enumeration member

AccountType

AccountType enumeration member

CreditDebit

CreditDebit enumeration member

NormalDataInput

NormalDataInput enumeration member

CurrencyType

CurrencyType class instance

Variance

Variance enumeration member

ActiveStatus

ActiveStatus enumeration

Attributes

Collection of Attribute type that represents the user defined attributes for segment1 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

Segment2

Segment2 represents data values for a company type segment. The following table provides a list of properties for the segment2 object.

Property Name

Property Description

Memberid

String IDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

Currency

Currency class instance

ActiveStatus

ActiveStatus enumeration

Attributes

Collection of Attribute type that represents the user-defined attributes for segment2 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

Segment3

Segment3 represents data values for sub-account or ICSegment segment type. The following table provides a list of properties for the segment3 object.

Property Name

Property Description

Memberid

StringIDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

ActiveStatus

ActiveStatus enumeration member

Attributes

Collection of Attribute type that represents the user defined attributes for segment4 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

Segment4

Segment4 represents data values for department or any other segment type. The following table provides a list of properties for the segment4 object.

Property Name

Property Description

Memberid

String IDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

ActiveStatus

ActiveStatus enumeration member

Attributes

Collection of Attribute type that represents the user defined attributes for segment4 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

Segment5

Segment5 represents data values for department or any other segment type. The following table provides a list of properties for the segment5 object.

Property Name

Property Description

Memberid

String IDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

ActiveStatus

ActiveStatus enumeration member

Attributes

Collection of Attribute type that represents the user defined attributes for segment5 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

Segment6

Segment6 represents data values for department or any other segment type. The following table provides a list of properties for the segment6 object.

Property Name

Property Description

Memberid

String IDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

ActiveStatus

ActiveStatus enumeration member

Attributes

Collection of Attribute type that represents the user defined attributes for segment6 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

Segment7

Segment7 represents data values for department or any other segment type. The following table provides a list of properties for the segment7 object.

Property Name

Property Description

Memberid

String IDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

ActiveStatus

ActiveStatus enumeration member

Attributes

Collection of Attribute type that represents the user defined attributes for segment7 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

Segment8

Segment8 represents data values for department or any other segment type. The following table provides a list of properties for the segment8 object.

Property Name

Property Description

Memberid

String IDX - segment index

Code

String

Name

String

ParentCode

String

Member Type

MemberType enumeration member

RollupOperator

RollupOperator class instance

ActiveStatus

ActiveStatus enumeration member

Attributes

Collection of Attribute type that represents the user defined attributes for segment8 members.

Sort

Integer

RollupLevels

Collection of RollupLevel type, which represents the rollup levels for the segment members.

GLData

GLData represents data values for budget / forecast / actual data for a fiscal period. The following table provides a list of properties for the GLData object.

Property Name

Property Description

Scenario

Scenario code

FiscalYear

Fiscal Year

FiscalPeriod

Fiscal period

Segment1

Segment1 code

Segment2

Segment2 code

Segment3

Segment3 code

Segment4

Segment4 code

Segment5

Segment5 code

Segment6

Segment6 code

Segment7

Segment7 code

Segment8

Segment8 code

Reporting

Reporting code

Calculated

Calculated code

AmountType

AmountType enumeration number

Amount

Amount

The GLData object is designed to support 8 segments of GL information. Non-applicable segments can be left as null during the instantiation of the GLData object.

Dimension Security

Property Name

Property Description

FirstName

String

LastName

String

UserLogin

A valid email ID (the API will check to see if the user is already mapped in the application)

NavigationRole

Existing reporting role

ReportingRole

Existing reporting role

SupportRole

Existing support role type (the API validates if the number of administrators are within the allowed limit

AuthenticationType

String

Status

In Boolean format (“false” for Inactive, “true” for Active)

LoginName

The credentials of the user are used to authenticate the API connection

Password

The credentials of the user are used to authenticate the API connection

TenantCode

The credentials of the user are used to authenticate the API connection

Memberid

StringIDX - segment index

Attribute

Attribute contains the details of user-defined attributes in the segments. The following table provides a list of properties for the Attribute object.

Property Name

Property Description

C

Name of the attribute.

Value

Value of the attribute.

RollupLevel

RollupLevel contains the details of rollup levels for segment members. The following table provides a list of properties for the RollupLevel object.

Property Name

Property Description

Code

Name of the rollup level.

Name

Value of the rollup level.

Level

Level value for the rollup level.

Segment1Filter

Segment1Filter contains the details of filter criteria for filtering the data rows during the segment1 retrieval. The following table provides a list of properties for the Segment1Filter object.

Property Name

Property Description

Field

Segment1Field enumeration member

FieldOperation

FieldOperator enumeration member

Value

Collection of string data that is to be filtered with the Field and FieldOperator criteria.

Segment2Filter

Segment2Filter contains the details of filter criteria for filtering the data rows during the segment2 retrieval. The following table provides a list of properties for the Segment1Filter object.

Property Name

Property Description

Field

Segment2Field enumeration member

FieldOperation

FieldOperator enumeration member

Value

Collection of string data that is to be filtered with the Field and FieldOperator criteria.

SegmentFilter

SegmentFilter contains the details of filter criteria for filtering the data rows during the data retrieval of segments other than segment1 and segment2. The following table provides a list of properties for the SegmentFilter object.

Property Name

Property Description

Field

SegmentFilter enumeration member

FieldOperator

FieldOperator enumeration member

Value

Collection of string data that is to be filtered with the Field and FieldOperator criteria.


Was this article helpful?

What's Next