Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ChartOfAccounts" of service "API_CHARTOFACCOUNTS_SRV". This service is part of the following communication scenarios: SAP Business Objects Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_CHARTOFACCOUNTS_SRV for more information.

Hierarchy

  • Entity
    • ChartOfAccounts

Implements

Index

Constructors

constructor

  • Returns ChartOfAccounts

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

chartOfAccounts

chartOfAccounts: string

Chart of Accounts. Maximum length: 4.

Optional chartOfAcctsIsBlocked

chartOfAcctsIsBlocked: boolean

Indicator: Is the Chart of Accounts Blocked ?. Indicator which blocks the chart of accounts from being released i.e. no G/L accounts can be created for this chart of accounts in the company codes. This is only advisable if charts of accounts are created centrally and accounts are created locally. If this is the case, then the block prevents accounts from being created in the company codes for a chart of accounts that is not yet completed.

nullable

Optional corporateGroupChartOfAccounts

corporateGroupChartOfAccounts: string

Group Chart of Accts. Chart of accounts which is used in the corporate group. You can enter a group account number as additional information in the G/L accounts of the chart of accounts you are using. The system checks whether the group account number exists in the corporate chart of accounts.If the structure of the chart of accounts is predetermined by national legal requirements, you can define a corporate chart of accounts. All accounts receive a group account number which is the same for all accounts of that particular type in various different charts of accounts.For consolidation purposes, you can define the balance sheet and P+L by using group account numbers, i.e. they do not need to be defined differently per country. Maximum length: 4.

nullable

Optional maintenanceLanguage

maintenanceLanguage: string

Maintenance Language for the Chart of Accounts. Language in which the chart of accounts is created. All accounts have a description in this language. Master data can only be displayed or maintained in this language.If you carry out functions with the account, the account name can be displayed both in the maintenance language and in the available alternative languages. Maximum length: 2.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

toText

One-to-many navigation property to the ChartOfAccountsText entity.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Static ALL_FIELDS

ALL_FIELDS: AllFields<ChartOfAccounts> = new AllFields('*', ChartOfAccounts)

All fields selector.

Static CHART_OF_ACCOUNTS

CHART_OF_ACCOUNTS: StringField<ChartOfAccounts> = new StringField('ChartOfAccounts', ChartOfAccounts, 'Edm.String')

Static representation of the chartOfAccounts property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CHART_OF_ACCTS_IS_BLOCKED

CHART_OF_ACCTS_IS_BLOCKED: BooleanField<ChartOfAccounts> = new BooleanField('ChartOfAcctsIsBlocked', ChartOfAccounts, 'Edm.Boolean')

Static representation of the chartOfAcctsIsBlocked property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CORPORATE_GROUP_CHART_OF_ACCOUNTS

CORPORATE_GROUP_CHART_OF_ACCOUNTS: StringField<ChartOfAccounts> = new StringField('CorporateGroupChartOfAccounts', ChartOfAccounts, 'Edm.String')

Static representation of the corporateGroupChartOfAccounts property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MAINTENANCE_LANGUAGE

MAINTENANCE_LANGUAGE: StringField<ChartOfAccounts> = new StringField('MaintenanceLanguage', ChartOfAccounts, 'Edm.String')

Static representation of the maintenanceLanguage property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_TEXT

TO_TEXT: Link<ChartOfAccounts, ChartOfAccountsText> = new Link('to_Text', ChartOfAccounts, ChartOfAccountsText)

Static representation of the one-to-many navigation property toText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<ChartOfAccounts> | BooleanField<ChartOfAccounts> | Link<ChartOfAccounts, ChartOfAccountsText>> = [ChartOfAccounts.CHART_OF_ACCOUNTS,ChartOfAccounts.CORPORATE_GROUP_CHART_OF_ACCOUNTS,ChartOfAccounts.CHART_OF_ACCTS_IS_BLOCKED,ChartOfAccounts.MAINTENANCE_LANGUAGE,ChartOfAccounts.TO_TEXT]

All fields of the ChartOfAccounts entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_CHARTOFACCOUNTS_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_ChartOfAccounts"

Technical entity name for ChartOfAccounts.

Static _keyFields

_keyFields: Array<Selectable<ChartOfAccounts>> = [ChartOfAccounts.CHART_OF_ACCOUNTS]

All key fields of the ChartOfAccounts entity.

Static _keys

_keys: object = ChartOfAccounts._keyFields.reduce((acc: { [keys: string]: Selectable<ChartOfAccounts> }, field: Selectable<ChartOfAccounts>) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property ChartOfAccounts.

Type declaration

Static _serviceName

_serviceName: string = "API_CHARTOFACCOUNTS_SRV"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for ChartOfAccounts.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

  • Returns an entity builder to construct instances ChartOfAccounts.

    Returns EntityBuilderType<ChartOfAccounts, ChartOfAccountsType>

    A builder that constructs instances of entity type ChartOfAccounts.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ChartOfAccounts.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ChartOfAccounts>

    A builder that constructs instances of entity type ChartOfAccounts.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the ChartOfAccounts entity type.

    Returns ChartOfAccountsRequestBuilder

    A ChartOfAccounts request builder.