Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.easybill.de/rest/v1/customers/:id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
strVal.s
last_name.s = CkJsonObject::ckStringOf(jResp,"last_name")
company_name.s = CkJsonObject::ckStringOf(jResp,"company_name")
acquire_options.i = CkJsonObject::ckIntOf(jResp,"acquire_options")
bank_account.s = CkJsonObject::ckStringOf(jResp,"bank_account")
bank_account_owner.s = CkJsonObject::ckStringOf(jResp,"bank_account_owner")
bank_bic.s = CkJsonObject::ckStringOf(jResp,"bank_bic")
bank_code.s = CkJsonObject::ckStringOf(jResp,"bank_code")
bank_iban.s = CkJsonObject::ckStringOf(jResp,"bank_iban")
bank_name.s = CkJsonObject::ckStringOf(jResp,"bank_name")
birth_date.s = CkJsonObject::ckStringOf(jResp,"birth_date")
cash_allowance.s = CkJsonObject::ckStringOf(jResp,"cash_allowance")
cash_allowance_days.i = CkJsonObject::ckIntOf(jResp,"cash_allowance_days")
cash_discount.s = CkJsonObject::ckStringOf(jResp,"cash_discount")
cash_discount_type.s = CkJsonObject::ckStringOf(jResp,"cash_discount_type")
city.s = CkJsonObject::ckStringOf(jResp,"city")
state.s = CkJsonObject::ckStringOf(jResp,"state")
country.s = CkJsonObject::ckStringOf(jResp,"country")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
updated_at.s = CkJsonObject::ckStringOf(jResp,"updated_at")
delivery_title.s = CkJsonObject::ckStringOf(jResp,"delivery_title")
delivery_city.s = CkJsonObject::ckStringOf(jResp,"delivery_city")
delivery_state.s = CkJsonObject::ckStringOf(jResp,"delivery_state")
delivery_company_name.s = CkJsonObject::ckStringOf(jResp,"delivery_company_name")
delivery_country.s = CkJsonObject::ckStringOf(jResp,"delivery_country")
delivery_first_name.s = CkJsonObject::ckStringOf(jResp,"delivery_first_name")
delivery_last_name.s = CkJsonObject::ckStringOf(jResp,"delivery_last_name")
delivery_personal.s = CkJsonObject::ckStringOf(jResp,"delivery_personal")
delivery_salutation.i = CkJsonObject::ckIntOf(jResp,"delivery_salutation")
delivery_street.s = CkJsonObject::ckStringOf(jResp,"delivery_street")
delivery_suffix_1.s = CkJsonObject::ckStringOf(jResp,"delivery_suffix_1")
delivery_suffix_2.s = CkJsonObject::ckStringOf(jResp,"delivery_suffix_2")
delivery_zip_code.s = CkJsonObject::ckStringOf(jResp,"delivery_zip_code")
display_name.s = CkJsonObject::ckStringOf(jResp,"display_name")
fax.s = CkJsonObject::ckStringOf(jResp,"fax")
first_name.s = CkJsonObject::ckStringOf(jResp,"first_name")
grace_period.s = CkJsonObject::ckStringOf(jResp,"grace_period")
due_in_days.s = CkJsonObject::ckStringOf(jResp,"due_in_days")
group_id.s = CkJsonObject::ckStringOf(jResp,"group_id")
id.s = CkJsonObject::ckStringOf(jResp,"id")
info_1.s = CkJsonObject::ckStringOf(jResp,"info_1")
info_2.s = CkJsonObject::ckStringOf(jResp,"info_2")
internet.s = CkJsonObject::ckStringOf(jResp,"internet")
login_id.s = CkJsonObject::ckStringOf(jResp,"login_id")
mobile.s = CkJsonObject::ckStringOf(jResp,"mobile")
note.s = CkJsonObject::ckStringOf(jResp,"note")
v_number.s = CkJsonObject::ckStringOf(jResp,"number")
payment_options.i = CkJsonObject::ckIntOf(jResp,"payment_options")
personal.i = CkJsonObject::ckBoolOf(jResp,"personal")
phone_1.s = CkJsonObject::ckStringOf(jResp,"phone_1")
phone_2.s = CkJsonObject::ckStringOf(jResp,"phone_2")
postbox.s = CkJsonObject::ckStringOf(jResp,"postbox")
postbox_city.s = CkJsonObject::ckStringOf(jResp,"postbox_city")
postbox_state.s = CkJsonObject::ckStringOf(jResp,"postbox_state")
postbox_country.s = CkJsonObject::ckStringOf(jResp,"postbox_country")
postbox_zip_code.s = CkJsonObject::ckStringOf(jResp,"postbox_zip_code")
sale_price_level.s = CkJsonObject::ckStringOf(jResp,"sale_price_level")
salutation.i = CkJsonObject::ckIntOf(jResp,"salutation")
sepa_agreement.s = CkJsonObject::ckStringOf(jResp,"sepa_agreement")
sepa_agreement_date.s = CkJsonObject::ckStringOf(jResp,"sepa_agreement_date")
sepa_mandate_reference.s = CkJsonObject::ckStringOf(jResp,"sepa_mandate_reference")
since_date.s = CkJsonObject::ckStringOf(jResp,"since_date")
street.s = CkJsonObject::ckStringOf(jResp,"street")
suffix_1.s = CkJsonObject::ckStringOf(jResp,"suffix_1")
suffix_2.s = CkJsonObject::ckStringOf(jResp,"suffix_2")
tax_number.s = CkJsonObject::ckStringOf(jResp,"tax_number")
court.s = CkJsonObject::ckStringOf(jResp,"court")
court_registry_number.s = CkJsonObject::ckStringOf(jResp,"court_registry_number")
tax_options.s = CkJsonObject::ckStringOf(jResp,"tax_options")
title.s = CkJsonObject::ckStringOf(jResp,"title")
archived.s = CkJsonObject::ckStringOf(jResp,"archived")
vat_identifier.s = CkJsonObject::ckStringOf(jResp,"vat_identifier")
zip_code.s = CkJsonObject::ckStringOf(jResp,"zip_code")
document_pdf_type.s = CkJsonObject::ckStringOf(jResp,"document_pdf_type")
buyer_reference.s = CkJsonObject::ckStringOf(jResp,"buyer_reference")
foreign_supplier_number.s = CkJsonObject::ckStringOf(jResp,"foreign_supplier_number")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"additional_groups_ids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"additional_groups_ids[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"emails")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"emails[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
