# Business Partners

**Lookup Business Partners**

The Lookup Business Partners endpoint is designed to search for Business Partners within all available data sources. It is specifically crafted to provide data formatted to meet the unique needs of SAP users. The endpoint's primary objective is to offer a seamless integration of CDQ Data Model into the SAP One Domain Model, ensuring that the information is readily accessible and compatible with SAP systems.

| CDQ Data Model      | SAP One Domain Model                        |
|---------------------|---------------------------------------------|
| name                | formattedOrgName??                          |
| identifiers         | taxNumbers/identifications with their types |
| legal form category | legal form                                  |

**Example:**

To meet SAP ODM data expectations Lookup Business Partner endpoint checks the technicalKey in the CDQ Identifiers object and compares it with the SAP identificationType's code. Based on this comparison divides identifiers into specific groups e.g. taxNumber.

**CDQ Data Model**
```json
{
  "identifiers": [
    {
      "type":
        {
          "url": "https://meta.cdq.com/Business_Registration_Number_(Germany)",
          "name": "Business Registration Number",
          "technicalKey": "DE_BNUM"
        },
      "value": "HRB 739690",
      "issuingBody":
        { }
    }
  ]
}
```

**SAP One Domain Model in the jsonRecord**
```json
{
  "identifications": [
    {
      "country": { },
      "identificationNumber": "HRB 739690",
      "institute": "Amtsgericht Ulm",
      "identificationType": {
        "code": "BUP002"
      }
    }
  ]
}
  ```

To ensure seamless integration and compliance with SAP standards, data transformations are essential. CDQ data model often contains values like 'CHE-218.608.886 HR/MWST' while SAP ODM adheres to a specific format, 'CHE218608886' These transformations bridge the gap between data models, enabling data to pass through internal SAP Data Validation checkpoints. It aligns the data with SAP's stringent standards, making it ready for further processing and validation within SAP systems. These transformations not only harmonize the data but also streamline the validation process, ensuring data accuracy and consistency throughout the SAP ecosystem.

Lookup Business Partner provides alignment with the SAP Factory Standard but can be customized to customer needs.

| Country | Field      | Field type | Transformation Input    | Transformation output |
|---------|------------|------------|-------------------------|-----------------------|
| CH      | Tax number | CH1        | CHE-218.608.886 HR/MWST | CHE218608886          |


## Lookup Business Partners

 - [POST /referencedata/rest/v4/businesspartners/lookup](https://developer.cdq.com/apis/sap-odm-api/api-v3/business-partners/paths/~1referencedata~1rest~1v4~1businesspartners~1lookup/post.md): Perform a Business Partner lookup operation across all available Data Sources. 
The output of this operation will be a comprehensive list of Business Partners, 
each accompanied by their respective Data Sources and meticulously calculated 
matching scores. It is important to note that all accessible data sources are 
comprehensively documented within the Data_source Category on CDQ Wiki. 

The Data Sources are categorized as follows:
  * OPEN: These Data Sources are open to everyone without any registration requirement.
  * FREE: These Data Sources are free to use, but registration is required.
  * COMMERCIAL: These Data Sources are only available to commercial users.
  
The results of the Business Partner lookup operation are sorted in descending 
order based on their matching scores. Additionally, the results are conveniently 
paginated, allowing for efficient navigation through the extensive list. The page 
size can be effortlessly customized to accommodate specific preferences.


## Fetch Business Partner

 - [POST /referencedata/rest/v4/businesspartners/fetch](https://developer.cdq.com/apis/sap-odm-api/api-v3/business-partners/paths/~1referencedata~1rest~1v4~1businesspartners~1fetch/post.md): Retrieves the Business Partner based on the Lookup and returning the result of the single record.

Read more about Golden Record here.