Get all employments
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [shared_owner, address, email_address, phone_number, income].
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
sort string
Field to sort by. Valid fields are [created_at, updated_at, employer]. Negative sign to denote DESC. Defaults to 'created_at'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET /api/v1/client/{client_uuid}/employment
curl \
-X GET 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}"
Response examples (200)
{
"data": [
{
"uuid": "b3fa0a3f-c074-4d55-86c6-289cc38729b8",
"income": {
"name": "My Salary",
"type": "salary",
"uuid": "10bbec3c-799c-44c1-8089-346db01247ac",
"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": "7ec3dcc4-4a3b-4989-8cbb-d996b802f980",
"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": "e26a39ce-1cb7-4445-b2d3-0d204b5e81d5",
"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": "a91e7734-9c68-44b1-ac52-95a7ff614432",
"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
}
]
}