Update an employment Run in API Explorer
Ask AI
Body
-
The employment status for the given employment. Available values: employed, self_employed, student, unemployed, house_person, retired and other
-
Make this employment the primary employment. Will make all other employments no longer primary.
-
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 if no suitable occupation code is found.
-
The name of the employer/business.
-
An optional start date of the employment.
-
An optional end date of the employment.
-
Denotes if the employment owner is the business owner.
-
The percentage of the business owned.
-
The email address of the employer. Will be added as a contact detail.
-
The phone number of the employer. In E.164 format. Will be added as a contact detail.
-
The date of the last salary increase.
-
The name of the business.
-
The year end of the business.
-
The value of the business in pennies.
-
The directors of the business.
-
The profit of the business in pennies.
-
The turnover history of the business for each year. All values must be in pennies as integers.
-
The name of the accountant company.
-
The email of the accountant.
-
The telephone number of the accountant.
-
The address of the accountant.
PUT
/api/v1/client/{client_uuid}/employment/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/employment/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"status":"employed","primary":true,"occupation_code":"FAC02774","job_title":"Senior Developer","employer":"Plannr Technologies Ltd","started_at":"2020-12-24T11:02:59+00:00","ended_at":"2021-12-24T11:02:59+00:00","is_business_owner":true,"percentage_of_business_owned":50,"address":{"address_1":"Work Address","address_2":"Suite E, 5 The Briars","address_3":"Waterberry Drive","address_4":"The Innovative Centre","town_city":"Waterlooville","county":"Hampshire","postcode":"PO7 7YH","country":"United Kingdom"},"email_address":"gareth@plannrcrm.com","phone_number":"+443330509960","shared_owner_uuid":"f6a92da9-0159-45f0-943a-b609b967b17a","last_salary_increase":"2019-01-01","business_name":"My Business","business_year_end":"2019-01-01","business_value":5000000,"directors":"John Doe","shareholding_in_business":50,"profit":5000000,"turnover_history":[{"year":2022,"value":5000000},{"year":2021,"value":4500000}],"accountant_company_name":"My Company","accountant_email":"accountant@email.com","accountant_telephone_number":"0123456789","accountant_address":"1 My Street, My Town, My Country"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"status": "employed",
"primary": true,
"occupation_code": "FAC02774",
"job_title": "Senior Developer",
"employer": "Plannr Technologies Ltd",
"started_at": "2020-12-24T11:02:59+00:00",
"ended_at": "2021-12-24T11:02:59+00:00",
"is_business_owner": true,
"percentage_of_business_owned": 50,
"address": {
"address_1": "Work Address",
"address_2": "Suite E, 5 The Briars",
"address_3": "Waterberry Drive",
"address_4": "The Innovative Centre",
"town_city": "Waterlooville",
"county": "Hampshire",
"postcode": "PO7 7YH",
"country": "United Kingdom"
},
"email_address": "gareth@plannrcrm.com",
"phone_number": "+443330509960",
"shared_owner_uuid": "f6a92da9-0159-45f0-943a-b609b967b17a",
"last_salary_increase": "2019-01-01",
"business_name": "My Business",
"business_year_end": "2019-01-01",
"business_value": 5000000,
"directors": "John Doe",
"shareholding_in_business": 50,
"profit": 5000000,
"turnover_history": [
{
"year": 2022,
"value": 5000000
},
{
"year": 2021,
"value": 4500000
}
],
"accountant_company_name": "My Company",
"accountant_email": "accountant@email.com",
"accountant_telephone_number": "0123456789",
"accountant_address": "1 My Street, My Town, My Country"
}
Response examples (200)
{
"uuid": "90c46467-65cc-413e-b55f-969bf22117ba",
"income": {
"name": "My Salary",
"type": "salary",
"uuid": "3b45e9d9-edb2-48fc-9bf1-a1e4fa79f9fc",
"amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"end_date": "2025-12-24",
"frequency": "annually",
"created_at": "2025-12-24T11:02:59+00:00",
"employment": "App\\Http\\Resources\\EmploymentResource",
"is_taxable": true,
"start_date": "2024-12-24",
"type_other": "Other income type",
"updated_at": "2025-12-24T11:02:59+00:00",
"amount_type": "net",
"shared_owner": "App\\Http\\Resources\\AccountResource",
"shared_owner_type": "individual"
},
"profit": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"status": "employed",
"address": {
"name": "Work Address",
"uuid": "0cfdb665-784c-4a17-b9ba-23b3c96f001d",
"county": "Hampshire",
"country": "United Kingdom",
"accounts": "App\\Http\\Resources\\AccountResource",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"address_3": "The Innovative Centre",
"address_4": "Waterlooville",
"town_city": "Waterlooville",
"created_at": "2025-12-24T11:02:59+00:00",
"updated_at": "2025-12-24T11:02:59+00:00",
"move_in_date": "2024-12-24"
},
"primary": true,
"employer": "Plannr Technologies Ltd",
"ended_at": "2021-12-24T11:02:59+00:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-12-24T11:02:59+00:00",
"occupation": "Financial Adviser",
"started_at": "2020-12-24T11:02:59+00:00",
"updated_at": "2025-12-24T11:02:59+00:00",
"phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "9704a005-6945-4205-b056-a185304dae3c",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-12-24T11:02:59+00:00",
"updated_at": "2025-12-24T11:02:59+00:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "9477c636-2ab9-46d2-8304-aa6a5ae0aa7a",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-12-24T11:02:59+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-24T11:02:59+00:00",
"with_login": true,
"inactive_at": "2025-12-24",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-12-24T11:02:59+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-24T11:02:59+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"last_interaction_at": "2025-12-24 11:02:59",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-12-24T11:02:59+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-24T11:02:59+00:00"
},
"business_name": "My Business",
"email_address": {
"name": "Work number",
"type": "phone_number",
"uuid": "6b289dbb-2de9-464b-9ad7-4038b9a84c8c",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-12-24T11:02:59+00:00",
"updated_at": "2025-12-24T11:02:59+00:00",
"phone_number_meta": {
"country": "GB",
"formatted": "0333 090 3630"
}
},
"business_value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"occupation_code": "FAC02774",
"accountant_email": "accountant@email.com",
"turnover_history": {
"year": 2020,
"value": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
}
},
"business_year_end": "2020-12-31",
"is_business_owner": true,
"shared_owner_type": "individual",
"accountant_address": "23 Chollerton, Hexham, Northumberland, NE46 4TF",
"last_salary_increase": "2019-01-01",
"accountant_company_name": "My Accountant",
"shareholding_in_business": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"accountant_telephone_number": "+441234567890",
"percentage_of_business_shared": 50
}