Create an employment

POST /api/v1/client/{client_uuid}/employment

Headers

Path parameters

client_uuid string Required

application/json

Body Required

status string Required

The employment status for the given employment. Available values: employed, self_employed, student, unemployed, house_person, retired and other
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 number

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

201 application/json
Hide response attributes Show response attributes 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
  
  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.
- turnover_history object
  
  The turnover history of the income.
- income object
  
  Incomes that bhave been linked to thi employment.

POST /api/v1/client/{client_uuid}/employment

curl \
 -X POST https://api.plannrcrm.com/api/v1/client/client_uuid/employment \
 -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 '{"status":"employed","occupation_code":"FAC02774","job_title":"Senior Developer","employer":"Plannr Technologies Ltd","started_at":"2019-10-16T11:10:14+01:00","ended_at":"2020-10-16T11:10:14+01:00","is_business_owner":true,"percentage_of_business_owned":50,"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"}}],"email_address":"gareth@plannrcrm.com","phone_number":"+443330509960","shared_owner_uuid":"83e63bb8-f518-4d77-bc19-4ba8c424a3c3","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.5,"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
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
{
  "status": "employed",
  "occupation_code": "FAC02774",
  "job_title": "Senior Developer",
  "employer": "Plannr Technologies Ltd",
  "started_at": "2019-10-16T11:10:14+01:00",
  "ended_at": "2020-10-16T11:10:14+01:00",
  "is_business_owner": true,
  "percentage_of_business_owned": 50,
  "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"
      }
    }
  ],
  "email_address": "gareth@plannrcrm.com",
  "phone_number": "+443330509960",
  "shared_owner_uuid": "83e63bb8-f518-4d77-bc19-4ba8c424a3c3",
  "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.5,
  "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 (201)

{
  "uuid": "d41b2f57-ee5a-4942-a38f-57bdb0050a36",
  "income": {
    "name": "My Salary",
    "type": "salary",
    "uuid": "623e2f39-db8e-4079-91f0-4436d7a8e102",
    "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"
      }
    },
    "end_date": "2024-10-16",
    "frequency": "annually",
    "created_at": "2024-10-16T11:10:14+01:00",
    "employment": "App\\Http\\Resources\\EmploymentResource",
    "is_taxable": true,
    "start_date": "2023-10-16",
    "updated_at": "2024-10-16T11:10:14+01: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",
    "county": "Hampshire",
    "country": "United Kingdom",
    "primary": true,
    "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": "2024-10-16T11:10:14+01:00",
    "updated_at": "2024-10-16T11:10:14+01:00"
  },
  "employer": "Plannr Technologies Ltd",
  "ended_at": "2020-10-16T11:10:14+01:00",
  "directors": "Susan F. Lancaster",
  "job_title": "Senior financial adviser",
  "created_at": "2024-10-16T11:10:14+01:00",
  "occupation": "Financial Adviser",
  "started_at": "2019-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01:00",
  "phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "a6a2d8f4-bae0-4910-b429-e51f9b2c2d4e",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:14+01:00",
    "updated_at": "2024-10-16T11:10:14+01: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": "a4198693-21f0-4451-8055-dcdb403c9224",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:14+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:14+01: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": "2024-10-16T11:10:14+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:14+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:14+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:14+01:00"
  },
  "business_name": "My Business",
  "email_address": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "764e20a5-0522-40e6-ba6e-aa1e7a599dd1",
    "value": "+443330903630",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": true,
    "created_at": "2024-10-16T11:10:14+01:00",
    "updated_at": "2024-10-16T11:10:14+01: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
}