Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "{{secretId}}"
loHttp.Password = "{{secretPassword}}"
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://domain.com/api/invoices/",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// 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
lcCount = loJResp.StringOf("count")
lcV_next = loJResp.StringOf("next")
lcPrevious = loJResp.StringOf("previous")
i = 0
lnCount_i = loJResp.SizeOfArray("results")
do while i < lnCount_i
loJResp.I = i
lcDescription = loJResp.StringOf("results[i].description")
lcProduct_identification = loJResp.StringOf("results[i].product_identification")
lcQuantity = loJResp.StringOf("results[i].quantity")
lcUnit_code = loJResp.StringOf("results[i].unit_code")
lcUnit_description = loJResp.StringOf("results[i].unit_description")
lcUnit_amount = loJResp.StringOf("results[i].unit_amount")
lcPre_tax_amount = loJResp.StringOf("results[i].pre_tax_amount")
lcTax_percentage = loJResp.StringOf("results[i].tax_percentage")
lcTax_amount = loJResp.StringOf("results[i].tax_amount")
lcTotal_amount = loJResp.StringOf("results[i].total_amount")
lcCollected_at = loJResp.StringOf("results[i].collected_at")
j = 0
lnCount_j = loJResp.SizeOfArray("results[i].retained_taxes")
do while j < lnCount_j
loJResp.J = j
lcCollected_at = loJResp.StringOf("results[i].retained_taxes[j].collected_at")
lcTax = loJResp.StringOf("results[i].retained_taxes[j].tax")
lcTax_percentage = loJResp.StringOf("results[i].retained_taxes[j].tax_percentage")
lcRetained_tax_amount = loJResp.StringOf("results[i].retained_taxes[j].retained_tax_amount")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
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]"
}
]
}
