Chilkat Online Tools

C / easybill REST API / Fetch document payment

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *document_id;
    const char *amount;
    const char *id;
    const char *is_overdue_fee;
    const char *login_id;
    const char *notice;
    const char *payment_at;
    const char *v_type;
    const char *provider;
    const char *reference;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttp_Create();

    CkHttp_SetRequestHeader(http,"Authorization","{{apiKey}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://api.easybill.de/rest/v1/document-payments/:id",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "document_id": "<long>",
    //   "amount": "<integer>",
    //   "id": "<long>",
    //   "is_overdue_fee": "<boolean>",
    //   "login_id": "<long>",
    //   "notice": "",
    //   "payment_at": "<date>",
    //   "type": "",
    //   "provider": "",
    //   "reference": ""
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    document_id = CkJsonObject_stringOf(jResp,"document_id");
    amount = CkJsonObject_stringOf(jResp,"amount");
    id = CkJsonObject_stringOf(jResp,"id");
    is_overdue_fee = CkJsonObject_stringOf(jResp,"is_overdue_fee");
    login_id = CkJsonObject_stringOf(jResp,"login_id");
    notice = CkJsonObject_stringOf(jResp,"notice");
    payment_at = CkJsonObject_stringOf(jResp,"payment_at");
    v_type = CkJsonObject_stringOf(jResp,"type");
    provider = CkJsonObject_stringOf(jResp,"provider");
    reference = CkJsonObject_stringOf(jResp,"reference");


    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/document-payments/:id

Postman Collection Item JSON

{
  "name": "Fetch document payment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/document-payments/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "document-payments",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of document payment"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/document-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"document_id\": \"<long>\",\n  \"amount\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"is_overdue_fee\": \"<boolean>\",\n  \"login_id\": \"<long>\",\n  \"notice\": \"\",\n  \"payment_at\": \"<date>\",\n  \"type\": \"\",\n  \"provider\": \"\",\n  \"reference\": \"\"\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/document-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/document-payments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-payments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}