CustomerBean
From
(Difference between revisions)
| Line 11: | Line 11: | ||
!Name | !Name | ||
!Type | !Type | ||
| + | !Size | ||
!Description | !Description | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|Deleted | |Deleted | ||
|boolean | |boolean | ||
| + | |1 | ||
|Indicates this customer has been deleted from EService, and is no longer considered active, nor can it be used to create jobs with. | |Indicates this customer has been deleted from EService, and is no longer considered active, nor can it be used to create jobs with. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|Regular | |Regular | ||
|boolean | |boolean | ||
| + | |1 | ||
|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. | |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. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|Address1 | |Address1 | ||
|String | |String | ||
| + | |60 | ||
|First part of the customers address, usually denotes street number and street name. | |First part of the customers address, usually denotes street number and street name. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|Address2 | |Address2 | ||
|String | |String | ||
| + | |30 | ||
|Second part of customers address, usually denotes suburb or city. For United States, it refers to the customers City. | |Second part of customers address, usually denotes suburb or city. For United States, it refers to the customers City. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|Address3 | |Address3 | ||
|String | |String | ||
| + | |30 | ||
|Third part of customers address, usually denotes city or region. For United States, it refers to the customers state. | |Third part of customers address, usually denotes city or region. For United States, it refers to the customers state. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|Address4 | |Address4 | ||
|String | |String | ||
| + | |30 | ||
|Fourth part of customers address, optional for New Zealand. For United States, it refers to the customers zip code. | |Fourth part of customers address, optional for New Zealand. For United States, it refers to the customers zip code. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
| Line 43: | Line 50: | ||
|ContactName | |ContactName | ||
|String | |String | ||
| + | |30 | ||
|The name of the contact person, will be different from the customer name if the customer name refers to a business or organisation. | |The name of the contact person, will be different from the customer name if the customer name refers to a business or organisation. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
| Line 51: | Line 59: | ||
|HomeNumber | |HomeNumber | ||
|String | |String | ||
| + | |15 | ||
|The home phone number for this customer. | |The home phone number for this customer. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|MobileNumber | |MobileNumber | ||
|String | |String | ||
| + | |15 | ||
|The mobile phone number for this customer. | |The mobile phone number for this customer. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|Name | |Name | ||
|String | |String | ||
| + | |30 | ||
|The name of this customer. May be a business or organisation name. | |The name of this customer. May be a business or organisation name. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|PrimaryKey | |PrimaryKey | ||
|String | |String | ||
| + | |15 | ||
|The Eservice primary key which uniquely identifies this customer. | |The Eservice primary key which uniquely identifies this customer. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
| Line 75: | Line 87: | ||
|WorkNumber | |WorkNumber | ||
|String | |String | ||
| + | |15 | ||
|The work number for this customer. | |The work number for this customer. | ||
|} | |} | ||
Revision as of 00:36, 3 June 2005
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.
Fields
The data fields of this object.
| Name | Type | Size | Description |
|---|---|---|---|
| Deleted | boolean | 1 | 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 | 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. |
| Address1 | String | 60 | First part of the customers address, usually denotes street number and street name. |
| Address2 | String | 30 | Second part of customers address, usually denotes suburb or city. For United States, it refers to the customers City. |
| Address3 | String | 30 | Third part of customers address, usually denotes city or region. For United States, it refers to the customers state. |
| Address4 | String | 30 | Fourth part of customers address, optional for New Zealand. For United States, it refers to the customers zip code. |
| Attributes | AttributeBean array | The list of customer attributes associated with this customer. | |
| ContactName | String | 30 | 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 | External primary key and area referring to this customer. | |
| HomeNumber | String | 15 | The home phone number for this customer. |
| MobileNumber | String | 15 | The mobile phone number for this customer. |
| Name | String | 30 | The name of this customer. May be a business or organisation name. |
| PrimaryKey | String | 15 | The Eservice primary key which uniquely identifies this customer. |
| UpdateIndex | int | 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 | The date and time the customer was last updated. | |
| WorkNumber | String | 15 | The work number for this customer. |
