Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[account_uuids] string

  Filter by a comma separated list of account UUIDs.

• filter[circle_uuids] string

  Filter by a comma separated list of circle UUIDs.

• filter[employment_uuids] string

  Filter by a comma separated list of employment UUIDs that are linked to incomes.

• filter[type] string

  Filter by comma separate list of income types. Possible values are [salary, dividend, bonus, benefit, other, investment, rental, pension].

• filter[frequency] string

  Filter by comma separate list of frequencies.

• filter[amount_type] string

  Filter by comma separate list of amount types. Possible values are [net,gross].

• filter[start_date] string

  Filter income by start date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

• filter[end_date] string

  Filter income by end date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

• filter[amount] string

  Filter income by amount in pennies. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [account, employment].

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, name, amount, start_date, end_date]. Negative sign to denote DESC. Defaults to 'created_at'.

• per_page integer

  Number of results to return with pagination (Default 15. Max 500).

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • data array[object]
    Hide data attributes Show data 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 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