Chilkat Online Tools

delphiAx / Belvo API Docs / List

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
description: WideString;
product_identification: WideString;
quantity: WideString;
unit_code: WideString;
unit_description: WideString;
unit_amount: WideString;
pre_tax_amount: WideString;
tax_percentage: WideString;
tax_amount: WideString;
total_amount: WideString;
collected_at: WideString;
j: Integer;
count_j: Integer;
tax: WideString;
retained_tax_amount: WideString;
count: WideString;
v_next: WideString;
previous: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := '{{secretId}}';
http.Password := '{{secretPassword}}';

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://domain.com/api/invoices/',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

count := jResp.StringOf('count');
v_next := jResp.StringOf('next');
previous := jResp.StringOf('previous');
i := 0;
count_i := jResp.SizeOfArray('results');
while i < count_i do
  begin
    jResp.I := i;
    description := jResp.StringOf('results[i].description');
    product_identification := jResp.StringOf('results[i].product_identification');
    quantity := jResp.StringOf('results[i].quantity');
    unit_code := jResp.StringOf('results[i].unit_code');
    unit_description := jResp.StringOf('results[i].unit_description');
    unit_amount := jResp.StringOf('results[i].unit_amount');
    pre_tax_amount := jResp.StringOf('results[i].pre_tax_amount');
    tax_percentage := jResp.StringOf('results[i].tax_percentage');
    tax_amount := jResp.StringOf('results[i].tax_amount');
    total_amount := jResp.StringOf('results[i].total_amount');
    collected_at := jResp.StringOf('results[i].collected_at');
    j := 0;
    count_j := jResp.SizeOfArray('results[i].retained_taxes');
    while j < count_j do
      begin
        jResp.J := j;
        collected_at := jResp.StringOf('results[i].retained_taxes[j].collected_at');
        tax := jResp.StringOf('results[i].retained_taxes[j].tax');
        tax_percentage := jResp.StringOf('results[i].retained_taxes[j].tax_percentage');
        retained_tax_amount := jResp.StringOf('results[i].retained_taxes[j].retained_tax_amount');
        j := j + 1;
      end;

    i := i + 1;
  end;

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