CFL Customer API

  • 2 minutes to read

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'customer';
EntitySetName = 'customers';

GET

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers?$expand=agedAccountsReceivables
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers?$expand=defaultDimensions
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers?$expand=customerFinancialDetail
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers?$expand=picture
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers?$expand=contactsInformation

Entity:

{
    "@odata.etag": "W/\"JzIwOzEwNzk5OTQ5Mzg1NDMwOTEyMjkwMTswMDsn\"",
    "id": "1c7e96f0-15e0-ec11-adf8-c90fab2a25c5",
    "number": "01121212",
    "name": "Spotsmeyer's Furnishings",
    "type": "Company",
    "address": "612 South Sunset Drive",
    "address2": "",
    "city": "MIAMI",
    "state": "FL",
    "countryRegionCode": "US",
    "countryRegionCodeVAT": "US",
    "postCode": "US-FL 37125",
    "phoneNo": "",
    "email": "",
    "emailInvoices": "",
    "emailReminders": "",
    "homePage": "",
    "salespersonCode": "RS",
    "balanceDue": 0,
    "creditLimit": 0,
    "taxLiable": false,
    "taxAreaId": "0531e12f-13e0-ec11-adf8-c90fab2a25c5",
    "taxAreaDisplayName": "Klanten en leveranciers (niet EU)",
    "taxRegistrationNumber": "",
    "currencyId": "de951606-13e0-ec11-adf8-c90fab2a25c5",
    "currencyCode": "USD",
    "paymentTermsId": "aa951606-13e0-ec11-adf8-c90fab2a25c5",
    "shipmentMethodId": "9232113a-2ae0-ec11-adf8-c90fab2a25c5",
    "paymentMethodId": "00000000-0000-0000-0000-000000000000",
    "blocked": " ",
    "vatLiable": true,
    "systemModifiedAt": "2022-06-01T08:13:37.637Z"
}

CREATE

method: POST
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers
Body:

{
    "name": "Spotsmeyer's Furnishings",
    "type": "Company",
    "address": "612 South Sunset Drive",
    "address2": "",
    "city": "MIAMI",
    "state": "FL",
    "countryRegionCode": "US",
    "countryRegionCodeVAT": "US",
    "postCode": "US-FL 37125",
    "phoneNo": "",
    "email": "",
    "emailInvoices": "",
    "emailReminders": "",
    "homePage": "",
    "salespersonCode": "RS",
    "creditLimit": 0,
    "taxLiable": false,
    "taxAreaId": "0531e12f-13e0-ec11-adf8-c90fab2a25c5",
    "taxRegistrationNumber": "",
    "currencyId": "de951606-13e0-ec11-adf8-c90fab2a25c5",
    "currencyCode": "USD",
    "paymentTermsId": "aa951606-13e0-ec11-adf8-c90fab2a25c5",
    "shipmentMethodId": "9232113a-2ae0-ec11-adf8-c90fab2a25c5",
    "paymentMethodId": "00000000-0000-0000-0000-000000000000",
    "blocked": " ",
    "vatLiable": true
}

DELETE

method: DELETE
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers(5ac1ebf3-14e7-ec11-adf7-94f78238fd27)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/customers(5ac1ebf3-14e7-ec11-adf7-94f78238fd27)
Headers:
"If-Match" : W/"JzE5Ozg5NTkwMTQwNjA0MDAyNDQ4MzIxOzAwOyc="
Body:

{
    "name": "Test aanpassing"
}