Chilkat Online Tools

Ruby / Belvo API Docs / List

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("{{secretId}}")
http.put_Password("{{secretPassword}}")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/api/invoices/",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    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
    jResp.put_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
        jResp.put_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]"
    }
  ]
}