Customer Classes
A customer class groups similar customers and carries data protection and business verification rules. See the Customer Classes guide for how classes work.
Methods
Section titled “Methods”Retrieve Single Customer Class
Section titled “Retrieve Single Customer Class”/backend/api/v1/customerClasses/ID - fetch the customer class with the specified ID.
List Customer Classes
Section titled “List Customer Classes”/backend/api/v1/customerClasses/ - list all customer classes.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include classes with a higher ID |
createdSince | datetime | No | Only include classes created since the given time |
updatedSince | datetime | No | Only include classes updated since the given time |
/backend/api/v1/customerClasses/ - add a new customer class. The newly-added class will be returned.
/backend/api/v1/customerClasses/ID - update the customer class with the specified ID. The modified class will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/customerClasses/ID - delete the customer class with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| customerClassName | Customer Class | Text | Name of the customer class |
| customerClassDisplayClass | Customer Class Display Class | Text | CSS class name used for display styling of this customer class |
| customerClassDisplayPosition | Customer Class Display Position | Number | Sort order position for displaying this customer class in lists |
| personalCustomer | Personal Customer | Preset Value | Whether customers in this class are personal customers requiring special data protection handling |
| soleTrader | Sole Trader | Preset Value | Whether customers in this class are sole traders |
| reseller | Reseller | Preset Value | Whether customers in this class are resellers who sell services to other customers |
| companiesHouseCheck | Check Companies House | Preset Value | |
| id | Customer Class ID | Text | The unique identifier for this customer class |