Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "ConsolidationDocumentType" of service "API_GRMASTERDATA_SRV". This service is part of the following communication scenarios: Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241), Finance - Cloud Consolidation Master Data for Group Reporting Integration (SAP_COM_0336). See https://api.sap.com/api/API_GRMASTERDATA_SRV for more information.

Hierarchy

  • Entity
    • ConsolidationDocumentType

Implements

Index

Constructors

constructor

  • Returns ConsolidationDocumentType

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 consolidationBalanceCheck

consolidationBalanceCheck: string

Balance check for consolidation document. This field determines the type of balance check to be used when posting to statistical items: Error message when balance not equal to zeroWarning message when balance not equal to zeroNo balance checkWhen at least one balance sheet or income statement item is posted, the system always displays an error message if the balance does not equal zero, regardless of the setting of this field. Maximum length: 1.

nullable

Optional consolidationBalanceCheckText

consolidationBalanceCheckText: string

Short Text for Fixed Values. This text appears when fixed values are displayed in the F4 help. It explains the possible input values. SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains. Maximum length: 60.

nullable

consolidationDocumentType

consolidationDocumentType: string

Document Type. Enter a document type. Maximum length: 2.

Optional consolidationDocumentTypeText

consolidationDocumentTypeText: string

Description. Enter a description of up to 30 characters in length. Maximum length: 30.

nullable

Optional consolidationPostgItemAutoFlag

consolidationPostgItemAutoFlag: boolean

Manual Posting. Set this indicator if you want to use the document type for manual posting only. This document type is thereby excluded from use in the automatic consolidation functions.If the indicator is not set, the document type can only be used for automatic posting, and not for manual posting.

nullable

Optional docHasCreditDeferredTax

docHasCreditDeferredTax: boolean

Credit deferred income taxes. Set this indicator if you want this document type to automatically credit deferred taxes during posting.

nullable

Optional docHasDebitDeferredTax

docHasDebitDeferredTax: boolean

Debit deferred income taxes. Set this indicator if you want this document type to automatically debit deferred taxes during posting.

nullable

Optional documentTypeBusinessAppl

documentTypeBusinessAppl: string

Business application. You use this field to classify document types according to their application in the consolidation component. This enables the system to check consolidation tasks by document type. Maximum length: 1.

nullable

Optional documentTypeBusinessApplText

documentTypeBusinessApplText: string

Short Text for Fixed Values. This text appears when fixed values are displayed in the F4 help. It explains the possible input values. SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains. Maximum length: 60.

nullable

Optional isDocumentPostInGroupCurrency

isDocumentPostInGroupCurrency: boolean

Post in group currency. Set this indicator to specify that the document type can post in group currency.

nullable

Optional isDocumentPostInLocalCurrency

isDocumentPostInLocalCurrency: boolean

Post in local currency. Set this indicator to specify that the document type can post in local currency.

nullable

Optional isDocumentPostInTransCurrency

isDocumentPostInTransCurrency: boolean

Post in transaction currency. Set this indicator to specify that the document type can post in transaction currency.

nullable

Optional postingLevel

postingLevel: string

Posting Level. Enter a posting level. 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

toCnsldtnDocumentTypeT

toCnsldtnDocumentTypeT: ConsolidationDocTypeText[]

One-to-many navigation property to the ConsolidationDocTypeText 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<ConsolidationDocumentType> = new AllFields('*', ConsolidationDocumentType)

All fields selector.

Static CONSOLIDATION_BALANCE_CHECK

CONSOLIDATION_BALANCE_CHECK: StringField<ConsolidationDocumentType> = new StringField('ConsolidationBalanceCheck', ConsolidationDocumentType, 'Edm.String')

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

Static CONSOLIDATION_BALANCE_CHECK_TEXT

CONSOLIDATION_BALANCE_CHECK_TEXT: StringField<ConsolidationDocumentType> = new StringField('ConsolidationBalanceCheck_Text', ConsolidationDocumentType, 'Edm.String')

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

Static CONSOLIDATION_DOCUMENT_TYPE

CONSOLIDATION_DOCUMENT_TYPE: StringField<ConsolidationDocumentType> = new StringField('ConsolidationDocumentType', ConsolidationDocumentType, 'Edm.String')

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

Static CONSOLIDATION_DOCUMENT_TYPE_TEXT

CONSOLIDATION_DOCUMENT_TYPE_TEXT: StringField<ConsolidationDocumentType> = new StringField('ConsolidationDocumentType_Text', ConsolidationDocumentType, 'Edm.String')

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

Static CONSOLIDATION_POSTG_ITEM_AUTO_FLAG

CONSOLIDATION_POSTG_ITEM_AUTO_FLAG: BooleanField<ConsolidationDocumentType> = new BooleanField('ConsolidationPostgItemAutoFlag', ConsolidationDocumentType, 'Edm.Boolean')

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

Static DOCUMENT_TYPE_BUSINESS_APPL

DOCUMENT_TYPE_BUSINESS_APPL: StringField<ConsolidationDocumentType> = new StringField('DocumentTypeBusinessAppl', ConsolidationDocumentType, 'Edm.String')

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

Static DOCUMENT_TYPE_BUSINESS_APPL_TEXT

DOCUMENT_TYPE_BUSINESS_APPL_TEXT: StringField<ConsolidationDocumentType> = new StringField('DocumentTypeBusinessAppl_Text', ConsolidationDocumentType, 'Edm.String')

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

Static DOC_HAS_CREDIT_DEFERRED_TAX

DOC_HAS_CREDIT_DEFERRED_TAX: BooleanField<ConsolidationDocumentType> = new BooleanField('DocHasCreditDeferredTax', ConsolidationDocumentType, 'Edm.Boolean')

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

Static DOC_HAS_DEBIT_DEFERRED_TAX

DOC_HAS_DEBIT_DEFERRED_TAX: BooleanField<ConsolidationDocumentType> = new BooleanField('DocHasDebitDeferredTax', ConsolidationDocumentType, 'Edm.Boolean')

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

Static IS_DOCUMENT_POST_IN_GROUP_CURRENCY

IS_DOCUMENT_POST_IN_GROUP_CURRENCY: BooleanField<ConsolidationDocumentType> = new BooleanField('IsDocumentPostInGroupCurrency', ConsolidationDocumentType, 'Edm.Boolean')

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

Static IS_DOCUMENT_POST_IN_LOCAL_CURRENCY

IS_DOCUMENT_POST_IN_LOCAL_CURRENCY: BooleanField<ConsolidationDocumentType> = new BooleanField('IsDocumentPostInLocalCurrency', ConsolidationDocumentType, 'Edm.Boolean')

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

Static IS_DOCUMENT_POST_IN_TRANS_CURRENCY

IS_DOCUMENT_POST_IN_TRANS_CURRENCY: BooleanField<ConsolidationDocumentType> = new BooleanField('IsDocumentPostInTransCurrency', ConsolidationDocumentType, 'Edm.Boolean')

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

Static POSTING_LEVEL

POSTING_LEVEL: StringField<ConsolidationDocumentType> = new StringField('PostingLevel', ConsolidationDocumentType, 'Edm.String')

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

Static TO_CNSLDTN_DOCUMENT_TYPE_T

TO_CNSLDTN_DOCUMENT_TYPE_T: Link<ConsolidationDocumentType, ConsolidationDocTypeText> = new Link('to_CnsldtnDocumentTypeT', ConsolidationDocumentType, ConsolidationDocTypeText)

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

Static _allFields

_allFields: Array<StringField<ConsolidationDocumentType> | BooleanField<ConsolidationDocumentType> | Link<ConsolidationDocumentType, ConsolidationDocTypeText>> = [ConsolidationDocumentType.CONSOLIDATION_DOCUMENT_TYPE,ConsolidationDocumentType.CONSOLIDATION_DOCUMENT_TYPE_TEXT,ConsolidationDocumentType.POSTING_LEVEL,ConsolidationDocumentType.CONSOLIDATION_BALANCE_CHECK,ConsolidationDocumentType.CONSOLIDATION_BALANCE_CHECK_TEXT,ConsolidationDocumentType.CONSOLIDATION_POSTG_ITEM_AUTO_FLAG,ConsolidationDocumentType.IS_DOCUMENT_POST_IN_TRANS_CURRENCY,ConsolidationDocumentType.IS_DOCUMENT_POST_IN_LOCAL_CURRENCY,ConsolidationDocumentType.IS_DOCUMENT_POST_IN_GROUP_CURRENCY,ConsolidationDocumentType.DOC_HAS_CREDIT_DEFERRED_TAX,ConsolidationDocumentType.DOC_HAS_DEBIT_DEFERRED_TAX,ConsolidationDocumentType.DOCUMENT_TYPE_BUSINESS_APPL,ConsolidationDocumentType.DOCUMENT_TYPE_BUSINESS_APPL_TEXT,ConsolidationDocumentType.TO_CNSLDTN_DOCUMENT_TYPE_T]

All fields of the ConsolidationDocumentType entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "ConsolidationDocumentType"

Technical entity name for ConsolidationDocumentType.

Static _keyFields

_keyFields: Array<Selectable<ConsolidationDocumentType>> = [ConsolidationDocumentType.CONSOLIDATION_DOCUMENT_TYPE]

All key fields of the ConsolidationDocumentType entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_GRMASTERDATA_SRV"
deprecated

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

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 ConsolidationDocumentType.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ConsolidationDocumentType>

    A builder that constructs instances of entity type ConsolidationDocumentType.

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 ConsolidationDocumentType entity type.

    Returns ConsolidationDocumentTypeRequestBuilder

    A ConsolidationDocumentType request builder.