CFL Country/Region API

• 6/20/2022
• 2 minutes to read

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'countryRegion';
EntitySetName = 'countriesRegions';

GET

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/countriesRegions

Entity:

{
    "@odata.etag": "W/\"JzIwOzE0OTc5OTI1Nzc1Mzg3NDY5ODY4MTswMDsn\"",
    "id": "17961606-13e0-ec11-adf8-c90fab2a25c5",
    "code": "AD",
    "displayName": "Andorra",
    "addressFormat": "City+Post Code",
    "contactAddressFormat": "First",
    "isoCode": "AD",
    "euContryRegionCode": "",
    "intrastatCode": "",
    "vatScheme": "",
    "ibanCountryRegion": false,
    "sepaAllowed": false,
    "customerPostingGroup": "NORMAAL",
    "vendorPostingGroup": "NORMAAL",
    "genBusPostingGroup": "NORMAAL",
    "vatBusPostingGroup": "IMPEXP",
    "vatBusPostingGroupNotVATLiable": "BINNENL",
    "languageCode": "ENU",
    "paymentTermsCode": "30 DAGEN",
    "rszCountryRegionCode": "00102",
    "shipmentMethodCode": "DAP",
    "exportProtocolCode": "NONSEPA1",
    "systemModifiedAt": "2022-05-30T12:25:07.85Z"
}

CREATE

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

{
    "code": "TEST",
    "displayName": "Test",
    "addressFormat": "City+Post Code",
    "contactAddressFormat": "First",
    "isoCode": "BE",
    "euContryRegionCode": "",
    "intrastatCode": "",
    "vatScheme": "",
    "ibanCountryRegion": false,
    "sepaAllowed": false,
    "customerPostingGroup": "NORMAAL",
    "vendorPostingGroup": "NORMAAL",
    "genBusPostingGroup": "NORMAAL",
    "vatBusPostingGroup": "BINNENL",
    "vatBusPostingGroupNotVATLiable": "BINNENL",
    "languageCode": "NLB",
    "paymentTermsCode": "30 DAGEN",
    "rszCountryRegionCode": "00102",
    "shipmentMethodCode": "DAP",
    "exportProtocolCode": "SEPA1"
}

DELETE

method: DELETE
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/countriesRegions(17961606-13e0-ec11-adf8-c90fab2a25c5)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/countriesRegions(17961606-13e0-ec11-adf8-c90fab2a25c5)
Headers:
"If-Match" : W/"JzIwOzE0OTc5OTI1Nzc1Mzg3NDY5ODY4MTswMDsn"
Body:

{
    "displayName": "Test aanpassing"
}