Business Partners

Everything about Business Partners

Create Supplier Gateway Record

SecurityapiKey
Request
Request Body schema: application/json
required
object (SupplierGatewayCreateBody)
Responses
200

successful operation

post/sgw/businesspartners
Request samples
application/json
{
  • "supplierGateway": {
    }
}
Response samples
{
  • "Code": "string",
  • "Message": "string",
  • "Supplier": {
    }
}

Fetch Business Partner WSDL

Fetch business partner by CDQ-ID

SecurityapiKey
Request
header Parameters
X-DNB-PASSWORD
string
Deprecated

Credentials are now stored in Data Source Settings in Cloud Apps.

X-DNB-USER
string
Deprecated

Credentials are now stored in Data Source Settings in Cloud Apps.

Request Body schema: application/json
required
cdqId
required
string

CDQ ID for businesspartner and address

configurationId
string (ReferenceDataFetchConfigurationId)

Configuration Id used to set up fetch. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):

  • screeningMatchingThreshold
  • featuresOn
  • featuresOff
featuresOff
Array of strings (BusinessPartnerFetchFeaturesDesc)

The features switched off in the business partner fetch

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Commercial Ultimate from BvD

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use DNB Master Data Basic to fetch record.

ACTIVATE_MASTER_DATA_EXTENDED

Use DNB Master Data Extended to fetch record.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

featuresOn
Array of strings (BusinessPartnerFetchFeaturesDesc)

The features with which the business partner fetch should be called

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Commercial Ultimate from BvD

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use DNB Master Data Basic to fetch record.

ACTIVATE_MASTER_DATA_EXTENDED

Use DNB Master Data Extended to fetch record.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

outboundMapping
string (OutboundMapping)
Deprecated

If outboundMapping is set, business partner is transformed to the desired mapped record in a key-value representation.

Avaliable mappings:

  • SAP
screeningMatchingThreshold
number

The matching threshold for compliance screening. If set and a fetch result is not above threshold, it will not be returned.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/fetch
Request samples
application/json
{
  • "cdqId": "VIES:CZ46981691"
}
Response samples
application/json
{
  • "cdqId": "VIES:CZ46981691",
  • "dataSource": "VIES",
  • "businessPartner": {
    }
}

Fetch Business Partner Relations WSDL

Fetch business partner Relations by CDQ-ID

SecurityapiKey
Request
Request Body schema: application/json
required
cdqId
string

CDQ ID for businesspartner and address

classTechnicalKey
string

Filter by class technical key

endedAfter
string

Find relations which endedAt is after given date

endedBefore
string

Find relations which endedAt is before given date

limit
integer <int32>
startAfter
string
startedAfter
string

Find relations which startedAt is after given date

startedBefore
string

Find relations which startedAt is before given date

typeTechnicalKey
string

Filter by type

Responses
200

OK

post/v3/businesspartners/fetchrelations
Request samples
application/json
{
  • "cdqId": "LEI:CZ46981691"
}
Response samples
application/json
{
  • "nextStartAfter": "string",
  • "limit": 0,
  • "total": 0,
  • "values": [
    ]
}

Fetch Business Partners in Batch WSDL

Fetch multiple business partners by multiple CDQ-ID

SecurityapiKey
Request
header Parameters
X-DNB-PASSWORD
string
Deprecated

Credentials are now stored in Data Source Settings in Cloud Apps.

X-DNB-USER
string
Deprecated

Credentials are now stored in Data Source Settings in Cloud Apps.

Request Body schema: application/json
required
cdqIds
Array of strings
featuresOff
Array of strings (BusinessPartnerFetchFeaturesDesc)

The features switched off in the business partner fetch

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Commercial Ultimate from BvD

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use DNB Master Data Basic to fetch record.

ACTIVATE_MASTER_DATA_EXTENDED

Use DNB Master Data Extended to fetch record.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

featuresOn
Array of strings (BusinessPartnerFetchFeaturesDesc)

The features with which the business partner fetch should be called

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Commercial Ultimate from BvD

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use DNB Master Data Basic to fetch record.

ACTIVATE_MASTER_DATA_EXTENDED

Use DNB Master Data Extended to fetch record.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/businesspartners/fetch-batch
Request samples
application/json
{
  • "cdqIds": [
    ]
}
Response samples
application/json
[
  • {
    }
]

Fetch DNB Record WSDL

Fetch D&B record by CDQ-ID. It is possible to read:

  • legacy CMPELK data
  • Data Blocks defined here

Fetch CMPELK

To fetch the CMPELK object no features have to be activated.

POST /dnb/businesspartners/fetch
{
  "cdqId": "DNB:123456789"
}

Fetch Data Blocks

It is possible to read pre defined Data Blocks

Fetch pre defined Data Blocks

There are 2 features with pre defined data blocks:

  • ACTIVATE_MASTER_DATA_BASIC uses following data blocks:
    • COMPANYINFO_L1_V1
  • ACTIVATE_MASTER_DATA_EXTENDED uses following data blocks:
    • COMPANYINFO_L1_V1
    • COMPANYINFO_L2_V1
    • HIERARCHYCONNECTIONS_L1_V1
    • PRINCIPALSCONTACTS_L2_V1
POST /dnb/businesspartners/fetch
{
  "cdqId": "DNB:123456789",
  "featuresOn": [
    "ACTIVATE_MASTER_DATA_BASIC"
  ]
}

Fetch LNKELI

It is poosible to fetch LNKELI data:

POST /dnb/businesspartners/fetch
{
  "cdqId": "DNB:123456789",
  "featuresOn": [
    "ACTIVATE_LINKAGE_LNKELI"
  ]
}
SecurityapiKey
Request
header Parameters
X-DNB-PASSWORD
string
X-DNB-USER
string
Request Body schema:
required
cdqId
string
featuresOff
Array of strings (DnbFetchFeature)
Items Enum: Description
ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

ACTIVATE_DATASOURCE_DNB_STORAGE

Checks storage and skips call to D&B if results were found.

ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY

Skips call to D&B entirely and only checks storage for results.

ENRICH_COMMERCIAL_ULTIMATE

Uses additional cmpelk calls to load whole organization hierarchy and detect global ultimate.

ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_CDQ_RECORD

Return also Dnb record mapped to cdq model.

featuresOn
Array of strings (DnbFetchFeature)
Items Enum: Description
ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

ACTIVATE_DATASOURCE_DNB_STORAGE

Checks storage and skips call to D&B if results were found.

ACTIVATE_DATASOURCE_DNB_STORAGE_ONLY

Skips call to D&B entirely and only checks storage for results.

ENRICH_COMMERCIAL_ULTIMATE

Uses additional cmpelk calls to load whole organization hierarchy and detect global ultimate.

ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_CDQ_RECORD

Return also Dnb record mapped to cdq model.

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/dnb/businesspartners/fetch
Request samples
{
  • "cdqId": "string",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
{
  • "cmpelkV2": {
    },
  • "dataBlock": {
    },
  • "lnkeli": {
    },
  • "commercialUltimate": {
    },
  • "cdqRecord": {
    },
  • "cdqCommercialUltimate": {
    },
  • "status": "string",
  • "message": "string"
}

Fetch Supplier Gateway Record

SecurityapiKey
Request
Request Body schema: application/json
required
cdqId
string
featuresOn
Array of strings
Items Value: "ENRICH_MINORITY_INDICATOR"
supplierNumber
string

Supplier Number to fetch the Record. Leading zeros are removed before querying SupplierGateWAY.

Responses
200

successful operation

post/sgw/businesspartners/fetch
Request samples
application/json
{
  • "cdqId": "string",
  • "supplierNumber": "string",
  • "featuresOn": [
    ]
}
Response samples
{
  • "cdqId": "string",
  • "supplierGateway": {
    },
  • "minorityIndicator": {
    }
}

Generate Golden Record

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

cdqId
string
featuresOn
Array of strings (BusinessPartnerGoldenRecordFeatureEnum)

The features with which the business partner golden record should be called

Items Value: Description
SHOW_FORMATTED_SAP_RECORD

Show formatted sap records in the golden record response.

Responses
200

OK

400

Bad Request

post/v3/businesspartners/goldenrecord
Request samples
application/json
{
  • "cdqId": "string",
  • "featuresOn": "SHOW_FORMATTED_SAP_RECORD"
}
Response samples
application/json
{
  • "cdqId": "string",
  • "matchingProfile": {
    },
  • "businessPartner": {