Create an income

POST /api/v2/income

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

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, pension, capital_gains, business_loan, investor_funding, grant, charity, crowdfunding, gross_profit, operating_profit, operating_revenue, non_operating_revenue and net_profit.

  • type_other string

    The type of income when the type is set to "other".

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

    • type_other string

      The other type of income, if the type is "other".

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

    • employment object

      Employment of this income.

      Hide employment attributes Show employment attributes object
      • uuid string
      • created_at string
      • updated_at string
      • status string
      • primary boolean
      • 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
      • turnover_history string
      • income string
      • account 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
POST /api/v2/income
curl \
 --request POST 'https://api.plannrcrm.com/api/v2/income' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuid":"ac3bc94e-2520-49d9-a441-de00149501ea","name":"My Salary","type":"salary","type_other":"My Other Income","amount":5000000,"amount_type":"net","start_date":"2024-08-07","end_date":"2025-08-07","frequency":"annually","is_taxable":true,"shared_owner_uuid":"fcd127ef-0679-47de-9b6e-0fb3649211a5","employment_uuid":"99e7f61f-a01c-42c8-917b-5d83cf03073d"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuid": "ac3bc94e-2520-49d9-a441-de00149501ea",
  "name": "My Salary",
  "type": "salary",
  "type_other": "My Other Income",
  "amount": 5000000,
  "amount_type": "net",
  "start_date": "2024-08-07",
  "end_date": "2025-08-07",
  "frequency": "annually",
  "is_taxable": true,
  "shared_owner_uuid": "fcd127ef-0679-47de-9b6e-0fb3649211a5",
  "employment_uuid": "99e7f61f-a01c-42c8-917b-5d83cf03073d"
}
Response examples (201)
{
  "name": "My Salary",
  "type": "salary",
  "uuid": "72ba9bf6-00c3-4f3f-bf61-8f7ef8b99012",
  "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": "52d54ef7-615e-47c5-b535-1dc236a050ed",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-08-07T13:41:47+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-08-07T13:41:47+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "end_date": "2025-08-07",
  "frequency": "annually",
  "created_at": "2025-08-07T13:41:47+01:00",
  "employment": {
    "uuid": "5dff0d19-3911-45be-bf93-16c5fae29b3c",
    "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-08-07T13:41:47+01:00",
    "directors": "Susan F. Lancaster",
    "job_title": "Senior financial adviser",
    "created_at": "2025-08-07T13:41:47+01:00",
    "occupation": "Financial Adviser",
    "started_at": "2020-08-07T13:41:47+01:00",
    "updated_at": "2025-08-07T13:41:47+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-08-07",
  "type_other": "Other income type",
  "updated_at": "2025-08-07T13:41:47+01:00",
  "amount_type": "net"
}