Delete batches of business partners by ID or a combination of DataSource and External ID. Maximum of 1000 business partners are allowed per batch. In case only a data source is provided in the request, all business partners related to this data source will be delete, but the data source itself will not be deleted.
cmd
OK
Created
Unauthorized
Forbidden
Not Found
{- "dataSource": "YOUR_DATASOURCE_ID",
- "businessPartners": [
- {
- "externalId": "BP_EXTERNAL_ID"
}
], - "featuresOn": [
- "DELETE_BY_EXTERNAL_ID"
]
}
{- "numberOfDeletes": "50",
- "numberOfFailures": "0",
- "failures": [
- {
- "id": "63e635235c06b7396330fe40",
- "dataSource": "648824a691d8d2503d65103e",
- "externalId": "The ID managed in the customer's SAP systems.",
- "message": "This record could not be stored due to timeout."
}
]
}
Fetch a Business Partner from this storage
OK
Unauthorized
Forbidden
{- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "648824a691d8d2503d65103e",
- "featuresOn": [
- "FETCH_RECORD"
], - "featuresOff": [
- "FETCH_RECORD"
]
}
{- "businessPartner": {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "disclosed": false,
- "updateMonitoring": true,
- "updateCommercialMonitoring": [
- {
- "type": {
- "technicalKey": "string"
}, - "value": false
}
], - "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "trigger": {
- "processedAt": "string",
- "provenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "type": {
- "name": "string",
- "technicalKey": "string"
}
}, - "jobProcessedAt": "string",
- "processedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": "1"
}
], - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2022-02-26",
- "validUntil": "2022-02-26"
}, - "profile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}, - "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": "NAF 2003",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": "FAX",
- "technicalKey": "string"
}, - "value": "+41 71 571 10 40"
}
], - "websites": [
- {
- "type": {
- "name": "Corporate Website",
- "technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": "WAREHOUSE"
}
}
], - "vatPayerStatus": {
- "publicationDate": "2020-07-21T17:32:28.000Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "string",
- "registrationAuthorityEntityId": "string",
- "otherRegistrationAuthorityId": "string"
}
}
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "url": null,
- "name": null,
- "technicalKey": null
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "addresses": [
- {
- "country": {
- "shortName": null,
- "value": null
}, - "postCodes": [
- null
], - "localities": [
- null
], - "thoroughfares": [
- null
]
}
], - "metadata": {
- "identityLinks": [
- {
- "linkId": null,
- "cdqId": null,
- "addressId": null,
- "externalAddressId": null
}
]
}
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "url": null,
- "name": null,
- "technicalKey": null
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "addresses": [
- {
- "country": {
- "shortName": null,
- "value": null
}, - "postCodes": [
- null
], - "localities": [
- null
], - "thoroughfares": [
- null
]
}
], - "metadata": {
- "identityLinks": [
- {
- "linkId": null,
- "cdqId": null,
- "addressId": null,
- "externalAddressId": null
}
]
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "1",
- "cdqId": "string",
- "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": "St. Gallen",
- "type": null,
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postCodes": [
- {
- "value": "9000",
- "type": {
- "name": "Regular",
- "technicalKey": "REGULAR"
}
}
], - "localities": [
- {
- "type": {
- "name": "City",
- "technicalKey": "CITY"
}, - "shortName": "St. Gallen",
- "value": "Sankt Gallen",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": "Industrial zone",
- "technicalKey": "INDUSTRIAL_ZONE"
}, - "shortName": "Lukasstr. 4",
- "number": "4",
- "value": "Lukasstraße 4",
- "name": "Lukasstraße",
- "direction": "221-bis Baker Street, North",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "premises": [
- {
- "value": "Lukasstraße 4",
- "shortName": "Lukasstr. 4",
- "number": "4",
- "type": {
- "name": "Factory",
- "technicalKey": "FACTORY"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": "Mailbox",
- "technicalKey": "MAILBOX"
}, - "shortName": "St Gallen, Postfach 460",
- "number": "460",
- "value": "Postfach",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": "Legal Address",
- "technicalKey": "LEGAL_ADDRESS"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2020-08-31T16:47+00:00",
- "lastPaymentDate": "2020-08-31T16:47+00:00",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": "KUNNR"
}
}
]
}
}, - "status": "string",
- "message": "string"
}
Lookup a Business Partner in this storage.
cmd
OK
Unauthorized
Forbidden
Not Found
{- "matchingThreshold": 0,
- "pageSize": 10,
- "page": 0,
- "dataSources": [
- "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""
], - "businessPartner": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "record": "string",
- "names": [
- {
- "value": "Corporate Data Quality AG"
}
], - "identifiers": [
- {
- "value": "CHE-218.608.886 HR/MWST",
- "type": {
- "technicalKey": "ABN_AU"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft"
}, - "addresses": [
- {
- "country": {
- "shortName": "CH"
}, - "administrativeAreas": [
- {
- "value": "Sankt Gallen"
}
], - "localities": [
- {
- "value": "Sankt Gallen"
}
], - "postCodes": [
- {
- "value": "9000"
}
], - "thoroughfares": [
- {
- "value": "Lukasstraße 4",
- "number": "4"
}
]
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": "KUNNR"
}
}
]
}, - "profile": {
- "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": "WAREHOUSE"
}
}
]
}
}, - "featuresOn": [
- "FETCH_RECORD"
], - "featuresOff": [
- "FETCH_RECORD"
]
}
{- "pageSize": 0,
- "total": 0,
- "page": 0,
- "values": [
- {
- "businessPartner": {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "disclosed": false,
- "updateMonitoring": true,
- "updateCommercialMonitoring": [
- {
- "type": {
- "technicalKey": "string"
}, - "value": false
}
], - "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": null,
- "technicalKey": null
}, - "trigger": {
- "processedAt": null,
- "provenance": null,
- "type": null
}, - "jobProcessedAt": "string",
- "processedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": "1"
}
], - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2022-02-26",
- "validUntil": "2022-02-26"
}, - "profile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}, - "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "+41 71 571 10 40"
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": null
}
}
], - "vatPayerStatus": {
- "publicationDate": "2020-07-21T17:32:28.000Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "string",
- "registrationAuthorityEntityId": "string",
- "otherRegistrationAuthorityId": "string"
}
}
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
], - "metadata": {
- "identityLinks": [ ]
}
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
], - "metadata": {
- "identityLinks": [ ]
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "1",
- "cdqId": "string",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": null,
- "type": null,
- "language": null
}
], - "postCodes": [
- {
- "value": null,
- "type": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null
}
], - "premises": [
- {
- "value": null,
- "shortName": null,
- "number": null,
- "type": null,
- "language": null
}
], - "postalDeliveryPoints": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "language": null
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "metadata": {
- "primaryProvenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2020-08-31T16:47+00:00",
- "lastPaymentDate": "2020-08-31T16:47+00:00",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": null
}
}
]
}
}, - "matchingProfile": {
- "matchingScores": {
- "overall": {
- "classification": {
- "technicalKey": "string",
- "name": "string"
}, - "value": 0
}, - "businessPartner": {
- "classification": {
- "technicalKey": "string",
- "name": "string"
}, - "value": 0
}, - "address": {
- "classification": {
- "technicalKey": "string",
- "name": "string"
}, - "value": 0
}
}
}
}
], - "debugInfo": {
- "features": [
- {
- "feature": "string",
- "active": true
}
], - "request": {
- "matchingThreshold": 0,
- "pageSize": 10,
- "page": 0,
- "dataSources": [
- "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""
], - "businessPartner": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "record": "string",
- "names": [
- {
- "value": "Corporate Data Quality AG"
}
], - "identifiers": [
- {
- "value": "CHE-218.608.886 HR/MWST",
- "type": {
- "technicalKey": "ABN_AU"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft"
}, - "addresses": [
- {
- "country": {
- "shortName": "CH"
}, - "administrativeAreas": [
- {
- "value": null
}
], - "localities": [
- {
- "value": null
}
], - "postCodes": [
- {
- "value": null
}
], - "thoroughfares": [
- {
- "value": null,
- "number": null
}
]
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": null
}
}
]
}, - "profile": {
- "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": null
}
}
]
}
}, - "featuresOn": [
- "FETCH_RECORD"
], - "featuresOff": [
- "FETCH_RECORD"
]
}
}
}
{- "job": {
- "id": "string",
- "createdBy": "string",
- "createdAt": "string",
- "modifiedAt": "string",
- "progress": 0,
- "status": "RUNNING",
- "statusMessage": "string",
- "enable": true,
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceId": "648824a691d8d2503d65103e",
- "countryShortName": "CH"
}, - "status": "string"
}
Get random Business Partners from this storage
OK
Unauthorized
Forbidden
{- "limit": 0,
- "values": [
- {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "disclosed": false,
- "updateMonitoring": true,
- "updateCommercialMonitoring": [
- {
- "type": {
- "technicalKey": "string"
}, - "value": false
}
], - "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "trigger": {
- "processedAt": "string",
- "provenance": {
- "name": null,
- "technicalKey": null,
- "cdqId": null
}, - "type": {
- "name": null,
- "technicalKey": null
}
}, - "jobProcessedAt": "string",
- "processedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": "1"
}
], - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2022-02-26",
- "validUntil": "2022-02-26"
}, - "profile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}, - "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": "NAF 2003",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": "FAX",
- "technicalKey": "string"
}, - "value": "+41 71 571 10 40"
}
], - "websites": [
- {
- "type": {
- "name": "Corporate Website",
- "technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": "WAREHOUSE"
}
}
], - "vatPayerStatus": {
- "publicationDate": "2020-07-21T17:32:28.000Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "string",
- "registrationAuthorityEntityId": "string",
- "otherRegistrationAuthorityId": "string"
}
}
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
], - "metadata": {
- "identityLinks": [
- null
]
}
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
], - "metadata": {
- "identityLinks": [
- null
]
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "1",
- "cdqId": "string",
- "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": "St. Gallen",
- "type": 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",
- "technicalKey": "LEGAL_ADDRESS"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2020-08-31T16:47+00:00",
- "lastPaymentDate": "2020-08-31T16:47+00:00",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": "KUNNR"
}
}
]
}
}
]
}
OK
{- "id": "63e635235c06b7396330fe40",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "disclosed": false,
- "updateMonitoring": true,
- "updateCommercialMonitoring": [
- {
- "type": {
- "technicalKey": "string"
}, - "value": false
}
], - "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "trigger": {
- "processedAt": "string",
- "provenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "type": {
- "name": "string",
- "technicalKey": "string"
}
}, - "jobProcessedAt": "string",
- "processedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": "1"
}
], - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2022-02-26",
- "validUntil": "2022-02-26"
}, - "profile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}, - "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": "NAF 2003",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": "FAX",
- "technicalKey": "string"
}, - "value": "+41 71 571 10 40"
}
], - "websites": [
- {
- "type": {
- "name": "Corporate Website",
- "technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": "WAREHOUSE"
}
}
], - "vatPayerStatus": {
- "publicationDate": "2020-07-21T17:32:28.000Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "string",
- "registrationAuthorityEntityId": "string",
- "otherRegistrationAuthorityId": "string"
}
}
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "addresses": [
- {
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "postCodes": [
- {
- "value": null,
- "type": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null
}
]
}
], - "metadata": {
- "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
]
}
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "addresses": [
- {
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "postCodes": [
- {
- "value": null,
- "type": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null
}
]
}
], - "metadata": {
- "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
]
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "1",
- "cdqId": "string",
- "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": "St. Gallen",
- "type": null,
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postCodes": [
- {
- "value": "9000",
- "type": {
- "name": "Regular",
- "technicalKey": "REGULAR"
}
}
], - "localities": [
- {
- "type": {
- "name": "City",
- "technicalKey": "CITY"
}, - "shortName": "St. Gallen",
- "value": "Sankt Gallen",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": "Industrial zone",
- "technicalKey": "INDUSTRIAL_ZONE"
}, - "shortName": "Lukasstr. 4",
- "number": "4",
- "value": "Lukasstraße 4",
- "name": "Lukasstraße",
- "direction": "221-bis Baker Street, North",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "premises": [
- {
- "value": "Lukasstraße 4",
- "shortName": "Lukasstr. 4",
- "number": "4",
- "type": {
- "name": "Factory",
- "technicalKey": "FACTORY"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": "Mailbox",
- "technicalKey": "MAILBOX"
}, - "shortName": "St Gallen, Postfach 460",
- "number": "460",
- "value": "Postfach",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": "Legal Address",
- "technicalKey": "LEGAL_ADDRESS"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2020-08-31T16:47+00:00",
- "lastPaymentDate": "2020-08-31T16:47+00:00",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": "KUNNR"
}
}
]
}
}
OK
Bad Request
Unauthorized
{- "startAfter": "string",
- "limit": 0,
- "total": 0,
- "values": [
- {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "disclosed": false,
- "updateMonitoring": true,
- "updateCommercialMonitoring": [
- {
- "type": {
- "technicalKey": "string"
}, - "value": false
}
], - "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "trigger": {
- "processedAt": "string",
- "provenance": {
- "name": null,
- "technicalKey": null,
- "cdqId": null
}, - "type": {
- "name": null,
- "technicalKey": null
}
}, - "jobProcessedAt": "string",
- "processedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": "1"
}
], - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2022-02-26",
- "validUntil": "2022-02-26"
}, - "profile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}, - "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": "NAF 2003",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": "FAX",
- "technicalKey": "string"
}, - "value": "+41 71 571 10 40"
}
], - "websites": [
- {
- "type": {
- "name": "Corporate Website",
- "technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": "WAREHOUSE"
}
}
], - "vatPayerStatus": {
- "publicationDate": "2020-07-21T17:32:28.000Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "string",
- "registrationAuthorityEntityId": "string",
- "otherRegistrationAuthorityId": "string"
}
}
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
], - "metadata": {
- "identityLinks": [
- null
]
}
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
], - "metadata": {
- "identityLinks": [
- null
]
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "1",
- "cdqId": "string",
- "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": "St. Gallen",
- "type": 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",
- "technicalKey": "LEGAL_ADDRESS"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2020-08-31T16:47+00:00",
- "lastPaymentDate": "2020-08-31T16:47+00:00",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": "KUNNR"
}
}
]
}
}
], - "nextStartAfter": "string"
}
Example Response:
{
"values": [
{
"businessPartner": {
"id": "123456",
"externalId": "EXTID-86",
...,
"record": "{<JSON>}"
},
"provenances": [
{
"name": "Supplier Gateway",
"technicalKey": "SGW"
}
],
"changeSet": [
{
"modifiedAt": "2007-08-31T16:47",
"propertyChanges": [
{
"newContent": "AAB",
"previousContent": "XYZ",
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"provenance": {
"name": "Supplier Gateway",
"technicalKey": "SGW"
},
"property": {
"name": "Minority Indicator Value",
"contentSelector": "$.profile.minorityIndicator.value",
"technicalKey": "MINORITY_INDICATOR_VALUE"
"parentConcept": {
"name": "Minority Indicator",
"technicalKey": "MINORITY_INDICATOR"
}
}
}
],
"provenances": [
{
"name": "Supplier Gateway",
"technicalKey": "SGW"
}
]
}
]
}
]
}
In typed concepts, like Name, Identifier or Premise, type.technicalKey and any non-empty property are required to be filled in order to monitor updates.
The following limits for updates calculated per concepts is applied:
$.addresses.administrativeAreas
: up to 5 sub concept levels supported$.addresses.localities
: up to 5 sub concept levels supported$.addresses.postCodes
: up to 3 sub concepts supported$.addresses.postalDeliveryPoints
: up to 3 sub concepts supported$.addresses.thoroughfares
: up to 3 sub concepts supported$.addresses.premises
: up to 6 sub concepts supportedOK
{- "limit": 0,
- "total": 0,
- "startAfter": "string",
- "nextStartAfter": "string",
- "values": [
- {
- "businessPartnerId": "string",
- "externalBusinessPartnerId": "string",
- "changeSets": [
- {
- "modifiedAt": "2007-08-31T16:47+00:00",
- "propertyChanges": [
- {
- "externalIds": [
- null
], - "property": {
- "parentConcept": null,
- "name": null,
- "technicalKey": null,
- "contentSelector": null,
- "instanceSelectors": [ ]
}, - "newContent": "AAB",
- "previousContent": "AAB",
- "provenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}, - "changeType": "MODIFIED",
- "changeClassification": "MAJOR",
- "confidenceScore": "0.0",
- "maxConfidenceScore": "1.0"
}
], - "provenances": [
- {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}
]
}
], - "businessPartner": {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "disclosed": false,
- "updateMonitoring": true,
- "updateCommercialMonitoring": [
- {
- "type": {
- "technicalKey": "string"
}, - "value": false
}
], - "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": null,
- "technicalKey": null
}, - "trigger": {
- "processedAt": null,
- "provenance": null,
- "type": null
}, - "jobProcessedAt": "string",
- "processedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": "1"
}
], - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2022-02-26",
- "validUntil": "2022-02-26"
}, - "profile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}, - "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "+41 71 571 10 40"
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": null
}
}
], - "vatPayerStatus": {
- "publicationDate": "2020-07-21T17:32:28.000Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "string",
- "registrationAuthorityEntityId": "string",
- "otherRegistrationAuthorityId": "string"
}
}
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
], - "metadata": {
- "identityLinks": [ ]
}
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
], - "metadata": {
- "identityLinks": [ ]
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "1",
- "cdqId": "string",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": null,
- "type": null,
- "language": null
}
], - "postCodes": [
- {
- "value": null,
- "type": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null
}
], - "premises": [
- {
- "value": null,
- "shortName": null,
- "number": null,
- "type": null,
- "language": null
}
], - "postalDeliveryPoints": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "language": null
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "metadata": {
- "primaryProvenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2020-08-31T16:47+00:00",
- "lastPaymentDate": "2020-08-31T16:47+00:00",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": null
}
}
]
}
}, - "storageBusinessPartner": {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "disclosed": false,
- "updateMonitoring": true,
- "updateCommercialMonitoring": [
- {
- "type": {
- "technicalKey": "string"
}, - "value": false
}
], - "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": null,
- "technicalKey": null
}, - "trigger": {
- "processedAt": null,
- "provenance": null,
- "type": null
}, - "jobProcessedAt": "string",
- "processedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": "1"
}
], - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2022-02-26",
- "validUntil": "2022-02-26"
}, - "profile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}, - "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "+41 71 571 10 40"
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": null
}
}
], - "vatPayerStatus": {
- "publicationDate": "2020-07-21T17:32:28.000Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "string",
- "registrationAuthorityEntityId": "string",
- "otherRegistrationAuthorityId": "string"
}
}
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
], - "metadata": {
- "identityLinks": [ ]
}
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
], - "metadata": {
- "identityLinks": [ ]
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "1",
- "cdqId": "string",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": null,
- "type": null,
- "language": null
}
], - "postCodes": [
- {
- "value": null,
- "type": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null
}
], - "premises": [
- {
- "value": null,
- "shortName": null,
- "number": null,
- "type": null,
- "language": null
}
], - "postalDeliveryPoints": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "language": null
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "metadata": {
- "primaryProvenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2020-08-31T16:47+00:00",
- "lastPaymentDate": "2020-08-31T16:47+00:00",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": null
}
}
]
}
}, - "provenances": [
- {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}
]
}
]
}
To toggle update monitoring on multiple BusinessPartners, the permission can be changed in two ways:
After the job is finished, the following actions are taken for business partners which match the dataSourceId and countryShortName criteria:
For toggling via a list of Business Partners, identified by their ID, please go to Toggle Update Monitoring of Business Partners.
OK
The sent request is malformed.
{- "enable": true,
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "dataSourceId": "648824a691d8d2503d65103e",
- "countryShortName": "CH"
}
{- "id": "string",
- "createdBy": "string",
- "createdAt": "string",
- "modifiedAt": "string",
- "progress": 0,
- "status": "RUNNING",
- "statusMessage": "string",
- "enable": true,
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceId": "648824a691d8d2503d65103e",
- "countryShortName": "CH"
}
To toggle update monitoring on multiple BusinessPartners, the permission can be changed via a list of Business Partners, identified by their ID.
After the job is finished, the following actions are taken for business partners which match the businessPartnerIds criteria:
For toggling a complete Data Source or for a certain Country of a Data Source, please go to Start Toggle Update Monitoring Job.
OK
{- "enable": true,
- "businessPartnerIds": [
- "string"
]
}
To un-/disclose multiple BusinessPartners, the disclosure can be changed in three ways:
Any other combination may result in a Bad Reqeust.
For more details, you can read about Sharing Scopes.