Description
The Customer Details class holds the details for each customer.
Derived By
Extending customer
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|---|---|---|---|
billingEntityUUID |
string |
0..1 |
The UUID of the Billing Entity to which the resource belongs |
resourceCreateDate |
dateTime |
0..1 |
The creation date of the resource |
resourceKey |
0..* |
The keys attached to the resource |
|
resourceMetadata |
0..1 |
The metadata attached to the resource |
|
resourceName |
string |
0..1 |
The name of the resource |
resourceState |
0..1 |
The state of the resource |
|
resourceType |
0..1 |
The type of the resource |
|
resourceUUID |
string |
0..1 |
The UUID of the resource (read-only) |
status |
0..1 |
The status of the customer (determining whether it is active etc.) |
|
limitsMap |
anyType (restriction) |
1..1 |
A map containing the system limitations of the customer |
carryOverBalance |
double |
1..1 |
The customer's current carry-over unit balance |
nonCarryOverBalance |
double |
1..1 |
The customer's current non-carry-over unit balance |
customerUUID |
string |
0..1 |
The UUID of the customer (which will be the same as the resource UUID) |
validatedString |
string |
0..1 |
The Validated string of the customer |
creditCustomer |
0..1 |
A flag to indicate whether the customer has a credit account |
|
organisationName |
string |
0..1 |
The organisation name for the customer |
vatNumber |
string |
0..1 |
The VAT number or tax reference for the customer |
customerCardCheck |
boolean |
1..1 |
A flag to indicate whether the customer requires credit card checks |
warningLevel |
double |
1..1 |
The unit level below which which a low balance warning should be sent |
warningSent |
boolean |
1..1 |
A flag to indicate the low balance warning has already been sent |
timeZone |
string |
0..1 |
The timezone associated with the customer |
vatExempt |
boolean |
1..1 |
The VAT exemption status of the customer |
users |
0..* |
The users/contacts associated with the customer |
|
string |
0..1 |
The email address associated with the user / contact |
|
address |
0..1 |
The address details of the customer |