Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Body
Required
-
account_uuid
string Required Client account UUID of who this income belongs to.
-
name
string Required The name of the income.
-
type
string Required The type of income. Possible values: salary, dividend, bonus, benefit, other, investment, rental and pension.
-
amount
integer Required The amount of the income in pennies. For example, £50,000 would be 5000000.
-
amount_type
string Required The type of the amount. Possible values: net and gross.
-
start_date
string The start date of the income.
-
end_date
string The end date of the income.
-
frequency
string Required The frequency of the income. Possible values: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc, and one_off.
-
is_taxable
boolean Denotes if the income is taxable or not.
-
employment_uuid
string 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 {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 '{"account_uuid":"61689f4b-ebfa-4076-beca-dc7a39548977","name":"My Salary","type":"salary","amount":5000000,"amount_type":"net","start_date":"2024-04-22","end_date":"2025-04-22","frequency":"annually","is_taxable":true,"shared_owner_uuid":"08298ad6-49fe-4331-b911-a8ecf1684216","employment_uuid":"25b36123-bbd7-4c19-8efc-282a28d3c487"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuid": "61689f4b-ebfa-4076-beca-dc7a39548977",
"name": "My Salary",
"type": "salary",
"amount": 5000000,
"amount_type": "net",
"start_date": "2024-04-22",
"end_date": "2025-04-22",
"frequency": "annually",
"is_taxable": true,
"shared_owner_uuid": "08298ad6-49fe-4331-b911-a8ecf1684216",
"employment_uuid": "25b36123-bbd7-4c19-8efc-282a28d3c487"
}
Response examples (201)
{
"name": "My Salary",
"type": "salary",
"uuid": "34543c21-8b79-4b28-8430-149ea96d883b",
"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": "42295f5f-4649-4c14-87be-c78c4012f276",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:22+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:22+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"end_date": "2025-04-22",
"frequency": "annually",
"created_at": "2025-04-22T13:44:22+01:00",
"employment": {
"uuid": "f566ea9b-42b4-4876-958a-ac51e5269d6c",
"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-04-22T13:44:22+01:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2025-04-22T13:44:22+01:00",
"occupation": "Financial Adviser",
"started_at": "2020-04-22T13:44:22+01:00",
"updated_at": "2025-04-22T13:44:22+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-04-22",
"updated_at": "2025-04-22T13:44:22+01:00",
"amount_type": "net"
}