PDF Export

JSON Business Partner

Example
{
      "role": "WE",
      "bpNumber": "1006346741",
      "fullSalutation": "Dear Mrs Customer",
      "lastName1": "Customer",
      "lastName2": "",
      "firstName": "Anne",
      "dateOfBirth": "",
      "fullLastName": "Customer",
      "nameAddition": "",
      "jobTitle": "",
      "title": "",
      "salutationCode": "02",
      "salutation": "Mrs",
      "company1": "",
      "company2": "",
      "company3": "",
      "department": "",
      "zipcode": "NN4 7BF",
      "street": "",
      "streetSuffix": "",
      "streetNumber": "",
      "streetNumberSuffix": "",
      "addressLine1": "1 Main Road",
      "addressLine2": "",
      "addressLine3": "",
      "regionCode": "NH",
      "regionText": "Northamptonshire",
      "fullStreet": "",
      "poBoxZipcode": "",
      "poBox": "",
      "poBoxCity": "",
      "majorCustZip": "",
      "city": "NORTHAMPTON",
      "district": "",
      "countryCode": "GB",
      "country": "United Kingdom",
      "advertisement": "Y",
      "blockTag": "N",
      "euSalesTaxNumber": "",
      "bicMasterNumber": "",
      "sector": "",
      "mobilePhoneNumber": "",
      "phoneNumber": "",
      "faxNumber": "",
      "emailAddress": "customer@example.com",
      "bpExtCommunication": [],
      "bpAttributes": [],
      "bpHolidayAddress": []
   }

Element Definitions

Field name Description
role C Type of business partner.
AG = orderer
WE = consignee
RE = invoice recipient
bpNumber C Business partner no.
fullSalutation C Mounted personal salutation
lastName1 C Lastname 1
lastName2 C Lastname 2
firstName C First-name
fullLastName C Mounted last-name
nameAddition C Name-addition, for example profession
jobTitle C Job title
title C Academic Title
salutationCode C Salutation-Code in AVS/3, For example
01 = Mr.
02 = Ms.
salutation C Salutation
company1 C 1. line of company address. If this field is filled is the above name the contact person of the firm.
company2 C 2. line of company address. Contains for example section or continuation of firm address.
company3 C 3. line of company address
department C department
zipcode C zipcode
street C Street with house no. and addition to house no.
streetSuffix C Addition to street
streetName C Street Name
streetNumber C Street Number
streetNumberSuffix C Street Number Suffix
addressLine1 C Address line 1 for UK addresses
addressLine2 C Address line 2 for UK addresses
addressLine3 C Address line 3 for UK addresses
poBoxZipcode C Po-box-zipcode
poBox C Po-box
poBoxCity C Po-box-city
majorCustZip C Major-cust-zip
city C City
district C Addition of city
regionCode C Region-Code (federal state, province, county)
regionText C Region as cleartext (e.g. County…)
countryCode C Two letter ISO 3166-1 alpha-2 country-code
country C country
advertisement C Advertisement permitted; Y / N
blockTag C General block-tag ( X = put block-tag )
euSalesTaxNumber C EU sales tax id
dateOfBirth D Birthdate (YYYY-MM-DD)
bicMasterNumber C Partner-ID of master (for example company of contact person)
sector C branch
mobilePhoneNumber C Mobile Telephone-No.: pre code + termination
phoneNumber C Telephone no..: pre code + termination
faxNumber C Fax-No.: pre code + termination
emailAddress C IS-M: e-mail number
bpExtCommunication Extended communication data (only with request parameter returnExtendedCommunicationData=true)
communicationType C Communication Types; Values
communicationValue C Communication value
communicationDefault C Default value Y / N

bpAttributes

bpHolidayAddress

This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information