Chilkat Online Tools

unicodeC / Belvo API Docs / Detail

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *tax;
    const wchar_t *retained_tax_amount;
    const wchar_t *description;
    const wchar_t *product_identification;
    const wchar_t *quantity;
    const wchar_t *unit_code;
    const wchar_t *unit_description;
    const wchar_t *unit_amount;
    const wchar_t *pre_tax_amount;
    const wchar_t *tax_percentage;
    const wchar_t *tax_amount;
    const wchar_t *total_amount;
    const wchar_t *collected_at;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"{{secretId}}");
    CkHttpW_putPassword(http,L"{{secretPassword}}");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://domain.com/api/invoices/:id/",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

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

    // {
    //   "description": "<string>",
    //   "product_identification": "<string>",
    //   "quantity": "<integer>",
    //   "unit_code": "<string>",
    //   "unit_description": "<string>",
    //   "unit_amount": "<number>",
    //   "pre_tax_amount": "<number>",
    //   "tax_percentage": "<number>",
    //   "tax_amount": "<number>",
    //   "total_amount": "<number>",
    //   "retained_taxes": [
    //     {
    //       "collected_at": "<dateTime>",
    //       "tax": "<string>",
    //       "tax_percentage": "<number>",
    //       "retained_tax_amount": "<number>"
    //     },
    //     {
    //       "collected_at": "<dateTime>",
    //       "tax": "<string>",
    //       "tax_percentage": "<number>",
    //       "retained_tax_amount": "<number>"
    //     }
    //   ],
    //   "collected_at": "<dateTime>"
    // }

    // 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.

    description = CkJsonObjectW_stringOf(jResp,L"description");
    product_identification = CkJsonObjectW_stringOf(jResp,L"product_identification");
    quantity = CkJsonObjectW_stringOf(jResp,L"quantity");
    unit_code = CkJsonObjectW_stringOf(jResp,L"unit_code");
    unit_description = CkJsonObjectW_stringOf(jResp,L"unit_description");
    unit_amount = CkJsonObjectW_stringOf(jResp,L"unit_amount");
    pre_tax_amount = CkJsonObjectW_stringOf(jResp,L"pre_tax_amount");
    tax_percentage = CkJsonObjectW_stringOf(jResp,L"tax_percentage");
    tax_amount = CkJsonObjectW_stringOf(jResp,L"tax_amount");
    total_amount = CkJsonObjectW_stringOf(jResp,L"total_amount");
    collected_at = CkJsonObjectW_stringOf(jResp,L"collected_at");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"retained_taxes");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        collected_at = CkJsonObjectW_stringOf(jResp,L"retained_taxes[i].collected_at");
        tax = CkJsonObjectW_stringOf(jResp,L"retained_taxes[i].tax");
        tax_percentage = CkJsonObjectW_stringOf(jResp,L"retained_taxes[i].tax_percentage");
        retained_tax_amount = CkJsonObjectW_stringOf(jResp,L"retained_taxes[i].retained_tax_amount");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/invoices/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/invoices/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "invoices",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `invoice.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific invoice."
  },
  "response": [
    {
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/invoices/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "invoices",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"description\": \"<string>\",\n\t\"product_identification\": \"<string>\",\n\t\"quantity\": \"<integer>\",\n\t\"unit_code\": \"<string>\",\n\t\"unit_description\": \"<string>\",\n\t\"unit_amount\": \"<number>\",\n\t\"pre_tax_amount\": \"<number>\",\n\t\"tax_percentage\": \"<number>\",\n\t\"tax_amount\": \"<number>\",\n\t\"total_amount\": \"<number>\",\n\t\"retained_taxes\": [\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t},\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t}\n\t],\n\t\"collected_at\": \"<dateTime>\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/invoices/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "invoices",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    },
    {
      "name": "Too Many Sessions",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/invoices/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "invoices",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    }
  ]
}