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.
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 "*".
Academic Title: Key. Key for academic title. You can define a key for an academic title in Customizing. Maximum length: 4.
Other Last Name of a Person. Maximum length: 40.
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.
Date of Birth of Business Partner.
Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.
Business Partner Category. Category under which a business partner is classified. You can distinguish between the following business partner categories:OrganizationNatural personGroup of natural persons or organizationsThe processing screens for the business partner categories are set up differently.So, for example, the screen for an organization contains the field Legal form, but this is not needed in the screen for a natural person. Maximum length: 1.
Business Partner Full Name. Maximum length: 81.
Business Partner Grouping. Classification assigned when creating a business partner. Assign each business partner to a grouping when you create the business partner. The grouping determines the number range. You cannot change the assignment afterwards.You can define the groupings, their descriptions, the associated number range and other attributes in Customizing.You can define standard groupings for the internal and the external number assignment.For each grouping create a number range.When you create a business partner, the entry in the grouping field determines whether and how an entry is made in the business partner number field. Maximum length: 4.
Business Partner Number in External System. Business partner number from an external system or a legacy system. If the current business partner is known under a different number in an external system, you can store this number here for information purposes.Direct input gives you the option of maintaining a business partner by specifying the external business partner number. If you maintain business partner data in your legacy system, you can transmit changes made to business partners to the SAP system without having to know the SAP business partner number in the legacy system. Maximum length: 20.
Central Block for Business Partner. If the business partner is blocked centrally, certain activities cannot be executed.
Business Partner Name. Maximum length: 81.
Business Partner Type. You can use the business partner type to group business partners according to your own criteria in Customizing (IMG). In Customizing you can show or hide fields for data entry, depending on the requirements of the relevant business partner type.Select a business partner type. You can obtain help by pressing the F4 key. Maximum length: 4.
Business Partner GUID.
Business Partner: Correspondence Language. Correspondence language (written) for business partners in the 'Person' category. Maintain the correspondence language for business partners in the 'Organization' and 'Group' category with the address (communication). When transferring data (direct input), make sure that for a'Person', the field 'LANGU_CORR' and for an'Organization' or "Group" the field 'LANGU'has an entry. Maximum length: 2.
User who created the object. Maximum length: 12.
Date on which the object was created.
Time at which the object was created.
Customer Number. Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system. Maximum length: 10.
E Tag. Maximum length: 26.
First Name of Business Partner (Person). Maximum length: 40.
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.
Name 1 (group). First name field for business partners in the Group category. Maximum length: 40.
Name 2 (group). Second name field for business partners in the Group category. Maximum length: 40.
Address Number. Internal key for identifying the address for communication data that spans all addresses in Business Partner. For more information on the significance and usage of the address number, see the documentation for Business Address Services (BAS). Maximum length: 10.
Industry sector. An industry sector is the term used to classify a company according to its main business activity. You can assign an industry sector to business partners in the category 'Organization'RetailBanksServicesIndustryHealth servicePublic sectorMedia. Maximum length: 10.
International location number (part 1). Here you enter the first 7 digits of the international location number. The International Location Number (ILN) is assigned (in Germany by the Centrale for Coorganisation GmbH)) when a company is founded. It consists of 13 digits, the last digit being the check digit. There are two categories of location numbers:Participants who only need an ILN to cleary and unmistakably identify themselves for communication with the business partner are given a category 1 ILN. This cannot be used to identify articles by means of EAN.Participants who wish to assign the location numbers for their own enterprise areas are given a category 2 ILN. For a category 2 ILN, digits 1 to 7 are described as basis number. This is used as basis for the creation of article numbers (EAN). Maximum length: 7.
International location number (Part 2). Here, you enter digits 8-12 of the 13-digit international location number. The international location number (ILN) is assigned when establishing a company (by the "Zentrale für Coorganisation GmbH" in Germany). It consists of 13 digits, the last of which is the check digit. There are two types of international location numbers:Subscribers who only need one ILN to identify themselves in communication with the business partner are given an ILN of type 1. These cannot be used for identifying articles by means of EAN.Subscribers who need to assign location numbers for their own company areas are given an ILN of type 2. Positions 1 through 7 of the ILN type 2 are known as the basis number. This basis number forms the basis for article numbers (EAN). Maximum length: 5.
Check digit for the international location number. The check digit is derived from a special check digit procedure from digits of the previous international location numbers. In this way, you can check whether the ILN entered is actually valid. Maximum length: 1.
Selection: Business partner is female.
Selection: Business partner is male.
Central Archiving Flag. Establishes if the business partner is meant to be archived. If the indicator is set, the relevant business partner can be archived from the view of the business partner administration.If the check of the data to be archived shows, for example, that there are still active business transactions the archiving of the business partner data is prevented even if the indicator is set.If the indicator is not set, the business partner will not be taken into consideration during archiving.
Business Partner Is a Natural Person Under the Tax Laws. Indicator through which a distinction between natural and legal persons can be made during tax reporting. Is used in Italy and Mexico ,among other countries.Brasil: If the indicator is not set, 'CGC' is relevant in tax number 1. If the indicator is set, 'CPF' is relevant in tax number 2.Colombia: In the case of some natural persons, the NIT number does not have a check digit. In this case you should set this indicator and the check is deactivated. Maximum length: 1.
Selection: Sex of business partner is not known.
Business partner: Language. Language for verbal communication with a business partner. This language may differ from the language(s) defined for written correspondence. Maximum length: 2.
Date when object was last changed.
Time at which object was last changed.
Last user to change object. Maximum length: 12.
Last Name of Business Partner (Person). Maximum length: 40.
BP: Legal form of organization. Denotes certain legal norms that are of significance for the organization of a company. For business partners in the category "Organization", you can state the legal form of the company. This is for information purposes only.Stock corporation (AG in Germany)Limited liability company (GmbH in Germany). Maximum length: 2.
Middle Name or Second Forename of a Person. Maximum length: 40.
Country for Name Format Rule. The name format rule country and the name format rule key together uniquely identify a formatting rule. A country can have several formats which correspond to different rules. Formatting rules describe the format of a person name. Maximum length: 3.
Name format. See Name format. Maximum length: 2.
Name 1 of organization. First name field for business partners in the Organization category. Maximum length: 40.
Name 2 of organization. Second name field for business partners in the Organization category. Maximum length: 40.
Name 3 of organization. Third name field for business partners in the Organization category. Maximum length: 40.
Name 4 of organization. Fourth name field for business partners in the Organization category. Maximum length: 40.
Date organization founded. Indicates the official registration of a company in the Commercial Register. If a company is not officially registered in the Commercial Register, it has to use some type of text addition, such as foundation pending, when referring to the legal form.
Liquidation date of organization. Term for the end of bankruptcy proceedings. This date also indicates that the company no longer exists.
Full Name. States the complete name of a person. The complete name is generally generated and saved by the Business Address Services (BAS) according to country-specific rules from the individual name components (without the form of address).If, during the formatting of an address, you want to use an alternative name, you can manually format the alternative name here. Maximum length: 80.
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.
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 the original OData properties.
Search term 1 for business partner. Denotes the term that you define for a business partner, and via which you can restrict the search for a business partner in the business partner search or in the locator. Maximum length: 20.
Account Number of Supplier. Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system. Maximum length: 10.
One-to-many navigation property to the BuPaIdentification entity.
One-to-many navigation property to the BuPaIndustry entity.
One-to-many navigation property to the BusinessPartnerAddress entity.
One-to-many navigation property to the BusinessPartnerBank entity.
One-to-many navigation property to the BusinessPartnerContact entity.
One-to-many navigation property to the BusinessPartnerRole entity.
One-to-many navigation property to the BusinessPartnerTaxNumber entity.
One-to-one navigation property to the Customer entity.
One-to-one navigation property to the Supplier entity.
Company ID of trading partner. Company ID standard for the whole group. Maximum length: 6.
Static representation of the academicTitle property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the additionalLastName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields selector.
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 representation of the birthDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the businessPartnerCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the businessPartnerFullName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the businessPartnerGrouping property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the businessPartnerIdByExtSystem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the businessPartnerIsBlocked property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the businessPartnerName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the businessPartnerType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the businessPartnerUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the correspondenceLanguage property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 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 representation of the creationTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the customer property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the eTag property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the firstName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the groupBusinessPartnerName1 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the groupBusinessPartnerName2 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the independentAddressId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the industry property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the internationalLocationNumber1 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the internationalLocationNumber2 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the internationalLocationNumber3 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isFemale property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isMale property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isMarkedForArchiving property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isNaturalPerson property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isSexUnknown property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the lastChangedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lastChangeDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lastChangeTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lastName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the legalForm property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the middleName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the nameCountry property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the nameFormat property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the organizationBpName1 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the organizationBpName2 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the organizationBpName3 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the organizationBpName4 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the organizationFoundationDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the organizationLiquidationDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the personFullName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the personNumber property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the searchTerm1 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the supplier property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toBusinessPartnerAddress for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toBusinessPartnerBank for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toBusinessPartnerContact for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toBusinessPartnerRole for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toBusinessPartnerTax for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toBuPaIdentification for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toBuPaIndustry for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-one navigation property toCustomer for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-one navigation property toSupplier for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the tradingPartner property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the BusinessPartner entity.
Default url path for the according service.
Technical entity name for BusinessPartner.
All key fields of the BusinessPartner entity.
Mapping of all key field names to the respective static field property BusinessPartner.
ETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined if not retrieved
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
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.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
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.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
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.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances BusinessPartner.
A builder that constructs instances of entity type BusinessPartner.
Returns a selectable object that allows the selection of custom field in a get request for the entity BusinessPartner.
Name of the custom field to select
A builder that constructs instances of entity type BusinessPartner.
Returns a request builder to construct requests for operations on the BusinessPartner entity type.
A BusinessPartner request builder.
This class represents the entity "A_BusinessPartner" of service "API_BUSINESS_PARTNER". This service is part of the following communication scenarios: Business Partner, Customer and Supplier Integration (SAP_COM_0008), SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_BUSINESS_PARTNER for more information.