# Fetch Business Partner Fetch business partner by CDQ-ID. Endpoint: POST /referencedata/rest/v3/businesspartners/fetch Version: 2 Security: apiKey ## Request fields (application/json): - `cdqId` (string) CDQ ID for business partner and address. Example: "VIES:PL8660001429" - `featuresOn` (array) List of features to be activated. Enum: "SHOW_DEBUG_INFO" - `featuresOff` (array) List of features to be deactivated. Enum: "SHOW_DEBUG_INFO" ## Response 200 fields (application/json): - `status` (string) status: * - Service returned a correct response. * - Call to external service failed. * - Given input parameter is invalid or entry not found. * - Authorization to external service does not succeed. Example: "OK" - `message` (string) Message describing the status of the request. Example: "Service returned a correct response." - `cdqId` (string) CDQ ID for Business Partner. Example: "VIES:PL8660001429" - `dataSource` (string) Technical key of the data source. Example: "BR_RF" - `businessPartner` (object) 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. - `businessPartner.names` (array) List of names of the Business Partner. - `businessPartner.names.shortName` (string) The abbreviated variant of a company's full name. Example: "CDQ AG" - `businessPartner.names.type` (object) The type of the name, e.g. a locally used name or an international version. - `businessPartner.names.type.url` (string) URL to the documentation which summarizes all details of the [Name Type](https://meta.cdq.com/Business_partner/name/type). Example: "https://meta.cdq.com/Business_partner/name/type" - `businessPartner.names.type.name` (string) Display label for the Name Type. Example: "Local Name" - `businessPartner.names.type.technicalKey` (string) Technical Keys of the Name Type. Example: "LOCAL" - `businessPartner.names.value` (string) The actual name. Example: "Corporate Data Quality AG" - `businessPartner.names.language` (object) Naming of a language according to ISO 639-1. - `businessPartner.names.language.name` (string) ISO 639-1 name of language. Example: "German" - `businessPartner.names.language.technicalKey` (string) ISO 639-1 two-letter code of languages. Example: "DE" - `businessPartner.legalForm` (object) The legal form of a [business partner/type/legal entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the form it takes in the eyes of the law governing it. The legal form of a [company](https://meta.cdq.com/Business_partner) 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](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc., LLC, S.A.). - `businessPartner.legalForm.name` (string) Display of the Legal Form. Example: "Aktiengesellschaft" - `businessPartner.legalForm.mainAbbreviation` (string) The primary abbreviation of a legal form, i.e. the most commonly used abbreviation in a country. Example: "AG" - `businessPartner.legalForm.categories` (array) - `businessPartner.legalForm.categories.name` (string) Descriptive display name of the Legal Form Category. Example: "Limited Liability Company" - `businessPartner.legalForm.categories.shortName` (string) Short display name of the Legal Form Category. Example: "LLC" - `businessPartner.legalForm.categories.url` (string) URL to the documentation which summarizes all details of the [Legal Form Category](https://meta.cdq.com/Business_partner/legal_form/category). Example: "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001" - `businessPartner.legalForm.categories.technicalKey` (string) Technical Key of the [Legal Form Category](https://meta.cdq.com/Business_partner/legal_form/category). Example: "LIMITED" - `businessPartner.legalForm.url` (string) URL to the documentation which summarizes all details of [Legal Form](https://meta.cdq.com/Business_partner/legal_form). Example: "https://meta.cdq.com/Business_partner/legal_form" - `businessPartner.legalForm.technicalKey` (string) Technical Key of a Legal Form. Descriptions of below enums contain , and . Example: "DE_9866" - `businessPartner.legalForm.cdlElfCode` (string) An unique identifier for CDL managed Legal Forms. Example: "AG" - `businessPartner.identifiers` (array) List of identifiers of the Business Partner. - `businessPartner.identifiers.value` (string) Value of the identifier. Example: "CHE-218.608.886 HR/MWST" - `businessPartner.identifiers.type` (object) Type of the identifier. - `businessPartner.identifiers.type.url` (string) URL to the documentation which summarizes all details of an [Identifier](https://meta.cdq.com/Business_partner/identifier/type). Example: "https://meta.cdq.com/Business_partner/identifier/type" - `businessPartner.identifiers.type.name` (string) Display label for the Identifier. Example: "CH_VAT_ID" - `businessPartner.identifiers.type.technicalKey` (string) Technical key of the type of the Identifier. Example: "CH_VAT_ID" - `businessPartner.identifiers.status` (object) Identifier Status refers to the current state of a unique identification number. - `businessPartner.identifiers.status.name` (string) Display label for the Identifier Status Name. Example: "ACTIVE" - `businessPartner.identifiers.status.url` (string) URL to the documentation which summarizes all details of the [Identifier Status](https://meta.cdq.com/Business_partner/identifier/status). Example: "https://meta.cdq.com/Business_partner/identifier/status" - `businessPartner.identifiers.status.technicalKey` (string) Technical key of the Identifier Status. Example: "ACTIVE" - `businessPartner.identifiers.issuingBody` (object) An Issuing Body is an organization or government institution that is responsible for assigning unique identifiers to individuals, organizations, or objects. - `businessPartner.identifiers.issuingBody.name` (string) Preferred display label for an Issuing Body. Example: "Amtsgericht Aachen" - `businessPartner.identifiers.issuingBody.shortName` (string) Preferred short display label for an Issuing Body. Example: "Amtsgericht Aachen" - `businessPartner.identifiers.issuingBody.names` (array) - `businessPartner.identifiers.issuingBody.description` (string) Description for an Issuing Body. Example: "Amtsgericht Aachen" - `businessPartner.identifiers.issuingBody.url` (string) URL to the documentation which summarizes all details of a [Issuing Body](https://meta.cdq.com/Business_partner/identifier/issuing_body). Example: "https://meta.cdq.com/Business_partner/identifier/issuing_body" - `businessPartner.identifiers.issuingBody.technicalKey` (string) Technical key of the Issuing Body. Example: "Amtsgericht Aachen" - `businessPartner.identifiers.issuingBody.jurisdiction` (object) The authority of an official organization to make decisions and judgments in a particular administrative area. - `businessPartner.identifiers.issuingBody.jurisdiction.country` (object, required) Country consisting of the country name and country code (ISO 3166-1 alpha-2). - `businessPartner.identifiers.issuingBody.jurisdiction.country.shortName` (string) Country code (ISO 3166-1 alpha-2). Example: "CH" - `businessPartner.identifiers.issuingBody.jurisdiction.country.value` (string) Country name (ISO 3166-1 alpha-2). Example: "Switzerland" - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas` (array) - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.value` (string) Name of the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "Sankt Gallen" - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.shortName` (string) Abbreviation for the [Administrative Area](https://meta.cdq.com/Address/administrative_area). Example: "SG" - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.fipsCode` (string) FIPS codes are numbers which uniquely identify geographic areas. The number of digits in FIPS codes vary depending on the level of geography. State-level FIPS codes have two digits, county-level FIPS codes have five digits of which the first two are the FIPS code of the state to which the county belongs. Example: "SZ15" - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.isoCode` (string) ISO 3166-2 code which uniquely defines the names of countries and their subdivisions (e.g., provinces or states). Example: "CH-SG" - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.type` (object) Type of the [Administrative Area](https://meta.cdq.com/Address/administrative_area). - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.type.name` (string) Display label for the Administrative Area Type. Example: "COUNTY" - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/administrative_area/type). Example: "https://meta.cdq.com/Address/administrative_area/type" - `businessPartner.identifiers.issuingBody.jurisdiction.administrativeAreas.type.technicalKey` (string) Technical key of the Administrative Area. Example: "COUNTY" - `businessPartner.identifiers.issuingBody.gleifCode` (string) Code of Global Legal Entity Identifier Foundation (GLEIF) Example: "RA000004" - `businessPartner.identifiers.issuingBody.localAuthorityCode` (string) Code of the local registration authority Example: "R3101" - `businessPartner.identifiers.issuingBody.externalUrl` (string) External url of the issuing body Example: "https://www.amtsgericht.de/muenchen" - `businessPartner.addresses` (array) List of addresses of the Business Partner. - `businessPartner.addresses.version` (object) CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language. - `businessPartner.addresses.version.characterSet` (object) Character set. - `businessPartner.addresses.version.characterSet.name` (string) Name of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "International" - `businessPartner.addresses.version.characterSet.technicalKey` (string) Technical key of character set. Supported character sets can be found [here](https://meta.cdq.com/Address/version/character_set). Example: "INTERNATIONAL" - `businessPartner.addresses.identifyingName` (object) An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent. - `businessPartner.addresses.identifyingName.value` (string) An identifying name assigned to an address. In most cases the identifying name refers to the name of a registered agent. Example: "John Doe" - `businessPartner.addresses.externalId` (string) ID the address has in the external system where the record originates from. Example: "1" - `businessPartner.addresses.metadata` (object) Specifies the language and primary data provenance. - `businessPartner.addresses.metadata.primaryProvenance` (object) The source of the change or update. Could be the reference data source as VIES or Organization. - `businessPartner.addresses.metadata.primaryProvenance.name` (string) Display Name of the Provenance Name. Example: "VIES" - `businessPartner.addresses.metadata.primaryProvenance.url` (string) URL to the documentation which summarizes all details of the Provenance Name. Example: "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=" - `businessPartner.addresses.metadata.primaryProvenance.technicalKey` (string) Technical Key of the Provenance Name. Example: "VIES" - `businessPartner.addresses.metadata.primaryProvenance.cdqId` (string) The ID provided for a linkage with the source by CDQ. Example: "VIES:PL8660001429" - `businessPartner.addresses.careOf` (object) Signifies an intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example, when the addressee has no standard address, is under a corporate mail system, or is being manually forwarded mail sent to a more accessible location. - `businessPartner.addresses.careOf.value` (string) Value of the CareOf. Example: "CDQ GmbH c/o Product Department" - `businessPartner.addresses.contexts` (array) - `businessPartner.addresses.contexts.value` (string) Value of the Address Context. Example: "Production hall 7, Storage field 8." - `businessPartner.addresses.postCodes` (array) Example: ["9000"] - `businessPartner.addresses.postCodes.value` (string) Effective [post code](https://meta.cdq.com/Address/post_code). Example: "9000" - `businessPartner.addresses.postCodes.type` (object) Type of the Post Code. - `businessPartner.addresses.postCodes.type.name` (string) Display label for the Post Code Type. Example: "Regular" - `businessPartner.addresses.postCodes.type.url` (string) URL to the documentation which summarizes all details of the [Administrative Area](https://meta.cdq.com/Address/post_code/type). Example: "https://meta.cdq.com/Address/post_code/type" - `businessPartner.addresses.postCodes.type.technicalKey` (string) Technical key of the Post Code. Example: "REGULAR" - `businessPartner.addresses.localities` (array) - `businessPartner.addresses.localities.type` (object) Type of the [Locality](https://meta.cdq.com/Address/locality). - `businessPartner.addresses.localities.type.name` (string) Display label for the Locality Type. Example: "City" - `businessPartner.addresses.localities.type.url` (string) URL to the documentation which summarizes all details of the [Locality Type](https://meta.cdq.com/Address/locality/type). Example: "https://meta.cdq.com/Address/locality/type" - `businessPartner.addresses.localities.type.technicalKey` (string) Technical Key of the Locality Type. Example: "CITY" - `businessPartner.addresses.localities.shortName` (string) Abbreviation of the [Locality](https://meta.cdq.com/Address/locality). Example: "St. Gallen" - `businessPartner.addresses.localities.value` (string) Name of the [Locality](https://meta.cdq.com/Address/locality). Example: "Sankt Gallen" - `businessPartner.addresses.thoroughfares` (array) - `businessPartner.addresses.thoroughfares.type` (object) Type of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). - `businessPartner.addresses.thoroughfares.type.name` (string) Display label for the Thoroughfare Type Name. Example: "Industrial zone" - `businessPartner.addresses.thoroughfares.type.url` (string) URL to the documentation which summarizes all details of the [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type). Example: "https://meta.cdq.com/Address/thoroughfare/type" - `businessPartner.addresses.thoroughfares.type.technicalKey` (string) Technical key of the Thoroughfare Type. Example: "INDUSTRIAL_ZONE" - `businessPartner.addresses.thoroughfares.shortName` (string) Abbreviation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "Lukasstr. 4" - `businessPartner.addresses.thoroughfares.number` (string) Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "4" - `businessPartner.addresses.thoroughfares.value` (string) Comprehensive designation of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the thoroughfare type such as Street, or Rue. Example: "Lukasstraße 4" - `businessPartner.addresses.thoroughfares.name` (string) Pure name of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising the thoroughfare type such as Street, or Rue. Example: "Lukasstraße" - `businessPartner.addresses.thoroughfares.direction` (string) Direction of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare). Example: "221-bis Baker Street, North" - `businessPartner.addresses.premises` (array) - `businessPartner.addresses.premises.value` (string) The actual value of a Premise in the language of the address. Example: "Lukasstraße 4" - `businessPartner.addresses.premises.shortName` (string) Abbreviation of the Premise. Example: "Lukasstr. 4" - `businessPartner.addresses.premises.number` (string) Number of the Premise. Example: "4" - `businessPartner.addresses.premises.type` (object) Type of the Premise. - `businessPartner.addresses.premises.type.name` (string) Display label for the Premise Type. Example: "Factory" - `businessPartner.addresses.premises.type.url` (string) URL to the documentation which summarizes all details of the [Premise Type](https://meta.cdq.com/Address/premise/type). Example: "https://meta.cdq.com/Address/premise/type" - `businessPartner.addresses.premises.type.technicalKey` (string) Technical key of the Premise Type. Example: "FACTORY" - `businessPartner.addresses.postalDeliveryPoints` (array) - `businessPartner.addresses.postalDeliveryPoints.type` (object) A single mailbox or other place at which postal mail is delivered. - `businessPartner.addresses.postalDeliveryPoints.type.name` (string) Display label for the Postal Delivery Point Type. Example: "Mailbox" - `businessPartner.addresses.postalDeliveryPoints.type.url` (string) URL to the documentation which summarizes all details of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type) Example: "https://meta.cdq.com/Address/postal_delivery_point/type" - `businessPartner.addresses.postalDeliveryPoints.type.technicalKey` (string) Technical key of the Postal Delivery Point. Example: "MAILBOX" - `businessPartner.addresses.postalDeliveryPoints.shortName` (string) Stort name of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "St Gallen, Postfach 460" - `businessPartner.addresses.postalDeliveryPoints.number` (string) Number of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "460" - `businessPartner.addresses.postalDeliveryPoints.value` (string) Value of the [Postal Delivery Point](https://meta.cdq.com/Address/postal_delivery_point). Example: "Postfach" - `businessPartner.addresses.openingHours` (array) - `businessPartner.addresses.openingHours.openingHour` (string) Company openning hour. Example: "09:00 AM" - `businessPartner.addresses.openingHours.closingHour` (string) Company closing hour. Example: "05:00 PM" - `businessPartner.addresses.openingHours.weekday` (string) A day in the week in which the company is open. Example: "Monday" - `businessPartner.addresses.geographicCoordinates` (object) Decimal geographic coordinates (WGS 84 - reference coordinate system). - `businessPartner.addresses.geographicCoordinates.latitude` (number) Plain on the earth's surface north or south of the equator. Example: "47.439549" - `businessPartner.addresses.geographicCoordinates.longitude` (number) Plain on the earth's surface east or west of a meridian. Example: "9.395275" - `businessPartner.addresses.types` (array) - `businessPartner.addresses.types.name` (string) Display label for the Address Type. Example: "Legal Address" - `businessPartner.addresses.types.url` (string) URL to the documentation which summarizes all details of the [Address Type](https://meta.cdq.com/Address/type). Example: "https://meta.cdq.com/Address/type" - `businessPartner.addresses.types.technicalKey` (string) Technical key of the Address Type. Example: "LEGAL_ADDRESS" - `businessPartner.addresses.formattedAddress` (object) A formatted address is a structured address of VIES data source. - `businessPartner.addresses.formattedAddress.country` (string) Country name. Example: "Switzerland" - `businessPartner.addresses.formattedAddress.administrativeArea` (string) A top-level geographical or political area division in a country. Example: "Sankt Gallen" - `businessPartner.addresses.formattedAddress.region` (string) Top level subdivision of a country. Example: "Sankt Gallen" - `businessPartner.addresses.formattedAddress.regionCode` (string) A country specific code for a certain address in the region. Example: "9004" - `businessPartner.addresses.formattedAddress.locality` (string) A locality is a named densely populated area (a place) such as town, village, suburb, etc. A locality composes of many individual addresses. Example: "Sankt Gallen" - `businessPartner.addresses.formattedAddress.district` (string) Type of administrative division that, in some countries, is managed by local government. Across the world, areas known as "districts" vary greatly in size, spanning regions or counties, several municipalities, subdivisions of municipalities, school district, or political district. Example: "City center" - `businessPartner.addresses.formattedAddress.postalCode` (string) A country specific code for a certain address. Example: "9000" - `businessPartner.addresses.formattedAddress.thoroughfare` (string) Details of the access route along which buildings, lots, or land are located, such as street, road, channel, crescent, avenue. Example: "Lukassstrasse" - `businessPartner.addresses.formattedAddress.premise` (string) A premise is a tract of land including its buildings. A premise may have several sub-levels to precisely identify. Example: "Lukasstraße 4, Building 2, Floor 3, Room 4" - `businessPartner.addresses.formattedAddress.interurbanDeliveryPoint` (string) A single mailbox or other place at which postal mail is delivered. Example: "Sankt Gallen, Postfach 460" - `businessPartner.addresses.formattedAddress.mailbox` (string) A location at an address where the post is delivered to. Example: "Postfach 460" - `businessPartner.addresses.formattedAddress.postOfficeBox` (string) A uniquely addressable lockable box located on the premises of a post office station. Example: "Postfach 460" - `businessPartner.externalId` (string) 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.jsonRecord` (object) Business Partner of SAP ODM. - `businessPartner.jsonRecord.displayId` (string) Human-readable identifier. Example: "SAP" - `businessPartner.jsonRecord.businessPartnerType` (string) Type under which a business partner is classified (organization, person, or businessPartnerGroup). Example: "organization" - `businessPartner.jsonRecord.organization` (object) Organization information of a business partner. This field is only filled if the Business Partner is of type 'organization'. - `businessPartner.jsonRecord.organization.nameDetails` (object) Address information of an organization including script variants. - `businessPartner.jsonRecord.organization.nameDetails.formattedOrgNameLine1` (string) Formatted organizational name line 1. Example: "SAP SE" - `businessPartner.jsonRecord.organization.nameDetails.formattedOrgNameLine2` (string) Formatted organizational name line 2. Example: "Hasso-Plattner-Ring 7" - `businessPartner.jsonRecord.organization.nameDetails.formattedOrgNameLine3` (string) Formatted organizational name line 3. Example: "69190 Walldorf" - `businessPartner.jsonRecord.organization.nameDetails.formattedOrgNameLine4` (string) Formatted organizational name line 4. Example: "Germany" - `businessPartner.jsonRecord.organization.nameDetails.formattedOrgName` (string) Fully formatted organization name. Example: "SAP SE, Hasso-Plattner-Ring 7, 69190 Walldorf, Germany" - `businessPartner.jsonRecord.organization.nameDetails.customSalutation` (string) A customizable, more informal salutation. Example: "Additional information" - `businessPartner.jsonRecord.organization.nameDetails.scriptVariants` (array) Scripted variants of an organization's name. - `businessPartner.jsonRecord.organization.nameDetails.scriptVariants.scriptCode` (object) A code for the presentation of names of scripts (language signs). - `businessPartner.jsonRecord.organization.nameDetails.scriptVariants.scriptCode.name` (string) User-facing name of a code list entry. Example: "Code list entry name." - `businessPartner.jsonRecord.organization.nameDetails.scriptVariants.scriptCode.code` (string) The script code (language sign). Example: "Latn" - `businessPartner.jsonRecord.organization.legalForm` (object) Codes that represent legal forms that are of significance for the organization of a company. - `businessPartner.jsonRecord.organization.legalForm.code` (string) Code list entry. Example: "AG" - `businessPartner.jsonRecord.organization.globalLocationNumber` (string) The Global Location Number (GLN) - former Internal Location Number (ILN) - assigned by GS1 organizations identifies physical locations or legal entities uniquely. Example: "0847976000005" - `businessPartner.jsonRecord.identifications` (array) Proof of identity. - `businessPartner.jsonRecord.identifications.identificationType` (object) Codes for identification types such as ID card or driver's license. - `businessPartner.jsonRecord.identifications.identificationNumber` (string) Number that identifies a business partner, such as a driver's license, or ID card number. Example: "DE123456789" - `businessPartner.jsonRecord.identifications.country` (object) Country codes following IES ISO-3166 ALPHA-2. - `businessPartner.jsonRecord.identifications.country.code` (string) The ISO-3166 2-char code of the country. Example: "DE" - `businessPartner.jsonRecord.identifications.region` (object) Represents the name of a principal subdivision (e.g. province or state) of countries coded in ISO 3166-1. This code is based on the two-letter code element from ISO 3166-1 followed by a separator and up to three alphanumeric characters (published as ISO 3166-2). - `businessPartner.jsonRecord.identifications.region.code` (string) Country subdivision code. Example: "DE-BW" - `businessPartner.jsonRecord.identifications.institute` (string) Institution that administers or assigns an ID number. Example: "Federal Republic of Germany" - `businessPartner.jsonRecord.taxNumbers` (array) Tax numbers of the business partner. - `businessPartner.jsonRecord.taxNumbers.taxNumberType` (object) Codes representing the type of tax numbers. - `businessPartner.jsonRecord.taxNumbers.taxNumber` (string) Specifies the tax number. Example: "DE123456789" - `businessPartner.jsonRecord.addressData` (array) The address information of the business partner. - `businessPartner.jsonRecord.addressData.validFrom` (string) Begin date of validity period (ISO 8601 compliant). Example: "2025-08-27T14:27:34Z" - `businessPartner.jsonRecord.addressData.validTo` (string) End date of validity period (ISO 8601 compliant). Example: "2025-08-27T14:27:34Z" - `businessPartner.jsonRecord.addressData.usages` (array) Usage about the address information that is assigned to a business partner. - `businessPartner.jsonRecord.addressData.usages.usage` (object) Codes defining the specific usage of address information for a business purpose (for example, used as for a shipping or billing address). - `businessPartner.jsonRecord.addressData.usages.isStandard` (boolean) Establishes the usage of the address information is standard. Example: "true" - `businessPartner.jsonRecord.addressData.postalAddressType` (string) Defines if the address is for a person or an organization. Enum: "organizationPostalAddress", "personPostalAddress" - `businessPartner.jsonRecord.addressData.organizationPostalAddress` (object) The type of address of an organization including script variants. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.streetPrefix1` (string) Defines first line of the street print layout. Example: "StreetPrefix1" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.streetPrefix2` (string) Defines second line of the street print layout. Example: "StreetPrefix1" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.street` (object) Links the name of a street to an optional Thoroughfare code as defined by ISO 19160-4:2017. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.street.name` (string) Name of a street. Example: "Main Street" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.street.ref` (object) StreetCodes are an alias (aiming for better readability and understandability) for Thoroughfare codes, which are defined by ISO 19160-4:2017 as an abstraction over street, road, square, and the like. Thoroughfare codes may be regulated locally, optional otherwise. identifies the road or part of a road or other access route along which a delivery point can be accessed, either directly or via a secondary or tertiary road or access route. For addressing purposes, a thoroughfare need not be on land, e.g. a canal or river might serve as a thoroughfare in the address of a houseboat or of a construction on the bank. A thoroughfare is a road or way connecting one location to another. On land a thoroughfare may refer to any type of road. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.street.ref.code` (string) Street code. Example: "101" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.streetSuffix1` (string) Defines before-last line of the street print layout. Example: "StreetSuffix1" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.streetSuffix2` (string) Defines last line of the street print layout. Example: "StreetSuffix2" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.houseNumber` (string) Building information. Example: "Building 1" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.houseNumberSupplement` (string) Additional information. Example: "2nd floor" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.building` (string) Building information. Example: "Building 1" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.floor` (string) Floor information. Example: "2nd floor" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.door` (string) Room, apartment, ... Example: "Room 14" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.careOf` (string) A care of (c/o) party name. Example: "c/o John Doe" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.primaryRegion` (object) Represents the name of a principal subdivision (e.g. province or state) of countries coded in ISO 3166-1. This code is based on the two-letter code element from ISO 3166-1 followed by a separator and up to three alphanumeric characters (published as ISO 3166-2). - `businessPartner.jsonRecord.addressData.organizationPostalAddress.secondaryRegion` (object) Links the name of a secondary region to an optional Region Code. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.secondaryRegion.name` (string) Name of a secondary region. Example: "Montgomery County" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.secondaryRegion.ref` (object) Region codes may be derived from ISO 3166-2 code list (subdivisions) or provided by local authorities. No assumptions about the length of the code. Code list with codes that are defined by local authorities. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.secondaryRegion.ref.code` (string) Secondary region code. Example: "091" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.tertiaryRegion` (object) Links the name of a tertiary region to an optional Region Code. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.tertiaryRegion.name` (string) Name of a tertiary region. Example: "Berlin" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.tertiaryRegion.ref` (object) Region codes may be derived from ISO 3166-2 code-list (subdivisions) or provided by local authorities. No assumptions about the length of the code. Code list with codes that are defined by local authorities. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.tertiaryRegion.ref.code` (string) Tertiary region code. Example: "650" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.town` (object) Links a town name to an optional Town Code as defined in ISO 19160-4:2017. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.town.name` (string) Name of a town. Example: "Berlin" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.town.ref` (object) Town is an abstraction defined in ISO 19160-4:2017 for cities, towns, villages, etc. Town codes are regulated locally for some countries (Qatar, Peru, Oman, Italy tax codes), otherwise just omitted. This defines a code-list for towns or just a name if a code is missing. Element indicating the name of the populated place in which a delivery point is located or near to or via which the delivery point is accessed. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.town.ref.code` (string) Town code. Example: "9000" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.district` (object) Links the name of a district to an optional District Code as defined in ISO 19160-4:2017. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.district.name` (string) Name of a district. Example: "Mitte" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.district.ref` (object) District is defined in ISO 19160-4:2017 as an addressable area inside a town or adjacent to a town. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.district.ref.code` (string) ISO 19160-4:2017. Example: "DE-BE" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.postCode` (string) Postal code (or Zip Code in the US, PLZ in Germany etc.). Example: "10115" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.alternative` (object) An alternative delivery address that does not have region, street, premises, and addressed object information but identifies delivery locations according to the service enum type. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.alternative.deliveryType` (object) Delivery types that identify delivery locations other than the ordinary mailbox or personal deliveries. - `businessPartner.jsonRecord.addressData.organizationPostalAddress.alternative.deliveryType.code` (string) The code. Example: "POBOX" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.alternative.deliveryServiceType` (string) A code-list containing a discriminator to select between address types. Enum: "POBoxDelivery", "PrivateBagDelivery", "PosteRestanteDelivery", "CompanyDelivery", "WorkerCampElectricityMeterDelivery", "WorkerCampBedDelivery", "Other" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.alternative.deliveryServiceQualifier` (string) Needed as the same service identifier is only unique within the scope of the qualifier (i.e. same identifier could be used in different Post offices in the same town). Example: "Post Office SouthEast" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.alternative.deliveryServiceIdentifier` (string) Identifier of the delivery service, e.g., the number of the PO Box. Unique within the scope of the deliveryServiceQualifier. Example: "1234" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.coordinates` (object) GeoCoordinates contain the geographic data, in other words longitude, latitude and altitude specified as per the WGS84 reference system, which enables you to determine a position on the globe. (https://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf). - `businessPartner.jsonRecord.addressData.organizationPostalAddress.coordinates.latitude` (number) Latitude value of the coordinates. Example: "52.520008" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.coordinates.longitude` (number) Longitude value of the coordinates. Example: "13.404954" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.coordinates.altitude` (number) Altitude value of the coordinates. Example: "34.0" - `businessPartner.jsonRecord.addressData.organizationPostalAddress.scriptVariants` (array) Scripted variants of the organization's address. - `businessPartner.jsonRecord.addressData.emailAddresses` (object) The default communication channel is email. - `businessPartner.jsonRecord.addressData.emailAddresses.address` (string) The email address. Assumption: to be able to process special characters in the address all connected systems must be unicode enabled. EmailAddress according to external standard IETF RFC 5321. Example: "developer-portal@cdq.com" - `businessPartner.jsonRecord.addressData.websites` (object) The default communication channel is website. - `businessPartner.jsonRecord.addressData.websites.url` (string) The URL path for the website. Example: "https://www.developer.cdq.com" - `businessPartner.types` (array) List of types of the Business Partner. - `businessPartner.types.name` (string) Display name of the Business Partner Type Name. Example: "Legal Entity" - `businessPartner.types.url` (string) URL to the documentation which summarizes all details of a [Buisness Partner Type](https://meta.cdq.com/Business_partner/type). Example: "https://meta.cdq.com/Business_partner/type" - `businessPartner.types.technicalKey` (string) Technical key of the Business Partner Type. Example: "LEGAL_ENTITY"