Business Partner DTO v17

This object is a general representation of companies or customers. This is related to the basic system (e.g. SAP B1, SAP ECC, MS Dynamics CRM, ...). The businesspartner type indicates the kind of relationship to this company. For more information about types @see BusinessPartnerType.

Field Name Type Category Constraint Reference Description
additionalName String Optional length >= 1 & length <= 512 The additional name for this business partner
city String Optional length >= 1 & length <= 128 city of the main address of this businesspartner (used to search and display in list) -> may overlap with the default address city
code String Optional length >= 1 & length <= 512 System code of this object, normally this correlates to the erp id given by the source system.
country String Optional length >= 1 & length <= 128 city of the main address of this businesspartner (used to search and display in list) -> may overlap with the default address city
creditLimit Monetary Optional credit limit of this businesspartner, specified as a monetary amount to be most precise and formattable
currency String Optional length >= 3 & length <= 3 Currency of this business partner. Business partners that have multiple currencies are indicated by not assigning any currency.
emailAddress String Optional length >= 1 & length <= 128 The public email address.
fax String Optional length >= 1 & length <= 128 The fax.
groupCode String Optional length >= 1 & length <= 512 The code of the group which the business partner belongs to. This must be a value which is also present in the BusinessPartnerGroup model.
groupName String Optional length >= 1 & length <= 512 The name of the group which the business partner belongs to. This must be a value which is also present in the BusinessPartnerGroup model.
language String Optional length >= 0 & length <= 255 default language settings value when an offline reports is generated on the client
mobilePhone String Optional length >= 1 & length <= 128 The mobile phone.
name String Optional length >= 1 & length <= 512 The name.
officePhone String Optional length >= 1 & length <= 128 The office phone.
otherPhone String Optional length >= 1 & length <= 128 An other phone.
password String Optional length >= 1 & length <= 512 Business partner password.
paymentTerm Identifier Optional PaymentTerm : 11, 12, 13, 14 Associated payment term.
paymentType Identifier Optional PaymentType : 12, 13, 14, 15 Link to default payment type.
priceList Identifier Optional PriceList : 11, 12, 13, 14 Specifies the pricelist assigned to this businesspartner. The pricelist is used during creation of sales orders, materials and other objects which allow to choose items to calculate the prices.
remarks String Optional length >= 1 & length <= 2147483647 Remarks or notes related to this object, can be used for any string based content.
salesPersons Set<Identifier> Optional Person : 15, 16, 17, 18, 19 List of related sales persons of this business partner. Considered by the permission system whenever read/write permission is set to OWN.
shippingType Identifier Optional ShippingType : 11, 12, 13, 14 Link to default shipping type.
type String Optional length >= 0 & length <= 255

Allowed values are defined into Enumerations having enumType = BUSINESSPARTNER_TYPE.
For learning about Enumerations, please check this.
Type of business partner (e.g. LEADER, SUPPLIER)
validityComment String Optional length >= 0 & length <= 512 Validity comment for dusiness partner.
website String Optional length >= 1 & length <= 512 The business partner's website.