Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{secretPassword}}"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/tax-returns/",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJarrResp = ObjCreate("Chilkat.JsonArray")
$oJarrResp.LoadSb($oSbResponseBody)
$oJarrResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJarrResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $oJson
Local $sId
Local $sLink
Local $sCollected_at
Local $sInformacion_general
Local $sueldos_salarios
Local $servicios_profesionales
Local $sDeducciones_personales
Local $sDeterminacion_impuesto
Local $sRetenciones
Local $sDividendos
Local $sDatos_informativos
Local $sPdf
Local $i = 0
Local $iCount_i = $oJarrResp.Size
While $i < $iCount_i
$oJson = $oJarrResp.ObjectAt($i)
$sId = $oJson.StringOf("id")
$sLink = $oJson.StringOf("link")
$sCollected_at = $oJson.StringOf("collected_at")
$sInformacion_general = $oJson.StringOf("informacion_general")
$sueldos_salarios = $oJson.StringOf("sueldos_salarios")
$servicios_profesionales = $oJson.StringOf("servicios_profesionales")
$sDeducciones_personales = $oJson.StringOf("deducciones_personales")
$sDeterminacion_impuesto = $oJson.StringOf("determinacion_impuesto")
$sRetenciones = $oJson.StringOf("retenciones")
$sDividendos = $oJson.StringOf("dividendos")
$sDatos_informativos = $oJson.StringOf("datos_informativos")
$sPdf = $oJson.StringOf("pdf")
$i = $i + 1
Wend
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]"
}
]
}
