Create an income Run in API Explorer
Ask AI
Body
-
The name of the income.
-
The type of income. Possible values:
Value Description salary Salary dividend Dividend bonus Bonus benefit Benefit other Other investment Investment rental Rental pension Pension capital_gains Capital Gains business_loan Business Loan investor_funding Investor Funding grant Grant charity Charity crowdfunding Crowdfunding gross_profit Gross Profit operating_profit Operating Profit operating_revenue Operating Revenue non_operating_revenue Non Operating Revenue net_profit Net Profit Values are
salary,dividend,bonus,benefit,other,investment,rental,pension,capital_gains,business_loan,investor_funding,grant,charity,crowdfunding,gross_profit,operating_profit,operating_revenue,non_operating_revenue, ornet_profit. -
The other type of income. This is required if the type is "other".
-
The amount of the income in pennies. For example, £50,000 would be 5000000.
-
The type of the amount.
Value Description net Net gross Gross Values are
netorgross. -
The start date of the income.
-
The end date of the income.
-
The frequency of the income.
Value Description daily Daily weekly Weekly fortnightly Fortnightly four_weekly Four Weekly monthly Monthly bimonthly Bimonthly quarterly Quarterly biannually Biannually annually Annually adhoc Adhoc one_off One Off Values are
daily,weekly,fortnightly,four_weekly,monthly,bimonthly,quarterly,biannually,annually,adhoc, orone_off. -
Denotes if the income is taxable or not.
-
Employment to link to this salary, dividend, bonus, benefit, other type incomes.
POST
/api/v1/client/{client_uuid}/income
curl \
--request POST 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/income' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"name":"My Salary","type":"salary","type_other":"null","amount":5000000,"amount_type":"net","start_date":"2024-12-16","end_date":"2025-12-16","frequency":"daily","is_taxable":true,"shared_owner_uuid":"fa74941d-c5ad-4609-80da-3ac1a0756dda","employment_uuid":"6b3645c2-9534-4119-ae9a-0455d415d155"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "My Salary",
"type": "salary",
"type_other": "null",
"amount": 5000000,
"amount_type": "net",
"start_date": "2024-12-16",
"end_date": "2025-12-16",
"frequency": "daily",
"is_taxable": true,
"shared_owner_uuid": "fa74941d-c5ad-4609-80da-3ac1a0756dda",
"employment_uuid": "6b3645c2-9534-4119-ae9a-0455d415d155"
}
Response examples (201)
{
"name": "My Salary",
"type": "salary",
"uuid": "77c442ec-e81f-4c69-b8d2-9f06f8e8d873",
"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": "e1542248-7373-4119-959f-049ee733b3c2",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-12-16T17:00:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-16T17:00:06+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"end_date": "2025-12-16",
"frequency": "annually",
"created_at": "2025-12-16T17:00:06+00:00",
"employment": {
"uuid": "79292103-75e8-42ed-9722-6ceddcc31cdf",
"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-12-16T17:00:06+00:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-12-16T17:00:06+00:00",
"occupation": "Financial Adviser",
"started_at": "2020-12-16T17:00:06+00:00",
"updated_at": "2025-12-16T17:00: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-12-16",
"type_other": "Other income type",
"updated_at": "2025-12-16T17:00:06+00:00",
"amount_type": "net",
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "3c6454a6-84cd-4e1e-afdd-517d26d52f1d",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-12-16T17:00:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-16T17:00:06+00:00",
"with_login": true,
"inactive_at": "2025-12-16",
"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-12-16T17:00:06+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-16T17:00:06+00: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-12-16T17:00:06+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-16T17:00:06+00:00"
},
"shared_owner_type": "individual"
}