Business Partners

Fetch Business Partner

Fetch business partner by CDQ-ID

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

CDQ ID for business partner and address.

Example: "CDQ:DE123456789"
featuresOff
Array of strings (BusinessPartnerFetchFeature)

List of features to be deactivated.

Items Value: Description
SHOW_DEBUG_INFO

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

Example: ["SHOW_DEBUG_INFO"]
featuresOn
Array of strings (BusinessPartnerFetchFeature)

List of features to be activated.

Items Value: Description
SHOW_DEBUG_INFO

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

Example: ["SHOW_DEBUG_INFO"]
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/fetch
Request samples
application/json
{
  • "cdqId": "VIES:CZ46981691"
}
Response samples
application/json
{
  • "status": "OK",
  • "message": "Message describing the status of the request.",
  • "cdqId": "CDQ:DE123456789",
  • "dataSource": "VIES",
  • "businessPartner": {
    },
  • "businessPartnerSapOdm": {
    }
}

Lookup Business Partners

Lookup a Business Partner in all available Data Sources. The lookup is performed based on the given Business Partner object.

SecurityapiKey
Request
Request Body schema: application/json
required
object (BusinessPartner)

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

featuresOff
Array of strings (LookupBusinessPartnerFeature)

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 (LookupBusinessPartnerFeature)

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 ]
Default: 50

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

Example: "50"
page
integer (Page) >= 0
Default: 0

Current page number.

Example: "1"
pageSize
integer (PageSize) [ 1 .. 1000 ]
Default: 10

Number of items per page.

Example: "100"
startAfter
string (StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/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": {
    }
}