Chilkat Online Tools

Powershell / Belvo API Docs / List

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "{{secretId}}"
$http.Password = "{{secretPassword}}"

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://domain.com/api/tax-compliance-status/",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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

$count = $jResp.StringOf("count")
$v_next = $jResp.StringOf("next")
$previous = $jResp.StringOf("previous")
$i = 0
$count_i = $jResp.SizeOfArray("results")
while ($i -lt $count_i) {
    $jResp.I = $i
    $id = $jResp.StringOf("results[i].id")
    $collected_at = $jResp.StringOf("results[i].collected_at")
    $internal_identification = $jResp.StringOf("results[i].internal_identification")
    $pdf = $jResp.StringOf("results[i].pdf")
    $rfc = $jResp.StringOf("results[i].rfc")
    $outcome = $jResp.StringOf("results[i].outcome")
    $i = $i + 1
}

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