GET /api/v1/client/{client_uuid}/expenditure
Personal access token & O auth2

Response includes all expenditures for a client along with their calculated income and disposal income

Path parameters

  • client_uuid string Required

    The uuid of the client.

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string

        UUID of the Expenditure

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

      • section string

        The Life Stage Section of the Expenditure.

      • amount object

        The amount of the Expenditure.

        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
      • position string

        The position/order of the Expenditure in any listing.

      • life_stage_uuid string

        UUID of the Life Stage

      • life_stage_section_uuid string

        UUID of the parent Life Stage Section

      • life_stage_field_uuid string

        UUID of the parent Life Stage Field
GET /api/v1/client/{client_uuid}/expenditure 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/f6aa1670-dcf0-484e-a0c5-08590fe89a84/expenditure' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "name": "Electricity",
      "uuid": "369597e5-e955-4ec1-9838-8807da4f5545",
      "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"
        }
      },
      "section": "Housekeeping Expenses",
      "position": "1",
      "created_at": "2025-12-10T18:17:05+00:00",
      "updated_at": "2025-12-10T18:17:05+00:00",
      "life_stage_uuid": "19b5ec9f-f858-414e-b057-a19acb5f9758",
      "life_stage_field_uuid": "212199be-c855-425e-9424-d5940868cda4",
      "life_stage_section_uuid": "7442ebd1-9224-4aa3-9128-7b2b124fcf9c"
    }
  ]
}