Chilkat Online Tools

phpExt / Belvo API Docs / List

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('{{secretId}}');
$http->put_Password('{{secretPassword}}');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/api/tax-returns/',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jarrResp = new CkJsonArray();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

$i = 0;
$count_i = $jarrResp->get_Size();
while ($i < $count_i) {
    // json is a CkJsonObject
    $json = $jarrResp->ObjectAt($i);
    $id = $json->stringOf('id');
    $link = $json->stringOf('link');
    $collected_at = $json->stringOf('collected_at');
    $informacion_general = $json->stringOf('informacion_general');
    $sueldos_salarios = $json->stringOf('sueldos_salarios');
    $servicios_profesionales = $json->stringOf('servicios_profesionales');
    $deducciones_personales = $json->stringOf('deducciones_personales');
    $determinacion_impuesto = $json->stringOf('determinacion_impuesto');
    $retenciones = $json->stringOf('retenciones');
    $dividendos = $json->stringOf('dividendos');
    $datos_informativos = $json->stringOf('datos_informativos');
    $pdf = $json->stringOf('pdf');

    $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]"
    }
  ]
}