Lookup Business Partners

Lookup a business partner in all available data sources.

SecurityapiKey
Request
Request Body schema: application/json
required
object

An organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

dataSources
Array of strings

Filter Data Sources used during lookup.

Example: "VIES"
featuresOff
Array of strings

List of features to be deactivated.

Items Enum: Description
SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, and request.

SHOW_GOLDENRECORD_QUICK

Calculate golden record for given request.

SHOW_GOLDENRECORD_STANDARD

Calculate golden record for given request.

Example: ["SHOW_DEBUG_INFO"]
featuresOn
Array of strings

List of features to be activated.

Items Enum: Description
SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, and request.

SHOW_GOLDENRECORD_QUICK

Calculate golden record for given request.

SHOW_GOLDENRECORD_STANDARD

Calculate golden record for given request.

Example: ["SHOW_DEBUG_INFO"]
limit
integer [ 0 .. 1000 ]

Number of items per page.

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

The matching threshold for the lookup.

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

The maximum number of candidates to be returned by the lookup. Default 50.

Example: "50"
page
integer >= 0
Default: 0

Current page number.

Example: "1"
pageSize
integer [ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "100"
startAfter
string

The ID which is used to read the page.

Example: "5712566172571652"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v3/businesspartners/lookup
Request samples
application/json
{
  • "businessPartner": {
    }
}
Response samples
application/json
{
  • "pageSize": "100",
  • "totals": "67",
  • "page": "1",
  • "limit": "100",
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "values": [
    ],
  • "goldenRecord": {
    }
}