Chilkat Online Tools

VBScript / Belvo API Docs / List

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

http.BasicAuth = 1
http.Login = "{{secretId}}"
http.Password = "{{secretPassword}}"

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = http.QuickGetSb("https://domain.com/api/balances/",sbResponseBody)
If (success = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = http.LastStatus
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(http.LastHeader)
    outFile.WriteLine("Failed.")
    WScript.Quit
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "count": "<integer>",
'   "next": "<string>",
'   "previous": "<string>",
'   "results": [
'     {
'       "id": "<uuid>",
'       "account": {
'         "id": "<uuid>",
'         "name": "<string>",
'         "category": "irure",
'         "currency": "<string>"
'       },
'       "collected_at": "<dateTime>",
'       "value_date": "<date>",
'       "balance": "<number>",
'       "current_balance": "<number>",
'       "statement": "<string>"
'     },
'     {
'       "id": "<uuid>",
'       "account": {
'         "id": "<uuid>",
'         "name": "<string>",
'         "category": "in culpa cupidatat ullamco",
'         "currency": "<string>"
'       },
'       "collected_at": "<dateTime>",
'       "value_date": "<date>",
'       "balance": "<number>",
'       "current_balance": "<number>",
'       "statement": "<string>"
'     }
'   ]
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

count = jResp.StringOf("count")
v_next = jResp.StringOf("next")
previous = jResp.StringOf("previous")
i = 0
count_i = jResp.SizeOfArray("results")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("results[i].id")
    Id = jResp.StringOf("results[i].account.id")
    Name = jResp.StringOf("results[i].account.name")
    Category = jResp.StringOf("results[i].account.category")
    v_Currency = jResp.StringOf("results[i].account.currency")
    collected_at = jResp.StringOf("results[i].collected_at")
    value_date = jResp.StringOf("results[i].value_date")
    balance = jResp.StringOf("results[i].balance")
    current_balance = jResp.StringOf("results[i].current_balance")
    statement = jResp.StringOf("results[i].statement")
    i = i + 1
Loop

outFile.Close

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/balances/

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/balances/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "balances",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set.",
          "disabled": true
        }
      ]
    },
    "description": "Get a paginated list of all existing balances in your Belvo account. We return up to 100 results per page."
  },
  "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/balances?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"irure\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"in culpa cupidatat ullamco\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\n\t\t}\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/balances?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "balances"
          ],
          "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]"
    }
  ]
}