Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BPContactToAddress" of service "API_BUSINESS_PARTNER". This service is part of the following communication scenarios: Business Partner, Customer and Supplier Integration (SAP_COM_0008). See https://api.sap.com/api/API_BUSINESS_PARTNER for more information.

Hierarchy

  • Entity
    • BpContactToAddress

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns BpContactToAddress

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 additionalStreetPrefixName

additionalStreetPrefixName: undefined | string

Street 3. Additional address field which is printed above the Street line. The Street address contains two lines above the street and two lines below the street.See Print the Street address. Maximum length: 40.

nullable

Optional additionalStreetSuffixName

additionalStreetSuffixName: undefined | string

Street 5. Additional address field which is printed under the Street line. The Street address has two lines above the street and two lines below the steet.See Print the Street address. Maximum length: 40.

nullable

addressId

addressId: string

Address number. Internal key for identifying a Business Address Services address. For more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation. Maximum length: 10.

Optional addressNumber

addressNumber: undefined | string

Address number. Internal key for identifying a Business Address Services address. For more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation. Maximum length: 10.

nullable

Optional addressTimeZone

addressTimeZone: undefined | string

Address time zone. Time zone as part of an address. The time zone is automatically determined by the system in address maintenance if time zone Customizing is maintained.It depends on the country and the region. (Region means state, province or county, depending on the country)The automatic determination is only made if there is no value in the time zone field. Maximum length: 6.

nullable

businessPartnerCompany

businessPartnerCompany: string

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

businessPartnerPerson

businessPartnerPerson: string

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

Optional careOfName

careOfName: undefined | string

c/o name. Part of the address (c/o = care of) if the recipient is different from the occupant and the names are not similar (e.g. subtenants). Put the country-specific code (e.g. c/o) in front of the name of the occupant. This is not automatically done in the print format, like the language-specific word "PO Box".John Smithc/o David BrownThis field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5. Maximum length: 40.

nullable

Optional cityCode

cityCode: undefined | string

City code for city/street file. Maximum length: 12.

nullable

Optional cityName

cityName: undefined | string

City. City name as part of the address. The city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure. Maximum length: 40.

nullable

Optional companyPostalCode

companyPostalCode: undefined | string

Company Postal Code (for Large Customers). Postal code that is assigned directly to one company (= company postal code = major customer postal code). This field is used for countries where major companies are assigned their own postal code by the national post office.This postal code has to be entered in the field "Company Postal Code". Postal codes for group major customers, however, have to be entered in the field "PO Box Postal Code", since individual customers with a shared postal code for group major customers are differentiated by means of their PO box. Maximum length: 10.

nullable

Optional country

country: undefined | string

Country Key. The country key contains information which the system uses to check entries such as the length of the postal code or bank account number. The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA. Maximum length: 3.

nullable

Optional county

county: undefined | string

County. Specifies the county’s name This field is used to store the county’s name. You can enter the name of the county in this field. Maximum length: 40.

nullable

Optional deliveryServiceNumber

deliveryServiceNumber: undefined | string

Number of Delivery Service. The delivery service is part of the PO box address. Some countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag. If an address is related to one of these delivery services, the information about this particular delivery service has to be entered in the corresponding fields.In the field "Number of Delivery Service," the number of the Private Bag, Response Bag, or other relevant service has to be entered. Entering a number is not mandatory for each delivery service.For each address, either the information about the PO box or the information about the delivery service can be entered, but not both types of information at the same time.Mr PickeringPrivate Bag 106999Timaru 7942Delivery services will only be taken into account for address formatting in countries in which they are commonly used in addition to regular postal delivery and PO boxes, for example, in Australia, New Zealand, and the USA. In all other countries, these fields will not be taken into account for address formatting. Maximum length: 10.

nullable

Optional deliveryServiceTypeCode

deliveryServiceTypeCode: undefined | string

Type of Delivery Service. The delivery service is part of the PO box address. Some countries offer different services in addition to regular postal delivery and PO boxes, for example the Private Bag or Response Bag. If an address is related to one of these delivery services, the information about this particular delivery service has to be entered in the corresponding fields.In the field "Type of Delivery Service," the type of the delivery service has to be entered.For each address, either the information about the PO box or the information about the delivery service can be entered, but not both types of information at the same time.Mr PickeringPrivate Bag 106999Timaru 7942Delivery services will only be taken into account for address formatting in countries in which they are commonly used in addition to regular postal delivery and PO boxes, for example, in Australia, New Zealand, and the USA. In all other countries, these fields will not be taken into account for address formatting. Maximum length: 4.

nullable

Optional district

district: undefined | string

District. City or District supplement In some countries, this entry is appended with a hyphen to the city name by the automatic address formatting, other countries, it is output on a line of its own or (e.g. in the USA) not printed.See the examples in the Address Layout Key documentation. Maximum length: 40.

nullable

Optional formOfAddress

formOfAddress: undefined | string

Form-of-Address Key. Key for form of address text. You can also define a form of address text in Customizing.The form of address text can be maintained in different languages. Maximum length: 4.

nullable

Optional fullName

fullName: undefined | string

Full name of a party (Bus. Partner, Org. Unit, Doc. address). This field contains the full name or formatted name of a party. For organizations or document addresses, typically the fields Name1 and Name2 are concatenated.For persons the field contains the formatted name according to country specific rules. It corresponds e.g. to the content of the fields BUT000-NAME1_TEXT or ADRP-NAME_TEXT. Maximum length: 80.

nullable

Optional homeCityName

homeCityName: undefined | string

City (different from postal city). City of residence which is different from the postal city In some countries, the residential city is required if it differs from the postal city.In the USA, the official street indexes, against which data can be checked, are based on the residential city, not the postal city, which may be different.It is the same in France, where a postally correct address must contain the residential city in a separate line above the postal city, if it differs from the postal city.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5. Maximum length: 40.

nullable

Optional houseNumber

houseNumber: undefined | string

House Number. House number as part of an address. It is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields. See Print the Street address.A house number (e.g. 117) or a house number with supplement (e.g. 117a), or a house number range (e.g. 16-20), can be maintained in this field. Maximum length: 10.

nullable

Optional houseNumberSupplementText

houseNumberSupplementText: undefined | string

House number supplement. House number supplement as part of an address, e.g. App. 17 orSuite 600.It is printed in the Street line.Further Street supplements can be put in one of the fields Street2, Street3, Street4 or Street5.See Print the Street address. Maximum length: 10.

nullable

Optional language

language: undefined | string

Language Key. The language key indicates

  • the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts. Maximum length: 2.
nullable

Optional person

person: undefined | string

Person number. Internal key for identifying a person in Business Address Services. For more information about the meaning and use of the person number and Business Address Services concepts, see the function group SZA0 documentation. Maximum length: 10.

nullable

Optional poBox

poBox: undefined | string

PO Box. PO Box number as part of an address. Only enter the PO Box number in this field. The text "PO Box" is provided in the recipient language by the system when you print the address.When you print an address, the "Street address" and the "PO Box address" are distinguished. The print program determines which of them has priority if both are maintained in an address record.Besides the PO Box number, the PO Box address uses the following fields:PO Box postal code, if specified (otherwise the normal postal code)PO Box city, if specified (otherwise the normal city)PO Box region, if specified (otherwise the normal region)PO Box country, if specified (otherwise the normal country)If the address is a "PO Box" (without a number), do not fill the "PO Box" field. Select the "PO Box w/o Number" indicator instead.You can also enter a company postal code for organizational addresses, instead of a PO Box. A separate field is predefined for this entry.For general information and examples about address formatting, see the documentation on the Address Structure Key. Maximum length: 10.

nullable

Optional poBoxDeviatingCityName

poBoxDeviatingCityName: undefined | string

PO Box city. Different city for the PO Box as an address component. The PO Box city can be entered here if it is different from the address city.If the address is only a PO Box address, enter the city in the normal city field.If the address contains two different city names for the address and the PO Box address, use this field. Maximum length: 40.

nullable

Optional poBoxDeviatingCountry

poBoxDeviatingCountry: undefined | string

PO box country. Different PO Box country in address. The PO Box country can be entered here, if it is different from the street address country.If the address only has a PO Box address, the country is in the normal country field.Use this field if the address has two different country values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5. Maximum length: 3.

nullable

Optional poBoxDeviatingRegion

poBoxDeviatingRegion: undefined | string

Region for PO Box (Country, State, Province, ...). Different Region for PO Box in an address. Enter the PO Box Region here, if it differs from the street address region.If the address only has a PO Box address, the Region in in the normal Region field.Use this field if the address has two different Region values for the street address and the PO Box address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5. Maximum length: 3.

nullable

Optional poBoxIsWithoutNumber

poBoxIsWithoutNumber: undefined | false | true

Flag: PO Box Without Number. PO Box address without PO Box number flag. Only the word 'PO Box' is output in PO Box addresses without PO Box number.Set this flag for a PO Box address without PO Box number.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5.

nullable

Optional poBoxLobbyName

poBoxLobbyName: undefined | string

PO Box Lobby. The PO box lobby is part of the PO box address. In some countries, entering a PO box, postal code and city is not sufficient to uniquely identify a PO box, because the same PO box number is assigned multiple times in some cities.Therefore, additional information might be required to determine the post office of the PO box in question. This information can be entered in the field "PO Box Lobby."Mr NellingPO Box 4099HighfieldTimaru 7942The PO box lobby will only be taken into account for address formatting in countries in which it is commonly used in addition to regular postal delivery and PO boxes, for example, in Canada or New Zealand. In all other countries, this field will not be taken into account for address formatting. Maximum length: 40.

nullable

Optional poBoxPostalCode

poBoxPostalCode: undefined | string

PO Box Postal Code. Postal code that is required for a unique assignment of the PO box. This field is used for countries where a different postal code applies to mail that is sent to the PO box rather than to the street address of a particular business partner.Postal codes for group major customers also have to be entered in the field for the PO box postal code since individual customers with a shared postal code for group major customers are differentiated by means of the PO box. Postal codes for major customers (= company postal codes), however, are assigned to one customer only and have to be entered in the field 'Company Postal Code'. Maximum length: 10.

nullable

Optional postalCode

postalCode: undefined | string

City Postal Code. Postal code as part of the address If different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code. Maximum length: 10.

nullable

Optional prfrdCommMediumType

prfrdCommMediumType: undefined | string

Communication Method (Key) (Business Address Services). Communication method with which you can exchange documents and messages with a business partner. In Business Address Services, you can specify a standard communication method that can be used by programs to determine the means of communication for sending messages.One business partner wants all messages by fax, another by e-mail.The application context can restrict the possible methods of communication. For example, invitations should perhaps only be sent by post because of enclosures, whereas minutes can be sent by post, fax or e-mail.Communication strategies can be defined for this purpose and applied in application contexts. Maximum length: 3.

nullable

Optional region

region: undefined | 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

relationshipNumber

relationshipNumber: string

BP Relationship Number. The business partner relationship number is an internal number that identifies the business partner relationship set. Maximum length: 12.

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: undefined | string

Street. Street name as part of the address. The street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street. See Print the Street address.The house number and other supplements are usually maintained in their own fields. See Formatting the Street line. Maximum length: 60.

nullable

Optional streetPrefixName

streetPrefixName: undefined | string

Street 2. Additional address field which is printed above the Street line. The Street address contains two lines above the street and two lines below the street.See Print the Street address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5. Maximum length: 40.

nullable

Optional streetSuffixName

streetSuffixName: undefined | string

Street 4. Additional address field which is printed below the Street line. The Street address contains two lines above the street and two lines below the street.See Print the Street address. Maximum length: 40.

nullable

Optional taxJurisdiction

taxJurisdiction: undefined | string

Tax Jurisdiction. Specifies the tax jurisdiction. Maximum length: 15.

nullable

toEmailAddress

toEmailAddress: AddressEmailAddress[]

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

toFaxNumber

toFaxNumber: AddressFaxNumber[]

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

toMobilePhoneNumber

toMobilePhoneNumber: AddressPhoneNumber[]

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

toPhoneNumber

toPhoneNumber: AddressPhoneNumber[]

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

toUrlAddress

toUrlAddress: AddressHomePageUrl[]

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

Optional transportZone

transportZone: undefined | string

Transportation zone to or from which the goods are delivered. Sales and distribution: Regional zone of Goods recipient.Purchasing:Regional zone of supplier.You can define regional zones to suit the requirements of your own business and country.Sales and distributionthe system automatically proposes a suitable route by using the transportation zone of the goods recipient in combination with other information about the delivery, such as theCountries of origin and destinationShipping conditionsTransportation groupIn the USA, for example, you can define regional zones to correspond to the US postal zip codes. Maximum length: 10.

nullable

validityEndDate

validityEndDate: Moment

Validity Date (Valid To).

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ADDITIONAL_STREET_PREFIX_NAME

ADDITIONAL_STREET_PREFIX_NAME: StringField<BpContactToAddress> = new StringField('AdditionalStreetPrefixName', BpContactToAddress, 'Edm.String')

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

Static ADDITIONAL_STREET_SUFFIX_NAME

ADDITIONAL_STREET_SUFFIX_NAME: StringField<BpContactToAddress> = new StringField('AdditionalStreetSuffixName', BpContactToAddress, 'Edm.String')

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

Static ADDRESS_ID

ADDRESS_ID: StringField<BpContactToAddress> = new StringField('AddressID', BpContactToAddress, 'Edm.String')

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

Static ADDRESS_NUMBER

ADDRESS_NUMBER: StringField<BpContactToAddress> = new StringField('AddressNumber', BpContactToAddress, 'Edm.String')

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

Static ADDRESS_TIME_ZONE

ADDRESS_TIME_ZONE: StringField<BpContactToAddress> = new StringField('AddressTimeZone', BpContactToAddress, 'Edm.String')

Static representation of the addressTimeZone 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<BpContactToAddress> = new AllFields('*', BpContactToAddress)

All fields selector.

Static BUSINESS_PARTNER_COMPANY

BUSINESS_PARTNER_COMPANY: StringField<BpContactToAddress> = new StringField('BusinessPartnerCompany', BpContactToAddress, 'Edm.String')

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

Static BUSINESS_PARTNER_PERSON

BUSINESS_PARTNER_PERSON: StringField<BpContactToAddress> = new StringField('BusinessPartnerPerson', BpContactToAddress, 'Edm.String')

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

Static CARE_OF_NAME

CARE_OF_NAME: StringField<BpContactToAddress> = new StringField('CareOfName', BpContactToAddress, 'Edm.String')

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

Static CITY_CODE

CITY_CODE: StringField<BpContactToAddress> = new StringField('CityCode', BpContactToAddress, 'Edm.String')

Static representation of the cityCode 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<BpContactToAddress> = new StringField('CityName', BpContactToAddress, '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 COMPANY_POSTAL_CODE

COMPANY_POSTAL_CODE: StringField<BpContactToAddress> = new StringField('CompanyPostalCode', BpContactToAddress, 'Edm.String')

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

Static COUNTRY

COUNTRY: StringField<BpContactToAddress> = new StringField('Country', BpContactToAddress, '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 COUNTY

COUNTY: StringField<BpContactToAddress> = new StringField('County', BpContactToAddress, 'Edm.String')

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

Static DELIVERY_SERVICE_NUMBER

DELIVERY_SERVICE_NUMBER: StringField<BpContactToAddress> = new StringField('DeliveryServiceNumber', BpContactToAddress, 'Edm.String')

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

Static DELIVERY_SERVICE_TYPE_CODE

DELIVERY_SERVICE_TYPE_CODE: StringField<BpContactToAddress> = new StringField('DeliveryServiceTypeCode', BpContactToAddress, 'Edm.String')

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

Static DISTRICT

DISTRICT: StringField<BpContactToAddress> = new StringField('District', BpContactToAddress, 'Edm.String')

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

Static FORM_OF_ADDRESS

FORM_OF_ADDRESS: StringField<BpContactToAddress> = new StringField('FormOfAddress', BpContactToAddress, 'Edm.String')

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

Static FULL_NAME

FULL_NAME: StringField<BpContactToAddress> = new StringField('FullName', BpContactToAddress, 'Edm.String')

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

Static HOME_CITY_NAME

HOME_CITY_NAME: StringField<BpContactToAddress> = new StringField('HomeCityName', BpContactToAddress, 'Edm.String')

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

Static HOUSE_NUMBER

HOUSE_NUMBER: StringField<BpContactToAddress> = new StringField('HouseNumber', BpContactToAddress, 'Edm.String')

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

Static HOUSE_NUMBER_SUPPLEMENT_TEXT

HOUSE_NUMBER_SUPPLEMENT_TEXT: StringField<BpContactToAddress> = new StringField('HouseNumberSupplementText', BpContactToAddress, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<BpContactToAddress> = new StringField('Language', BpContactToAddress, 'Edm.String')

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

Static PERSON

PERSON: StringField<BpContactToAddress> = new StringField('Person', BpContactToAddress, 'Edm.String')

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

Static POSTAL_CODE

POSTAL_CODE: StringField<BpContactToAddress> = new StringField('PostalCode', BpContactToAddress, 'Edm.String')

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

Static PO_BOX

PO_BOX: StringField<BpContactToAddress> = new StringField('POBox', BpContactToAddress, 'Edm.String')

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

Static PO_BOX_DEVIATING_CITY_NAME

PO_BOX_DEVIATING_CITY_NAME: StringField<BpContactToAddress> = new StringField('POBoxDeviatingCityName', BpContactToAddress, 'Edm.String')

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

Static PO_BOX_DEVIATING_COUNTRY

PO_BOX_DEVIATING_COUNTRY: StringField<BpContactToAddress> = new StringField('POBoxDeviatingCountry', BpContactToAddress, 'Edm.String')

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

Static PO_BOX_DEVIATING_REGION

PO_BOX_DEVIATING_REGION: StringField<BpContactToAddress> = new StringField('POBoxDeviatingRegion', BpContactToAddress, 'Edm.String')

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

Static PO_BOX_IS_WITHOUT_NUMBER

PO_BOX_IS_WITHOUT_NUMBER: BooleanField<BpContactToAddress> = new BooleanField('POBoxIsWithoutNumber', BpContactToAddress, 'Edm.Boolean')

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

Static PO_BOX_LOBBY_NAME

PO_BOX_LOBBY_NAME: StringField<BpContactToAddress> = new StringField('POBoxLobbyName', BpContactToAddress, 'Edm.String')

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

Static PO_BOX_POSTAL_CODE

PO_BOX_POSTAL_CODE: StringField<BpContactToAddress> = new StringField('POBoxPostalCode', BpContactToAddress, 'Edm.String')

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

Static PRFRD_COMM_MEDIUM_TYPE

PRFRD_COMM_MEDIUM_TYPE: StringField<BpContactToAddress> = new StringField('PrfrdCommMediumType', BpContactToAddress, 'Edm.String')

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

Static REGION

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

RELATIONSHIP_NUMBER: StringField<BpContactToAddress> = new StringField('RelationshipNumber', BpContactToAddress, 'Edm.String')

Static representation of the relationshipNumber 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<BpContactToAddress> = new StringField('StreetName', BpContactToAddress, '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 STREET_PREFIX_NAME

STREET_PREFIX_NAME: StringField<BpContactToAddress> = new StringField('StreetPrefixName', BpContactToAddress, 'Edm.String')

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

Static STREET_SUFFIX_NAME

STREET_SUFFIX_NAME: StringField<BpContactToAddress> = new StringField('StreetSuffixName', BpContactToAddress, 'Edm.String')

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

Static TAX_JURISDICTION

TAX_JURISDICTION: StringField<BpContactToAddress> = new StringField('TaxJurisdiction', BpContactToAddress, 'Edm.String')

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

Static TO_EMAIL_ADDRESS

TO_EMAIL_ADDRESS: Link<BpContactToAddress, AddressEmailAddress> = new Link('to_EmailAddress', BpContactToAddress, AddressEmailAddress)

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

Static TO_FAX_NUMBER

TO_FAX_NUMBER: Link<BpContactToAddress, AddressFaxNumber> = new Link('to_FaxNumber', BpContactToAddress, AddressFaxNumber)

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

Static TO_MOBILE_PHONE_NUMBER

TO_MOBILE_PHONE_NUMBER: Link<BpContactToAddress, AddressPhoneNumber> = new Link('to_MobilePhoneNumber', BpContactToAddress, AddressPhoneNumber)

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

Static TO_PHONE_NUMBER

TO_PHONE_NUMBER: Link<BpContactToAddress, AddressPhoneNumber> = new Link('to_PhoneNumber', BpContactToAddress, AddressPhoneNumber)

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

Static TO_URL_ADDRESS

TO_URL_ADDRESS: Link<BpContactToAddress, AddressHomePageUrl> = new Link('to_URLAddress', BpContactToAddress, AddressHomePageUrl)

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

Static TRANSPORT_ZONE

TRANSPORT_ZONE: StringField<BpContactToAddress> = new StringField('TransportZone', BpContactToAddress, 'Edm.String')

Static representation of the transportZone 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<BpContactToAddress> = new DateField('ValidityEndDate', BpContactToAddress, '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 _allFields

_allFields: Array<StringField<BpContactToAddress> | DateField<BpContactToAddress> | BooleanField<BpContactToAddress> | Link<BpContactToAddress, AddressEmailAddress> | Link<BpContactToAddress, AddressFaxNumber> | Link<BpContactToAddress, AddressPhoneNumber> | Link<BpContactToAddress, AddressHomePageUrl>> = [BpContactToAddress.RELATIONSHIP_NUMBER,BpContactToAddress.BUSINESS_PARTNER_COMPANY,BpContactToAddress.BUSINESS_PARTNER_PERSON,BpContactToAddress.VALIDITY_END_DATE,BpContactToAddress.ADDRESS_ID,BpContactToAddress.ADDRESS_NUMBER,BpContactToAddress.ADDITIONAL_STREET_PREFIX_NAME,BpContactToAddress.ADDITIONAL_STREET_SUFFIX_NAME,BpContactToAddress.ADDRESS_TIME_ZONE,BpContactToAddress.CARE_OF_NAME,BpContactToAddress.CITY_CODE,BpContactToAddress.CITY_NAME,BpContactToAddress.COMPANY_POSTAL_CODE,BpContactToAddress.COUNTRY,BpContactToAddress.COUNTY,BpContactToAddress.DELIVERY_SERVICE_NUMBER,BpContactToAddress.DELIVERY_SERVICE_TYPE_CODE,BpContactToAddress.DISTRICT,BpContactToAddress.FORM_OF_ADDRESS,BpContactToAddress.FULL_NAME,BpContactToAddress.HOME_CITY_NAME,BpContactToAddress.HOUSE_NUMBER,BpContactToAddress.HOUSE_NUMBER_SUPPLEMENT_TEXT,BpContactToAddress.LANGUAGE,BpContactToAddress.PO_BOX,BpContactToAddress.PO_BOX_DEVIATING_CITY_NAME,BpContactToAddress.PO_BOX_DEVIATING_COUNTRY,BpContactToAddress.PO_BOX_DEVIATING_REGION,BpContactToAddress.PO_BOX_IS_WITHOUT_NUMBER,BpContactToAddress.PO_BOX_LOBBY_NAME,BpContactToAddress.PO_BOX_POSTAL_CODE,BpContactToAddress.PERSON,BpContactToAddress.POSTAL_CODE,BpContactToAddress.PRFRD_COMM_MEDIUM_TYPE,BpContactToAddress.REGION,BpContactToAddress.STREET_NAME,BpContactToAddress.STREET_PREFIX_NAME,BpContactToAddress.STREET_SUFFIX_NAME,BpContactToAddress.TAX_JURISDICTION,BpContactToAddress.TRANSPORT_ZONE,BpContactToAddress.TO_EMAIL_ADDRESS,BpContactToAddress.TO_FAX_NUMBER,BpContactToAddress.TO_MOBILE_PHONE_NUMBER,BpContactToAddress.TO_PHONE_NUMBER,BpContactToAddress.TO_URL_ADDRESS]

All fields of the BpContactToAddress entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BPContactToAddress"

Technical entity name for BpContactToAddress.

Static _keyFields

_keyFields: Array<Selectable<BpContactToAddress>> = [BpContactToAddress.RELATIONSHIP_NUMBER, BpContactToAddress.BUSINESS_PARTNER_COMPANY, BpContactToAddress.BUSINESS_PARTNER_PERSON, BpContactToAddress.VALIDITY_END_DATE, BpContactToAddress.ADDRESS_ID]

All key fields of the BpContactToAddress entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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 | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BpContactToAddress>

    A builder that constructs instances of entity type BpContactToAddress.

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, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

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

    Returns BpContactToAddressRequestBuilder

    A BpContactToAddress request builder.