Data Mappers

Transform Business PartnersDeprecated

Use a Data Mapper Definition to transform a list of Business Partners into key-value lists.

SecurityapiKey

Request

path Parameters

required

string (DataMapperDefinitionId)

ID of the Data Mapper Definition.

Example: 6440dba32b30176c5917b1b7

Request Body schema: application/json
required

Records

Array of objects (BusinessPartner)

List of Business Partners.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/datamappers/{id}/transformFields

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:23Z",
"modifiedAt": "2024-12-21T01:35:23Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-12-21T01:35:23Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-12-21T01:35:23Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-12-21T01:35:23Z",
"processedAt": "2024-12-21T01:35:23Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-12-21T01:35:23Z",
"validUntil": "2024-12-21T01:35:23Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-12-21T01:35:23Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {"generalLicense": {"professionType": {"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [{"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {"name": null,
"url": null,
"technicalKey": null
},
"activityStatus": {"name": null,
"url": null,
"technicalKey": null
},
"practiceLocations": [null
]
}
]
}
},
"relations": [{"startedAt": "2024-12-21T01:35:23Z",
"endedAt": "2024-12-21T01:35:23Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-12-21T01:35:23Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-12-21T01:35:23Z",
"lastPaymentDate": "2024-12-21T01:35:23Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
]
}

Response samples

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:23Z",
"modifiedAt": "2024-12-21T01:35:23Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-12-21T01:35:23Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-12-21T01:35:23Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-12-21T01:35:23Z",
"processedAt": "2024-12-21T01:35:23Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-12-21T01:35:23Z",
"validUntil": "2024-12-21T01:35:23Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-12-21T01:35:23Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {"generalLicense": {"professionType": {"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [{"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {"name": null,
"url": null,
"technicalKey": null
},
"activityStatus": {"name": null,
"url": null,
"technicalKey": null
},
"practiceLocations": [null
]
}
]
}
},
"relations": [{"startedAt": "2024-12-21T01:35:23Z",
"endedAt": "2024-12-21T01:35:23Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-12-21T01:35:23Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-12-21T01:35:23Z",
"lastPaymentDate": "2024-12-21T01:35:23Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
],
"fieldBusinessPartners": [{"fields": [{"key": "ADDRESS",
"value": "Lukasstrasse 4, 9008 St. Gallen, Switzerland"
}
]
}
]
}

Transform Business Partners

Use a Data Mapper Definition to transform a list of Business Partners into key-value lists.

SecurityapiKey

Request

path Parameters

required

string (DataMapperDefinitionId)

Data Mapper Definition ID.

Example: 6440dba32b30176c5917b1b7

Request Body schema: application/json
required

Records

Array of objects (BusinessPartner)

List of Business Partners.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v4/datamapperdefinitions/{id}/transformFields

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:23Z",
"modifiedAt": "2024-12-21T01:35:23Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-12-21T01:35:23Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-12-21T01:35:23Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-12-21T01:35:23Z",
"processedAt": "2024-12-21T01:35:23Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-12-21T01:35:23Z",
"validUntil": "2024-12-21T01:35:23Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-12-21T01:35:23Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {"generalLicense": {"professionType": {"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [{"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {"name": null,
"url": null,
"technicalKey": null
},
"activityStatus": {"name": null,
"url": null,
"technicalKey": null
},
"practiceLocations": [null
]
}
]
}
},
"relations": [{"startedAt": "2024-12-21T01:35:23Z",
"endedAt": "2024-12-21T01:35:23Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-12-21T01:35:23Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-12-21T01:35:23Z",
"lastPaymentDate": "2024-12-21T01:35:23Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
]
}

Response samples

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:23Z",
"modifiedAt": "2024-12-21T01:35:23Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-12-21T01:35:23Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-12-21T01:35:23Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-12-21T01:35:23Z",
"processedAt": "2024-12-21T01:35:23Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-12-21T01:35:23Z",
"validUntil": "2024-12-21T01:35:23Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-12-21T01:35:23Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {"generalLicense": {"professionType": {"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [{"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {"name": null,
"url": null,
"technicalKey": null
},
"activityStatus": {"name": null,
"url": null,
"technicalKey": null
},
"practiceLocations": [null
]
}
]
}
},
"relations": [{"startedAt": "2024-12-21T01:35:23Z",
"endedAt": "2024-12-21T01:35:23Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-12-21T01:35:23Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-12-21T01:35:23Z",
"lastPaymentDate": "2024-12-21T01:35:23Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
],
"fieldBusinessPartners": [{"fields": [{"key": "ADDRESS",
"value": "Lukasstrasse 4, 9008 St. Gallen, Switzerland"
}
]
}
]
}

Transform RecordsDeprecated

Use a Data Mapper Definition to transform a list of records into Business Partners.

SecurityapiKey

Request

path Parameters

required

string (DataMapperDefinitionId)

ID of the Data Mapper Definition

Example: 6440dba32b30176c5917b1b7

Request Body schema: application/json
required

Records.

businessPartners

Array of strings (BusinessPartnerId)

List of Business Partners.

Example: ["63e635235c06b7396330fe40"]

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/datamappers/{id}/transformBusinessPartners

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartners": ["63e635235c06b7396330fe40"
]
}

Response samples

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:23Z",
"modifiedAt": "2024-12-21T01:35:23Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-12-21T01:35:23Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-12-21T01:35:23Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-12-21T01:35:23Z",
"processedAt": "2024-12-21T01:35:23Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-12-21T01:35:23Z",
"validUntil": "2024-12-21T01:35:23Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-12-21T01:35:23Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {"generalLicense": {"professionType": {"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [{"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {"name": null,
"url": null,
"technicalKey": null
},
"activityStatus": {"name": null,
"url": null,
"technicalKey": null
},
"practiceLocations": [null
]
}
]
}
},
"relations": [{"startedAt": "2024-12-21T01:35:23Z",
"endedAt": "2024-12-21T01:35:23Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-12-21T01:35:23Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-12-21T01:35:23Z",
"lastPaymentDate": "2024-12-21T01:35:23Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
]
}

Transform Records

Use a Data Mapper Definition to transform a list of records into Business Partners.

SecurityapiKey

Request

path Parameters

required

string (DataMapperDefinitionId)

Data Mapper Definition ID.

Example: 6440dba32b30176c5917b1b7

Request Body schema: application/json
required

Records

businessPartners

Array of strings (BusinessPartnerId)

List of Business Partners.

Example: ["63e635235c06b7396330fe40"]

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v4/datamapperdefinitions/{id}/transformBusinessPartners

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartners": ["63e635235c06b7396330fe40"
]
}

Response samples

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:23Z",
"modifiedAt": "2024-12-21T01:35:23Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-12-21T01:35:23Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-12-21T01:35:23Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-12-21T01:35:23Z",
"processedAt": "2024-12-21T01:35:23Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-12-21T01:35:23Z",
"validUntil": "2024-12-21T01:35:23Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-12-21T01:35:23Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {"generalLicense": {"professionType": {"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [{"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {"name": null,
"url": null,
"technicalKey": null
},
"activityStatus": {"name": null,
"url": null,
"technicalKey": null
},
"practiceLocations": [null
]
}
]
}
},
"relations": [{"startedAt": "2024-12-21T01:35:23Z",
"endedAt": "2024-12-21T01:35:23Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-12-21T01:35:23Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-12-21T01:35:23Z",
"lastPaymentDate": "2024-12-21T01:35:23Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
]
}

Data Mappers

Transform Business PartnersDeprecated

path Parameters

Request Body schema: application/jsonrequired

Transform Business Partners

path Parameters

Request Body schema: application/jsonrequired

Transform RecordsDeprecated

path Parameters

Request Body schema: application/jsonrequired

Transform Records

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required