Skip to main content

Find Customer

Find Customer

Request Body REQUIRED
key string REQUIRED

keyword to search a customer by

keyType string REQUIRED

Possible values: [name, companyName, email]

Search customer by name, companyName, email

Responses
201

Returns the customer by search criteria

Schema OPTIONAL
id integer OPTIONAL
name string OPTIONAL
phone1 string OPTIONAL
phone2 string OPTIONAL
phone3 string OPTIONAL
type integer OPTIONAL
email string OPTIONAL
contact_address object[] OPTIONAL
id integer OPTIONAL
address object OPTIONAL
id integer OPTIONAL
address string OPTIONAL
zip_code string OPTIONAL
region string OPTIONAL
country string OPTIONAL
type integer OPTIONAL
is_default boolean OPTIONAL
fax string OPTIONAL
registration string OPTIONAL
company_name string OPTIONAL
reference string OPTIONAL
enabled boolean OPTIONAL
debt string OPTIONAL
turnover string OPTIONAL
debit string OPTIONAL
credit string OPTIONAL
balance string OPTIONAL
contact_phones object[] OPTIONAL
id integer OPTIONAL
type integer OPTIONAL
country string OPTIONAL
value string OPTIONAL
is_default boolean OPTIONAL
display_in_doc boolean OPTIONAL
400

Returns the form with errors

Schema OPTIONAL
object