Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_GLAccountInChartOfAccounts" of service "API_GLACCOUNTINCHARTOFACCOUNTS_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_GLACCOUNTINCHARTOFACCOUNTS_SRV for more information.

Hierarchy

  • Entity
    • GlAccountInChartOfAccounts

Implements

Index

Constructors

constructor

  • Returns GlAccountInChartOfAccounts

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 "*".

Optional accountIsBlockedForCreation

accountIsBlockedForCreation: boolean

Indicator: Account Is Blocked for Creation ?. An entry in this field causes the account to be blocked for creation in the specified company code.

nullable

Optional accountIsBlockedForPlanning

accountIsBlockedForPlanning: boolean

Indicator: Account Blocked for Planning ?. An entry in this field causes the account to be blocked for planning.

nullable

Optional accountIsBlockedForPosting

accountIsBlockedForPosting: boolean

Indicator: Is Account Blocked for Posting?. An entry in this field means that the account is blocked for zum posting.

nullable

Optional accountIsMarkedForDeletion

accountIsMarkedForDeletion: boolean

Indicator: Account Marked for Deletion?. Indicator which specifies that master record data is to be deleted. The deletion must be carried out using the program for archiving G/L account master data. This program archives the master records that have been marked for deletion, providing there is no dependent data remaining in the system.The program for deleting master records also takes account of those master records marked for deletion. However, you should only use this program to delete test data before you go live with the system.

nullable

chartOfAccounts

chartOfAccounts: string

Chart of Accounts. Key that uniquely identifies a chart of accounts. Maximum length: 4.

Optional corporateGroupAccount

corporateGroupAccount: string

Group Account Number. When you define the balance sheet and P+L structures, then accounts are assigned to line items within the balance sheet and P+L. This assignment is made either via the G/L account number or alternatively via the group account number given in this field. The usage of the group account number offers the advantage that by specifying a number, a group of accounts can be assigned immediately to the balance sheet or P+L item.If a balance sheet or P+L structure is to be defined which is to be used for several company codes with different charts of accounts, the problems which are created as a result can be avoided by using the group account number so that:accounts with the same meaning have different account numbersaccounts with the same account number have different meanings and, if necessary, are to be assigned to different line items in the balance sheet or P+L. Maximum length: 10.

nullable

Optional createdByUser

createdByUser: string

Name of Person who Created the Object. Name with which the user who entered the master record was logged on in the R/3 System. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date on which the Record Was Created. Date on which the master record, or the part of the master record being viewed, was created.

nullable

Optional functionalArea

functionalArea: string

Functional Area. Structure criterion for an enterprise or government based on functional aspects. Use for Cost-of-Sales AccountingThe functional area is required to create a profit and loss account in Financial Accounting using cost-of-sales accounting. The following are examples of structure criteria:ManufacturingAdministrationSalesResearch and developmentUse for GovernmentThe functional area is needed for Funds Management to meet legal requirements for reporting with functional aspects. You can use the functional area to represent the global targets and goals (such as public safety or city development), in particular the expenses of your organization.Use in cost-of-sales accountingSee the documentation on Filling the Functional Area Field.For comprehensive information on cost-of-sales accounting and on the functional area, see the SAP Library under Accounting -> Financial Accounting -> General Ledger -> Cost-of-Sales Accounting.Use in governmentFor more information on the functional area, see the implementation Guide for Funds Management Government in the section Activate Account Assignment Elements. Maximum length: 16.

nullable

glAccount

glAccount: string

G/L Account Number. The G/L account number identifies the G/L account in a chart of accounts. Maximum length: 10.

Optional glAccountExternal

glAccountExternal: string

G/L Account Number, Significant Length. The number of the G/L account clearly identifies the G/L account in a chart of accounts. Maximum length: 10.

nullable

Optional glAccountGroup

glAccountGroup: string

G/L Account Group. The account group is a classifying feature within the G/L account master records. The account is a required entry. The account group determines the fields for the entry screens if you create or change a master record in the company code. The account group also determines in which number range the account number must be contained. Maximum length: 4.

nullable

Optional glAccountType

glAccountType: string

Type of a General Ledger Account. Specifies the general ledger account type that classifies the general ledger account. The general ledger account type determines how the general ledger account can be used in financial accounting (FI) and controlling (CO).The following values are possible:X - Balance Sheet AccountBalance sheet accountN - Nonoperating Expense or IncomeProfit and loss account that is used in FI onlyP - Primary Costs or RevenueProfit and loss account that is used in FI and COS - Secondary CostsProfit and loss account that is used in CO only. Maximum length: 1.

nullable

Optional isBalanceSheetAccount

isBalanceSheetAccount: boolean

Indicator: Account is a balance sheet account?. Indicates that the G/L account is managed as a balance sheet account. You must enter all balance sheet accounts in this field. If you determine that you erroneously defined a G/L account as a balance sheet account instead of a profit and loss account for the previous fiscal year, the G/L account master will have to be changed. You then have to rerun the SAPF011 program so that the balance carried forward for the G/L accounts is correct.

nullable

Optional isProfitLossAccount

isProfitLossAccount: boolean

Indicator: Account is a balance sheet account?. Indicates that the G/L account is managed as a balance sheet account. You must enter all balance sheet accounts in this field. If you determine that you erroneously defined a G/L account as a balance sheet account instead of a profit and loss account for the previous fiscal year, the G/L account master will have to be changed. You then have to rerun the SAPF011 program so that the balance carried forward for the G/L accounts is correct.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

UTC Time Stamp in Short Form (YYYYMMDDhhmmss). The UTC timestamp is the date and time relative to the UTC (Universal coordinated time). To normalize local times in a UTC time stamp and make them comparable, they must be converted using their time zone and the ABAP command convert.Although the time zone for the conversion can be fetched from customizing or master data, you should save it redundantly.The internal structure of the UTC time stamp is logically divided into a date and time part in packed number format <YYYYMMDDhhmmss>. There is also a high resolution UTC time stamp (10^-7 seconds).

nullable

Optional partnerCompany

partnerCompany: string

Partner Company ID. Company ID standard for the whole group. Maximum length: 6.

nullable

Optional profitLossAccountType

profitLossAccountType: string

P&L statement account type. With the P&L statement account type, you determine the retained earnings account for each P&L account. The retained earnings account is used during year-end closing to calculate the company's result. If you are creating a P&L account, you must make an entry here.If you determine during a fiscal year that you mistakenly designated a G/L account as a P&L account instead of a balance sheet account, you will need to change its master record. You will then have to rerun program SAPF011 to correct the balances of the G/L accounts carried forward. 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

Optional sampleGlAccount

sampleGlAccount: string

Number of the Sample Account. The number of the sample account uniquely identifies the sample account in the SAP system. The sample account contains data which will be transferred when you have created a master record in the company code. Using the sample accounts is optional. Data transfer rules determine how data will be transferred from the sample account. Maximum length: 10.

nullable

toText

toText: GlAccountText[]

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ACCOUNT_IS_BLOCKED_FOR_CREATION

ACCOUNT_IS_BLOCKED_FOR_CREATION: BooleanField<GlAccountInChartOfAccounts> = new BooleanField('AccountIsBlockedForCreation', GlAccountInChartOfAccounts, 'Edm.Boolean')

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

Static ACCOUNT_IS_BLOCKED_FOR_PLANNING

ACCOUNT_IS_BLOCKED_FOR_PLANNING: BooleanField<GlAccountInChartOfAccounts> = new BooleanField('AccountIsBlockedForPlanning', GlAccountInChartOfAccounts, 'Edm.Boolean')

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

Static ACCOUNT_IS_BLOCKED_FOR_POSTING

ACCOUNT_IS_BLOCKED_FOR_POSTING: BooleanField<GlAccountInChartOfAccounts> = new BooleanField('AccountIsBlockedForPosting', GlAccountInChartOfAccounts, 'Edm.Boolean')

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

Static ACCOUNT_IS_MARKED_FOR_DELETION

ACCOUNT_IS_MARKED_FOR_DELETION: BooleanField<GlAccountInChartOfAccounts> = new BooleanField('AccountIsMarkedForDeletion', GlAccountInChartOfAccounts, 'Edm.Boolean')

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

Static ALL_FIELDS

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

All fields selector.

Static CHART_OF_ACCOUNTS

CHART_OF_ACCOUNTS: StringField<GlAccountInChartOfAccounts> = new StringField('ChartOfAccounts', GlAccountInChartOfAccounts, '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 CORPORATE_GROUP_ACCOUNT

CORPORATE_GROUP_ACCOUNT: StringField<GlAccountInChartOfAccounts> = new StringField('CorporateGroupAccount', GlAccountInChartOfAccounts, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<GlAccountInChartOfAccounts> = new StringField('CreatedByUser', GlAccountInChartOfAccounts, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<GlAccountInChartOfAccounts> = new DateField('CreationDate', GlAccountInChartOfAccounts, 'Edm.DateTime')

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

Static FUNCTIONAL_AREA

FUNCTIONAL_AREA: StringField<GlAccountInChartOfAccounts> = new StringField('FunctionalArea', GlAccountInChartOfAccounts, 'Edm.String')

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

Static GL_ACCOUNT

GL_ACCOUNT: StringField<GlAccountInChartOfAccounts> = new StringField('GLAccount', GlAccountInChartOfAccounts, 'Edm.String')

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

Static GL_ACCOUNT_EXTERNAL

GL_ACCOUNT_EXTERNAL: StringField<GlAccountInChartOfAccounts> = new StringField('GLAccountExternal', GlAccountInChartOfAccounts, 'Edm.String')

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

Static GL_ACCOUNT_GROUP

GL_ACCOUNT_GROUP: StringField<GlAccountInChartOfAccounts> = new StringField('GLAccountGroup', GlAccountInChartOfAccounts, 'Edm.String')

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

Static GL_ACCOUNT_TYPE

GL_ACCOUNT_TYPE: StringField<GlAccountInChartOfAccounts> = new StringField('GLAccountType', GlAccountInChartOfAccounts, 'Edm.String')

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

Static IS_BALANCE_SHEET_ACCOUNT

IS_BALANCE_SHEET_ACCOUNT: BooleanField<GlAccountInChartOfAccounts> = new BooleanField('IsBalanceSheetAccount', GlAccountInChartOfAccounts, 'Edm.Boolean')

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

Static IS_PROFIT_LOSS_ACCOUNT

IS_PROFIT_LOSS_ACCOUNT: BooleanField<GlAccountInChartOfAccounts> = new BooleanField('IsProfitLossAccount', GlAccountInChartOfAccounts, 'Edm.Boolean')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<GlAccountInChartOfAccounts> = new DateField('LastChangeDateTime', GlAccountInChartOfAccounts, 'Edm.DateTimeOffset')

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

Static PARTNER_COMPANY

PARTNER_COMPANY: StringField<GlAccountInChartOfAccounts> = new StringField('PartnerCompany', GlAccountInChartOfAccounts, 'Edm.String')

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

Static PROFIT_LOSS_ACCOUNT_TYPE

PROFIT_LOSS_ACCOUNT_TYPE: StringField<GlAccountInChartOfAccounts> = new StringField('ProfitLossAccountType', GlAccountInChartOfAccounts, 'Edm.String')

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

Static SAMPLE_GL_ACCOUNT

SAMPLE_GL_ACCOUNT: StringField<GlAccountInChartOfAccounts> = new StringField('SampleGLAccount', GlAccountInChartOfAccounts, 'Edm.String')

Static representation of the sampleGlAccount 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<GlAccountInChartOfAccounts, GlAccountText> = new Link('to_Text', GlAccountInChartOfAccounts, GlAccountText)

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<GlAccountInChartOfAccounts> | BooleanField<GlAccountInChartOfAccounts> | DateField<GlAccountInChartOfAccounts> | Link<GlAccountInChartOfAccounts, GlAccountText>> = [GlAccountInChartOfAccounts.CHART_OF_ACCOUNTS,GlAccountInChartOfAccounts.GL_ACCOUNT,GlAccountInChartOfAccounts.IS_BALANCE_SHEET_ACCOUNT,GlAccountInChartOfAccounts.GL_ACCOUNT_GROUP,GlAccountInChartOfAccounts.CORPORATE_GROUP_ACCOUNT,GlAccountInChartOfAccounts.PROFIT_LOSS_ACCOUNT_TYPE,GlAccountInChartOfAccounts.SAMPLE_GL_ACCOUNT,GlAccountInChartOfAccounts.ACCOUNT_IS_MARKED_FOR_DELETION,GlAccountInChartOfAccounts.ACCOUNT_IS_BLOCKED_FOR_CREATION,GlAccountInChartOfAccounts.ACCOUNT_IS_BLOCKED_FOR_POSTING,GlAccountInChartOfAccounts.ACCOUNT_IS_BLOCKED_FOR_PLANNING,GlAccountInChartOfAccounts.PARTNER_COMPANY,GlAccountInChartOfAccounts.FUNCTIONAL_AREA,GlAccountInChartOfAccounts.CREATION_DATE,GlAccountInChartOfAccounts.CREATED_BY_USER,GlAccountInChartOfAccounts.LAST_CHANGE_DATE_TIME,GlAccountInChartOfAccounts.GL_ACCOUNT_TYPE,GlAccountInChartOfAccounts.GL_ACCOUNT_EXTERNAL,GlAccountInChartOfAccounts.IS_PROFIT_LOSS_ACCOUNT,GlAccountInChartOfAccounts.TO_TEXT]

All fields of the GlAccountInChartOfAccounts entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_GLAccountInChartOfAccounts"

Technical entity name for GlAccountInChartOfAccounts.

Static _keyFields

_keyFields: Array<Selectable<GlAccountInChartOfAccounts>> = [GlAccountInChartOfAccounts.CHART_OF_ACCOUNTS, GlAccountInChartOfAccounts.GL_ACCOUNT]

All key fields of the GlAccountInChartOfAccounts entity.

Static _keys

_keys: any = GlAccountInChartOfAccounts._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_GLACCOUNTINCHARTOFACCOUNTS_SRV"
deprecated

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

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

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<GlAccountInChartOfAccounts>

    A builder that constructs instances of entity type GlAccountInChartOfAccounts.

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>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns GlAccountInChartOfAccountsRequestBuilder

    A GlAccountInChartOfAccounts request builder.