List of fields to be displayed in the response for customers list.


field type description
customer_code_365 string 365 customer code.
customer_code_secondary string Customer secondary code. Typically generated by third-party software when a new customer is submitted, and used to validate and prevent duplicate entries.
account_code_365 string 365 account code assigned to the customer.
is_company boolean Specifies if the customer is a company or a person.
company_name string Company name if the customer is flagged as company.
last_name string Customer last name if the customer is flagged as person.
first_name string Customer first name if the customer is flagged as person.
short_name string Customer short name.
store_code_365 string 365 Store code assigned to the customer.
active boolean Specifies if the customer is active or not.
date_of_birth string Customer date of birth as string in format "yyyy-mm-dd"
gender string Customer gender. "M" - masculin, "F" - female, "O" - other.
tel_1 string Customer phone 1 number.
tel_2 string Customer phone 2 number.
mobile string Customer mobile number.
sms string Customer sms number.
fax string Customer fax number.
email string Customer email address.
website string Customer website.
category_code_1_365 string 365 customer category 1 code.
category_1_name string Customer category 1 name.
category_code_2_365 string 365 customer category 2 code.
category_2_name string Customer category 2 name.
company_activity_code_365 string 365 company activity code.
company_activity_name string Company activity name.
credit_limit_amount decimal Allowed credit amount.
customer_id string Customer ID.
vat_registration_number string Customer vat registration number.
remarks string Customer remarks.
address_line_1 string Customer address line 1.
address_line_2 string Customer address line 2.
address_line_3 string Customer address line 3.
postal_code string Customer postal code.
town string Customer town.
country_code_iso2 string ISO2 customer country code.
country_name string Country name.
contact_last_name string Contact last name.
contact_first_name string Contact first name.
default_price integer
Customer default price assigned.
  • 0 - Default price. It is the price defined at the system level
  • 1 - Price1
  • 2 - Price2
  • 3 - Price3
  • 4 - Price4
  • 5 - Price5
  • 6 - Price6
  • 7 - Price7
  • 8 - Price8
  • 9 - Price9
  • 10 - Price10
  • 87 - Weighted Average Cost
  • 88 - Average Cost
  • 99 - Latest Cost
  • 72 - Discount price 2
  • 73 - Discount price 3
  • 74 - Discount price 4
  • 75 - Discount price 5
  • 76 - Discount price 6
  • 77 - Discount price 7
  • 78 - Discount price 8
  • 79 - Discount price 9
  • 80 - Discount price 10
  • 97 - Last Price
  • 98 - Last Discount
loyalty_factor integer Loyalty factor.
text_field_1_value string Extra text field 1 value.
text_field_2_value string Extra text field 2 value.
text_field_3_value string Extra text field 3 value.
text_field_4_value string Extra text field 4 value.
text_field_5_value string Extra text field 5 value.
number_field_1_value decimal Extra numeric field 1 value.
number_field_2_value decimal Extra numeric field 2 value.
number_field_3_value decimal Extra numeric field 3 value.
number_field_4_value decimal Extra numeric field 4 value.
number_field_5_value decimal Extra numeric field 5 value.
date_field_1_value string Extra date field 1 value as string in format "yyyy-mm-dd".
date_field_2_value string Extra date field 2 value as string in format "yyyy-mm-dd".
date_field_3_value string Extra date field 3 value as string in format "yyyy-mm-dd".
date_field_4_value string Extra date field 4 value as string in format "yyyy-mm-dd".
date_field_5_value string Extra date field 5 value as string in format "yyyy-mm-dd".
points_balance decimal Customer points balance.
points_ever_balance decimal Customer points ever balance.
is_euc boolean Specifies if customer is flagged as EUC. Customer is from a country member of EU.
is_export boolean Specifies if customer is flagged as export. Customer is from a country different from locally country set in settings.
discount_limit decimal Discount limit given to the customer.
agent_code_365 string 365 agent code.
agent_name string Agent name.
balance decimal Customer current balance.
b2b boolean Specifies if customer is flagged as B2B.
general_ledger_header_code_365 string 365 general ledger header code.
general_ledger_header_name string General ledger header name.
detail_account_header_code_365 string 365 detail account header code.
detail_account_header_name string 365 detail account name.