new CustomerInfo()
- Source:
Methods
(static) CustomerInfo#getCustomer() → {customers.Customer}
Get the field value
The customer object that Clover uses. This is the base model for a Clover customer, any additional information external systems need should exist in other fields
- Source:
Returns:
- Type
- customers.Customer
(static) CustomerInfo#getDisplayString() → {String}
Get the field value
A custom way to display this customer for an external system
- Source:
Returns:
- Type
- String
(static) CustomerInfo#getExternalId() → {String}
Get the field value
an id for an external system to use to reference this Customer.
- Source:
Returns:
- Type
- String
(static) CustomerInfo#getExternalSystemName() → {String}
Get the field value
The name of the external system that 'owns' this. It is the system that understands the link from the externalId to the Customer.
- Source:
Returns:
- Type
- String
(static) CustomerInfo#getExtras() → {Object.<String, String>}
Get the field value
Extra data used by external systems.
- Source:
Returns:
A map of to <>
- Type
- Object.<String, String>
(static) CustomerInfo#setCustomer(customer)
Set the field value
The customer object that Clover uses. This is the base model for a Clover customer, any additional information external systems need should exist in other fields
Parameters:
Name | Type | Description |
---|---|---|
customer |
customers.Customer |
- Source:
(static) CustomerInfo#setDisplayString(displayString)
Set the field value
A custom way to display this customer for an external system
Parameters:
Name | Type | Description |
---|---|---|
displayString |
String |
- Source:
(static) CustomerInfo#setExternalId(externalId)
Set the field value
an id for an external system to use to reference this Customer.
Parameters:
Name | Type | Description |
---|---|---|
externalId |
String |
- Source:
(static) CustomerInfo#setExternalSystemName(externalSystemName)
Set the field value
The name of the external system that 'owns' this. It is the system that understands the link from the externalId to the Customer.
Parameters:
Name | Type | Description |
---|---|---|
externalSystemName |
String |
- Source:
(static) CustomerInfo#setExtras(extras)
Set the field value
Extra data used by external systems.
Parameters:
Name | Type | Description |
---|---|---|
extras |
Object.<String, String> | A map of |
- Source: