Customers

Get all customers

The fields are not the same as in get individual / get business customers.

get/v1/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
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

matchstring

match type of the filtering. Supported values: =, >=, <=, contains, startswith. Default is =

idsinteger[]

Search by the customer ids

customerType'PERSON' | 'COMPANY'

Search by the customer type. Possible values are 'PERSON', 'COMPANY'

businessTypeIdsinteger[]

Search by the business type ids

changedinteger

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.

customerGroupIdsinteger[]

Search by the customer group ids

businessAreaIdsinteger[]

Search by the business area ids

jobTitleIdsinteger[]

Search by the Person's job title ids

employerIdsinteger[]

Search by the employer ids. (Persons only.) Business where this individual is an employee / a contact person

customerManagerIdsinteger[]

Search by the customer manager ids

titleIdsinteger[]

Search by the title ids. A title (Mr / Mrs / Miss) etc.

eInvoiceEmailstring

Search by the e-invoice email address

eInvoicesViaEmailEnabledboolean

whether the customer wants to receive invoices via electronic channels.

eInvoiceReferencestring

Search by the e-invoice reference number.

invoicesViaEmailEnabledboolean

whether the customer wants to receive invoices via email.

invoicesViaDocuraEnabledboolean

whether the customer wants to receive invoices via docura.

paperMailsEnabledboolean

whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).

operatorIdstring

Search by the operator id. E-invoice integration parameter.

ediCodestring

Search by the edi codeE-invoice integration parameter.

ediType'2DOC' | '4DOC' | 'SPECIAL'

Search by the edi type. E-invoice integration parameter.

lastNamestring

Search by the last name / family name. For individuals only.

firstNamestring

Search by the first name / given name. For individuals only.

businessNamestring

Search by the business name, For businesses only.

namestring

Search by the company name. For businesses only.

fullNamestring

Search by the Full name of the customer

codestring

Search by the national Id

birthDatestring

Search by the person's birthday

vatNumberstring

Search by the VAT number

bankNamestring

Search by the name of the bank

bankAccountNumberstring

Search by the customer's bank account number

bankSwiftCodestring

Search by the BIC/SWIFT identifier of customer's bank account

bankIbanstring

Search by the IBAN number of customer's bank account

phonestring

Search by phone

mobilestring

Search by mobile

faxstring

Search by fax

mailstring

Search by mail

skypestring

Search by skype

websitestring

Search by website

notesstring

Search by notes

webShopUsernamestring

Search by the web-shop username. This is for web shop integrations: to store customers' web-shop login credentials in Erply

salesForCashOnlyboolean

Search by the flag “Sales for cash only”. By default,false

creditLimitinteger

Search by the customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe

defaultPaymentDeadLineinteger

Search by the default payment deadline (in days)

penaltyForOverduenumber

Search by the late fee / penalty for overdue invoices

payerIdsinteger[]

Search by the payer ids, payer of invoices is another customer

countryIdsinteger[]

Search by the customer’s country

referenceNumberstring

Search by the customer’s reference number for sales invoices

integrationCodestring

Search by the integration code. Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)

loyaltyCardNumberstring

Search by the loyalty card number. The code of customer's loyalty/membership card. This code must match the sequence produced by card swipe

factoringContractNumberstring

Search by the factoring contract number

type'DOMESTIC' | 'EU' | 'OUTSIDE_EU' | 'EU_WITH_VAT'

Customer type. Possible values are

priceListIdsinteger[]

Search by the assigned price list

priceListIds2integer[]

Search by the second assigned price list

priceListIds3integer[]

Search by the third assigned price list

priceListIds4integer[]

Search by the fourth assigned price list

priceListIds5integer[]

Search by the fifth assigned price list

taxExemptboolean

Search by the flag “taxExempt”.

partialTaxExemptionboolean

Search by the flag “Partial tax exemption”.

doNotSellboolean

Search by the flag “Do not sell”.

tagIdsinteger[]

Search by tagIds. Get all customers with at least one of those tags

taxOfficeIdsinteger[]

Search by the tax office ids. Feature used by Greek customers: office where the customer / supplier reports to.

homeStoreCustomIdsinteger[]

Search by custom homestore IDs. Used only by specific accounts.

signUpStoreIdinteger

Search by signUpStoreId

colorstring

Search by color. Color that the customer entry is marked with. Possible values:

addedinteger

Search by added date.

addedFrominteger

Search by added from.

addedTointeger

Search by added to.

changedByEmployeeIdinteger

Search by changedByEmployeeId.

isStarredboolean

Mark if a customer should be starred

addressPostalCodestring

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.

orderBystring

field to order by

orderByDirection'ASC' | 'DESC'

direction to order by

skipinteger

skip n records

takeinteger

items to take, default: 20, max: 100000

withTotalCountboolean

optionally return total number of records in the X-Total-Count response header

Response

OK

GLNstring

Global Location Number.

addedinteger
bankAccountNumberstring

Number of customer's bank account.

bankIbanstring

IBAN number of customer's bank account.

bankNamestring

Name of customer's bank.

bankSwiftCodestring

BIC/SWIFT identifier of customer's bank account.

birthDatestring

Person's birthday (yyyy-mm-dd)

businessAreaIdinteger

area of business.

businessNamestring

For businesses only.

businessTypeIdinteger

Customer type ID, for businesses only.

changedinteger
changedBystring
changedByEmployeeIdinteger
codestring

National ID

colorstring

Color that the customer entry is marked with. Possible values: "", "yellow", "red", "blue", "green".

countryIdinteger

Customer’s country.

creditLimitinteger

Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.

customerBalanceDisabledboolean

Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)

customerGroupIdinteger
customerManagerIdinteger

Customer manager (must be an employee)

customerTypestring

COMPANY or PERSON. For businesses, the following ributes are set: fullName, businessName (both have the same value). For individuals, the following attributes are set: fullName, firstName, lastName. fullName is a combination of latter two: "lastName, firstName". fullName can be used for displaying customer's name wherever needed. Companies should have one name field and the attribute that is edited should be businessName. Persons should have separate fields for given name and surname (respective attributes: firstName, lastName).

defaultPaymentDeadLineinteger

Default payment deadline (in days).

deliveryTypeIdinteger

A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.

displayedNamestring

Name with customer type

doNotSellboolean

Whether the customer is marked with a do not sell flag or not.

eInvoiceEmailstring

In UI, the field is titled “E-invoice email address”.

eInvoiceReferencestring

Customer reference for e-invoices.

eInvoicesViaEmailEnabledboolean

whether the customer wants to receive invoices via electronic channels.

ediCodestring

E-invoice integration parameter.

ediTypestring

EDI type. Possible values: 2DOC, 4DOC, SPECIAL.

emailOptOutboolean

Flag indicating that this customer does not want to receive email correspondence.

employerIdinteger

Used to indicate that this individual is a contact person / an employee in a particular business.

facebookNamestring
factoringContractNumberstring

Factoring contract number.

faxstring
firstNamestring

First name / given name. For individuals only.

fullNamestring

Full name of the customer, use for displaying customer name.

genderstring

Gender. Erply API only accepts "male" "female" or an empty string.

homeStoreCustomIdinteger

Additional, custom home store ID

homeStoreIdinteger

Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses

idinteger
integrationCodestring

Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)

invoicesViaDocuraEnabledboolean

Whether the customer wants to receive invoices via Docura channels.

invoicesViaEmailEnabledboolean

whether the customer wants to receive invoices via email.

isStarredboolean

Mark if a customer should be starred

jobTitleIdinteger

Individual's job title Ids.

lastNamestring

Last name / family name. For individuals only.

loyaltyCardNumberstring

Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.

mailstring
mobilestring
namestring

For businesses only.

notesstring
operatorIdstring

E-invoice integration parameter.

paperMailsEnabledboolean

whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).

partialTaxExemptionboolean
payerIdinteger

“Payer of invoices” (another customer).

paysViaFactoringboolean

Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)

penaltyForOverduenumber

Late fee / penalty for overdue invoices. The semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”

peppolIdstring

Peppol ID

phonestring
posCouponsDisabledboolean

Flag indicating that coupons must not be automatically printed to this customer.

priceListIdinteger

Assign the customer a price list

priceListId2integer
priceListId3integer
priceListId4integer
priceListId5integer
primaryStoreIdinteger

ID of the primary store

referenceNumberstring

Customer’s reference number for sales invoices. Assign a reference number - if system is configured to use hand-created customer reference numbers. By default,not necessary, since reference numbers are created automatically.

rewardPointsDisabledboolean

Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)

salesForCashOnlyboolean

Flag “Sales for cash only”. By default,false

secondaryStoreIdinteger

ID of the secondary store

shipGoodsWithWaybillsboolean

A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.

signUpStoreIdinteger

Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses

skypestring
taxExemptboolean

Flag indicating that this customer must not be charged sales tax.

taxOfficeIdinteger

Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)

titleIdinteger

A title (Mr / Mrs / Miss) etc.

twitterIdstring
typestring

Customer type. Possible values are "DOMESTIC", "EU", "OUTSIDE_EU", "EU_WITH_VAT

vatNumberstring

Customer's VAT number.

webShopUsernamestring

This is for web shop integrations: to store customers' web-shop login credentials in Erply.

websitestring

Example response

[
  {
    "GLN": "901234500004",
    "gender": "male"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.