Path parameters

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.

  • 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.

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

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

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
PUT /api/v2/income/{uuid}
curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/income/uuid' \
 --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-22","end_date":"2025-04-22","frequency":"annually","is_taxable":true,"shared_owner_uuid":"d7a4f4ca-97de-4dbf-bda1-e25b50e07984","employment_uuid":"b578c1c1-56a1-486b-9231-0230a7f8c317"}'
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-22",
  "end_date": "2025-04-22",
  "frequency": "annually",
  "is_taxable": true,
  "shared_owner_uuid": "d7a4f4ca-97de-4dbf-bda1-e25b50e07984",
  "employment_uuid": "b578c1c1-56a1-486b-9231-0230a7f8c317"
}
Response examples (200)
{
  "name": "My Salary",
  "type": "salary",
  "uuid": "64e9e38e-f01d-4eb0-91e7-9d4b83c2b737",
  "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": "d246fc3f-0659-4ffc-9c4b-ab03104294b1",
    "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": "8601b450-1f6f-426c-93bc-197b03b3a0e6",
    "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"
}