Chilkat Online Tools

autoit / Belvo API Docs / List

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_9_5_0.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "{{secretId}}"
$oHttp.Password = "{{secretPassword}}"

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/api/tax-compliance-status/",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.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)

; {
;   "count": "<integer>",
;   "next": "<string>",
;   "previous": "<string>",
;   "results": [
;     {
;       "id": "<uuid>",
;       "collected_at": "<dateTime>",
;       "internal_identification": "<string>",
;       "pdf": "<binary>",
;       "rfc": "<string>",
;       "outcome": "<string>"
;     },
;     {
;       "id": "<uuid>",
;       "collected_at": "<dateTime>",
;       "internal_identification": "<string>",
;       "pdf": "<binary>",
;       "rfc": "<string>",
;       "outcome": "<string>"
;     }
;   ]
; }

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

Local $sId
Local $sCollected_at
Local $sInternal_identification
Local $sPdf
Local $sRfc
Local $sOutcome

Local $sCount = $oJResp.StringOf("count")
Local $sV_next = $oJResp.StringOf("next")
Local $sPrevious = $oJResp.StringOf("previous")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("results")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("results[i].id")
    $sCollected_at = $oJResp.StringOf("results[i].collected_at")
    $sInternal_identification = $oJResp.StringOf("results[i].internal_identification")
    $sPdf = $oJResp.StringOf("results[i].pdf")
    $sRfc = $oJResp.StringOf("results[i].rfc")
    $sOutcome = $oJResp.StringOf("results[i].outcome")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/tax-compliance-status/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "tax-compliance-status",
        ""
      ]
    },
    "description": "Get a paginated list of all existing Tax compliance statuses 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/tax-compliance-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-compliance-status"
          ]
        }
      },
      "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\"collected_at\": \"<dateTime>\",\n\t\t\t\"internal_identification\": \"<string>\",\n\t\t\t\"pdf\": \"<binary>\",\n\t\t\t\"rfc\": \"<string>\",\n\t\t\t\"outcome\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"internal_identification\": \"<string>\",\n\t\t\t\"pdf\": \"<binary>\",\n\t\t\t\"rfc\": \"<string>\",\n\t\t\t\"outcome\": \"<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/tax-compliance-status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "tax-compliance-status"
          ]
        }
      },
      "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]"
    }
  ]
}