Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body Required
-
accountant_address string
The address of the accountant.
-
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.
-
address array[string]
The address of the employer.
-
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.
-
email_address string
The email address of the employer. Will be added as a contact detail.
-
employer string
The name of the employer/business.
-
ended_at date
An optional end date of the employment.
-
is_business_owner boolean
Denotes if the employment owner is the business owner.
-
job_title string
Job title if no suitable occupation code is found.
-
last_salary_increase date
The date of the last salary increase.
-
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.
-
percentage_of_business_owned integer
The percentage of the business owned.
-
phone_number string
The phone number of the employer. In E.164 format. Will be added as a contact detail.
-
primary boolean
Make this employment the primary employment. Will make all other employments no longer primary.
-
profit integer
The profit of the business in pennies.
-
The employment status for the given employment. Available values: employed, self_employed, student, unemployed, house_person, retired and other
-
started_at date
An optional start date of the employment.
PUT
/api/v2/employments/{uuid}
curl \
-X PUT https://api.plannrcrm.com/api/v2/employments/uuid \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
-d '{"accountant_address":"73 Sting Street, Testerton, Testershire","accountant_company_name":"My Company","accountant_email":"accountant@example.com","accountant_telephone_number":"0123456789","address":[{"county":{"type":"string","example":"Hampshire","required":false,"description":"County"},"country":{"type":"string","example":"United Kingdom","required":false,"description":"Country"},"postcode":{"type":"string","example":"PO7 7YH","required":false,"description":"Postcode"},"address_1":{"type":"string","example":"Work Address","required":false,"description":"Name of the address"},"address_2":{"type":"string","example":"Suite E, 5 The Briars","required":false,"description":"Second line of the address"},"address_3":{"type":"string","example":"Waterberry Drive","required":false,"description":"Third line of the address"},"address_4":{"type":"string","example":"The Innovative Centre","required":false,"description":"Fourth line of the address"},"town_city":{"type":"string","example":"Waterlooville","required":false,"description":"Town/City"},"move_in_date":{"type":"string","example":"2024-06-20","required":false,"description":"Move in date"}}],"business_name":"My Business","business_year_end":"2019-01-01","business_value":5000000,"directors":"John Doe","email_address":"gareth@plannrcrm.com","employer":"Plannr Technologies Ltd","ended_at":"2021-01-17T11:18:33+00:00","is_business_owner":true,"job_title":"Senior Developer","last_salary_increase":"2019-01-01","occupation_code":"FAC02774","percentage_of_business_owned":50,"phone_number":"+443330509960","primary":true,"profit":5000000,"shareholding_in_business":50.5,"status":"employed","started_at":"2020-01-17T11:18:33+00:00"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"accountant_address": "73 Sting Street, Testerton, Testershire",
"accountant_company_name": "My Company",
"accountant_email": "accountant@example.com",
"accountant_telephone_number": "0123456789",
"address": [
{
"county": {
"type": "string",
"example": "Hampshire",
"required": false,
"description": "County"
},
"country": {
"type": "string",
"example": "United Kingdom",
"required": false,
"description": "Country"
},
"postcode": {
"type": "string",
"example": "PO7 7YH",
"required": false,
"description": "Postcode"
},
"address_1": {
"type": "string",
"example": "Work Address",
"required": false,
"description": "Name of the address"
},
"address_2": {
"type": "string",
"example": "Suite E, 5 The Briars",
"required": false,
"description": "Second line of the address"
},
"address_3": {
"type": "string",
"example": "Waterberry Drive",
"required": false,
"description": "Third line of the address"
},
"address_4": {
"type": "string",
"example": "The Innovative Centre",
"required": false,
"description": "Fourth line of the address"
},
"town_city": {
"type": "string",
"example": "Waterlooville",
"required": false,
"description": "Town/City"
},
"move_in_date": {
"type": "string",
"example": "2024-06-20",
"required": false,
"description": "Move in date"
}
}
],
"business_name": "My Business",
"business_year_end": "2019-01-01",
"business_value": 5000000,
"directors": "John Doe",
"email_address": "gareth@plannrcrm.com",
"employer": "Plannr Technologies Ltd",
"ended_at": "2021-01-17T11:18:33+00:00",
"is_business_owner": true,
"job_title": "Senior Developer",
"last_salary_increase": "2019-01-01",
"occupation_code": "FAC02774",
"percentage_of_business_owned": 50,
"phone_number": "+443330509960",
"primary": true,
"profit": 5000000,
"shareholding_in_business": 50.5,
"status": "employed",
"started_at": "2020-01-17T11:18:33+00:00"
}
Response examples (200)
{
"uuid": "3df70add-423e-415b-8a28-3284a5b58428",
"income": {
"name": "My Salary",
"type": "salary",
"uuid": "481694a9-7290-4ceb-97b9-9e9b2d0ac3c8",
"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-01-17",
"frequency": "annually",
"created_at": "2025-01-17T11:18:33+00:00",
"employment": "App\\Http\\Resources\\EmploymentResource",
"is_taxable": true,
"start_date": "2024-01-17",
"updated_at": "2025-01-17T11:18:33+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",
"account": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "b7e77887-d8e6-4c48-bf1d-850ef4bd3324",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-01-17T11:18:33+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-17T11:18:33+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"address": {
"name": "Work Address",
"uuid": "cfb8725c-4124-4e46-93a7-83fcd5502c68",
"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-01-17T11:18:33+00:00",
"updated_at": "2025-01-17T11:18:33+00:00",
"move_in_date": "2024-01-17"
},
"employer": "Plannr Technologies Ltd",
"ended_at": "2021-01-17T11:18:33+00:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-01-17T11:18:33+00:00",
"occupation": "Financial Adviser",
"started_at": "2020-01-17T11:18:33+00:00",
"updated_at": "2025-01-17T11:18:33+00:00",
"phone_number": {
"name": "Work number",
"type": "phone_number",
"uuid": "ad650605-9a6c-4d63-aa59-aa211a1593c8",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-01-17T11:18:33+00:00",
"updated_at": "2025-01-17T11:18:33+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": "b17248bd-ec9c-4d1e-98df-601f36624662",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-17T11:18:33+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-17T11:18:33+00:00",
"with_login": true,
"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-01-17T11:18:33+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-17T11:18:33+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-17T11:18:33+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-17T11:18:33+00:00"
},
"business_name": "My Business",
"email_address": {
"name": "Work number",
"type": "phone_number",
"uuid": "b6ea2f11-a861-412c-8dc0-49bbd8302047",
"value": "+443330903630",
"accounts": "App\\Http\\Resources\\AccountResource",
"created_at": "2025-01-17T11:18:33+00:00",
"updated_at": "2025-01-17T11:18:33+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": {
"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_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
}