Options
All
  • Public
  • Public/Protected
  • All
Menu

Business Partner Identification

Hierarchy

  • Entity
    • BuPaIdentification

Implements

Index

Properties

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

authorizationGroup

authorizationGroup: string

Authorization Group. You can use authorization groups to stipulate which business partners a user is allowed to process. Use the following authorization object:'Business partners: authorization groups' (B_BUPA_GRP).The system only checks this authorization if you made an entry in the "Authorization group" field for the business partner. Otherwise, any user may process the business partner. Maximum length: 4.

nullable

bpIdentificationEntryDate

bpIdentificationEntryDate: Moment

Date of Entry for ID Number. Date on which the ID number was registered or assigned by the appropriate authority.

nullable

bpIdentificationNumber

bpIdentificationNumber: string

Identification Number. Number that serves to identify a business partner, such as driver's license, or ID card number. Maximum length: 60.

bpIdentificationType

bpIdentificationType: string

Identification Type. A document (such as an ID card or driver's license) or an entry in a system of records (such as a commercial register) whose key can be stored as an attribute for a business partner. The identification type is for classifying identification numbers.You can define the identification types and their descriptions in Customizing.You can also specify for which business partner category an ID type should be valid.If necessary, assign the identification type to an Identification Category.You can only assign one identification type to an identification category. Maximum length: 6.

bpIdnNmbrIssuingInstitute

bpIdnNmbrIssuingInstitute: string

Responsible Institution for ID Number. Institution that adminsters or assigns an ID number. Maximum length: 40.

nullable

businessPartner

businessPartner: string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.

country

country: string

Country in Which ID Number is Valid or Was Assigned. Country in which an ID number was assigned, or in which the number is valid. Maximum length: 3.

nullable

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

validityEndDate

validityEndDate: Moment

Validity End for ID Number. This date marks the end of validity of an ID number.

nullable

validityStartDate

validityStartDate: Moment

Validity Start for ID Number. This date marks the start of validity of an ID number.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<BuPaIdentification> = new StringField('AuthorizationGroup', BuPaIdentification, 'Edm.String')

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

Static BP_IDENTIFICATION_ENTRY_DATE

BP_IDENTIFICATION_ENTRY_DATE: DateField<BuPaIdentification> = new DateField('BPIdentificationEntryDate', BuPaIdentification, 'Edm.DateTime')

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

Static BP_IDENTIFICATION_NUMBER

BP_IDENTIFICATION_NUMBER: StringField<BuPaIdentification> = new StringField('BPIdentificationNumber', BuPaIdentification, 'Edm.String')

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

Static BP_IDENTIFICATION_TYPE

BP_IDENTIFICATION_TYPE: StringField<BuPaIdentification> = new StringField('BPIdentificationType', BuPaIdentification, 'Edm.String')

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

Static BP_IDN_NMBR_ISSUING_INSTITUTE

BP_IDN_NMBR_ISSUING_INSTITUTE: StringField<BuPaIdentification> = new StringField('BPIdnNmbrIssuingInstitute', BuPaIdentification, 'Edm.String')

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

Static BUSINESS_PARTNER

BUSINESS_PARTNER: StringField<BuPaIdentification> = new StringField('BusinessPartner', BuPaIdentification, 'Edm.String')

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

Static COUNTRY

COUNTRY: StringField<BuPaIdentification> = new StringField('Country', BuPaIdentification, 'Edm.String')

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

Static REGION

REGION: StringField<BuPaIdentification> = new StringField('Region', BuPaIdentification, '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 VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<BuPaIdentification> = new DateField('ValidityEndDate', BuPaIdentification, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<BuPaIdentification> = new DateField('ValidityStartDate', BuPaIdentification, 'Edm.DateTime')

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

Static _allFields

_allFields: (StringField<BuPaIdentification> | DateField<BuPaIdentification>)[] = [BuPaIdentification.BUSINESS_PARTNER,BuPaIdentification.BP_IDENTIFICATION_TYPE,BuPaIdentification.BP_IDENTIFICATION_NUMBER,BuPaIdentification.BP_IDN_NMBR_ISSUING_INSTITUTE,BuPaIdentification.BP_IDENTIFICATION_ENTRY_DATE,BuPaIdentification.COUNTRY,BuPaIdentification.REGION,BuPaIdentification.VALIDITY_START_DATE,BuPaIdentification.VALIDITY_END_DATE,BuPaIdentification.AUTHORIZATION_GROUP]

All fields of the BuPaIdentification entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BuPaIdentification"

Technical entity name for BuPaIdentification.

Static _keyFields

_keyFields: Array<Selectable<BuPaIdentification>> = [BuPaIdentification.BUSINESS_PARTNER, BuPaIdentification.BP_IDENTIFICATION_TYPE, BuPaIdentification.BP_IDENTIFICATION_NUMBER]

All key fields of the BuPaIdentification entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"

Technical service name for BuPaIdentification.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): this
  • Returns this

getUpdatedProperties

  • getUpdatedProperties(): this
  • Returns all changed properties compared to the last known remote state.

    Returns this

    Entity with all properties that changed

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.

    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

Static builder

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

    Returns BuPaIdentificationRequestBuilder

    A BuPaIdentification request builder.