CFL Deferral Templates API

• 6/20/2022
• 2 minutes to read

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'deferralTemplate';
EntitySetName = 'deferralTemplates';

GET

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

Entity:

 {
    "@odata.etag": "W/\"JzE5OzY5MDg5Mzg4NTc4OTA2OTY2MzIxOzAwOyc=\"",
    "id": "543b43a0-10e7-ec11-adf7-94f78238fd27",
    "deferralCode": "12M",
    "description": "12 maanden",
    "deferralAccount": "499999",
    "deferralPercent": 100,
    "calcMethod": "Straight-Line",
    "startDate": "Posting Date",
    "noOfPeriods": 12,
    "periodDescription": "Maand",
    "systemModifiedAt": "2022-06-08T09:52:10.367Z"
}

CREATE

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

{
    "deferralCode": "6M",
    "description": "6 maanden",
    "deferralAccount": "499999",
    "deferralPercent": 50,
    "calcMethod": "Straight-Line",
    "startDate": "Posting Date",
    "noOfPeriods": 6,
    "periodDescription": "Maand"
}

DELETE

method: DELETE
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/deferralTemplates(543b43a0-10e7-ec11-adf7-94f78238fd27)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/deferralTemplates(543b43a0-10e7-ec11-adf7-94f78238fd27)
Headers:
"If-Match" : W/"JzE5OzY5MDg5Mzg4NTc4OTA2OTY2MzIxOzAwOyc="
Body:

{
    "description": "Test aanpassing"
}