CFL Vendor API

• 6/20/2022
• 2 minutes to read

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'vendor';
EntitySetName = 'vendors';

GET

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

Entity:

{
    "@odata.etag": "W/\"JzIwOzExMzQ3Nzc5MzA0MTg0NTY5NjM5MTswMDsn\"",
    "id": "657e96f0-15e0-ec11-adf8-c90fab2a25c5",
    "number": "01254796",
    "name": "Progressive Home Furnishings",
    "address": "222 Reagan Drive",
    "address2": "",
    "city": "COLUMBIA",
    "county": "",
    "countryRegionCode": "US",
    "countryRegionCodeVAT": "US",
    "postCode": "US-SC 27136",
    "phoneNo": "",
    "email": "",
    "homePage": "",
    "taxRegistrationNumber": "",
    "currencyId": "e36d3886-3390-eb11-bb60-000d3a38e6db",
    "currencyCode": "USD",
    "paymentTermsId": "8b6d3886-3390-eb11-bb60-000d3a38e6db",
    "paymentMethodId": "00000000-0000-0000-0000-000000000000",
    "taxLiable": false,
    "blocked": " ",
    "balance": 164375.35,
    "systemModifiedAt": "2022-05-30T12:42:44.83Z"
}

CREATE

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

{
    "name": "Progressive Home Furnishings",
    "address": "222 Reagan Drive",
    "address2": "",
    "city": "COLUMBIA",
    "county": "",
    "countryRegionCode": "US",
    "countryRegionCodeVAT": "US",
    "postCode": "US-SC 27136",
    "phoneNo": "",
    "email": "",
    "homePage": "",
    "taxRegistrationNumber": "",
    "currencyId": "e36d3886-3390-eb11-bb60-000d3a38e6db",
    "currencyCode": "USD",
    "paymentTermsId": "8b6d3886-3390-eb11-bb60-000d3a38e6db",
    "paymentMethodId": "00000000-0000-0000-0000-000000000000",
    "taxLiable": false,
    "blocked": " "
}

DELETE

method: DELETE
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/vendors(657e96f0-15e0-ec11-adf8-c90fab2a25c5)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/vendors(657e96f0-15e0-ec11-adf8-c90fab2a25c5)
Headers:
"If-Match" : W/"JzIwOzExMzQ3Nzc5MzA0MTg0NTY5NjM5MTswMDsn" Body:

{
    "name": "Test aanpassing"
}