Body
-
Client account UUID of who this income belongs to.
-
The name of the income.
Maximum length is
255. -
The type of income.
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 type of income when the type is set to "other".
Maximum length is
255. -
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/v2/income
curl \
--request POST 'https://api.plannrcrm.com/api/v2/income' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"account_uuid":"8d71540e-ac24-49e7-b67e-590d76e526e3","name":"My Salary","type":"salary","type_other":"My Other Income","amount":5000000,"amount_type":"net","start_date":"2025-01-16","end_date":"2026-01-16","frequency":"daily","is_taxable":true,"employment_uuid":"cbdfc35a-e4bf-4cc5-bd91-893f2922ea05"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuid": "8d71540e-ac24-49e7-b67e-590d76e526e3",
"name": "My Salary",
"type": "salary",
"type_other": "My Other Income",
"amount": 5000000,
"amount_type": "net",
"start_date": "2025-01-16",
"end_date": "2026-01-16",
"frequency": "daily",
"is_taxable": true,
"employment_uuid": "cbdfc35a-e4bf-4cc5-bd91-893f2922ea05"
}
Response examples (201)
{
"name": "My Salary",
"type": "salary",
"uuid": "7f51c398-8e5d-4390-b4da-12f93a115099",
"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": "a32c4d2a-bafd-49c7-9d42-405e2fbcb65a",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2026-01-16T13:10:24+00:00",
"first_name": "Gareth",
"updated_at": "2026-01-16T13:10:24+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"end_date": "2026-01-16",
"frequency": "annually",
"created_at": "2026-01-16T13:10:24+00:00",
"employment": {
"uuid": "90ba1761-0b80-4eea-a09e-30935933d24a",
"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",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"address": "App\\Http\\Resources\\AddressResource",
"primary": true,
"employer": "Plannr Technologies Ltd",
"ended_at": "2022-01-16T13:10:24+00:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2026-01-16T13:10:24+00:00",
"occupation": "Financial Adviser",
"started_at": "2021-01-16T13:10:24+00:00",
"updated_at": "2026-01-16T13:10:24+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": "2019-01-01",
"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": "2025-01-16",
"type_other": "Other income type",
"updated_at": "2026-01-16T13:10:24+00:00",
"amount_type": "net"
}