Partner-object "partner" – RetailForce Software GmbH

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": 
    "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: Québec/Canada: Mandatory information
partnerType		O	Type / kind of (business) partner (Enum). Currently: [0] = Customer
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.
street		O	Street
streetNumber		O	Street number
postalCode		O	Postal code
city		O	City / Town
community		O	In some countries (e.g. Slovenia) the so-called "community" is part of the address.
countryCode		O	Country code according to ISO 3166 alpha-3 (3-digit).

partner-object

Related articles