Chilkat Online Tools

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.easybill.de/rest/v1/customers/:id",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $strVal

Local $sLast_name = $oJResp.StringOf("last_name")
Local $sCompany_name = $oJResp.StringOf("company_name")
Local $iAcquire_options = $oJResp.IntOf("acquire_options")
Local $sBank_account = $oJResp.StringOf("bank_account")
Local $sBank_account_owner = $oJResp.StringOf("bank_account_owner")
Local $sBank_bic = $oJResp.StringOf("bank_bic")
Local $sBank_code = $oJResp.StringOf("bank_code")
Local $sBank_iban = $oJResp.StringOf("bank_iban")
Local $sBank_name = $oJResp.StringOf("bank_name")
Local $sBirth_date = $oJResp.StringOf("birth_date")
Local $sCash_allowance = $oJResp.StringOf("cash_allowance")
Local $iCash_allowance_days = $oJResp.IntOf("cash_allowance_days")
Local $sCash_discount = $oJResp.StringOf("cash_discount")
Local $sCash_discount_type = $oJResp.StringOf("cash_discount_type")
Local $sCity = $oJResp.StringOf("city")
Local $state = $oJResp.StringOf("state")
Local $sCountry = $oJResp.StringOf("country")
Local $sCreated_at = $oJResp.StringOf("created_at")
Local $sUpdated_at = $oJResp.StringOf("updated_at")
Local $sDelivery_title = $oJResp.StringOf("delivery_title")
Local $sDelivery_city = $oJResp.StringOf("delivery_city")
Local $sDelivery_state = $oJResp.StringOf("delivery_state")
Local $sDelivery_company_name = $oJResp.StringOf("delivery_company_name")
Local $sDelivery_country = $oJResp.StringOf("delivery_country")
Local $sDelivery_first_name = $oJResp.StringOf("delivery_first_name")
Local $sDelivery_last_name = $oJResp.StringOf("delivery_last_name")
Local $sDelivery_personal = $oJResp.StringOf("delivery_personal")
Local $iDelivery_salutation = $oJResp.IntOf("delivery_salutation")
Local $sDelivery_street = $oJResp.StringOf("delivery_street")
Local $sDelivery_suffix_1 = $oJResp.StringOf("delivery_suffix_1")
Local $sDelivery_suffix_2 = $oJResp.StringOf("delivery_suffix_2")
Local $sDelivery_zip_code = $oJResp.StringOf("delivery_zip_code")
Local $sDisplay_name = $oJResp.StringOf("display_name")
Local $sFax = $oJResp.StringOf("fax")
Local $sFirst_name = $oJResp.StringOf("first_name")
Local $sGrace_period = $oJResp.StringOf("grace_period")
Local $sDue_in_days = $oJResp.StringOf("due_in_days")
Local $sGroup_id = $oJResp.StringOf("group_id")
Local $sId = $oJResp.StringOf("id")
Local $sInfo_1 = $oJResp.StringOf("info_1")
Local $sInfo_2 = $oJResp.StringOf("info_2")
Local $sInternet = $oJResp.StringOf("internet")
Local $sLogin_id = $oJResp.StringOf("login_id")
Local $sMobile = $oJResp.StringOf("mobile")
Local $sNote = $oJResp.StringOf("note")
Local $sV_number = $oJResp.StringOf("number")
Local $iPayment_options = $oJResp.IntOf("payment_options")
Local $bPersonal = $oJResp.BoolOf("personal")
Local $sPhone_1 = $oJResp.StringOf("phone_1")
Local $sPhone_2 = $oJResp.StringOf("phone_2")
Local $sPostbox = $oJResp.StringOf("postbox")
Local $sPostbox_city = $oJResp.StringOf("postbox_city")
Local $sPostbox_state = $oJResp.StringOf("postbox_state")
Local $sPostbox_country = $oJResp.StringOf("postbox_country")
Local $sPostbox_zip_code = $oJResp.StringOf("postbox_zip_code")
Local $sale_price_level = $oJResp.StringOf("sale_price_level")
Local $iSalutation = $oJResp.IntOf("salutation")
Local $sepa_agreement = $oJResp.StringOf("sepa_agreement")
Local $sepa_agreement_date = $oJResp.StringOf("sepa_agreement_date")
Local $sepa_mandate_reference = $oJResp.StringOf("sepa_mandate_reference")
Local $since_date = $oJResp.StringOf("since_date")
Local $street = $oJResp.StringOf("street")
Local $suffix_1 = $oJResp.StringOf("suffix_1")
Local $suffix_2 = $oJResp.StringOf("suffix_2")
Local $sTax_number = $oJResp.StringOf("tax_number")
Local $sCourt = $oJResp.StringOf("court")
Local $sCourt_registry_number = $oJResp.StringOf("court_registry_number")
Local $sTax_options = $oJResp.StringOf("tax_options")
Local $sTitle = $oJResp.StringOf("title")
Local $sArchived = $oJResp.StringOf("archived")
Local $sVat_identifier = $oJResp.StringOf("vat_identifier")
Local $sZip_code = $oJResp.StringOf("zip_code")
Local $sDocument_pdf_type = $oJResp.StringOf("document_pdf_type")
Local $sBuyer_reference = $oJResp.StringOf("buyer_reference")
Local $sForeign_supplier_number = $oJResp.StringOf("foreign_supplier_number")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("additional_groups_ids")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("additional_groups_ids[i]")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("emails")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("emails[i]")
    $i = $i + 1
Wend

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