Delphi (DLL) / easybill REST API / Fetch customers list
Back to Collection Items
var
begin
CkJsonObject_UpdateString(queryParams,'limit','<integer>');CkJsonObject_UpdateString(queryParams,'page','<integer>');CkJsonObject_UpdateString(queryParams,'group_id','<string>');CkJsonObject_UpdateString(queryParams,'additional_group_id','<string>');CkJsonObject_UpdateString(queryParams,'number','<string>');CkJsonObject_UpdateString(queryParams,'country','<string>');CkJsonObject_UpdateString(queryParams,'zip_code','<string>');CkJsonObject_UpdateString(queryParams,'emails','<string>');CkJsonObject_UpdateString(queryParams,'first_name','<string>');CkJsonObject_UpdateString(queryParams,'last_name','<string>');CkJsonObject_UpdateString(queryParams,'company_name','<string>');CkJsonObject_UpdateString(queryParams,'created_at','<string>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);last_name := CkJsonObject__stringOf(jResp,'items[i].last_name');company_name := CkJsonObject__stringOf(jResp,'items[i].company_name');acquire_options := CkJsonObject_IntOf(jResp,'items[i].acquire_options');bank_account := CkJsonObject__stringOf(jResp,'items[i].bank_account');bank_account_owner := CkJsonObject__stringOf(jResp,'items[i].bank_account_owner');bank_bic := CkJsonObject__stringOf(jResp,'items[i].bank_bic');bank_code := CkJsonObject__stringOf(jResp,'items[i].bank_code');bank_iban := CkJsonObject__stringOf(jResp,'items[i].bank_iban');bank_name := CkJsonObject__stringOf(jResp,'items[i].bank_name');birth_date := CkJsonObject__stringOf(jResp,'items[i].birth_date');cash_allowance := CkJsonObject__stringOf(jResp,'items[i].cash_allowance');cash_allowance_days := CkJsonObject_IntOf(jResp,'items[i].cash_allowance_days');cash_discount := CkJsonObject__stringOf(jResp,'items[i].cash_discount');cash_discount_type := CkJsonObject__stringOf(jResp,'items[i].cash_discount_type');city := CkJsonObject__stringOf(jResp,'items[i].city');state := CkJsonObject__stringOf(jResp,'items[i].state');country := CkJsonObject__stringOf(jResp,'items[i].country');created_at := CkJsonObject__stringOf(jResp,'items[i].created_at');updated_at := CkJsonObject__stringOf(jResp,'items[i].updated_at');delivery_title := CkJsonObject__stringOf(jResp,'items[i].delivery_title');delivery_city := CkJsonObject__stringOf(jResp,'items[i].delivery_city');delivery_state := CkJsonObject__stringOf(jResp,'items[i].delivery_state');delivery_company_name := CkJsonObject__stringOf(jResp,'items[i].delivery_company_name');delivery_country := CkJsonObject__stringOf(jResp,'items[i].delivery_country');delivery_first_name := CkJsonObject__stringOf(jResp,'items[i].delivery_first_name');delivery_last_name := CkJsonObject__stringOf(jResp,'items[i].delivery_last_name');delivery_personal := CkJsonObject__stringOf(jResp,'items[i].delivery_personal');delivery_salutation := CkJsonObject_IntOf(jResp,'items[i].delivery_salutation');delivery_street := CkJsonObject__stringOf(jResp,'items[i].delivery_street');delivery_suffix_1 := CkJsonObject__stringOf(jResp,'items[i].delivery_suffix_1');delivery_suffix_2 := CkJsonObject__stringOf(jResp,'items[i].delivery_suffix_2');delivery_zip_code := CkJsonObject__stringOf(jResp,'items[i].delivery_zip_code');display_name := CkJsonObject__stringOf(jResp,'items[i].display_name');fax := CkJsonObject__stringOf(jResp,'items[i].fax');first_name := CkJsonObject__stringOf(jResp,'items[i].first_name');grace_period := CkJsonObject__stringOf(jResp,'items[i].grace_period');due_in_days := CkJsonObject__stringOf(jResp,'items[i].due_in_days');group_id := CkJsonObject__stringOf(jResp,'items[i].group_id');id := CkJsonObject__stringOf(jResp,'items[i].id');info_1 := CkJsonObject__stringOf(jResp,'items[i].info_1');info_2 := CkJsonObject__stringOf(jResp,'items[i].info_2');internet := CkJsonObject__stringOf(jResp,'items[i].internet');login_id := CkJsonObject__stringOf(jResp,'items[i].login_id');mobile := CkJsonObject__stringOf(jResp,'items[i].mobile');note := CkJsonObject__stringOf(jResp,'items[i].note');v_number := CkJsonObject__stringOf(jResp,'items[i].number');payment_options := CkJsonObject_IntOf(jResp,'items[i].payment_options');personal := CkJsonObject_BoolOf(jResp,'items[i].personal');phone_1 := CkJsonObject__stringOf(jResp,'items[i].phone_1');phone_2 := CkJsonObject__stringOf(jResp,'items[i].phone_2');postbox := CkJsonObject__stringOf(jResp,'items[i].postbox');postbox_city := CkJsonObject__stringOf(jResp,'items[i].postbox_city');postbox_state := CkJsonObject__stringOf(jResp,'items[i].postbox_state');postbox_country := CkJsonObject__stringOf(jResp,'items[i].postbox_country');postbox_zip_code := CkJsonObject__stringOf(jResp,'items[i].postbox_zip_code');sale_price_level := CkJsonObject__stringOf(jResp,'items[i].sale_price_level');salutation := CkJsonObject_IntOf(jResp,'items[i].salutation');sepa_agreement := CkJsonObject__stringOf(jResp,'items[i].sepa_agreement');sepa_agreement_date := CkJsonObject__stringOf(jResp,'items[i].sepa_agreement_date');sepa_mandate_reference := CkJsonObject__stringOf(jResp,'items[i].sepa_mandate_reference');since_date := CkJsonObject__stringOf(jResp,'items[i].since_date');street := CkJsonObject__stringOf(jResp,'items[i].street');suffix_1 := CkJsonObject__stringOf(jResp,'items[i].suffix_1');suffix_2 := CkJsonObject__stringOf(jResp,'items[i].suffix_2');tax_number := CkJsonObject__stringOf(jResp,'items[i].tax_number');court := CkJsonObject__stringOf(jResp,'items[i].court');court_registry_number := CkJsonObject__stringOf(jResp,'items[i].court_registry_number');tax_options := CkJsonObject__stringOf(jResp,'items[i].tax_options');title := CkJsonObject__stringOf(jResp,'items[i].title');archived := CkJsonObject__stringOf(jResp,'items[i].archived');vat_identifier := CkJsonObject__stringOf(jResp,'items[i].vat_identifier');zip_code := CkJsonObject__stringOf(jResp,'items[i].zip_code');document_pdf_type := CkJsonObject__stringOf(jResp,'items[i].document_pdf_type');buyer_reference := CkJsonObject__stringOf(jResp,'items[i].buyer_reference');foreign_supplier_number := CkJsonObject__stringOf(jResp,'items[i].foreign_supplier_number');j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'items[i].additional_groups_ids');CkJsonObject_putJ(jResp,j);strVal := CkJsonObject__stringOf(jResp,'items[i].additional_groups_ids[j]');j := j + 1;j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'items[i].emails');CkJsonObject_putJ(jResp,j);strVal := CkJsonObject__stringOf(jResp,'items[i].emails[j]');j := j + 1;i := i + 1;
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "group_id=%3Cstring%3E"
-d "additional_group_id=%3Cstring%3E"
-d "number=%3Cstring%3E"
-d "country=%3Cstring%3E"
-d "zip_code=%3Cstring%3E"
-d "emails=%3Cstring%3E"
-d "first_name=%3Cstring%3E"
-d "last_name=%3Cstring%3E"
-d "company_name=%3Cstring%3E"
-d "created_at=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/customers
Postman Collection Item JSON
{
"name": "Fetch customers list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/customers?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"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?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"last_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"acquire_options\": 7,\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\": \"PERCENT\",\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\": 3,\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\": \"COR1\",\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\": \"sStfr\",\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 },\n {\n \"last_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"acquire_options\": 7,\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\": \"PERCENT\",\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\": 3,\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\": \"SALEPRICE6\",\n \"salutation\": 0,\n \"sepa_agreement\": \"NULL\",\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\": \"nStb\",\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 }\n ]\n}"
},
{
"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?limit=<integer>&page=<integer>&group_id=<string>&additional_group_id=<string>&number=<string>&country=<string>&zip_code=<string>&emails=<string>&first_name=<string>&last_name=<string>&company_name=<string>&created_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"customers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "group_id",
"value": "<string>",
"description": "Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "additional_group_id",
"value": "<string>",
"description": "Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id."
},
{
"key": "number",
"value": "<string>",
"description": "Filter customers by number. You can add multiple numbers separate by comma like no,no,no."
},
{
"key": "country",
"value": "<string>",
"description": "Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR."
},
{
"key": "zip_code",
"value": "<string>",
"description": "Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip."
},
{
"key": "emails",
"value": "<string>",
"description": "Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail."
},
{
"key": "first_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "last_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "company_name",
"value": "<string>",
"description": "Filter customers by first_name. You can add multiple names separate by comma like name,name,name."
},
{
"key": "created_at",
"value": "<string>",
"description": "Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
