Partner-object "partner" – RetailForce

This Article deals with the partner object within the Document object.

A complete description of the RetailForce DOM (Document Object Model), as well as a description of the individual elements, can be found in the downloads area of the RetailForce website (Object model documentation.pdf) in the respective version directory.

The object "parter" contains information on the respective (business) partners of the document-issuing company. These can be, for example, external partners such as customers or suppliers, but also internal "customers" such as a particular branch of the company to which goods are sent.

partner-object

The following partner object contains sample data.

"partner": {
  "id": "2241247",
  "caption": "Jane Doe",
  "isBusiness": true,
  "partnerType": "[0] = Customer",
  "partnerClassification": "Customer",
  "vatNumber": null,
  "taxNumber": null,
  "identificationType": "passport",
  "partnerIdentification": null,
  "additionalIdentifications": null,
  "addresses": [
    {
      "addressType": "[1] = BillingAddress,
      "street": "Hintere Zollamtsstraße",
      "streetNumber": "4",
      "postalCode": "1030",
      "city": "Wien",
      "community": null,
      "countryCode": "AUT"
    }
  ],
  "addressType": "[1] = BillingAddress,
  "street": "Hintere Zollamtsstraße",
  "streetNumber": "4",
  "postalCode": "1030",
  "city": "Wien",
  "community": null,
  "countryCode": "AUT"
},

The partner object contains the following information.

Information in "Type" column:

M ... mandatory / requird
M* ... mandatory / requird in certain countries or under certain conditions
R ... recommended
O... optional

Elements		Type	Description
id		M	ID of the partner. Can be e.g. the customer number / ID.
caption		O	Designation of the partners (e.g. name, company name).
isBusiness		M*	Indicates whether the transaction is a B2B transaction (true) or a B2C transaction (false). Country details: France: Mandatory information Portugal: Mandatory information Québec/Canada: Mandatory information
partnerType		M*	Type / kind of (business) partner (Enum). Currently: [0] = Customer [1] = Supplier Country details: Portugal: Mandatory information
partnerClassification		O	Classification of the partner (not the PartnerType!).
vatNumber		M*	VAT ID of the partner (necessary for B2B transactions).
taxNumber		O	Tax number of the partner, e.g. "company tax number" (NOT the VAT number!)
identificationType		M*	in which way the identity of the partner was confirmed. Enum PartnerIdentificationType: OfficialDocument Other Passport ResidenceCertificate
partnerIdentification		M*	Identification of the partner - if set, the property IdentificationType must also be set.
additionalIdentifications		O	Additional ID features for various purposes.
	lotteryId	O	Personal lottery ID of a customer in Italy. Is required to participate in the so-called deferred lottery ("Lotteria Differita") of the "Lotteria degli Scontrini" ( "Receipt Lottery"). Country details: Italy: If a customer wishes to participate in the Lotteria Differita, their personal ID must be entered in this field.
	additionalProp1	O	Additional ID features for various purposes.
	additionalProp2	O	Additional ID features for various purposes.
	additionalProp3	O	Additional ID features for various purposes.
addresses		O/M*	Allows multiple / additional addresses to be entered. If only one address is to be provided, use the general field "Document.Partner". Note: As a general rule, addresses must always be included on B2B invoices ("DocumentType": "[1] = Invoice").
	addressType	O/M*	The "AddressType" property defined at this level specifies the type of address entered under "Document.Partner.Addresses". The following address types are available: [1] = BillingAddress, [2] = DeliveryAddress, [3] = ResidentialAddress, [4] = CompanyLocation, [5] = ServiceRendered Country information: Portugal: Specification of address types for B2B invoices in Portugal: [1] = BillingAddress - Mandatory, [2] = DeliveryAddress - Optional
	street	O/M*	Street Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers.
	streetNumber	O/M*	Street number Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers.
	postalCode	O/M*	Postal code Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers. The postcode must be in Canadian format: A9A9A9 6 characters 1 character (letter), 1 number, 1 character (letter), 1 number, 1 character (letter), 1 number.
	city	O/M*	City / Town Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers.
	community	O	In some countries (e.g. Slovenia) the so-called "community" is part of the address.
	countryCode	O/M*	Country code according to ISO 3166 alpha-3 (3-digit). Country details: Portugal: Mandatory field
addressType		O/M*	The property "AddressType" set on this level defines the type of address entered at "Document.Partner". If you need to specify several different addresses with different address types, you can do so under "Document.Partner.Addresses". The following address types are available: [1] = BillingAddress, [2] = DeliveryAddress, [3] = ResidentialAddress, [4] = CompanyLocation, [5] = ServiceRendered Country details: Portugal: Specifying address types on B2B invoices in Portugal: [1] = BillingAddress - Mandatory, [2] = DeliveryAddress - Optional
street		O/M*	Street Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers.
streetNumber		O/M*	Street number Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers.
postalCode		O/M*	Postal code Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers. The postcode must be in Canadian format: A9A9A9 6 characters 1 character (letter), 1 number, 1 character (letter), 1 number, 1 character (letter), 1 number.
city		O/M*	City / Town Country details: Portugal: Mandatory field Québec: Mandatory field if a ‘partner’ (customer) is specified. Revenu Québec only supports information about Canadian customers.
community		O	In some countries (e.g. Slovenia) the so-called "community" is part of the address.
countryCode		O/M*	Country code according to ISO 3166 alpha-3 (3-digit). Country details: Portugal: Mandatory field

partner-object

Related articles