# Update an employment

**PUT /api/v1/client/{client_uuid}/employment/{uuid}**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)


### Path parameters
- **client_uuid** (string)

- **uuid** (string)



### Body: application/json (object)

- **status** (string)
  The employment status for the given employment. Available values: employed, self_employed, student, unemployed, house_person, retired and other
- **primary** (boolean)
  Make this employment the primary employment.  Will make all other employments no longer primary.
- **occupation_code** (string)
  The Origo occupation code for the given employment. You can use the /api/v1/static/occupations endpoint to get a list of occupations.
- **job_title** (string)
  Job title if no suitable occupation code is found.
- **employer** (string)
  The name of the employer/business.
- **started_at** (date)
  An optional start date of the employment.
- **ended_at** (date)
  An optional end date of the employment.
- **is_business_owner** (boolean)
  Denotes if the employment owner is the business owner.
- **percentage_of_business_owned** (integer)
  The percentage of the business owned.
- **address** (array[string])
  The address of the employer.
- **email_address** (string)
  The email address of the employer. Will be added as a contact detail.
- **phone_number** (string)
  The phone number of the employer. In E.164 format. Will be added as a contact detail.
- **shared_owner_uuid** (string)
  Optional UUID of an owner account. The client must be a shared type.
- **last_salary_increase** (date)
  The date of the last salary increase.
- **business_name** (string)
  The name of the business.
- **business_year_end** (string)
  The year end of the business.
- **business_value** (integer)
  The value of the business in pennies.
- **directors** (string)
  The directors of the business.
- **shareholding_in_business** (integer)
  The shareholding in the business in percentage.
- **profit** (integer)
  The profit of the business in pennies.
- **turnover_history** (array[string])
  The turnover history of the business for each year.  All values must be in pennies as integers.
- **accountant_company_name** (string)
  The name of the accountant company.
- **accountant_email** (string)
  The email of the accountant.
- **accountant_telephone_number** (string)
  The telephone number of the accountant.
- **accountant_address** (string)
  The address of the accountant.


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **status** (string)
  The employment status. Available values: employed, self_employed, student, unemployed, house_person, retired and other
- **occupation** (string)
  The occupation name found from the occupation code provided.
- **occupation_code** (string)
  @deprecated The Origo occupation code.
- **job_title** (string)
  Job title if not suitable occupation code is found.
- **employer** (string)
  The name of the employer.
- **started_at** (string)
  The employment start date.
- **ended_at** (string)
  The employment end date if provided.
- **is_business_owner** (boolean)
  Denotes if the account is the business owner.
- **percentage_of_business_shared** (integer)
  The percentage of business shared.
- **address** (object)
  The address of the employer.
- **phone_number** (object)
  The phone number of the employer.
- **email_address** (object)
  The email address of the employer.
- **shared_owner_type** (string)
  Denotes if the employment is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)
- **shared_owner** (object)
  The owner of the employment. Only provided if the shared_owner_type is "individual".
- **last_salary_increase** (object)
  The last salary increase.
- **business_name** (string)
  The name of the business.
- **business_year_end** (string)
  The year end of the business.
- **business_value** (object)
  The value of the business.
- **directors** (string)
  The directors of the business.
- **shareholding_in_business** (object)
  The shareholding in the business.
- **profit** (object)
  The profit of the business.
- **accountant_company_name** (string)
  The name of the accountant.
- **accountant_email** (string)
  The email of the accountant.
- **accountant_telephone_number** (string)
  The telephone number of the accountant.
- **accountant_address** (string)
  The address of the accountant.
- **primary** (boolean)
  Denotes if the employment is the primary employment for the account associated.
- **turnover_history** (object)
  The turnover history of the income.
- **income** (object)
  Incomes that have been linked to the employment.


[Powered by Bump.sh](https://bump.sh)