Create an income

POST /api/v1/client/{client_uuid}/income

Personal access token & O auth2

Headers

Path parameters

client_uuid string Required

application/json

Body Required

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.
shared_owner_uuid string

Optional UUID of an owner account. The client must be a shared type.
employment_uuid string

Employment to link to this salary, dividend, bonus, benefit, other type incomes.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  The name of the income.
- type string
  
  The type of income.
- amount object
  
  The amount of the income.
- amount_type string
  
  The type of the amount.
- start_date string
  
  The start date of the income.
- end_date string
  
  The end date of the income.
- frequency string
  
  The frequency of the income.
- is_taxable boolean
  
  Denotes if the income is taxable or not.
- shared_owner_type string
  
  Denotes if the employment is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients).
- shared_owner object
  
  The owner of the employment. Only provided if the shared_owner_type is "individual".
- employment object
  
  Employment of this income.
- account object
  
  Account that owns this income.

POST /api/v1/client/{client_uuid}/income

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/client/client_uuid/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 '{"name":"My Salary","type":"salary","amount":5000000,"amount_type":"net","start_date":"2024-04-02","end_date":"2025-04-02","frequency":"annually","is_taxable":true,"shared_owner_uuid":"e8ec7aa5-0d31-4f98-b85b-30e290ebc0c7","employment_uuid":"c4744556-8098-4309-9097-1959dc420328"}'

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": "2024-04-02",
  "end_date": "2025-04-02",
  "frequency": "annually",
  "is_taxable": true,
  "shared_owner_uuid": "e8ec7aa5-0d31-4f98-b85b-30e290ebc0c7",
  "employment_uuid": "c4744556-8098-4309-9097-1959dc420328"
}

Response examples (201)

{
  "name": "My Salary",
  "type": "salary",
  "uuid": "9e7aedd6-a960-4094-9a6f-0752adb1443d",
  "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": "7af47d00-faf8-4485-8c6a-22e72f07aa94",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-02T13:27:55+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:55+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "end_date": "2025-04-02",
  "frequency": "annually",
  "created_at": "2025-04-02T13:27:55+01:00",
  "employment": {
    "uuid": "767f3742-416c-4a6d-ae10-06b3cea08c9a",
    "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-04-02T13:27:55+01:00",
    "directors": "Susan F. Lancaster",
    "job_title": "Senior financial adviser",
    "created_at": "2025-04-02T13:27:55+01:00",
    "occupation": "Financial Adviser",
    "started_at": "2020-04-02T13:27:55+01:00",
    "updated_at": "2025-04-02T13:27:55+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-02",
  "updated_at": "2025-04-02T13:27:55+01:00",
  "amount_type": "net",
  "shared_owner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "8b1ba093-d91e-4032-97c3-5268c27fe033",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-02T13:27:55+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:55+01:00",
    "with_login": true,
    "inactive_at": "2025-04-02",
    "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-04-02T13:27:55+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-02T13:27:55+01: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-04-02T13:27:55+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-02T13:27:55+01:00"
  },
  "shared_owner_type": "individual"
}