Chilkat Online Tools

delphiDll / Belvo API Docs / List

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
description: PWideChar;
product_identification: PWideChar;
quantity: PWideChar;
unit_code: PWideChar;
unit_description: PWideChar;
unit_amount: PWideChar;
pre_tax_amount: PWideChar;
tax_percentage: PWideChar;
tax_amount: PWideChar;
total_amount: PWideChar;
collected_at: PWideChar;
j: Integer;
count_j: Integer;
tax: PWideChar;
retained_tax_amount: PWideChar;
count: PWideChar;
v_next: PWideChar;
previous: PWideChar;
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 := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'{{secretId}}');
CkHttp_putPassword(http,'{{secretPassword}}');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/api/invoices/',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

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

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    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 := CkJsonObject__stringOf(jResp,'count');
v_next := CkJsonObject__stringOf(jResp,'next');
previous := CkJsonObject__stringOf(jResp,'previous');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'results');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    description := CkJsonObject__stringOf(jResp,'results[i].description');
    product_identification := CkJsonObject__stringOf(jResp,'results[i].product_identification');
    quantity := CkJsonObject__stringOf(jResp,'results[i].quantity');
    unit_code := CkJsonObject__stringOf(jResp,'results[i].unit_code');
    unit_description := CkJsonObject__stringOf(jResp,'results[i].unit_description');
    unit_amount := CkJsonObject__stringOf(jResp,'results[i].unit_amount');
    pre_tax_amount := CkJsonObject__stringOf(jResp,'results[i].pre_tax_amount');
    tax_percentage := CkJsonObject__stringOf(jResp,'results[i].tax_percentage');
    tax_amount := CkJsonObject__stringOf(jResp,'results[i].tax_amount');
    total_amount := CkJsonObject__stringOf(jResp,'results[i].total_amount');
    collected_at := CkJsonObject__stringOf(jResp,'results[i].collected_at');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'results[i].retained_taxes');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        collected_at := CkJsonObject__stringOf(jResp,'results[i].retained_taxes[j].collected_at');
        tax := CkJsonObject__stringOf(jResp,'results[i].retained_taxes[j].tax');
        tax_percentage := CkJsonObject__stringOf(jResp,'results[i].retained_taxes[j].tax_percentage');
        retained_tax_amount := CkJsonObject__stringOf(jResp,'results[i].retained_taxes[j].retained_tax_amount');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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]"
    }
  ]
}