Lookup Business Partner

Knowledge Base

Getting started

Developer Guidelines

Articles

Instructions

Tutorials

API Catalogue

Bankaccount Data API

Case Management API

Data Clinic API

Data Compliance API

Data Curation API

Data Exchange API

Quickstart

Resources

Data Exchange API

Analytics

Business Partner Storages

Business Partners

post

Delete Business Partners

get

List Business Partners

post

Lookup Business Partner

get

Poll Toggle Update Monitoring Job

get

Read Business Partner

post

Start a Toggle Update Monitoring Job

put

Toggle Business Partners Update Monitoring

put

Upsert Business Partners

Data Matching API

Data Validation API

Email Analysis API

Knowledge Graph API

Metadata API

Organization Management API

Product Identification API

Reference Data API

Vendor Extensions

Salesforce API

SAP DQM API

SAP ODM API

SAP BN API

Lookup Business PartnerWSDL

Lookup a Business Partner in provided storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

cmd

required

object

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.

Responses

200

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/storages/{storageId}/businesspartners/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": "Administrative Area"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "ABN_AU"
}
}
],
"legalForm": {"value": "Administrative Area"
},
"address": {"thoroughfares": [{"value": "Lukasstraße 4",
"number": "4"
}
],
"localities": [{"value": "Administrative Area"
}
],
"administrativeAreas": {"value": "Administrative Area"
},
"postCode": {"value": "Administrative Area"
},
"country": {"value": "Administrative Area"
}
}
}
}

Response samples

application/json

{"pageSize": "100",
"totals": "67",
"page": "1",
"values": [{"cdqId": "VIES:PL8660001429",
"debugInfo": {"features": [{"feature": "TRANSFORM_RECORD",
"active": "true"
}
],
"request": {"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": null
}
],
"identifiers": [{"value": null,
"type": { }
}
],
"legalForm": {"value": "Administrative Area"
},
"address": {"thoroughfares": [{ }
],
"localities": [null
],
"administrativeAreas": {"value": null
},
"postCode": {"value": null
},
"country": {"value": null
}
}
}
},
"cureatedRequest": {"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [{"value": null
}
],
"identifiers": [{"value": null,
"type": { }
}
],
"legalForm": {"value": "Administrative Area"
},
"address": {"thoroughfares": [{ }
],
"localities": [null
],
"administrativeAreas": {"value": null
},
"postCode": {"value": null
},
"country": {"value": null
}
}
}
}
},
"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"id": "63e635235c06b7396330fe40",
"names": [{"details": "Marketing department",
"language": "DE",
"shortname": "CDQ AG",
"type": "LOCAL",
"value": "Corporate Data Quality AG"
}
],
"identifiers": [{"type": "CH_VAT_ID",
"value": "CHE-218.608.886 HR/MWST"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form"
},
"classifications": [{"code": "20.20Z",
"label": "NAF 2003",
"type": "NAF 2003"
}
],
"status": {"explanations": ["No errors have been found"
],
"recordStatus": "ACCEPTED"
},
"address": {"id": "0",
"externalId": "1",
"addressTypes": ["LEGAL_ADDRESS"
],
"careOf": "CDQ GmbH c/o Product Department",
"context": ["Production hall 7, Storage field 8."
],
"country": {"shortname": "CH",
"value": "Switzerland"
},
"administrativeArea": {"value": "Sankt Gallen"
},
"postCode": {"value": "9000",
"type": "REGULAR"
},
"locality": {"value": "Sankt Gallen",
"type": "CITY"
},
"thoroughfare": {"number": "4",
"type": "INDUSTRIAL_ZONE",
"value": "Lukasstraße 4"
},
"premise": {"number": "4",
"shortname": "Lukasstr. 4",
"technicalKey": "FACTORY",
"type": "FACTORY",
"value": "Lukasstraße 4"
},
"postalDeliveryPoint": {"number": "460",
"type": "MAILBOX",
"value": "Postfach"
},
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"district": "City center",
"locality": "Sankt Gallen",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"mailbox": "Postfach 460",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"postOfficeBox": "Postfach 460"
},
"results": {"curationResult": {"accuracyIndicator": "5",
"changes": [null
],
"curatedAddress": { },
"curationLevel": "LEVEL_4",
"requestSimilarity": {"geoCoordinates": null,
"locality": null,
"overall": null,
"postCode": null,
"thoroughfare": null
},
"response": {"message": null,
"status": null,
"timestamp": null
}
},
"goldenRecordGenerationResult": {"explanations": [null
],
"goldenRecord": {"id": null,
"disclosed": null,
"names": [ ],
"legalForm": null,
"identifiers": [ ],
"categories": [ ],
"classifications": [ ],
"companyStatus": null,
"status": null,
"results": null,
"addresses": [ ],
"externalId": null,
"dataSource": null,
"record": null
},
"originalBusinessPartner": {"id": null,
"disclosed": null,
"names": [ ],
"legalForm": null,
"identifiers": [ ],
"categories": [ ],
"classifications": [ ],
"companyStatus": null,
"status": null,
"results": null,
"addresses": [ ],
"externalId": null,
"dataSource": null,
"record": null
},
"originalDataDefects": [null
],
"referenceBusinesspartners": [null
],
"remainingDataDefects": [null
]
},
"lookupResults": {"lookupMatches": [null
]
},
"validationResult": {"dataDefects": [null
],
"fixProposals": [null
]
}
}
}
},
"matchingScore": "0.9",
"addressMatchingScore": "0.9",
"businessPartnerMatchingScore": "0.9",
"matchingExplanation": "{'BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'}"
}
]
}

Lookup Business PartnerWSDL

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required