Get all incomes

GET /api/v2/income

Headers

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 frequenciess.
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]
  
  Additional properties are allowed.

GET /api/v2/income

curl \
 -X GET https://api.plannrcrm.com/api/v2/income \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "My Salary",
      "type": "salary",
      "uuid": "e5ee9669-7e57-48f0-82a6-3431f8aaa61d",
      "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": "2b347de3-9343-4856-98ba-6df80691bb02",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-01-17T11:18:33+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:33+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "end_date": "2025-01-17",
      "frequency": "annually",
      "created_at": "2025-01-17T11:18:33+00:00",
      "employment": {
        "uuid": "e90bbd53-b150-48dc-b171-7a62d88c8def",
        "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",
        "employer": "Plannr Technologies Ltd",
        "ended_at": "2021-01-17T11:18:33+00:00",
        "directors": "Susan F. Lancaster",
        "job_title": "Senior financial adviser",
        "created_at": "2025-01-17T11:18:33+00:00",
        "occupation": "Financial Adviser",
        "started_at": "2020-01-17T11:18:33+00:00",
        "updated_at": "2025-01-17T11:18:33+00: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-01-17",
      "updated_at": "2025-01-17T11:18:33+00:00",
      "amount_type": "net"
    }
  ]
}