Create an income
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body Required
-
The name of the income.
-
The type of income. Possible values: salary, dividend, bonus, benefit, other, investment, rental and pension.
-
The amount of the income in pennies. For example, £50,000 would be 5000000.
-
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.
-
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/v1/client/{client_uuid}/income
curl \
-X POST https://api.plannrcrm.com/api/v1/client/client_uuid/income \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
-d '{"name":"My Salary","type":"salary","amount":5000000,"amount_type":"net","start_date":"2023-11-20","end_date":"2024-11-20","frequency":"annually","is_taxable":true,"shared_owner_uuid":"05b18a2f-d6c1-49cc-8a36-8a9cb3b727ad","employment_uuid":"9a8e9caf-38ad-46a9-832b-0d6e8f19418f"}'
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
{
"name": "My Salary",
"type": "salary",
"amount": 5000000,
"amount_type": "net",
"start_date": "2023-11-20",
"end_date": "2024-11-20",
"frequency": "annually",
"is_taxable": true,
"shared_owner_uuid": "05b18a2f-d6c1-49cc-8a36-8a9cb3b727ad",
"employment_uuid": "9a8e9caf-38ad-46a9-832b-0d6e8f19418f"
}
Response examples (201)
{
"name": "My Salary",
"type": "salary",
"uuid": "aaea4493-4617-49b6-9e17-f33f8823d06f",
"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"
}
},
"end_date": "2024-11-20",
"frequency": "annually",
"created_at": "2024-11-20T13:24:00+00:00",
"employment": {
"uuid": "d0541338-35c7-4e77-b679-9daebc3cc04d",
"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": "2020-11-20T13:24:00+00:00",
"directors": "Susan F. Lancaster",
"job_title": "Senior financial adviser",
"created_at": "2024-11-20T13:24:00+00:00",
"occupation": "Financial Adviser",
"started_at": "2019-11-20T13:24:00+00:00",
"updated_at": "2024-11-20T13:24:00+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": "2023-11-20",
"updated_at": "2024-11-20T13:24:00+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": "29de14d4-9df1-4b8a-b6df-4a86e46882cc",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:00+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:00+00:00",
"with_login": true,
"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": "2024-11-20T13:24:00+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:00+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:00+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:00+00:00"
},
"shared_owner_type": "individual"
}