CustomerBean

Description

This bean contains all information related to a customer of EService. This information is likely a subset of the full set of information any company is likely to store about a given customer, as the only information EService requires is that which facilitates the processing of jobs for that customer. Thus information such as gender, account numbers, current balance or other non job-critical information can not be stored in the defualt customer storage record.

There is facility for adding a limited number of "custom" fields for all customers, allowing for the the storing of other job-critical datums not covered by the default fields, on a per organisation basis. These extra fields are called attributes, and should be set up during initial setup of the organisation.

Customers can be either regular or not regular (true or false on the "Regular" field). The EService "Regular" field is not an indication that the customer is one for whom jobs are often done for, although this may be the case. The "Regular" flag indicates that on the EService website's Customer screen, a list of all regular customers will be displayed. Additionally, the Create New Job screen will have a drop down box populated with all regular customers. In all other respects, regular customers are identical to normal ones.

Thus, only customers for which quick and immediate access is required should be marked as regular, and that list should be kept as small as possible to ensure the responsiveness of the website remains unimpaired.

Note: If you have enabled mapping via the website then address fields 1, 3 and 4 will need to be populated before a customer can be created or updated.

Fields

The data fields of this object.

Name	Type	Size	Required	Description
Deleted	boolean	1	No	Indicates this customer has been deleted from EService, and is no longer considered active, nor can it be used to create jobs with.
Regular	boolean	1	No	Indicates this customer is a regular customer, and thus will appear on the customer screen, and in the drop down box shortcut when creating new jobs. In all other respects, this customer is the same as any non-regular customer. Note that this list should be kept as small as possible, only extremely commonly used customers should be set as "Regular".
Address1	String	200	No	First part of the customers address, usually denotes street number and street name.
Address2	String	30	No	Second part of customers address, usually denotes suburb or local area.
Address3	String	30	No	Third part of customers address, usually denotes city or region.
Address4	String	30	No	Fourth part of customers address, optional for New Zealand. For United States, it refers to the customers State.
PostCode	String	10	No	Post or Zip code of the customer.
Country	String	30	No	Customers country.
Attributes	AttributeBean array	N/A	No	The list of customer attributes associated with this customer. This list of attributes are used to populate value into the Customer Custom Fields, matched by attribue name to customer custom field name.
ContactName	String	30	No	The name of the contact person, will be different from the customer name if the customer name refers to a business or organisation.
ExternalRef	ExternalRefBean	N/A	No	External primary key and area referring to this customer.
HomeNumber	String	15	No	The home phone number for this customer.
MobileNumber	String	15	No	The mobile phone number for this customer.
Name	String	30	Yes	The name of this customer. May be a business or organisation name.
PrimaryKey	String	15	No	The Eservice primary key which uniquely identifies this customer.
UpdateIndex	int	10	Yes	This is a unique index value, used to check for issues of concurrency. If an attempt is made to update a customer, and the passed in UpdateIndex value differs from the one on the server, a Concurrency failure will be returned.
WhenLastUpdated	Calendar	N/A	No	The date and time the customer was last updated.
WorkNumber	String	15	No	The work number for this customer.