Business Partners

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 deleted, but the data source itself will not be deleted.

Deprecated. Please use higher versions.

Read a page of business partners from the storage.

Lookup a Business Partner in provided storage.

Poll endpoint for a job created in POST toggleUpdateMonitoringJobs.

Deprecated. Please use higher versions.

Read a single Business Partner from the storage.

To toggle update monitoring on multiple BusinessPartners, the permission can be changed in two ways:

1. A complete Data Source identified by the parameter 'dataSourceId'
2. Or for a certain Country of a Data Source. This requires both parameters 'dataSourceId' and 'countryShortName' to be set

After the job is finished, the following actions are taken for Business Partners which match the dataSourceId and countryShortName criteria:

• businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable
• if enable is true then:
  • an attempt is taken to find Business Partner in all configured update monitors for non-commercial reference data sources and links are created if matches are found via defined linkage strategies
  • if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to Business Partner updates
• if enable is false then:
  • all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed
  • updates are no more propagated for this Business Partner
  • linkage is not performed for any non-commercial reference data source

For toggling via a list of Business Partners, identified by their ID, please go to Toggle Update Monitoring of Business Partners.

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:

• businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable
• if enable is true then:
  • an attempt is taken to find Business Partner in all configured update monitors for non-commercial reference data sources and links are created if matches are found via defined linkage strategies
  • if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to Business Partner updates
• if enable is false then:
  • all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed
  • updates are no more propagated for this Business Partner
  • linkage is not performed for any non-commercial reference data source

For toggling a complete Data Source or for a certain Country of a Data Source, please go to Start Toggle Update Monitoring Job.

Upsert Business Partners in a Business Partner storage in batches. Maximum of 1000 Business Partners are allowed per batch.

If no data source (via field: dataSource) is provided and the storage has only one, then this data source will be used/set. Other options are to provide an existing data source in the request, which will then be taken for all the Business Partner or to provide a data source for each Business Partner individually.

In the following cases an API error will be thrown:

1. given data source in the Request or the BusinessPartner is unknown
2. no data source given and more than one data source is attached to the storage

To start upserting Business Partners into a storage, use the following request.

PUT https://api.corporate-data-league.ch/data-exchange/rest/v4/storages/{YOUR STORAGE ID}/businesspartners
{
  "dataSource": "{YOUR DATA SOURCE}",
  "featuresOn": ["UPSERT_BY_EXTERNAL_ID"],
  "businessPartners": [
   {
     "externalId": "123",
     "record": "{\"MyId\":\"123\", \"City\":\"St. Gallen\"}",
     "names": [
       {
         "value": "CDQ AG",
         "type": "BUSINESS_PARTNER_NAME_TYPE_LOCAL"
       }
     ],
     "addresses": [{
       "thoroughfare": {
         "value": "Lukasstrasse 4"
       },
       "postCode": {
         "value": "9008"
       },
       "locality": {
         "value": "St. Gallen"
       },
       "country": {
         "shortname": "CH"
       }
     }]
   }]
}'

The response is shown below.

{
   "numberOfInserts": "1",
   "numberOfUpdates": "0",
}

If there is no name typed LOCAL in businessPartner.names and exists any name with empty type or not filled type.technicalKey, it becomes name of type LOCAL.

Warn: in order to support multiple data sources, include dataSource into the request, either in $.dataSource or $.businessPartners[*].dataSource. Otherwise, multiple data sources with no selection of data source will lead to "No DataSource was provided for the given Business Partners and the storage has more than one attached to it." exception.

Limits

Business Partner and Address fields have defined array size limits