| id |
required |
string |
The id of the client. |
| client_type |
required |
client-type |
Indicates if the client is an inquiry or not. |
| first_name |
required |
string |
The first name of the client. |
| last_name |
required |
string |
The last name of the client. |
| email |
optional |
email |
The email of the client. |
| gender |
optional |
gender |
The gender of the client. |
| phone_number |
optional |
phone |
The phone number of the client. |
| address.street |
optional |
string |
The street address of the client. |
| address.city |
optional |
string |
The city address of the client. |
| address.state |
optional |
region |
The state address of the client. |
| address.postal_code |
optional |
postal |
The postal code address of the client. |
| address.country |
optional |
country |
The country address of the client. |
| dob |
optional |
date |
The date of birth of the client. |
| picture |
optional |
string |
Ignore this for now. |
| notes |
optional |
string |
Any notes that should be attached to the client. |
| inquiry_date |
optional |
date |
The date the client inquired on. |
| inquirer.id |
required |
relation:"employees.id" |
The id of the employee to use as the "inquiry taker". |
| inquiry_method.id |
required |
relation:"inquiry_methods.id" |
The id of the inquiry method the client used. |
| inquiry_source.id |
required |
relation:"inquiry_methods.id" |
The id of the inquiry source the client used. |
| inquiry_interest.id |
optional |
relation:"inquiry_methods.id" |
The id of the inquiry interest the client used. |
| date_joined |
optional |
date |
The date the client joined. |
| level |
optional |
string |
The level the client has achieved (For Arthur Murray studios). |
| partner_email |
optional |
email |
For couples, the email of a second person. |
| partner_phone |
optional |
phone |
For couples, the phone number of a second person. |
| assigned_employee.id |
optional |
relation:"employees.id" |
An employee that has been assigned to the client for managerial purposes. |
| last_active |
optional |
date |
The date the client was last active. |
| department |
required |
department |
Wether they are in the front or back department (For Arthur Murray studios). |
| outstanding_balance |
required |
money |
The outstanding balance of the client. |
| client_status |
required |
client-status |
Indication if the client is active or archived. |
| metadata |
optional |
json |
TODO explain how taken adjustments can be outlined. |