Business Partner

Everything about Business Partners.

Match Business Partners

Matches the given Business Partners against the given data matching definition.

SecurityapiKey

Request

Request Body schema: application/json
required

required	Array of objects (BusinessPartner) [ 1 .. 1000 ] items List of Business Partners to be matched.
dataMatchingDefinitionId	string (DataMatchingDefinitionId) Id of the data matching definition. Example: "6461e6113b1865304b3038b6"
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.

Responses

200

400

The sent request is malformed.

post/businesspartners/match

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"candidates": [{"id": "63e635235c06b7396330fe40",
"names": [{"details": "Corporate Data Quality AG - Marketing Department",
"language": "German",
"shortName": "CDQ AG",
"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form"
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen"
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
},
"address": {"externalId": "1",
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
}
}
],
"postCode": {"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
},
"localities": [{"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type",
"technicalKey": "CITY"
},
"shortName": "St. Gallen",
"value": "Sankt Gallen"
}
],
"thoroughfares": [{"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type",
"technicalKey": "INDUSTRIAL_ZONE"
},
"shortName": "Lukasstr. 4",
"number": "4",
"direction": "221-bis Baker Street, North",
"value": "Lukasstraße 4"
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type",
"technicalKey": "FACTORY"
}
}
],
"postalDeliveryPoint": {"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type",
"technicalKey": "MAILBOX"
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach"
}
},
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "Internal customers",
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
}
],
"pattern": {"id": "63e635235c06b7396330fe40",
"names": [{"details": "Corporate Data Quality AG - Marketing Department",
"language": "German",
"shortName": "CDQ AG",
"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form"
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen"
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
},
"address": {"externalId": "1",
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
}
}
],
"postCode": {"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
},
"localities": [{"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type",
"technicalKey": "CITY"
},
"shortName": "St. Gallen",
"value": "Sankt Gallen"
}
],
"thoroughfares": [{"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type",
"technicalKey": "INDUSTRIAL_ZONE"
},
"shortName": "Lukasstr. 4",
"number": "4",
"direction": "221-bis Baker Street, North",
"value": "Lukasstraße 4"
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type",
"technicalKey": "FACTORY"
}
}
],
"postalDeliveryPoint": {"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type",
"technicalKey": "MAILBOX"
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach"
}
},
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "Internal customers",
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
},
"dataMatchingDefinitionId": "6461e6113b1865304b3038b6"
}

Response samples

application/json

{"matchingProfiles": [{"externalId": "The ID managed in the customer's SAP systems.",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
}
}
]
}

Business Partner

Match Business Partners

Request Body schema: application/jsonrequired

Request Body schema: application/json
required