Skip to content

Reference Data Update Consumer (1)

Propagating Reference Data Storage updates into subscribed Storages.

Download OpenAPI description
api-v1.json
api-v1.yaml
Overview
URL

https://www.cdq.ch/team

Michał Malinka

michal.malinka@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/reference-data-update-consumer/api-v1/

Production SOAP

https://api.corporate-data-league.ch/referencedata-update-consumer/soap/v1/

Production

https://api.corporate-data-league.ch/referencedata-update-consumer/

ReferenceData updates

Updates of BusinessPartners from ReferenceData.

Operations

Updates Listening Process

Request

Start updates listening process for a BusinessPartner by provide a ReferenceDataUpdateEvent. WARN: Do not use in production real object updates - this is not creating the fully correct event.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired
typestring(ReferenceDataUpdateEventTypeParam)

Type of the Reference Data Update Event.

Default "REFERENCE_DATA_SOURCE"
Enum"REFERENCE_DATA_SOURCE""STORAGE_DATA_SOURCE"
Example: "REFERENCE_DATA_SOURCE"
storageOwnerOrganizationIdstring

ID of organization that is assigned to storage where this update event originates.

Example: "cdq"
cdqIdstringrequired

ID uniquely identifying a pair of reference business partner and address when type is REFERENCE_DATA_SOURCE.

Example: "CH.UIDR:CHE218608886"
referenceDataSourcestringrequired

Technical key of reference data source when type is REFERENCE_DATA_SOURCE. StorageId:dataSourceId when type is STORAGE_DATA_SOURCE.

Example: "CH_UIDR"
referenceDataSourceIdstring

ID of data source when type is STORAGE_DATA_SOURCE.

Example: "648824a691d8d2503d65103e"
businessPartnerobject(BusinessPartner)required

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

businessPartner.​namesArray of objects(Name)
businessPartner.​legalFormobject(LegalForm)

The legal form of a business partner/type/legal entity is the form it takes in the eyes of the law governing it. The legal form of a company is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).

businessPartner.​identifiersArray of objects(Identifier)
businessPartner.​categoriesArray of objects(BusinessPartnerCategory)
businessPartner.​statusobject(BusinessPartnerStatus)

Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).

businessPartner.​addressesArray of objects(Address)
businessPartner.​externalIdstring(BusinessPartnerExternalId)

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

Example: "The ID managed in the customer's SAP systems."
businessPartner.​profileobject(PartnerProfile)

A business partner profile contains important information about a company, such as its classification, tags, contact details, or minority indicator.

businessPartner.​formattedSapRecordobject(FormattedSapRecord)

Provides business partner and address information in a data structure similar to SAP Business Partner table BUT000 and SAP Business Address Services table ADRC. Field names are equal or very similar to SAP field names in order to simplify field mapping. Data for name and street fields is already split into chunks of max. 35 characters.

businessPartner.​relationsArray of objects(BusinessPartnerRelation)
businessPartner.​bankAccountsArray of objects(BankAccount)
businessPartner.​typesArray of objects(BusinessPartnerType)
businessPartner.​externalContextobject(ExternalContext)

Describe own identifiers of a record (others than just the external Id).

businessPartnerEventobject(BusinessPartnerEvent)required

Updates or changes to Business Partner.

businessPartnerEvent.​affectedPropertiesArray of strings

List of affected properties.

Example: ["NAME_VALUE"]
businessPartnerEvent.​propertyChangesArray of objects(PropertyChange)

List of PropertyChanges.

businessPartnerEvent.​provenancesArray of objects(Provenance)

List of Provenances.

businessPartnerEvent.​updatedBusinessPartnerobject(UpdatedBusinessPartner)

A business partner which contains also contextual information about applied updates.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/reference-data-update-consumer/api-v1/updates/referencedata/referenceDataUpdateEvent \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "type": "REFERENCE_DATA_SOURCE",
    "storageOwnerOrganizationId": "cdq",
    "cdqId": "CH.UIDR:CHE218608886",
    "referenceDataSource": "CH_UIDR",
    "referenceDataSourceId": "648824a691d8d2503d65103e",
    "businessPartner": {
      "names": [
        {
          "shortName": "CDQ AG",
          "type": {
            "url": "https://meta.cdq.com/Business_partner/name/type",
            "name": "Local Name",
            "technicalKey": "LOCAL"
          },
          "value": "Corporate Data Quality AG",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          }
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft",
        "language": {
          "name": "German",
          "technicalKey": "DE"
        },
        "mainAbbreviation": "AG",
        "cdlElfCode": "AG",
        "categories": [
          {
            "name": "Limited Liability Company",
            "shortName": "LLC",
            "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
            "technicalKey": "LIMITED"
          }
        ],
        "url": "https://meta.cdq.com/Business_partner/legal_form",
        "technicalKey": "DE_9866"
      },
      "identifiers": [
        {
          "value": "CHE-218.608.886 HR/MWST",
          "type": {
            "url": "https://meta.cdq.com/Business_partner/identifier/type",
            "name": "CH_VAT_ID",
            "technicalKey": "CH_VAT_ID"
          },
          "status": {
            "name": "ACTIVE",
            "url": "https://meta.cdq.com/Business_partner/identifier/status",
            "technicalKey": "ACTIVE"
          },
          "issuingBody": {
            "name": "Amtsgericht Aachen",
            "shortName": "Amtsgericht Aachen",
            "names": [
              {
                "shortName": "CDQ AG",
                "type": {},
                "value": "Corporate Data Quality AG",
                "language": {}
              }
            ],
            "description": "Amtsgericht Aachen",
            "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
            "technicalKey": "Amtsgericht Aachen",
            "jurisdiction": {
              "country": {
                "shortName": "CH",
                "value": "Switzerland"
              },
              "administrativeAreas": [
                {}
              ]
            },
            "gleifCode": "RA000004",
            "localAuthorityCode": "R3101",
            "externalUrl": "https://www.amtsgericht.de/muenchen"
          }
        }
      ],
      "categories": [
        {
          "name": "Hotel",
          "url": "https://meta.cdq.com/Business_partner/category",
          "technicalKey": "HOTEL"
        }
      ],
      "status": {
        "officialDenotation": "Good Standing",
        "validFrom": "2022-02-26",
        "validUntil": "2022-02-26",
        "type": {
          "name": "In Liquidation",
          "url": "https://meta.cdq.com/Business_partner/status/type",
          "technicalKey": "IN_LIQUIDATION"
        }
      },
      "addresses": [
        {
          "version": {
            "characterSet": {
              "name": "International",
              "technicalKey": "INTERNATIONAL"
            },
            "language": {
              "name": "German",
              "technicalKey": "DE"
            }
          },
          "identifyingName": {
            "value": "John Doe"
          },
          "externalId": "1",
          "metadata": {
            "primaryProvenance": {
              "name": "VIES",
              "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
              "technicalKey": "VIES",
              "cdqId": "VIES:PL8660001429"
            },
            "language": {
              "name": "German",
              "technicalKey": "DE"
            }
          },
          "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",
              "fipsCode": "SZ15",
              "isoCode": "CH-SG",
              "type": {
                "name": "COUNTY",
                "url": "https://meta.cdq.com/Address/administrative_area/type",
                "technicalKey": "COUNTY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "postCodes": [
            "9000"
          ],
          "localities": [
            {
              "type": {
                "name": "City",
                "url": "https://meta.cdq.com/Address/locality/type",
                "technicalKey": "CITY"
              },
              "shortName": "St. Gallen",
              "value": "Sankt Gallen",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "thoroughfares": [
            {
              "type": {
                "name": "Industrial zone",
                "url": "https://meta.cdq.com/Address/thoroughfare/type",
                "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",
                "url": "https://meta.cdq.com/Address/premise/type",
                "technicalKey": "FACTORY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "postalDeliveryPoints": [
            {
              "type": {
                "name": "Mailbox",
                "url": "https://meta.cdq.com/Address/postal_delivery_point/type",
                "technicalKey": "MAILBOX"
              },
              "shortName": "St Gallen, Postfach 460",
              "number": "460",
              "value": "Postfach",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "openingHours": [
            {
              "openingHour": "09:00 AM",
              "closingHour": "05:00 PM",
              "weekday": "Monday"
            }
          ],
          "geographicCoordinates": {
            "latitude": "47.439549",
            "longitude": "9.395275"
          },
          "types": [
            {
              "name": "Legal Address",
              "url": "https://meta.cdq.com/Address/type",
              "technicalKey": "LEGAL_ADDRESS"
            }
          ],
          "formattedAddress": {
            "country": "Switzerland",
            "administrativeArea": "Sankt Gallen",
            "region": "Sankt Gallen",
            "regionCode": "9004",
            "locality": "Sankt Gallen",
            "district": "City center",
            "postalCode": "9000",
            "thoroughfare": "Lukassstrasse",
            "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
            "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
            "mailbox": "Postfach 460",
            "postOfficeBox": "Postfach 460"
          }
        }
      ],
      "externalId": "The ID managed in the customer'\''s SAP systems.",
      "profile": {
        "classifications": [
          {
            "value": "Manufacture of pesticides and other agrochemical products.",
            "code": "20.20Z",
            "level": "primary",
            "type": {
              "name": "NAF 2003",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
              "technicalKey": "NAF_2003"
            }
          }
        ],
        "contactEmails": [
          {
            "value": "developer-portal@cdq.com"
          }
        ],
        "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": "Granted",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/permission_status/url",
                "technicalKey": "GRANTED"
              },
              "activityStatus": {
                "name": "Inactive",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/activity_status/url",
                "technicalKey": "INACTIVE"
              },
              "practiceLocations": [
                {}
              ]
            }
          ]
        },
        "minorityIndicator": {
          "value": "Social enterprise"
        },
        "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"
          }
        ],
        "tags": [
          {
            "value": "Warehouse",
            "type": {
              "technicalKey": "WAREHOUSE"
            }
          }
        ],
        "vatPayerStatus": {
          "publicationDate": "2020-07-21T17:32:28Z",
          "status": {
            "name": "RELIABLE",
            "technicalKey": "VAT_PAYER_STATUS"
          },
          "registrationAuthority": {
            "registrationAuthorityId": "RA000009",
            "registrationAuthorityEntityId": "RA000009",
            "otherRegistrationAuthorityId": "RA000009"
          }
        },
        "websites": [
          {
            "url": "https://cdq.com",
            "type": {
              "name": "Corporate Website",
              "url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
              "technicalKey": "WEBSITE_TYPE_CORPORATE"
            }
          }
        ]
      },
      "formattedSapRecord": {
        "name1": "CDQ AG",
        "name2": "CDQ AG",
        "name3": "CDQ AG",
        "name4": "CDQ AG",
        "nameCo": "Aktiengesellschaft",
        "legalEntity": "Aktiengesellschaft",
        "legalForm": "Aktiengesellschaft",
        "indSector": "NAF",
        "indSectorCode": "NAF",
        "emailAddress": "bp@gmail.com",
        "narp": "Friedrich Nietzsche",
        "stceg": "CHE-218.608.88",
        "stcd1": "CHE-218.608.88",
        "stcd2": "CHE-218.608.88",
        "stcd3": "CHE-218.608.88",
        "stcd4": "CHE-218.608.88",
        "stcd5": "CHE-218.608.88",
        "url": "www.cdq.com",
        "telNumber": "+41 71 571 10 40",
        "country": "Switzerland",
        "countryCode": "CH",
        "region": "Sankt Gallen",
        "regionCodeSap": "9004",
        "regionCode": "9004",
        "county": "Sankt Gallen",
        "countyCode": "9004",
        "township": "Sankt Gallen",
        "townshipCode": "9004",
        "city": "Sankt Gallen",
        "district": "St. Georgen",
        "postalCode": "9000",
        "postalCode3": "9000",
        "street1": "Lukasstraße 4",
        "street2": "Lukasstraße 4",
        "street5": "Lukasstraße 4",
        "houseNum": "4",
        "houseNum2": "4",
        "building": "Office 2",
        "floor": "2",
        "roomnumber": "123",
        "poBoxCountry": "9000",
        "poBoxCity": "9000",
        "poBoxPostalCode": "9000",
        "poBox": "9000",
        "latitude": "47.439549",
        "longitude": "9.395275"
      },
      "relations": [
        {
          "startedAt": "2019-08-31T16:47+00:00",
          "endedAt": "2019-08-31T16:47+00:00",
          "type": {
            "name": "Commercial ultimate",
            "url": "https://meta.cdq.com/Business_partner/relation/type",
            "technicalKey": "COMMERCIAL_ULTIMATE"
          },
          "class": {
            "name": "CDQ Hierarchy",
            "url": "https://meta.cdq.com/Business_partner/relation/class",
            "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
          },
          "startNode": "FR.RC:5664645",
          "endNode": "FR.RC:5664645"
        }
      ],
      "bankAccounts": [
        {
          "internationalBankAccountIdentifier": "CH8800781619278412000",
          "internationalBankIdentifier": "KBSGCH22XXX",
          "nationalBankAccountIdentifier": "619278412000",
          "nationalBankIdentifier": "00781",
          "bank": {
            "name": "Sparda Bank",
            "branch": "Filiale München",
            "address": {
              "localities": [
                {}
              ],
              "country": {
                "shortName": "CH",
                "value": "Switzerland"
              },
              "administrativeAreas": [
                {}
              ],
              "postCodes": [
                "9000"
              ],
              "thoroughfares": [
                {}
              ]
            }
          }
        }
      ],
      "types": [
        {
          "name": "Legal Entity",
          "url": "https://meta.cdq.com/Business_partner/type",
          "technicalKey": "LEGAL_ENTITY"
        }
      ],
      "externalContext": {
        "identifiers": [
          {
            "value": "7250017031",
            "type": {
              "technicalKey": "KUNNR"
            }
          }
        ]
      }
    },
    "businessPartnerEvent": {
      "affectedProperties": [
        "NAME_VALUE"
      ],
      "propertyChanges": [
        {
          "externalIds": [
            {
              "externalId": "123",
              "dataSourceId": "VIES",
              "id": "123",
              "concept": {
                "name": "Address",
                "technicalKey": "ADDRESS"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "characterSet": {
                "name": "International",
                "technicalKey": "INTERNATIONAL"
              }
            }
          ],
          "property": {
            "parentConcept": {
              "name": "Address",
              "technicalKey": "ADDRESS"
            },
            "name": "Minority Indicator Value",
            "technicalKey": "MINORITY_INDICATOR_VALUE",
            "contentSelector": "$.partnerProfile.minorityIndicator.value"
          },
          "newContent": "AAB",
          "previousContent": "AAB",
          "provenance": {
            "name": "VIES",
            "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
            "technicalKey": "VIES",
            "cdqId": "VIES:PL8660001429"
          },
          "changeType": "MODIFIED",
          "changeClassification": "MAJOR",
          "confidenceScore": "0.0",
          "maxConfidenceScore": "1.0"
        }
      ],
      "provenances": [
        {
          "name": "VIES",
          "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
          "technicalKey": "VIES",
          "cdqId": "VIES:PL8660001429"
        }
      ],
      "updatedBusinessPartner": {
        "summary": {
          "createdAt": "2020-08-31T16:47+00:00",
          "tags": [
            "IDENTIFIER_ADDED"
          ],
          "classification": {
            "technicalKey": "MAJOR",
            "reason": "The modified post code has deprecated format."
          }
        },
        "names": [
          {
            "shortName": "CDQ AG",
            "type": {
              "url": "https://meta.cdq.com/Business_partner/name/type",
              "name": "Local Name",
              "technicalKey": "LOCAL"
            },
            "value": "Corporate Data Quality AG",
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "shortName": "CDQ AG",
                "type": {},
                "value": "Corporate Data Quality AG",
                "language": {}
              }
            }
          }
        ],
        "legalForm": {
          "name": "Aktiengesellschaft",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          },
          "mainAbbreviation": "AG",
          "cdlElfCode": "AG",
          "categories": [
            {
              "name": "Limited Liability Company",
              "shortName": "LLC",
              "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
              "technicalKey": "LIMITED"
            }
          ],
          "url": "https://meta.cdq.com/Business_partner/legal_form",
          "technicalKey": "DE_9866",
          "updateAssessment": {
            "action": {
              "technicalKey": "ADDED"
            },
            "classification": {
              "technicalKey": "MAJOR",
              "reason": "The modified post code has deprecated format."
            },
            "provenances": [
              {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429"
              }
            ],
            "modifiedAt": "2020-08-31T16:47+00:00",
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "before": {
              "name": "Aktiengesellschaft",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "mainAbbreviation": "AG",
              "cdlElfCode": "AG",
              "categories": [
                {}
              ],
              "url": "https://meta.cdq.com/Business_partner/legal_form",
              "technicalKey": "DE_9866"
            }
          }
        },
        "identifiers": [
          {
            "value": "CHE-218.608.886 HR/MWST",
            "type": {
              "url": "https://meta.cdq.com/Business_partner/identifier/type",
              "name": "CH_VAT_ID",
              "technicalKey": "CH_VAT_ID"
            },
            "status": {
              "name": "ACTIVE",
              "url": "https://meta.cdq.com/Business_partner/identifier/status",
              "technicalKey": "ACTIVE"
            },
            "issuingBody": {
              "name": "Amtsgericht Aachen",
              "shortName": "Amtsgericht Aachen",
              "names": [
                {}
              ],
              "description": "Amtsgericht Aachen",
              "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
              "technicalKey": "Amtsgericht Aachen",
              "jurisdiction": {
                "country": {},
                "administrativeAreas": [
                  null
                ]
              },
              "gleifCode": "RA000004",
              "localAuthorityCode": "R3101",
              "externalUrl": "https://www.amtsgericht.de/muenchen"
            },
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "value": "CHE-218.608.886 HR/MWST",
                "type": {},
                "status": {},
                "issuingBody": {
                  "names": []
                }
              }
            }
          }
        ],
        "categories": [
          {
            "name": "Hotel",
            "url": "https://meta.cdq.com/Business_partner/category",
            "technicalKey": "HOTEL",
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "name": "Hotel",
                "url": "https://meta.cdq.com/Business_partner/category",
                "technicalKey": "HOTEL"
              }
            }
          }
        ],
        "status": {
          "officialDenotation": "Good Standing",
          "validFrom": "2022-02-26",
          "validUntil": "2022-02-26",
          "type": {
            "name": "In Liquidation",
            "url": "https://meta.cdq.com/Business_partner/status/type",
            "technicalKey": "IN_LIQUIDATION"
          },
          "updateAssessment": {
            "action": {
              "technicalKey": "ADDED"
            },
            "classification": {
              "technicalKey": "MAJOR",
              "reason": "The modified post code has deprecated format."
            },
            "provenances": [
              {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429"
              }
            ],
            "modifiedAt": "2020-08-31T16:47+00:00",
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "before": {
              "officialDenotation": "Good Standing",
              "validFrom": "2022-02-26",
              "validUntil": "2022-02-26",
              "type": {
                "name": "In Liquidation",
                "url": "https://meta.cdq.com/Business_partner/status/type",
                "technicalKey": "IN_LIQUIDATION"
              }
            }
          }
        },
        "addresses": [
          {
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ]
            },
            "version": {
              "characterSet": {
                "name": "International",
                "technicalKey": "INTERNATIONAL"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            },
            "identifyingName": {
              "value": "John Doe"
            },
            "externalId": "1",
            "metadata": {
              "primaryProvenance": {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            },
            "careOf": {
              "value": "CDQ GmbH c/o Product Department"
            },
            "contexts": [
              {
                "value": "Production hall 7, Storage field 8."
              }
            ],
            "country": {
              "shortName": "CH",
              "value": "Switzerland",
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            },
            "administrativeAreas": [
              {
                "value": "Sankt Gallen",
                "shortName": "SG",
                "fipsCode": "SZ15",
                "isoCode": "CH-SG",
                "type": {},
                "language": {},
                "updateAssessment": {
                  "provenances": [],
                  "tags": []
                }
              }
            ],
            "postCodes": [
              {
                "updateAssessment": {
                  "provenances": [],
                  "tags": []
                }
              }
            ],
            "localities": [
              {
                "type": {},
                "shortName": "St. Gallen",
                "value": "Sankt Gallen",
                "language": {},
                "updateAssessment": {
                  "provenances": [],
                  "tags": []
                }
              }
            ],
            "thoroughfares": [
              {
                "type": {},
                "shortName": "Lukasstr. 4",
                "number": "4",
                "value": "Lukasstraße 4",
                "name": "Lukasstraße",
                "direction": "221-bis Baker Street, North",
                "language": {},
                "updateAssessment": {
                  "provenances": [],
                  "tags": []
                }
              }
            ],
            "premises": [
              {
                "value": "Lukasstraße 4",
                "shortName": "Lukasstr. 4",
                "number": "4",
                "type": {},
                "language": {},
                "updateAssessment": {
                  "provenances": [],
                  "tags": []
                }
              }
            ],
            "postalDeliveryPoints": [
              {
                "type": {},
                "shortName": "St Gallen, Postfach 460",
                "number": "460",
                "value": "Postfach",
                "language": {},
                "updateAssessment": {
                  "provenances": [],
                  "tags": []
                }
              }
            ],
            "openingHours": [
              {
                "openingHour": "09:00 AM",
                "closingHour": "05:00 PM",
                "weekday": "Monday"
              }
            ],
            "geographicCoordinates": {
              "latitude": "47.439549",
              "longitude": "9.395275",
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            },
            "types": [
              {
                "name": "Legal Address",
                "url": "https://meta.cdq.com/Address/type",
                "technicalKey": "LEGAL_ADDRESS"
              }
            ]
          }
        ],
        "externalId": "The ID managed in the customer'\''s SAP systems.",
        "profile": {
          "classifications": [
            {
              "value": "Manufacture of pesticides and other agrochemical products.",
              "code": "20.20Z",
              "level": "primary",
              "type": {
                "name": "NAF 2003",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
                "technicalKey": "NAF_2003"
              }
            }
          ],
          "contactEmails": [
            {
              "value": "developer-portal@cdq.com"
            }
          ],
          "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": {},
                "activityStatus": {},
                "practiceLocations": [
                  null
                ]
              }
            ]
          },
          "minorityIndicator": {
            "value": "Social enterprise"
          },
          "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"
            }
          ],
          "tags": [
            {
              "value": "Warehouse",
              "type": {
                "technicalKey": "WAREHOUSE"
              }
            }
          ],
          "vatPayerStatus": {
            "publicationDate": "2020-07-21T17:32:28Z",
            "status": {
              "name": "RELIABLE",
              "technicalKey": "VAT_PAYER_STATUS"
            },
            "registrationAuthority": {
              "registrationAuthorityId": "RA000009",
              "registrationAuthorityEntityId": "RA000009",
              "otherRegistrationAuthorityId": "RA000009"
            }
          },
          "websites": [
            {
              "url": "https://cdq.com",
              "type": {
                "name": "Corporate Website",
                "url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
                "technicalKey": "WEBSITE_TYPE_CORPORATE"
              }
            }
          ]
        },
        "formattedSapRecord": {
          "name1": "CDQ AG",
          "name2": "CDQ AG",
          "name3": "CDQ AG",
          "name4": "CDQ AG",
          "nameCo": "Aktiengesellschaft",
          "legalEntity": "Aktiengesellschaft",
          "legalForm": "Aktiengesellschaft",
          "indSector": "NAF",
          "indSectorCode": "NAF",
          "emailAddress": "bp@gmail.com",
          "narp": "Friedrich Nietzsche",
          "stceg": "CHE-218.608.88",
          "stcd1": "CHE-218.608.88",
          "stcd2": "CHE-218.608.88",
          "stcd3": "CHE-218.608.88",
          "stcd4": "CHE-218.608.88",
          "stcd5": "CHE-218.608.88",
          "url": "www.cdq.com",
          "telNumber": "+41 71 571 10 40",
          "country": "Switzerland",
          "countryCode": "CH",
          "region": "Sankt Gallen",
          "regionCodeSap": "9004",
          "regionCode": "9004",
          "county": "Sankt Gallen",
          "countyCode": "9004",
          "township": "Sankt Gallen",
          "townshipCode": "9004",
          "city": "Sankt Gallen",
          "district": "St. Georgen",
          "postalCode": "9000",
          "postalCode3": "9000",
          "street1": "Lukasstraße 4",
          "street2": "Lukasstraße 4",
          "street5": "Lukasstraße 4",
          "houseNum": "4",
          "houseNum2": "4",
          "building": "Office 2",
          "floor": "2",
          "roomnumber": "123",
          "poBoxCountry": "9000",
          "poBoxCity": "9000",
          "poBoxPostalCode": "9000",
          "poBox": "9000",
          "latitude": "47.439549",
          "longitude": "9.395275"
        },
        "relations": [
          {
            "startedAt": "2019-08-31T16:47+00:00",
            "endedAt": "2019-08-31T16:47+00:00",
            "type": {
              "name": "Commercial ultimate",
              "url": "https://meta.cdq.com/Business_partner/relation/type",
              "technicalKey": "COMMERCIAL_ULTIMATE"
            },
            "class": {
              "name": "CDQ Hierarchy",
              "url": "https://meta.cdq.com/Business_partner/relation/class",
              "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
            },
            "startNode": "FR.RC:5664645",
            "endNode": "FR.RC:5664645",
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "startedAt": "2019-08-31T16:47+00:00",
                "endedAt": "2019-08-31T16:47+00:00",
                "type": {},
                "class": {},
                "startNode": "FR.RC:5664645",
                "endNode": "FR.RC:5664645"
              }
            }
          }
        ],
        "bankAccounts": [
          {
            "internationalBankAccountIdentifier": "CH8800781619278412000",
            "internationalBankIdentifier": "KBSGCH22XXX",
            "nationalBankAccountIdentifier": "619278412000",
            "nationalBankIdentifier": "00781",
            "bank": {
              "name": "Sparda Bank",
              "branch": "Filiale München",
              "address": {
                "localities": [
                  null
                ],
                "country": {},
                "administrativeAreas": [
                  null
                ],
                "postCodes": [
                  null
                ],
                "thoroughfares": [
                  null
                ]
              }
            }
          }
        ],
        "types": [
          {
            "name": "Legal Entity",
            "url": "https://meta.cdq.com/Business_partner/type",
            "technicalKey": "LEGAL_ENTITY"
          }
        ],
        "externalContext": {
          "identifiers": [
            {
              "value": "7250017031",
              "type": {
                "technicalKey": "KUNNR"
              }
            }
          ]
        }
      }
    }
  }'

Responses

OK

Response
No content