Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[account_uuids] string
Filter by a comma separated list of account UUIDs.
-
filter[circle_uuids] string
Filter by a comma separated list of circle UUIDs.
-
filter[employment_uuids] string
Filter by a comma separated list of employment UUIDs that are linked to incomes.
-
filter[type] string
Filter by comma separate list of income types. Possible values are [salary, dividend, bonus, benefit, other, investment, rental, pension].
-
filter[frequency] string
Filter by comma separate list of frequenciess.
-
filter[amount_type] string
Filter by comma separate list of amount types. Possible values are [net,gross].
-
filter[start_date] string
Filter income by start date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
filter[end_date] string
Filter income by end date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
filter[amount] string
Filter income by amount in pennies. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [account, employment].
-
sort string
Field to sort by. Valid fields are [created_at, updated_at, name, amount, start_date, end_date]. Negative sign to denote DESC. Defaults to 'created_at'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
curl \
--request GET https://api.plannrcrm.com/api/v2/income \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"{
"data": [
{
"name": "My Salary",
"type": "salary",
"uuid": "8432e506-2bd6-42cb-87e0-623d3cb71117",
"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": "6c324435-c42f-4c39-bc68-6dae81c38ecd",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-02-20T10:13:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:06+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"end_date": "2025-02-20",
"frequency": "annually",
"created_at": "2025-02-20T10:13:06+00:00",
"employment": {
"uuid": "538031ee-9e63-44ca-b95b-fea40cda85e5",
"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",
"employer": "Plannr Technologies Ltd",
"ended_at": "2021-02-20T10:13:06+00:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-02-20T10:13:06+00:00",
"occupation": "Financial Adviser",
"started_at": "2020-02-20T10:13:06+00:00",
"updated_at": "2025-02-20T10:13:06+00: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-02-20",
"updated_at": "2025-02-20T10:13:06+00:00",
"amount_type": "net"
}
]
}