Enumerations
  • 1 Minute to read
  • Dark
    Light
  • PDF

Enumerations

  • Dark
    Light
  • PDF

Article summary

Enumerations are a group of named constants. Enumerations are built for the Host API and used during data import / export operations. Use enumerations to restrict the possible values of the web method argument. For example, FieldOperator contains the list of filtering patterns supported by the Host API. The following table provides a list of enumerations built for the Host API:

Enumeration
Members

AccountGroup

Asset, Equity, Income, Liability, Statistical

AccountType

Balance, Flow

ActiveStatus

Active, Inactive

Amount Type

Opening Balance, MTD, QTD, YTD

CreditDebit

Credit, Debit

FieldOperator

Contains, EndsWith, Equals, Greater, GreaterEq, Less, LessEq, NotEquals, StartsWith

GLDataField

All, Scenario, Segment1, Segment2, Segment3, Segment4, Segment5, Segment6, Segment7, Segment8, Reporting, FiscalYear, FiscalPeriod

MemberType

ConsolMember, CalcMember,LeafMember

NormalDataInput

YTD, MTD

Segment1Field

All, Code, Name, MemberType, RollupOperator, ActiveStatus, AccountGroup, AccountType, CreditDebit, NormalDataInput, CurrencyType,Variance

Segment2Field

All, Code, Name, MemberType, RollupOperator, ActiveStatus, Currency

SegmentField

All, Code, Name, MemberType, RollupOperator, ActiveStatus

Variance

Positive, Negative

Visibility

Visible, NotVisible


Was this article helpful?