Get all customers
The fields are not the same as in get individual / get business customers.
Request
- Base URL(relative, and it does not resolve against the document’s source URL)
- Auth
- API key in header sessionKey
- or API key in header clientCode
- or API key in header jwt
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
match type of the filtering. Supported values: =, >=, <=, contains, startswith. Default is =
Search by the customer ids
Search by the customer type. Possible values are 'PERSON', 'COMPANY'
Search by the business type ids
Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.
Search by the customer group ids
Search by the business area ids
Search by the Person's job title ids
Search by the employer ids. (Persons only.) Business where this individual is an employee / a contact person
Search by the customer manager ids
Search by the title ids. A title (Mr / Mrs / Miss) etc.
Search by the e-invoice email address
whether the customer wants to receive invoices via electronic channels.
Search by the e-invoice reference number.
whether the customer wants to receive invoices via email.
whether the customer wants to receive invoices via docura.
whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).
Search by the operator id. E-invoice integration parameter.
Search by the edi codeE-invoice integration parameter.
Search by the edi type. E-invoice integration parameter.
Search by the last name / family name. For individuals only.
Search by the first name / given name. For individuals only.
Search by the business name, For businesses only.
Search by the company name. For businesses only.
Search by the Full name of the customer
Search by the national Id
Search by the person's birthday
Search by the VAT number
Search by the name of the bank
Search by the customer's bank account number
Search by the BIC/SWIFT identifier of customer's bank account
Search by the IBAN number of customer's bank account
Search by phone
Search by mobile
Search by fax
Search by mail
Search by skype
Search by website
Search by notes
Search by the web-shop username. This is for web shop integrations: to store customers' web-shop login credentials in Erply
Search by the flag “Sales for cash only”. By default,false
Search by the customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe
Search by the default payment deadline (in days)
Search by the late fee / penalty for overdue invoices
Search by the payer ids, payer of invoices is another customer
Search by the customer’s country
Search by the customer’s reference number for sales invoices
Search by the integration code. Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)
Search by the loyalty card number. The code of customer's loyalty/membership card. This code must match the sequence produced by card swipe
Search by the factoring contract number
Customer type. Possible values are
Search by the assigned price list
Search by the second assigned price list
Search by the third assigned price list
Search by the fourth assigned price list
Search by the fifth assigned price list
Search by the flag “taxExempt”.
Search by the flag “Partial tax exemption”.
Search by the flag “Do not sell”.
Search by tagIds. Get all customers with at least one of those tags
Search by the tax office ids. Feature used by Greek customers: office where the customer / supplier reports to.
Search by custom homestore IDs. Used only by specific accounts.
Search by signUpStoreId
Search by color. Color that the customer entry is marked with. Possible values:
Search by added date.
Search by added from.
Search by added to.
Search by changedByEmployeeId.
Mark if a customer should be starred
Search by the postal code of the customer's address. Note that this option uses additional source to search the result, which makes it slower.
field to order by
direction to order by
skip n records
items to take, default: 20, max: 100000
optionally return total number of records in the X-Total-Count response header
Response
OK
Example response
[
{
"GLN": "901234500004",
"gender": "male"
}
]Changes
No recorded changes to this operation across all 1 revision of this API.