Sales API - REST

Table of contents :

• Customers
  • Headers
  • Response
  • Query parameters
  • Example of use

The Sales API supports the following endpoints :

• /rest/v1/customers

Customers

GET /rest/v1/customers

Headers

This endpoint requires the next HTTP header

X-Conversation-Id: {Optional header parameter provided by the client}
X-Webhook-Correlation-Id: {Optional header parameter provided by the client in case of webhook usage}
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}

Response

The payload returned by the GET operation has the following format:

{
    "header": {
        "apiName": "sales-exp",
        "apiVersion": "1.0.0",
        "correlationId": "6d540420-d809-11eb-a905-0433c2fabbd0"
    },
    "data": [
        {
            "idocNumber": "",
            "function": "",
            "customerNumber": "",
            "title": "",
            "customerOrder": "",
            "industryKey": "",
            "customerBilling": "",
            "fiscalAccountAddress": "",
            "alternativePayerAccount": "",
            "groupKey": "",
            "customerAccountGroup": "",
            "customerClassification": "",
            "isoCountryCode": "",
            "vendorOrCreditorAccountNumber": "",
            "customerCenterDeliveryBlock": "",
            "cityCoordinates": "",
            "deleteRecordFlag": "",
            "name1": "",
            "name2": "",
            "name3": "",
            "name4": "",
            "nielsenId": "",
            "customerCity": "",
            "district": "",
            "pobox": "",
            "poboxPostalCode": "",
            "postalCode": "",
            "region": "",
            "countryCode": "",
            "cityCode": "",
            "sortField": "",
            "centralPostingBlock": "",
            "languageKey": "",
            "taxNumber1": "",
            "taxNumber2": "",
            "vatLiable": "",
            "addressLine1": "",
            "tel1": "",
            "tel2": "",
            "fax": "",
            "teletext": "",
            "osmose": "",
            "vat": "",
            "vat2": "",
            "vat3": "",
            "vat4": "",
            "vat5": "",
            "vat6": "",
            "vat7": "",
            "vat8": "",
            "vat9": "",
            "vat10": "",
            "legalStatus": "",
            "industryCode1": "",
            "salesFigureCurrency": "",
            "attribute1": "",
            "attribute2": "",
            "attribute3": "",
            "attribute5": "",
            "taxJurisdiction": "",
            "poboxCity": "",
            "sapLanguageCode": "",
            "taxType": "",
            "taxNumberType": "",
            "tax3": "",
            "tax4": "",
            "customerCentralBlock": "",
            "centralBlocRecord": "",
            "cnae": "",
            "legalNature": "",
            "crtNumber": "",
            "icmsTaxPayer": "",
            "industryMainType": "",
            "taxDeclarationType": "",
            "companySize": "",
            "declarationRegimen": "",
            "specificData": {
                "bvdId": "",
                "customerStreet": "",
                "houseNumber": "",
                "email": ""
            },
            "salesData": {
                "function": "",
                "salesOrganisationCode": "",
                "distributionChannel": "",
                "division": "",
                "deleteRecordFlag": "",
                "customerOrder": "",
                "customerGroup": "",
                "priceGroup": "",
                "itemOrderProbability": "",
                "incotermsPart1": "",
                "incotermsPart2": "",
                "salesAreaCustDeliveryBlock": "",
                "shippingConditions": "",
                "salesDistributionsCustBillingBlock": "",
                "currency": "",
                "accountAssignementGroup": "",
                "paymentKey": "",
                "deliveringPlant": "",
                "salesGroup": "",
                "salesOffice": "",
                "customerGrp1": "",
                "customerGrp2": "",
                "customerGrp3": "",
                "customerGrp4": "",
                "customerGrp5": "",
                "salesBloc": "",
                "partnersData": [
                    {
                        "function": "",
                        "partnerFunction": "",
                        "businessPartnerCustNumber": "",
                        "defaultPartner": "",
                        "partnerCustDesc": "",
                        "partnerCounter": ""
                    }
                ],
                "salesFormData": {
                    "function": "",
                    "dispatchTime": "",
                    "sapLanguageCode": ""
                },
                "taxData": {
                    "function": "",
                    "departureCountry": "",
                    "taxCategory": "",
                    "taxClassification": ""
                },
                "licenceData": {
                    "departureCountry": "",
                    "taxCategory": ""
                }
            },
            "financialData": {
                "function": "",
                "companyCode": "",
                "companyCodePublication": "",
                "masterRecordDelFlag": "",
                "headOfficeAccountNumber": "",
                "alternativePayerAccount": "",
                "custIndicatorPaymentNotice": "",
                "paymentMethods": "",
                "paymentBlockKey": "",
                "paymentKey": "",
                "memo": "",
                "previousMasterRecordNumber": "",
                "deletionBlockForMasterRecord": "",
                "email": "",
                "bankDetails": {
                    "function": "",
                    "country": "",
                    "bankNumber": "",
                    "bankAccountNumb": "",
                    "bankControlKey": "",
                    "bankHouseAndStr": "",
                    "bankCity": "",
                    "bankCountryKey": "",
                    "bankIban": "",
                    "bankSwiftBic": "",
                    "iban": ""
                }
            },
            "contactsData": {
                "function": "",
                "contactId": "",
                "contactLastName": "",
                "contactFirstName": "",
                "dptCust": "",
                "department": "",
                "higherLevelPartner": "",
                "tel": "",
                "title": "",
                "contactFunction": "",
                "vipPartner": "",
                "partnerGender": "",
                "partnerLanguage": "",
                "sortField": "",
                "contactPersonTitle": "",
                "sapLanguageCode": ""
            },
            "creditCentralManagementData": {
                "currency": ""
            },
            "creditControlManagementData": {
                "function": "",
                "blockedByManagement": ""
            }
        }
    ],
    "pagination": {
        "links": {},
        "currentPage": 1,
        "totalPages": 1
    },
    "error": {}
}

Query parameters

Example of use

Retrieve all customers for company F132

GET /rest/v1/customers?salesOrganisationCode=F132

Retrieve all customers for company F132 with customer account Z001

GET /rest/v1/customers?salesOrganisationCode=F132&customerAccountGroup=Z001

Retrieve all customers for company F132 with customer account Z001 and customer number 0000100211

GET /rest/v1/customers?salesOrganisationCode=F132&customerAccountGroup=Z001&customerNumber=0000100211

Retrieve all customers for company F132 with customer account Z001 and customer number 0000100211 created or updated since 16 june 2021

GET /rest/v1/customers?salesOrganisationCode=F132&customerAccountGroup=Z001&customerNumber=0000100211&createdOrUpdatedSince=2021-06-16

Retrieve 10 customers for company F132

GET /rest/v1/customers?salesOrganisationCode=F132&limit=10

Retrieve 10 customers for company F132 from page 2

GET /rest/v1/customers?salesOrganisationCode=F132&limit=10&page=2