Query parameters
-
Comma separated list of relationships to include in the response. Valid relationships are [shared_owner, employment].
-
Filter by a comma separated list of UUIDs.
-
Field to sort by. Valid fields are [created_at, updated_at, name, amount]. Negative sign to denote DESC. Defaults to 'created_at'.
-
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/client/{client_uuid}/income
curl \
--request GET 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/income' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "My Salary",
"type": "salary",
"uuid": "550ba761-6e3d-4041-8c30-244f091a8b46",
"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": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "d73ac889-fbb2-4654-bbff-487bb9c6fd2f",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"end_date": "2025-07-17",
"frequency": "annually",
"created_at": "2025-07-17T16:23:20+01:00",
"employment": {
"uuid": "0616d3d9-225e-4d5b-bc46-e32efcd389fc",
"income": "App\\Http\\Resources\\IncomeResource",
"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": "App\\Http\\Resources\\AddressResource",
"primary": true,
"employer": "Plannr Technologies Ltd",
"ended_at": "2021-07-17T16:23:20+01:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-07-17T16:23:20+01:00",
"occupation": "Financial Adviser",
"started_at": "2020-07-17T16:23:20+01:00",
"updated_at": "2025-07-17T16:23:20+01:00",
"phone_number": "App\\Http\\Resources\\ContactDetailResource",
"shared_owner": "App\\Http\\Resources\\AccountResource",
"business_name": "My Business",
"email_address": "App\\Http\\Resources\\ContactDetailResource",
"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": "App\\Http\\Resources\\TurnoverHistoryResource",
"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
},
"is_taxable": true,
"start_date": "2024-07-17",
"type_other": "Other income type",
"updated_at": "2025-07-17T16:23:20+01:00",
"amount_type": "net",
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "f4e4eaed-763a-417c-a294-b5c74b1fb1d9",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-07-17T16:23:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-07-17T16:23:20+01:00",
"with_login": true,
"inactive_at": "2025-07-17",
"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-07-17T16:23:20+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-07-17T16:23:20+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-07-17T16:23:20+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-07-17T16:23:20+01:00"
},
"shared_owner_type": "individual"
}
]
}