Update an income

PUT /api/v1/client/{client_uuid}/income/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

client_uuid string Required
uuid string Required

application/json

Body

name string

The name of the income.
type string

The type of income. Possible values: salary, dividend, bonus, benefit, other, investment, rental and pension.
amount integer

The amount of the income in pennies. For example, £50,000 would be 5000000.
amount_type string

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

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

200 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.
  
  Hide amount attributes Show amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
- 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".
  
  Hide shared_owner attributes Show shared_owner attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- employment object
  
  Employment of this income.
  
  Hide employment attributes Show employment attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  status string
  
  occupation string
  
  occupation_code string
  
  job_title string
  
  employer string
  
  started_at string
  
  ended_at string
  
  is_business_owner boolean
  
  percentage_of_business_shared integer
  
  address string
  
  phone_number string
  
  email_address string
  
  shared_owner_type string
  
  shared_owner string
  
  last_salary_increase object
  
  Hide last_salary_increase attributes Show last_salary_increase attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  business_name string
  
  business_year_end string
  
  business_value object
  
  Hide business_value attributes Show business_value attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  directors string
  
  shareholding_in_business object
  
  Hide shareholding_in_business attributes Show shareholding_in_business attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  profit object
  
  Hide profit attributes Show profit attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  accountant_company_name string
  
  accountant_email string
  
  accountant_telephone_number string
  
  accountant_address string
  
  primary boolean
  
  turnover_history string
  
  income string
- account object
  
  Account that owns this income.
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string

PUT /api/v1/client/{client_uuid}/income/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/income/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: 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-06-26","end_date":"2025-06-26","frequency":"annually","is_taxable":true,"shared_owner_uuid":"b06e7b7f-62b9-47b3-a38b-c6acc7440ad7","employment_uuid":"073f209f-02c3-42ac-b424-0e7bba302af7"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "My Salary",
  "type": "salary",
  "amount": 5000000,
  "amount_type": "net",
  "start_date": "2024-06-26",
  "end_date": "2025-06-26",
  "frequency": "annually",
  "is_taxable": true,
  "shared_owner_uuid": "b06e7b7f-62b9-47b3-a38b-c6acc7440ad7",
  "employment_uuid": "073f209f-02c3-42ac-b424-0e7bba302af7"
}

Response examples (200)

{
  "name": "My Salary",
  "type": "salary",
  "uuid": "f39faf14-204f-4845-992d-b80941a01d13",
  "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": "793c68fd-8e1e-4a86-9506-79c65c8d383f",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-06-26T11:37:04+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:04+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "end_date": "2025-06-26",
  "frequency": "annually",
  "created_at": "2025-06-26T11:37:04+01:00",
  "employment": {
    "uuid": "d1c5cc64-0b77-4d71-b8b6-ff4bfbe5b7d1",
    "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-06-26T11:37:04+01:00",
    "directors": "Susan F. Lancaster",
    "job_title": "Senior financial adviser",
    "created_at": "2025-06-26T11:37:04+01:00",
    "occupation": "Financial Adviser",
    "started_at": "2020-06-26T11:37:04+01:00",
    "updated_at": "2025-06-26T11:37:04+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-06-26",
  "updated_at": "2025-06-26T11:37:04+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": "381f152e-3292-447c-9691-9e5456a647f5",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-26T11:37:04+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:04+01:00",
    "with_login": true,
    "inactive_at": "2025-06-26",
    "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-06-26T11:37:04+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-26T11:37:04+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-06-26T11:37:04+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-26T11:37:04+01:00"
  },
  "shared_owner_type": "individual"
}