HomeAPI ReferenceHelp Center
API Reference
Start typing to search…

The customer object

The customer object provides access to customer account details stored in the system. Customer accounts represent people who made bookings or purchases. If customer account login is active, these accounts will provide people access to manage their bookings via the customer account area.

Attributes

  • *id** integer The unique id for the customer object.
  • reference string
    The unique reference for the customer.
  • *ip** string
    The ip of the customer.
  • *firstname** _string
    The first name of the customer.
  • *lastname** _string
    The last name of the customer.
  • *email** string
    The email for the customer.
  • *mobile** string
    The mobile number for the customer.
  • *telephone** string
    The telephone number for the customer.
  • *address** string
    The address of the customer.
  • *address2** string
    The address2 of the customer.
  • *city** string
    The city of the customer.
  • *county** string
    The county of the customer.
  • *postcode** string
    The postcode of the customer.
  • *country** string
    The country of the customer.
  • *image** string
    The profile image of the customer.
  • *salestotal** _positive float or zero
    The sales (bookings/purchases) total for the customer.
  • *paidtotal** _positive float or zero
    The paid total for the customer.
  • *duetotal** _positive float or zero
    The due total for the customer.
  • *customfields** _array_objects
    The custom fields for this customer, as dictated by the customers settings
  • *credittotal** _float
    The total amount of credit for the customer.
  • *waiversigned** _boolean
    If the customer has signed the waiver, if applicable.
  • *waiver** boolean
    If signed, the waiver object for the customer.