Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JarrResp
integer li_RespStatusCode
oleobject loo_Json
string ls_Id
string ls_Link
string ls_Collected_at
string ls_Informacion_general
string ls_Sueldos_salarios
string ls_Servicios_profesionales
string ls_Deducciones_personales
string ls_Determinacion_impuesto
string ls_Retenciones
string ls_Dividendos
string ls_Datos_informativos
string ls_Pdf
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "{{secretId}}"
loo_Http.Password = "{{secretPassword}}"
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://domain.com/api/tax-returns/",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JarrResp = create oleobject
// Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
li_rc = loo_JarrResp.ConnectToNewObject("Chilkat.JsonArray")
loo_JarrResp.LoadSb(loo_SbResponseBody)
loo_JarrResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JarrResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JarrResp
return
end if
// 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
li_Count_i = loo_JarrResp.Size
do while i < li_Count_i
loo_Json = loo_JarrResp.ObjectAt(i)
ls_Id = loo_Json.StringOf("id")
ls_Link = loo_Json.StringOf("link")
ls_Collected_at = loo_Json.StringOf("collected_at")
ls_Informacion_general = loo_Json.StringOf("informacion_general")
ls_Sueldos_salarios = loo_Json.StringOf("sueldos_salarios")
ls_Servicios_profesionales = loo_Json.StringOf("servicios_profesionales")
ls_Deducciones_personales = loo_Json.StringOf("deducciones_personales")
ls_Determinacion_impuesto = loo_Json.StringOf("determinacion_impuesto")
ls_Retenciones = loo_Json.StringOf("retenciones")
ls_Dividendos = loo_Json.StringOf("dividendos")
ls_Datos_informativos = loo_Json.StringOf("datos_informativos")
ls_Pdf = loo_Json.StringOf("pdf")
destroy loo_Json
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JarrResp
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]"
}
]
}
