Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "{{secretId}}";
http.Password = "{{secretPassword}}";
var sbResponseBody = new chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/api/tax-returns/",sbResponseBody);
if (success == false) {
console.log(http.LastErrorText);
return;
}
var jarrResp = new chilkat.JsonArray();
jarrResp.LoadSb(sbResponseBody);
jarrResp.EmitCompact = false;
console.log("Response Body:");
console.log(jarrResp.Emit());
var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(http.LastHeader);
console.log("Failed.");
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
// json: JsonObject
var json;
var id;
var link;
var collected_at;
var informacion_general;
var sueldos_salarios;
var servicios_profesionales;
var deducciones_personales;
var determinacion_impuesto;
var retenciones;
var dividendos;
var datos_informativos;
var pdf;
var i = 0;
var count_i = jarrResp.Size;
while (i < count_i) {
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;
}
}
chilkatExample();
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]"
}
]
}
