Get all expenditures including totals for a client Run in API Explorer

View as markdown
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
      • created_at string
      • updated_at string
      • name string
      • section string
      • amount object
        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
      • life_stage_uuid string
      • life_stage_section_uuid string
      • life_stage_field_uuid string
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": "77f96e2a-bd46-4b82-acf5-6ba228d21d73",
      "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-11-19T13:56:57+00:00",
      "updated_at": "2025-11-19T13:56:57+00:00",
      "life_stage_uuid": "c4ca6a63-10c7-4dc7-a2a9-62edec012dcf",
      "life_stage_field_uuid": "8241550f-2d55-4e40-9b2a-33aa525f0764",
      "life_stage_section_uuid": "b353e70b-29d9-4e87-b1cc-e7022909fa5f"
    }
  ]
}