SAP ODM API (2)

Download OpenAPI specification:Download

This API provides access to several CDQ API endpoints according to the SAP One Domain Model (ODM). Requests and responses are mapped from the CDQ data model to ODM in order to simplify service access from SAP systems.

Business Partners

Fetch Business Partner

Fetch business partner by CDQ-ID.

SecurityapiKey

Request

Request Body schema: application/json
required

cdqId

string

CDQ ID for business partner and address.

Example: "VIES:PL8660001429"

featuresOff

Array of strings (BusinessPartnerFetchFeature)

List of features to be deactivated.

Items Value:	Description
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, and request.

Example: ["SHOW_DEBUG_INFO"]

featuresOn

Array of strings (BusinessPartnerFetchFeature)

List of features to be activated.

Items Value:	Description
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, and request.

Example: ["SHOW_DEBUG_INFO"]

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v3/businesspartners/fetch

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"example": "VIES:PL8660001429"
}

Response samples

application/json

{"status": "OK",
"message": "Service returned a correct response.",
"cdqId": "VIES:PL8660001429",
"dataSource": "BR_RF",
"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": {"url": null,
"name": null,
"technicalKey": null
},
"value": "Corporate Data Quality AG",
"language": {"name": null,
"technicalKey": null
}
}
],
"description": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"fipsCode": null,
"isoCode": null,
"type": null,
"language": null
}
]
},
"gleifCode": "RA000004",
"localAuthorityCode": "R3101",
"externalUrl": "https://www.amtsgericht.de/muenchen"
}
}
],
"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.",
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": {"formattedOrgNameLine1": "SAP SE",
"formattedOrgNameLine2": "Hasso-Plattner-Ring 7",
"formattedOrgNameLine3": "69190 Walldorf",
"formattedOrgNameLine4": "Germany",
"formattedOrgName": "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany",
"customSalutation": "Additional information",
"scriptVariants": [{"formattedOrgNameLine1": "SAP SE",
"formattedOrgNameLine2": "Hasso-Plattner-Ring 7",
"formattedOrgNameLine3": "69190 Walldorf",
"formattedOrgNameLine4": "Germany",
"formattedOrgName": "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany",
"customSalutation": "Additional information",
"scriptCode": {"name": null,
"code": null
}
}
]
},
"legalForm": {"name": "Code list entry name.",
"code": "AG"
},
"globalLocationNumber": "0847976000005"
},
"identifications": [{"identificationType": {"name": "Code list entry name.",
"code": "IDCARD"
},
"identificationNumber": "DE123456789",
"country": {"name": "Code list entry name.",
"code": "DE"
},
"region": {"name": "Code list entry name.",
"code": "DE-BW"
},
"institute": "Federal Republic of Germany"
}
],
"taxNumbers": [{"taxNumberType": {"name": "Code list entry name.",
"code": "VAT"
},
"taxNumber": "DE123456789"
}
],
"addressData": [{"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"usages": [{"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"usage": {"name": null,
"code": null
},
"isStandard": "true"
}
],
"postalAddressType": "organizationPostalAddress",
"organizationPostalAddress": {"streetPrefix1": "StreetPrefix1",
"streetPrefix2": "StreetPrefix1",
"street": {"name": "Main Street",
"ref": {"name": null,
"code": null
}
},
"streetSuffix1": "StreetSuffix1",
"streetSuffix2": "StreetSuffix2",
"houseNumber": "Building 1",
"houseNumberSupplement": "2nd floor",
"building": "Building 1",
"floor": "2nd floor",
"door": "Room 14",
"careOf": "c/o John Doe",
"primaryRegion": {"name": "Code list entry name.",
"code": "DE-BW"
},
"secondaryRegion": {"name": "Montgomery County",
"ref": {"name": null,
"code": null
}
},
"tertiaryRegion": {"name": "Berlin",
"ref": {"name": null,
"code": null
}
},
"town": {"name": "Berlin",
"ref": {"name": null,
"code": null
}
},
"district": {"name": "Mitte",
"ref": {"name": null,
"code": null
}
},
"country": {"name": "Code list entry name.",
"code": "DE"
},
"postCode": "10115",
"alternative": {"country": {"name": null,
"code": null
},
"postCode": "10115",
"primaryRegion": {"name": null,
"code": null
},
"secondaryRegion": {"name": null,
"ref": null
},
"tertiaryRegion": {"name": null,
"ref": null
},
"town": {"name": null,
"ref": null
},
"district": {"name": null,
"ref": null
},
"deliveryType": {"name": null,
"code": null
},
"deliveryServiceType": "POBoxDelivery",
"deliveryServiceQualifier": "Post Office SouthEast",
"deliveryServiceIdentifier": "1234"
},
"coordinates": {"latitude": "52.520008",
"longitude": "13.404954",
"altitude": "34.0"
},
"scriptVariants": [{"formattedOrgNameLine1": null,
"formattedOrgNameLine2": null,
"formattedOrgNameLine3": null,
"formattedOrgNameLine4": null,
"formattedOrgName": null,
"streetPrefix1": null,
"streetPrefix2": null,
"street": null,
"streetSuffix1": null,
"streetSuffix2": null,
"houseNumber": null,
"houseNumberSupplement": null,
"building": null,
"floor": null,
"door": null,
"careOf": null,
"primaryRegion": null,
"secondaryRegion": null,
"tertiaryRegion": null,
"town": null,
"district": null,
"country": { },
"postCode": null,
"alternative": null,
"coordinates": null,
"scriptCode": null
}
]
},
"emailAddresses": {"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"address": "developer-portal@cdq.com"
},
"websites": {"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"url": "https://www.developer.cdq.com"
}
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
]
}
}

Lookup Business Partners

Lookup a business partner in all available data sources.

SecurityapiKey

Request

Request Body schema: application/json
required

object (BusinessPartner)

An organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

dataSources

Array of strings

Filter Data Sources used during lookup.

Example: "VIES"

featuresOff

Array of strings (LookupBusinessPartnerFeature)

List of features to be deactivated.

Items Enum:	Description
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, and request.
SHOW_GOLDENRECORD_QUICK	Calculate golden record for given request.
SHOW_GOLDENRECORD_STANDARD	Calculate golden record for given request.

Example: ["SHOW_DEBUG_INFO"]

featuresOn

Array of strings (LookupBusinessPartnerFeature)

List of features to be activated.

Items Enum:	Description
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, and request.
SHOW_GOLDENRECORD_QUICK	Calculate golden record for given request.
SHOW_GOLDENRECORD_STANDARD	Calculate golden record for given request.

Example: ["SHOW_DEBUG_INFO"]

limit

integer [ 0 .. 1000 ]

Number of items per page.

Example: "100"

matchingThreshold

number <double> [ 0 .. 1 ]

The matching threshold for the lookup.

Example: "0.5"

maxCandidates

integer [ 20 .. 100 ]

The maximum number of candidates to be returned by the lookup. Default 50.

Example: "50"

page

integer (Page) >= 0

Default: 0

Current page number.

Example: "1"

pageSize

integer [ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "100"

startAfter

string (StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v3/businesspartners/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"addresses": [{"country": {"shortName": "DE"
}
}
],
"names": [{"value": "SAP"
}
]
}
}

Response samples

application/json

{"pageSize": "100",
"totals": "67",
"page": "1",
"limit": "100",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"values": [{"cdqId": "VIES:PL8660001429",
"dataSource": "5e2874fb8d2a7400011acee1",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"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": [null
],
"description": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": null,
"administrativeAreas": [ ]
},
"gleifCode": "RA000004",
"localAuthorityCode": "R3101",
"externalUrl": "https://www.amtsgericht.de/muenchen"
}
}
],
"addresses": [{"version": {"characterSet": {"name": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"metadata": {"primaryProvenance": {"name": null,
"url": null,
"technicalKey": null,
"cdqId": null
},
"language": {"name": null,
"technicalKey": null
}
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"fipsCode": null,
"isoCode": null,
"type": null,
"language": null
}
],
"postCodes": ["9000"
],
"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
}
],
"openingHours": [{"openingHour": null,
"closingHour": null,
"weekday": null
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"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.",
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": {"formattedOrgNameLine1": "SAP SE",
"formattedOrgNameLine2": "Hasso-Plattner-Ring 7",
"formattedOrgNameLine3": "69190 Walldorf",
"formattedOrgNameLine4": "Germany",
"formattedOrgName": "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany",
"customSalutation": "Additional information",
"scriptVariants": [null
]
},
"legalForm": {"name": "Code list entry name.",
"code": "AG"
},
"globalLocationNumber": "0847976000005"
},
"identifications": [{"identificationType": {"name": null,
"code": null
},
"identificationNumber": "DE123456789",
"country": {"name": null,
"code": null
},
"region": {"name": null,
"code": null
},
"institute": "Federal Republic of Germany"
}
],
"taxNumbers": [{"taxNumberType": {"name": null,
"code": null
},
"taxNumber": "DE123456789"
}
],
"addressData": [{"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"usages": [null
],
"postalAddressType": "organizationPostalAddress",
"organizationPostalAddress": {"streetPrefix1": null,
"streetPrefix2": null,
"street": null,
"streetSuffix1": null,
"streetSuffix2": null,
"houseNumber": null,
"houseNumberSupplement": null,
"building": null,
"floor": null,
"door": null,
"careOf": null,
"primaryRegion": null,
"secondaryRegion": null,
"tertiaryRegion": null,
"town": null,
"district": null,
"country": { },
"postCode": null,
"alternative": null,
"coordinates": null,
"scriptVariants": [ ]
},
"emailAddresses": {"validFrom": null,
"validTo": null,
"address": null
},
"websites": {"validFrom": null,
"validTo": null,
"url": null
}
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
]
}
}
],
"goldenRecord": {"cdqId": "VIES:PL8660001429",
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
},
"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": null,
"type": null,
"value": null,
"language": null
}
],
"description": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
},
"administrativeAreas": [null
]
},
"gleifCode": "RA000004",
"localAuthorityCode": "R3101",
"externalUrl": "https://www.amtsgericht.de/muenchen"
}
}
],
"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": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": ["9000"
],
"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
}
}
],
"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.",
"jsonRecord": {"displayId": "SAP",
"businessPartnerType": "organization",
"organization": {"nameDetails": {"formattedOrgNameLine1": "SAP SE",
"formattedOrgNameLine2": "Hasso-Plattner-Ring 7",
"formattedOrgNameLine3": "69190 Walldorf",
"formattedOrgNameLine4": "Germany",
"formattedOrgName": "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany",
"customSalutation": "Additional information",
"scriptVariants": [{"formattedOrgNameLine1": null,
"formattedOrgNameLine2": null,
"formattedOrgNameLine3": null,
"formattedOrgNameLine4": null,
"formattedOrgName": null,
"customSalutation": null,
"scriptCode": null
}
]
},
"legalForm": {"name": "Code list entry name.",
"code": "AG"
},
"globalLocationNumber": "0847976000005"
},
"identifications": [{"identificationType": {"name": "Code list entry name.",
"code": "IDCARD"
},
"identificationNumber": "DE123456789",
"country": {"name": "Code list entry name.",
"code": "DE"
},
"region": {"name": "Code list entry name.",
"code": "DE-BW"
},
"institute": "Federal Republic of Germany"
}
],
"taxNumbers": [{"taxNumberType": {"name": "Code list entry name.",
"code": "VAT"
},
"taxNumber": "DE123456789"
}
],
"addressData": [{"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"usages": [{"validFrom": null,
"validTo": null,
"usage": null,
"isStandard": null
}
],
"postalAddressType": "organizationPostalAddress",
"organizationPostalAddress": {"streetPrefix1": "StreetPrefix1",
"streetPrefix2": "StreetPrefix1",
"street": {"name": null,
"ref": null
},
"streetSuffix1": "StreetSuffix1",
"streetSuffix2": "StreetSuffix2",
"houseNumber": "Building 1",
"houseNumberSupplement": "2nd floor",
"building": "Building 1",
"floor": "2nd floor",
"door": "Room 14",
"careOf": "c/o John Doe",
"primaryRegion": {"name": null,
"code": null
},
"secondaryRegion": {"name": null,
"ref": null
},
"tertiaryRegion": {"name": null,
"ref": null
},
"town": {"name": null,
"ref": null
},
"district": {"name": null,
"ref": null
},
"country": {"name": null,
"code": null
},
"postCode": "10115",
"alternative": {"country": { },
"postCode": null,
"primaryRegion": null,
"secondaryRegion": null,
"tertiaryRegion": null,
"town": null,
"district": null,
"deliveryType": null,
"deliveryServiceType": null,
"deliveryServiceQualifier": null,
"deliveryServiceIdentifier": null
},
"coordinates": {"latitude": null,
"longitude": null,
"altitude": null
},
"scriptVariants": [null
]
},
"emailAddresses": {"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"address": "developer-portal@cdq.com"
},
"websites": {"validFrom": "2024-12-04T13:28:19Z",
"validTo": "2024-12-04T13:28:19Z",
"url": "https://www.developer.cdq.com"
}
}
]
},
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
]
}
}
}

SAP ODM API (2)

Business Partners

Fetch Business Partner

Request Body schema: application/jsonrequired

Lookup Business Partners

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required