Chilkat Online Tools

Go / Belvo API Docs / List

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("{{secretId}}")
    http.SetPassword("{{secretPassword}}")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://domain.com/api/tax-returns/",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jarrResp := chilkat.NewJsonArray()
    jarrResp.LoadSb(sbResponseBody)
    jarrResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jarrResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jarrResp.DisposeJsonArray()
        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 is a JsonObject_Ref.html">JsonObject
    var id *string = new(string)
    var link *string = new(string)
    var collected_at *string = new(string)
    var informacion_general *string = new(string)
    var sueldos_salarios *string = new(string)
    var servicios_profesionales *string = new(string)
    var deducciones_personales *string = new(string)
    var determinacion_impuesto *string = new(string)
    var retenciones *string = new(string)
    var dividendos *string = new(string)
    var datos_informativos *string = new(string)
    var pdf *string = new(string)

    i := 0
    count_i := jarrResp.Size()
    for 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")
        json.DisposeJsonObject()
        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jarrResp.DisposeJsonArray()

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