Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BankDetail" of service "API_BANKDETAIL_SRV". This service is part of the following communication scenarios: Finance - Bank Integration (SAP_COM_0127). See https://api.sap.com/api/API_BANKDETAIL_SRV for more information.

Hierarchy

  • Entity
    • BankDetail

Implements

Index

Constructors

constructor

  • Returns BankDetail

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

bankCountry

bankCountry: string

Bank country key. Identifies the country in which the bank is located. The country key defines the rules according to which bank data, such as the bank and account numbers, is to be validated. Maximum length: 3.

Optional bankGroup

bankGroup: string

Bank group (bank network). Serves to classify banks in such a way that payment transactions within a group are processed as quickly as possible (bank chain optimization). For automatic payment transactions, if possible, a combination of the business partner's bank details and your own bank details is selected in which both banks involved belong to the same group. Maximum length: 2.

nullable

bankInternalId

bankInternalId: string

Bank Keys. In this field, you specify the bank key under which bank data from the respective country is stored. When you define the country key, you also specify the country-specific definition of the bank key.Normally, you manage banks using their bank number. The bank number in the control data for the bank is then displayed twice, that is, as the bank key too.In certain countries, the bank account number takes on this function; then there are no bank numbers and the bank data is managed using the account number.For data medium exchange, you may find it useful to be able to enter foreign business partners without a bank number, even if there are bank numbers in the country in question. In this case, the bank key can be assigned internally.To manage bank data using another key, for example, the SWIFT code, external number assignment can also be used. Maximum length: 15.

Optional bankName

bankName: string

Name of Bank. The name under which the bank operates. Maximum length: 60.

nullable

Optional bankNumber

bankNumber: string

Bank number. This field contains the bank number or the bank code. Maximum length: 15.

nullable

Optional branch

branch: string

Bank Branch. This field contains the branch name of the financial institution. Maximum length: 40.

nullable

Optional cityName

cityName: string

City. Name of the city as a part of the address. Maximum length: 35.

nullable

Optional region

region: string

Region (State, Province, County). In some countries, the region forms part of the address. The meaning depends on the country. The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State. Maximum length: 3.

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 streetName

streetName: string

Street and House Number. Street and house number as part of the address. Maximum length: 35.

nullable

Optional swiftCode

swiftCode: string

SWIFT/BIC for International Payments. Uniquely identifies a bank throughout the world. SWIFT stands for Society for Worldwide Interbank Financial Telecommunication.BIC stands for Bank Identifier Code.This globally unique code can be used in international payment transactions to identify the bank without the need to specify an address or bank number. Specification of the SWIFT code/BIC is mainly relevant for automatic payment transactions. Maximum length: 11.

nullable

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<BankDetail> = new AllFields('*', BankDetail)

All fields selector.

Static BANK_COUNTRY

BANK_COUNTRY: StringField<BankDetail> = new StringField('BankCountry', BankDetail, 'Edm.String')

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

Static BANK_GROUP

BANK_GROUP: StringField<BankDetail> = new StringField('BankGroup', BankDetail, 'Edm.String')

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

Static BANK_INTERNAL_ID

BANK_INTERNAL_ID: StringField<BankDetail> = new StringField('BankInternalID', BankDetail, 'Edm.String')

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

Static BANK_NAME

BANK_NAME: StringField<BankDetail> = new StringField('BankName', BankDetail, 'Edm.String')

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

Static BANK_NUMBER

BANK_NUMBER: StringField<BankDetail> = new StringField('BankNumber', BankDetail, 'Edm.String')

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

Static BRANCH

BRANCH: StringField<BankDetail> = new StringField('Branch', BankDetail, 'Edm.String')

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

Static CITY_NAME

CITY_NAME: StringField<BankDetail> = new StringField('CityName', BankDetail, 'Edm.String')

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

Static REGION

REGION: StringField<BankDetail> = new StringField('Region', BankDetail, 'Edm.String')

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

Static STREET_NAME

STREET_NAME: StringField<BankDetail> = new StringField('StreetName', BankDetail, 'Edm.String')

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

Static SWIFT_CODE

SWIFT_CODE: StringField<BankDetail> = new StringField('SWIFTCode', BankDetail, 'Edm.String')

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

Static _allFields

_allFields: Array<StringField<BankDetail>> = [BankDetail.BANK_COUNTRY,BankDetail.BANK_INTERNAL_ID,BankDetail.BANK_NAME,BankDetail.SWIFT_CODE,BankDetail.BANK_GROUP,BankDetail.BANK_NUMBER,BankDetail.REGION,BankDetail.STREET_NAME,BankDetail.CITY_NAME,BankDetail.BRANCH]

All fields of the BankDetail entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BankDetail"

Technical entity name for BankDetail.

Static _keyFields

_keyFields: Array<Selectable<BankDetail>> = [BankDetail.BANK_COUNTRY, BankDetail.BANK_INTERNAL_ID]

All key fields of the BankDetail entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BANKDETAIL_SRV"
deprecated

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

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

    Returns EntityBuilderType<BankDetail, BankDetailType>

    A builder that constructs instances of entity type BankDetail.

Static customField

  • customField(fieldName: string): CustomField<BankDetail>
  • Returns a selectable object that allows the selection of custom field in a get request for the entity BankDetail.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BankDetail>

    A builder that constructs instances of entity type BankDetail.

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

    Returns BankDetailRequestBuilder

    A BankDetail request builder.