Perform a Business Partner lookup operation across all available Data Sources. The output of this operation will be a comprehensive list of Business Partners, each accompanied by their respective Data Sources and meticulously calculated matching scores. It is important to note that all accessible data sources are comprehensively documented within the Data_source Category on CDQ Wiki.
The Data Sources are categorized as follows:
The results of the Business Partner lookup operation are sorted in descending order based on their matching scores. Additionally, the results are conveniently paginated, allowing for efficient navigation through the extensive list. The page size can be effortlessly customized to accommodate specific preferences.
cmd
object (BusinessPartnerParam) Refers to 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| configurationId | string (ReferenceDataConfigurationId) Configuration ID used to set up lookup. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):
Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dataSources | Array of strings Filter data sources used during lookup. Example: ["VIES"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| featuresOff | Array of strings (businessPartnerFeaturesDescription) List of features to be deactivated.
Example: ["ACTIVATE_DATASOURCE_BVD"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| featuresOn | Array of strings (businessPartnerFeaturesDescription) List of features to be activated.
Example: ["ACTIVATE_DATASOURCE_BVD"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer (LookupConfigurationLimit) [ 0 .. 1000 ] Number of items per page. Default value is 10. Example: "10" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| matchingThreshold | number <double> (LookupConfigurationMatchingThreshold) [ 0 .. 1 ] Matching threshold for the lookup process. Default value is 0.5. Example: "0.5" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| maxCandidates | integer (LookupConfigurationMaxCandidates) [ 20 .. 200 ] Maximum number of candidates to be returned. Default value is 50. Example: "50" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| startAfter | string The ID which is used to read the page. Example: "5712566172571652" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (StoragesDataSource) This field allows to filter data mirrors that will be queried. For each data mirror, data sources can also be filtered. Leave empty to include all available data mirrors in query. |
OK
Unauthorized
Forbidden
Not Found
| Message ID | Technical Key | Message |
|---|---|---|
| 429000007 | CREDITS_EXCEEDED | Credits exceeded. There is not enough credits to execute the request. Contact sales to get additional credits |
{- "matchingThreshold": 0,
- "pageSize": 10,
- "page": 0,
- "dataSources": [
- "string"
], - "businessPartner": {
- "names": [
- {
- "value": "string"
}
], - "identifiers": [
- {
- "value": "string",
- "type": {
- "technicalKey": "string"
}
}
], - "legalForm": {
- "value": "string"
}, - "addresses": [
- {
- "thoroughfares": [
- {
- "value": "string",
- "number": "string"
}
], - "localities": [
- {
- "value": "string"
}
], - "administrativeAreas": [
- {
- "value": "string"
}
], - "postCodes": [
- {
- "value": "string"
}
], - "country": {
- "shortName": "string"
}
}
]
}
}{- "cdqId": "VIES:CZ46981691",
- "dataSource": {
- "aleiPrefix": "VIES",
- "name": "VIES"
}, - "businessPartner": {
- "names": [
- {
- "type": {
- "name": "VAT Registered Name",
- "technicalKey": "VAT_REGISTERED"
}, - "value": "TESCOMA s.r.o.",
- "language": { }
}
], - "identifiers": [
- {
- "type": {
- "name": "Value added tax identification number",
- "technicalKey": "EU_VAT_ID_CZ"
}, - "value": "CZ46981691",
- "status": {
- "technicalKey": "ACTIVE"
}
}
], - "categories": [ ],
- "addresses": [
- {
- "version": {
- "characterSet": {
- "name": "Latin",
- "technicalKey": "LATIN"
}, - "language": {
- "name": "en",
- "technicalKey": "en"
}
}, - "country": {
- "shortName": "CZ",
- "value": "Czechia"
}, - "administrativeAreas": [ ],
- "postCodes": [
- {
- "value": "760 01",
- "type": {
- "name": "Regular",
- "technicalKey": "REGULAR"
}
}
], - "localities": [
- {
- "value": "Zlín"
}
], - "thoroughfares": [
- {
- "type": {
- "name": "Street",
- "technicalKey": "STREET"
}, - "number": "1",
- "value": "U Tescomy Lužkovice"
}
], - "premises": [ ],
- "postalDeliveryPoints": [ ],
- "types": [
- {
- "name": "VAT Registered Address",
- "technicalKey": "VAT_REGISTERED"
}
], - "formattedAddress": {
- "country": "Czechia",
- "locality": "Zlín",
- "postalCode": "760 01",
- "thoroughfare": "U Tescomy Lužkovice 1"
}
}
], - "formattedSapRecord": {
- "narp": "NO",
- "stceg": "CZ46981691",
- "country": "Czechia",
- "countryCode": "CZ",
- "city": "Zlín",
- "postalCode": "760 01",
- "street1": "U Tescomy Lužkovice",
- "houseNum": "1"
}, - "types": [ ]
}
}