Chilkat Online Tools

unicodeCpp / Belvo API Docs / List

Back to Collection Items

#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonArrayW.h>
#include <CkJsonObjectW.h>

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

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"{{secretId}}");
    http.put_Password(L"{{secretPassword}}");

    CkStringBuilderW sbResponseBody;
    success = http.QuickGetSb(L"https://domain.com/api/tax-returns/",sbResponseBody);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonArrayW jarrResp;
    jarrResp.LoadSb(sbResponseBody);
    jarrResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jarrResp.emit());

    int respStatusCode = http.get_LastStatus();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",http.lastHeader());
        wprintf(L"Failed.\n");
        return;
    }

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

    // [
    //   {
    //     "id": "<uuid>",
    //     "link": "<uuid>",
    //     "collected_at": "<dateTime>",
    //     "informacion_general": "<object>",
    //     "sueldos_salarios": "<object>",
    //     "servicios_profesionales": "<object>",
    //     "deducciones_personales": "<object>",
    //     "determinacion_impuesto": "<object>",
    //     "retenciones": "<object>",
    //     "dividendos": "<object>",
    //     "datos_informativos": "<object>",
    //     "pdf": "<binary>"
    //   },
    //   {
    //     "id": "<uuid>",
    //     "link": "<uuid>",
    //     "collected_at": "<dateTime>",
    //     "informacion_general": "<object>",
    //     "sueldos_salarios": "<object>",
    //     "servicios_profesionales": "<object>",
    //     "deducciones_personales": "<object>",
    //     "determinacion_impuesto": "<object>",
    //     "retenciones": "<object>",
    //     "dividendos": "<object>",
    //     "datos_informativos": "<object>",
    //     "pdf": "<binary>"
    //   }
    // ]

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

    CkJsonObjectW *json = 0;
    const wchar_t *id = 0;
    const wchar_t *link = 0;
    const wchar_t *collected_at = 0;
    const wchar_t *informacion_general = 0;
    const wchar_t *sueldos_salarios = 0;
    const wchar_t *servicios_profesionales = 0;
    const wchar_t *deducciones_personales = 0;
    const wchar_t *determinacion_impuesto = 0;
    const wchar_t *retenciones = 0;
    const wchar_t *dividendos = 0;
    const wchar_t *datos_informativos = 0;
    const wchar_t *pdf = 0;

    int i = 0;
    int count_i = jarrResp.get_Size();
    while (i < count_i) {
        json = jarrResp.ObjectAt(i);
        id = json->stringOf(L"id");
        link = json->stringOf(L"link");
        collected_at = json->stringOf(L"collected_at");
        informacion_general = json->stringOf(L"informacion_general");
        sueldos_salarios = json->stringOf(L"sueldos_salarios");
        servicios_profesionales = json->stringOf(L"servicios_profesionales");
        deducciones_personales = json->stringOf(L"deducciones_personales");
        determinacion_impuesto = json->stringOf(L"determinacion_impuesto");
        retenciones = json->stringOf(L"retenciones");
        dividendos = json->stringOf(L"dividendos");
        datos_informativos = json->stringOf(L"datos_informativos");
        pdf = json->stringOf(L"pdf");
        delete json;
        i = i + 1;
    }
    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/tax-returns/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "tax-returns",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set.",
          "disabled": true
        }
      ]
    },
    "description": "Get a paginated list of all existing tax returns in your Belvo account. We return up to 100 results per page.\n\nThe results will include a mix of both monthly and yearly tax returns."
  },
  "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/tax-returns?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-returns"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"informacion_general\": \"<object>\",\n\t\t\"sueldos_salarios\": \"<object>\",\n\t\t\"servicios_profesionales\": \"<object>\",\n\t\t\"deducciones_personales\": \"<object>\",\n\t\t\"determinacion_impuesto\": \"<object>\",\n\t\t\"retenciones\": \"<object>\",\n\t\t\"dividendos\": \"<object>\",\n\t\t\"datos_informativos\": \"<object>\",\n\t\t\"pdf\": \"<binary>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"informacion_general\": \"<object>\",\n\t\t\"sueldos_salarios\": \"<object>\",\n\t\t\"servicios_profesionales\": \"<object>\",\n\t\t\"deducciones_personales\": \"<object>\",\n\t\t\"determinacion_impuesto\": \"<object>\",\n\t\t\"retenciones\": \"<object>\",\n\t\t\"dividendos\": \"<object>\",\n\t\t\"datos_informativos\": \"<object>\",\n\t\t\"pdf\": \"<binary>\"\n\t}\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/tax-returns?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-returns"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "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]"
    }
  ]
}