Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "{{secretId}}"
CkHttp_put_Password $http "{{secretPassword}}"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/api/invoices/" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "count": "<integer>",
# "next": "<string>",
# "previous": "<string>",
# "results": [
# {
# "description": "<string>",
# "product_identification": "<string>",
# "quantity": "<integer>",
# "unit_code": "<string>",
# "unit_description": "<string>",
# "unit_amount": "<number>",
# "pre_tax_amount": "<number>",
# "tax_percentage": "<number>",
# "tax_amount": "<number>",
# "total_amount": "<number>",
# "retained_taxes": [
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# },
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# }
# ],
# "collected_at": "<dateTime>"
# },
# {
# "description": "<string>",
# "product_identification": "<string>",
# "quantity": "<integer>",
# "unit_code": "<string>",
# "unit_description": "<string>",
# "unit_amount": "<number>",
# "pre_tax_amount": "<number>",
# "tax_percentage": "<number>",
# "tax_amount": "<number>",
# "total_amount": "<number>",
# "retained_taxes": [
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# },
# {
# "collected_at": "<dateTime>",
# "tax": "<string>",
# "tax_percentage": "<number>",
# "retained_tax_amount": "<number>"
# }
# ],
# "collected_at": "<dateTime>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set count [CkJsonObject_stringOf $jResp "count"]
set v_next [CkJsonObject_stringOf $jResp "next"]
set previous [CkJsonObject_stringOf $jResp "previous"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "results"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set description [CkJsonObject_stringOf $jResp "results[i].description"]
set product_identification [CkJsonObject_stringOf $jResp "results[i].product_identification"]
set quantity [CkJsonObject_stringOf $jResp "results[i].quantity"]
set unit_code [CkJsonObject_stringOf $jResp "results[i].unit_code"]
set unit_description [CkJsonObject_stringOf $jResp "results[i].unit_description"]
set unit_amount [CkJsonObject_stringOf $jResp "results[i].unit_amount"]
set pre_tax_amount [CkJsonObject_stringOf $jResp "results[i].pre_tax_amount"]
set tax_percentage [CkJsonObject_stringOf $jResp "results[i].tax_percentage"]
set tax_amount [CkJsonObject_stringOf $jResp "results[i].tax_amount"]
set total_amount [CkJsonObject_stringOf $jResp "results[i].total_amount"]
set collected_at [CkJsonObject_stringOf $jResp "results[i].collected_at"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].retained_taxes"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set collected_at [CkJsonObject_stringOf $jResp "results[i].retained_taxes[j].collected_at"]
set tax [CkJsonObject_stringOf $jResp "results[i].retained_taxes[j].tax"]
set tax_percentage [CkJsonObject_stringOf $jResp "results[i].retained_taxes[j].tax_percentage"]
set retained_tax_amount [CkJsonObject_stringOf $jResp "results[i].retained_taxes[j].retained_tax_amount"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/invoices/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/invoices/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set.",
"disabled": true
}
]
},
"description": "Get a paginated list of all existing invoices 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/invoices?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
],
"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\"description\": \"<string>\",\n\t\t\t\"product_identification\": \"<string>\",\n\t\t\t\"quantity\": \"<integer>\",\n\t\t\t\"unit_code\": \"<string>\",\n\t\t\t\"unit_description\": \"<string>\",\n\t\t\t\"unit_amount\": \"<number>\",\n\t\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"tax_amount\": \"<number>\",\n\t\t\t\"total_amount\": \"<number>\",\n\t\t\t\"retained_taxes\": [\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"collected_at\": \"<dateTime>\"\n\t\t},\n\t\t{\n\t\t\t\"description\": \"<string>\",\n\t\t\t\"product_identification\": \"<string>\",\n\t\t\t\"quantity\": \"<integer>\",\n\t\t\t\"unit_code\": \"<string>\",\n\t\t\t\"unit_description\": \"<string>\",\n\t\t\t\"unit_amount\": \"<number>\",\n\t\t\t\"pre_tax_amount\": \"<number>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"tax_amount\": \"<number>\",\n\t\t\t\"total_amount\": \"<number>\",\n\t\t\t\"retained_taxes\": [\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\t\"tax\": \"<string>\",\n\t\t\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"collected_at\": \"<dateTime>\"\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/invoices?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices"
],
"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]"
}
]
}