CFL Journals API

• 6/20/2022
• 2 minutes to read

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'journal';
EntitySetName = 'journals';

GET

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

Entity:

{
    "@odata.etag": "W/\"JzIwOzEwOTk0Nzg4NTcxNjc0MDczOTUzMTswMDsn\"",
    "id": "62e2bc4d-13e0-ec11-adf8-c90fab2a25c5",
    "name": "ISABEL",
    "description": "Betalingen via Isabel",
    "journalTemplateName": "ALGEMEEN",
    "systemModifiedAt": "2022-05-30T12:32:51.583Z",
    "balancingAccountId": "ec44f4fa-3390-eb11-bb60-000d3a38e6db",
    "balancingAccountNumber": "499999"
}

CREATE

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/journals?$expand=journalLines

Entity:

{
    "@odata.etag": "W/\"JzIwOzE2Nzc2NzM1MTMzMjU2Njk5NTI5MTswMDsn\"",
    "id": "e0f36a5e-34e3-ec11-adf7-d8f92d083b76",
    "name": "TEST",
    "description": "test aanpassing",
    "journalTemplateName": "ALGEMEEN",
    "systemModifiedAt": "2022-06-03T11:58:43.88Z",
    "balancingAccountId": "00000000-0000-0000-0000-000000000000",
    "balancingAccountNumber": "",
    "journalLines": [
        {
            "@odata.etag": "W/\"JzE5Ozg0MzczNjIyMDQ4MTE5MjIwNzcxOzAwOyc=\"",
            "id": "f65cbb6c-36e3-ec11-adf7-d8f92d083b76",
            "journalBatchId": "e0f36a5e-34e3-ec11-adf7-d8f92d083b76",
            "journalBatchName": "TEST",
            "lineNumber": 10000,
            "accountType": "Customer",
            "accountId": "00000000-0000-0000-0000-000000000000",
            "accountNumber": "K00010",
            "postingDate": "2023-01-26",
            "documentNumber": "TEST",
            "externalDocumentNumber": "",
            "amount": 100,
            "description": "Christiaens NV",
            "comment": "",
            "taxCode": "",
            "numberPlate": "",
            "balanceAccountType": "G/L Account",
            "balancingAccountId": "00000000-0000-0000-0000-000000000000",
            "balancingAccountNumber": "",
            "systemModifiedAt": "2022-06-03T12:12:32.29Z"
        }
    ]
}

CREATE

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

{
    "name": "TEST",
    "description": "TEST-desc",
    "journalTemplateName": "ALGEMEEN",
    "balancingAccountId": "ec44f4fa-3390-eb11-bb60-000d3a38e6db",
    "balancingAccountNumber": "499999",
    "journalLines": [
        {
            "lineNumber": 10000,
            "accountType": "Customer",
            "accountNumber": "K00010",
            "postingDate": "2023-01-26",
            "documentNumber": "TEST1",
            "externalDocumentNumber": "Test external 1",
            "amount": 100,
            "description": "Christiaens NV",
            "comment": "",
            "taxCode": "",
            "numberPlate": "",
            "balanceAccountType": "G/L Account",
            "balancingAccountId": "00000000-0000-0000-0000-000000000000",
            "balancingAccountNumber": "",
        },
        {
            "lineNumber": 20000,
            "accountType": "Customer",
            "accountNumber": "K00010",
            "postingDate": "2023-01-27",
            "documentNumber": "TEST2",
            "externalDocumentNumber": "Test external 2",
            "amount": 200,
            "description": "Christiaens NV",
            "comment": "",
            "taxCode": "",
            "numberPlate": "",
            "balanceAccountType": "G/L Account",
            "balancingAccountId": "00000000-0000-0000-0000-000000000000",
            "balancingAccountNumber": "",
        }
    ]
}

DELETE

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

UPDATE

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

{
    "description": "TEST-aanpassing"
}

CFL JournalLines API

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'journalLine';
EntitySetName = 'journalLines';

GET

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/journalLines(1bff65f6-38e3-ec11-adf7-d8f92d083b76)

Entity:

{
    "@odata.context": "http://bc201-opleiding:7048/BC/api/Christiaens/BoCountDynamics/v2.0/$metadata#companies(9bf826fd-0be0-ec11-adf8-c90fab2a25c5)/journalLines/$entity",
    "@odata.etag": "W/\"JzE5OzYyMDc1NTg0MDQ5NTc2NDE1NjQxOzAwOyc=\"",
    "id": "1bff65f6-38e3-ec11-adf7-d8f92d083b76",
    "journalBatchId": "1aff65f6-38e3-ec11-adf7-d8f92d083b76",
    "journalBatchName": "TEST",
    "lineNumber": 10000,
    "accountType": "Customer",
    "accountId": "00000000-0000-0000-0000-000000000000",
    "accountNumber": "K00010",
    "postingDate": "2023-01-26",
    "documentNumber": "TEST1",
    "externalDocumentNumber": "TEST EXTERNAL 1",
    "amount": 100,
    "description": "Christiaens NV",
    "comment": "",
    "taxCode": "",
    "numberPlate": "",
    "balanceAccountType": "G/L Account",
    "balancingAccountId": "00000000-0000-0000-0000-000000000000",
    "balancingAccountNumber": "",
    "systemModifiedAt": "2022-06-03T12:30:34.57Z"
}

CREATE

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/journals?$expand=journalLines

Entity:

{
    "journalBatchId": "1aff65f6-38e3-ec11-adf7-d8f92d083b76",
    "lineNumber": 20000,
    "accountType": "Customer",
    "accountId": "00000000-0000-0000-0000-000000000000",
    "accountNumber": "K00010",
    "postingDate": "2023-01-26",
    "documentNumber": "TEST1",
    "externalDocumentNumber": "TEST EXTERNAL 1",
    "amount": 100,
    "description": "Christiaens NV",
    "comment": "",
    "taxCode": "",
    "numberPlate": "",
    "balanceAccountType": "G/L Account",
    "balancingAccountId": "00000000-0000-0000-0000-000000000000",
    "balancingAccountNumber": "",
}   

DELETE

method: DELETE
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/numberplates(1aff65f6-38e3-ec11-adf7-d8f92d083b76)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/numberplates(1aff65f6-38e3-ec11-adf7-d8f92d083b76)
Headers:
"If-Match" : W/"JzE5OzQ1MzQ2ODQwOTQ3NTEyMDk0NjUxOzAwOyc="
Body:

{
    "externalDocumentNumber": "TEST-aanpassing"
}