PowerBuilder / easybill REST API / Fetch customers list
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Last_name
string ls_Company_name
integer li_Acquire_options
string ls_Bank_account
string ls_Bank_account_owner
string ls_Bank_bic
string ls_Bank_code
string ls_Bank_iban
string ls_Bank_name
string ls_Birth_date
string ls_Cash_allowance
integer li_Cash_allowance_days
string ls_Cash_discount
string ls_Cash_discount_type
string ls_City
string ls_State
string ls_Country
string ls_Created_at
string ls_Updated_at
string ls_Delivery_title
string ls_Delivery_city
string ls_Delivery_state
string ls_Delivery_company_name
string ls_Delivery_country
string ls_Delivery_first_name
string ls_Delivery_last_name
string ls_Delivery_personal
integer li_Delivery_salutation
string ls_Delivery_street
string ls_Delivery_suffix_1
string ls_Delivery_suffix_2
string ls_Delivery_zip_code
string ls_Display_name
string ls_Fax
string ls_First_name
string ls_Grace_period
string ls_Due_in_days
string ls_Group_id
string ls_Id
string ls_Info_1
string ls_Info_2
string ls_Internet
string ls_Login_id
string ls_Mobile
string ls_Note
string ls_V_number
integer li_Payment_options
integer li_Personal
string ls_Phone_1
string ls_Phone_2
string ls_Postbox
string ls_Postbox_city
string ls_Postbox_state
string ls_Postbox_country
string ls_Postbox_zip_code
string ls_Sale_price_level
integer li_Salutation
string ls_Sepa_agreement
string ls_Sepa_agreement_date
string ls_Sepa_mandate_reference
string ls_Since_date
string ls_Street
string ls_Suffix_1
string ls_Suffix_2
string ls_Tax_number
string ls_Court
string ls_Court_registry_number
string ls_Tax_options
string ls_Title
string ls_Archived
string ls_Vat_identifier
string ls_Zip_code
string ls_Document_pdf_type
string ls_Buyer_reference
string ls_Foreign_supplier_number
integer j
integer li_Count_j
string ls_StrVal
string ls_Page
string ls_Pages
string ls_Limit
string ls_Total
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("limit","<integer>")
loo_QueryParams.UpdateString("page","<integer>")
loo_QueryParams.UpdateString("group_id","<string>")
loo_QueryParams.UpdateString("additional_group_id","<string>")
loo_QueryParams.UpdateString("number","<string>")
loo_QueryParams.UpdateString("country","<string>")
loo_QueryParams.UpdateString("zip_code","<string>")
loo_QueryParams.UpdateString("emails","<string>")
loo_QueryParams.UpdateString("first_name","<string>")
loo_QueryParams.UpdateString("last_name","<string>")
loo_QueryParams.UpdateString("company_name","<string>")
loo_QueryParams.UpdateString("created_at","<string>")
loo_Http.SetRequestHeader("Authorization","{{apiKey}}")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/customers",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page": "<integer>",
// "pages": "<integer>",
// "limit": "<integer>",
// "total": "<integer>",
// "items": [
// {
// "last_name": "<string>",
// "company_name": "<string>",
// "acquire_options": 7,
// "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": "PERCENT",
// "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": 3,
// "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": "COR1",
// "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": "sStfr",
// "title": "<string>",
// "archived": "<boolean>",
// "vat_identifier": "<string>",
// "zip_code": "<string>",
// "document_pdf_type": "default",
// "buyer_reference": "<string>",
// "foreign_supplier_number": "<string>"
// },
// {
// "last_name": "<string>",
// "company_name": "<string>",
// "acquire_options": 7,
// "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": "PERCENT",
// "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": 3,
// "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": "SALEPRICE6",
// "salutation": 0,
// "sepa_agreement": "NULL",
// "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": "nStb",
// "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
ls_Page = loo_JResp.StringOf("page")
ls_Pages = loo_JResp.StringOf("pages")
ls_Limit = loo_JResp.StringOf("limit")
ls_Total = loo_JResp.StringOf("total")
i = 0
li_Count_i = loo_JResp.SizeOfArray("items")
do while i < li_Count_i
loo_JResp.I = i
ls_Last_name = loo_JResp.StringOf("items[i].last_name")
ls_Company_name = loo_JResp.StringOf("items[i].company_name")
li_Acquire_options = loo_JResp.IntOf("items[i].acquire_options")
ls_Bank_account = loo_JResp.StringOf("items[i].bank_account")
ls_Bank_account_owner = loo_JResp.StringOf("items[i].bank_account_owner")
ls_Bank_bic = loo_JResp.StringOf("items[i].bank_bic")
ls_Bank_code = loo_JResp.StringOf("items[i].bank_code")
ls_Bank_iban = loo_JResp.StringOf("items[i].bank_iban")
ls_Bank_name = loo_JResp.StringOf("items[i].bank_name")
ls_Birth_date = loo_JResp.StringOf("items[i].birth_date")
ls_Cash_allowance = loo_JResp.StringOf("items[i].cash_allowance")
li_Cash_allowance_days = loo_JResp.IntOf("items[i].cash_allowance_days")
ls_Cash_discount = loo_JResp.StringOf("items[i].cash_discount")
ls_Cash_discount_type = loo_JResp.StringOf("items[i].cash_discount_type")
ls_City = loo_JResp.StringOf("items[i].city")
ls_State = loo_JResp.StringOf("items[i].state")
ls_Country = loo_JResp.StringOf("items[i].country")
ls_Created_at = loo_JResp.StringOf("items[i].created_at")
ls_Updated_at = loo_JResp.StringOf("items[i].updated_at")
ls_Delivery_title = loo_JResp.StringOf("items[i].delivery_title")
ls_Delivery_city = loo_JResp.StringOf("items[i].delivery_city")
ls_Delivery_state = loo_JResp.StringOf("items[i].delivery_state")
ls_Delivery_company_name = loo_JResp.StringOf("items[i].delivery_company_name")
ls_Delivery_country = loo_JResp.StringOf("items[i].delivery_country")
ls_Delivery_first_name = loo_JResp.StringOf("items[i].delivery_first_name")
ls_Delivery_last_name = loo_JResp.StringOf("items[i].delivery_last_name")
ls_Delivery_personal = loo_JResp.StringOf("items[i].delivery_personal")
li_Delivery_salutation = loo_JResp.IntOf("items[i].delivery_salutation")
ls_Delivery_street = loo_JResp.StringOf("items[i].delivery_street")
ls_Delivery_suffix_1 = loo_JResp.StringOf("items[i].delivery_suffix_1")
ls_Delivery_suffix_2 = loo_JResp.StringOf("items[i].delivery_suffix_2")
ls_Delivery_zip_code = loo_JResp.StringOf("items[i].delivery_zip_code")
ls_Display_name = loo_JResp.StringOf("items[i].display_name")
ls_Fax = loo_JResp.StringOf("items[i].fax")
ls_First_name = loo_JResp.StringOf("items[i].first_name")
ls_Grace_period = loo_JResp.StringOf("items[i].grace_period")
ls_Due_in_days = loo_JResp.StringOf("items[i].due_in_days")
ls_Group_id = loo_JResp.StringOf("items[i].group_id")
ls_Id = loo_JResp.StringOf("items[i].id")
ls_Info_1 = loo_JResp.StringOf("items[i].info_1")
ls_Info_2 = loo_JResp.StringOf("items[i].info_2")
ls_Internet = loo_JResp.StringOf("items[i].internet")
ls_Login_id = loo_JResp.StringOf("items[i].login_id")
ls_Mobile = loo_JResp.StringOf("items[i].mobile")
ls_Note = loo_JResp.StringOf("items[i].note")
ls_V_number = loo_JResp.StringOf("items[i].number")
li_Payment_options = loo_JResp.IntOf("items[i].payment_options")
li_Personal = loo_JResp.BoolOf("items[i].personal")
ls_Phone_1 = loo_JResp.StringOf("items[i].phone_1")
ls_Phone_2 = loo_JResp.StringOf("items[i].phone_2")
ls_Postbox = loo_JResp.StringOf("items[i].postbox")
ls_Postbox_city = loo_JResp.StringOf("items[i].postbox_city")
ls_Postbox_state = loo_JResp.StringOf("items[i].postbox_state")
ls_Postbox_country = loo_JResp.StringOf("items[i].postbox_country")
ls_Postbox_zip_code = loo_JResp.StringOf("items[i].postbox_zip_code")
ls_Sale_price_level = loo_JResp.StringOf("items[i].sale_price_level")
li_Salutation = loo_JResp.IntOf("items[i].salutation")
ls_Sepa_agreement = loo_JResp.StringOf("items[i].sepa_agreement")
ls_Sepa_agreement_date = loo_JResp.StringOf("items[i].sepa_agreement_date")
ls_Sepa_mandate_reference = loo_JResp.StringOf("items[i].sepa_mandate_reference")
ls_Since_date = loo_JResp.StringOf("items[i].since_date")
ls_Street = loo_JResp.StringOf("items[i].street")
ls_Suffix_1 = loo_JResp.StringOf("items[i].suffix_1")
ls_Suffix_2 = loo_JResp.StringOf("items[i].suffix_2")
ls_Tax_number = loo_JResp.StringOf("items[i].tax_number")
ls_Court = loo_JResp.StringOf("items[i].court")
ls_Court_registry_number = loo_JResp.StringOf("items[i].court_registry_number")
ls_Tax_options = loo_JResp.StringOf("items[i].tax_options")
ls_Title = loo_JResp.StringOf("items[i].title")
ls_Archived = loo_JResp.StringOf("items[i].archived")
ls_Vat_identifier = loo_JResp.StringOf("items[i].vat_identifier")
ls_Zip_code = loo_JResp.StringOf("items[i].zip_code")
ls_Document_pdf_type = loo_JResp.StringOf("items[i].document_pdf_type")
ls_Buyer_reference = loo_JResp.StringOf("items[i].buyer_reference")
ls_Foreign_supplier_number = loo_JResp.StringOf("items[i].foreign_supplier_number")
j = 0
li_Count_j = loo_JResp.SizeOfArray("items[i].additional_groups_ids")
do while j < li_Count_j
loo_JResp.J = j
ls_StrVal = loo_JResp.StringOf("items[i].additional_groups_ids[j]")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("items[i].emails")
do while j < li_Count_j
loo_JResp.J = j
ls_StrVal = loo_JResp.StringOf("items[i].emails[j]")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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": ""
}
]
}
