Body
Required
-
Client account UUID of who this income belongs to.
-
The name of the income.
-
The type of income. Possible values: 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 and net_profit.
-
The type of income when the type is set to "other".
-
The amount of the income in pennies. For example, £50,000 would be 5000000.
-
The type of the amount. Possible values: net and gross.
-
The start date of the income.
-
The end date of the income.
-
The frequency of the income. Possible values: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc, and one_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":"4e438b5e-2316-4b90-abf8-7eaf718fcb6d","name":"My Salary","type":"salary","type_other":"My Other Income","amount":5000000,"amount_type":"net","start_date":"2024-12-04","end_date":"2025-12-04","frequency":"annually","is_taxable":true,"shared_owner_uuid":"a657171b-1815-40f8-a1f7-573e031e4af9","employment_uuid":"fcc500ce-b801-4959-bd07-a69fe97525eb"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuid": "4e438b5e-2316-4b90-abf8-7eaf718fcb6d",
"name": "My Salary",
"type": "salary",
"type_other": "My Other Income",
"amount": 5000000,
"amount_type": "net",
"start_date": "2024-12-04",
"end_date": "2025-12-04",
"frequency": "annually",
"is_taxable": true,
"shared_owner_uuid": "a657171b-1815-40f8-a1f7-573e031e4af9",
"employment_uuid": "fcc500ce-b801-4959-bd07-a69fe97525eb"
}
Response examples (201)
{
"name": "My Salary",
"type": "salary",
"uuid": "ee90cfb5-9a28-4979-b3e9-1072412cc52b",
"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": "f907ac6a-1f7b-4524-a139-985849844da8",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-12-04T22:09:17+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-04T22:09:17+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"end_date": "2025-12-04",
"frequency": "annually",
"created_at": "2025-12-04T22:09:17+00:00",
"employment": {
"uuid": "bc511a82-b8a7-4678-8254-986c862cc0d9",
"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": "2021-12-04T22:09:17+00:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-12-04T22:09:17+00:00",
"occupation": "Financial Adviser",
"started_at": "2020-12-04T22:09:17+00:00",
"updated_at": "2025-12-04T22:09:17+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-04",
"type_other": "Other income type",
"updated_at": "2025-12-04T22:09:17+00:00",
"amount_type": "net"
}