Business Partners

Lookup Business Partners

Lookup a business partner in all available data sources.

SecurityapiKey
Request
Request Body schema: application/json
required
city
string

City of the Business Partner.

Example: "Hamburg"
country
string

Country of the Business Partner.

Example: "DE"
houseNo
string

House number of the Business Partner.

Example: "4"
identifierType
string

Identifier type of the Business Partner.

Example: "EU_VAT_ID_DE"
identifierValue
string

Identifier value of the Business Partner.

Example: "DE123456789"
limitResults
integer

Number of items per page.

Example: "100"
matchingThreshold
number <double> [ 0 .. 1 ]

Matching threshold for the Business Partner.

Example: "0.5"
maxCandidates
integer [ 20 .. 100 ]

Maximum number of candidates to return. Default is 50.

Example: "50"
name
string

Name of the Business Partner.

Example: "CDQ AG"
page
integer
Default: 0

Current page number.

Example: "0"
pageSize
integer

Number of items per page.

Example: "10"
postCode
string

Post code of the Business Partner.

Example: "20095"
startAfter
string (StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
street
string

Street of the Business Partner.

Example: "Jungfernstieg"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/restv3/businesspartners/lookup
Request samples
application/json
{
  • "businessPartner": {
    }
}
Response samples
application/json
{
  • "pageSize": "10",
  • "totals": "67",
  • "page": "0",
  • "limitResults": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "businessPartnerCandidates": [
    ]
}