Chilkat Online Tools

VB6 / easybill REST API / Fetch customer

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

http.SetRequestHeader "Authorization","{{apiKey}}"
http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://api.easybill.de/rest/v1/customers/:id",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "last_name": "<string>",
'   "company_name": "<string>",
'   "acquire_options": 2,
'   "additional_groups_ids": [
'     "<integer>",
'     "<integer>"
'   ],
'   "bank_account": "<string>",
'   "bank_account_owner": "<string>",
'   "bank_bic": "<string>",
'   "bank_code": "<string>",
'   "bank_iban": "<string>",
'   "bank_name": "<string>",
'   "birth_date": "<date>",
'   "cash_allowance": "<float>",
'   "cash_allowance_days": 7,
'   "cash_discount": "<float>",
'   "cash_discount_type": "AMOUNT",
'   "city": "<string>",
'   "state": "<string>",
'   "country": "<string>",
'   "created_at": "<date>",
'   "updated_at": "<string>",
'   "delivery_title": "<string>",
'   "delivery_city": "<string>",
'   "delivery_state": "<string>",
'   "delivery_company_name": "<string>",
'   "delivery_country": "<string>",
'   "delivery_first_name": "<string>",
'   "delivery_last_name": "<string>",
'   "delivery_personal": "<boolean>",
'   "delivery_salutation": 0,
'   "delivery_street": "<string>",
'   "delivery_suffix_1": "<string>",
'   "delivery_suffix_2": "<string>",
'   "delivery_zip_code": "<string>",
'   "display_name": "<string>",
'   "emails": [
'     "<string>",
'     "<string>"
'   ],
'   "fax": "<string>",
'   "first_name": "<string>",
'   "grace_period": "<integer>",
'   "due_in_days": "<integer>",
'   "group_id": "<integer>",
'   "id": "<long>",
'   "info_1": "<string>",
'   "info_2": "<string>",
'   "internet": "<string>",
'   "login_id": "<long>",
'   "mobile": "<string>",
'   "note": "<string>",
'   "number": "<string>",
'   "payment_options": 5,
'   "personal": false,
'   "phone_1": "<string>",
'   "phone_2": "<string>",
'   "postbox": "<string>",
'   "postbox_city": "<string>",
'   "postbox_state": "<string>",
'   "postbox_country": "<string>",
'   "postbox_zip_code": "<string>",
'   "sale_price_level": "SALEPRICE10",
'   "salutation": 0,
'   "sepa_agreement": "BASIC",
'   "sepa_agreement_date": "<date>",
'   "sepa_mandate_reference": "<string>",
'   "since_date": "<date>",
'   "street": "<string>",
'   "suffix_1": "<string>",
'   "suffix_2": "<string>",
'   "tax_number": "<string>",
'   "court": "<string>",
'   "court_registry_number": "<string>",
'   "tax_options": "nStbUstID",
'   "title": "<string>",
'   "archived": "<boolean>",
'   "vat_identifier": "<string>",
'   "zip_code": "<string>",
'   "document_pdf_type": "default",
'   "buyer_reference": "<string>",
'   "foreign_supplier_number": "<string>"
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim strVal As String

Dim last_name As String
last_name = jResp.StringOf("last_name")
Dim company_name As String
company_name = jResp.StringOf("company_name")
Dim acquire_options As Long
acquire_options = jResp.IntOf("acquire_options")
Dim bank_account As String
bank_account = jResp.StringOf("bank_account")
Dim bank_account_owner As String
bank_account_owner = jResp.StringOf("bank_account_owner")
Dim bank_bic As String
bank_bic = jResp.StringOf("bank_bic")
Dim bank_code As String
bank_code = jResp.StringOf("bank_code")
Dim bank_iban As String
bank_iban = jResp.StringOf("bank_iban")
Dim bank_name As String
bank_name = jResp.StringOf("bank_name")
Dim birth_date As String
birth_date = jResp.StringOf("birth_date")
Dim cash_allowance As String
cash_allowance = jResp.StringOf("cash_allowance")
Dim cash_allowance_days As Long
cash_allowance_days = jResp.IntOf("cash_allowance_days")
Dim cash_discount As String
cash_discount = jResp.StringOf("cash_discount")
Dim cash_discount_type As String
cash_discount_type = jResp.StringOf("cash_discount_type")
Dim city As String
city = jResp.StringOf("city")
Dim state As String
state = jResp.StringOf("state")
Dim country As String
country = jResp.StringOf("country")
Dim created_at As String
created_at = jResp.StringOf("created_at")
Dim updated_at As String
updated_at = jResp.StringOf("updated_at")
Dim delivery_title As String
delivery_title = jResp.StringOf("delivery_title")
Dim delivery_city As String
delivery_city = jResp.StringOf("delivery_city")
Dim delivery_state As String
delivery_state = jResp.StringOf("delivery_state")
Dim delivery_company_name As String
delivery_company_name = jResp.StringOf("delivery_company_name")
Dim delivery_country As String
delivery_country = jResp.StringOf("delivery_country")
Dim delivery_first_name As String
delivery_first_name = jResp.StringOf("delivery_first_name")
Dim delivery_last_name As String
delivery_last_name = jResp.StringOf("delivery_last_name")
Dim delivery_personal As String
delivery_personal = jResp.StringOf("delivery_personal")
Dim delivery_salutation As Long
delivery_salutation = jResp.IntOf("delivery_salutation")
Dim delivery_street As String
delivery_street = jResp.StringOf("delivery_street")
Dim delivery_suffix_1 As String
delivery_suffix_1 = jResp.StringOf("delivery_suffix_1")
Dim delivery_suffix_2 As String
delivery_suffix_2 = jResp.StringOf("delivery_suffix_2")
Dim delivery_zip_code As String
delivery_zip_code = jResp.StringOf("delivery_zip_code")
Dim display_name As String
display_name = jResp.StringOf("display_name")
Dim fax As String
fax = jResp.StringOf("fax")
Dim first_name As String
first_name = jResp.StringOf("first_name")
Dim grace_period As String
grace_period = jResp.StringOf("grace_period")
Dim due_in_days As String
due_in_days = jResp.StringOf("due_in_days")
Dim group_id As String
group_id = jResp.StringOf("group_id")
Dim id As String
id = jResp.StringOf("id")
Dim info_1 As String
info_1 = jResp.StringOf("info_1")
Dim info_2 As String
info_2 = jResp.StringOf("info_2")
Dim internet As String
internet = jResp.StringOf("internet")
Dim login_id As String
login_id = jResp.StringOf("login_id")
Dim mobile As String
mobile = jResp.StringOf("mobile")
Dim note As String
note = jResp.StringOf("note")
Dim v_number As String
v_number = jResp.StringOf("number")
Dim payment_options As Long
payment_options = jResp.IntOf("payment_options")
Dim personal As Long
personal = jResp.BoolOf("personal")
Dim phone_1 As String
phone_1 = jResp.StringOf("phone_1")
Dim phone_2 As String
phone_2 = jResp.StringOf("phone_2")
Dim postbox As String
postbox = jResp.StringOf("postbox")
Dim postbox_city As String
postbox_city = jResp.StringOf("postbox_city")
Dim postbox_state As String
postbox_state = jResp.StringOf("postbox_state")
Dim postbox_country As String
postbox_country = jResp.StringOf("postbox_country")
Dim postbox_zip_code As String
postbox_zip_code = jResp.StringOf("postbox_zip_code")
Dim sale_price_level As String
sale_price_level = jResp.StringOf("sale_price_level")
Dim salutation As Long
salutation = jResp.IntOf("salutation")
Dim sepa_agreement As String
sepa_agreement = jResp.StringOf("sepa_agreement")
Dim sepa_agreement_date As String
sepa_agreement_date = jResp.StringOf("sepa_agreement_date")
Dim sepa_mandate_reference As String
sepa_mandate_reference = jResp.StringOf("sepa_mandate_reference")
Dim since_date As String
since_date = jResp.StringOf("since_date")
Dim street As String
street = jResp.StringOf("street")
Dim suffix_1 As String
suffix_1 = jResp.StringOf("suffix_1")
Dim suffix_2 As String
suffix_2 = jResp.StringOf("suffix_2")
Dim tax_number As String
tax_number = jResp.StringOf("tax_number")
Dim court As String
court = jResp.StringOf("court")
Dim court_registry_number As String
court_registry_number = jResp.StringOf("court_registry_number")
Dim tax_options As String
tax_options = jResp.StringOf("tax_options")
Dim title As String
title = jResp.StringOf("title")
Dim archived As String
archived = jResp.StringOf("archived")
Dim vat_identifier As String
vat_identifier = jResp.StringOf("vat_identifier")
Dim zip_code As String
zip_code = jResp.StringOf("zip_code")
Dim document_pdf_type As String
document_pdf_type = jResp.StringOf("document_pdf_type")
Dim buyer_reference As String
buyer_reference = jResp.StringOf("buyer_reference")
Dim foreign_supplier_number As String
foreign_supplier_number = jResp.StringOf("foreign_supplier_number")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("additional_groups_ids")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("additional_groups_ids[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("emails")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("emails[i]")
    i = i + 1
Loop

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/customers/:id

Postman Collection Item JSON

{
  "name": "Fetch customer",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/customers/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "customers",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of customer that needs to be fetched"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/customers/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"last_name\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"acquire_options\": 2,\n  \"additional_groups_ids\": [\n    \"<integer>\",\n    \"<integer>\"\n  ],\n  \"bank_account\": \"<string>\",\n  \"bank_account_owner\": \"<string>\",\n  \"bank_bic\": \"<string>\",\n  \"bank_code\": \"<string>\",\n  \"bank_iban\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"birth_date\": \"<date>\",\n  \"cash_allowance\": \"<float>\",\n  \"cash_allowance_days\": 7,\n  \"cash_discount\": \"<float>\",\n  \"cash_discount_type\": \"AMOUNT\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"country\": \"<string>\",\n  \"created_at\": \"<date>\",\n  \"updated_at\": \"<string>\",\n  \"delivery_title\": \"<string>\",\n  \"delivery_city\": \"<string>\",\n  \"delivery_state\": \"<string>\",\n  \"delivery_company_name\": \"<string>\",\n  \"delivery_country\": \"<string>\",\n  \"delivery_first_name\": \"<string>\",\n  \"delivery_last_name\": \"<string>\",\n  \"delivery_personal\": \"<boolean>\",\n  \"delivery_salutation\": 0,\n  \"delivery_street\": \"<string>\",\n  \"delivery_suffix_1\": \"<string>\",\n  \"delivery_suffix_2\": \"<string>\",\n  \"delivery_zip_code\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"emails\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"fax\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"grace_period\": \"<integer>\",\n  \"due_in_days\": \"<integer>\",\n  \"group_id\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"info_1\": \"<string>\",\n  \"info_2\": \"<string>\",\n  \"internet\": \"<string>\",\n  \"login_id\": \"<long>\",\n  \"mobile\": \"<string>\",\n  \"note\": \"<string>\",\n  \"number\": \"<string>\",\n  \"payment_options\": 5,\n  \"personal\": false,\n  \"phone_1\": \"<string>\",\n  \"phone_2\": \"<string>\",\n  \"postbox\": \"<string>\",\n  \"postbox_city\": \"<string>\",\n  \"postbox_state\": \"<string>\",\n  \"postbox_country\": \"<string>\",\n  \"postbox_zip_code\": \"<string>\",\n  \"sale_price_level\": \"SALEPRICE10\",\n  \"salutation\": 0,\n  \"sepa_agreement\": \"BASIC\",\n  \"sepa_agreement_date\": \"<date>\",\n  \"sepa_mandate_reference\": \"<string>\",\n  \"since_date\": \"<date>\",\n  \"street\": \"<string>\",\n  \"suffix_1\": \"<string>\",\n  \"suffix_2\": \"<string>\",\n  \"tax_number\": \"<string>\",\n  \"court\": \"<string>\",\n  \"court_registry_number\": \"<string>\",\n  \"tax_options\": \"nStbUstID\",\n  \"title\": \"<string>\",\n  \"archived\": \"<boolean>\",\n  \"vat_identifier\": \"<string>\",\n  \"zip_code\": \"<string>\",\n  \"document_pdf_type\": \"default\",\n  \"buyer_reference\": \"<string>\",\n  \"foreign_supplier_number\": \"<string>\"\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/customers/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/customers/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}