Get all expenditures including totals for a client

GET /api/v1/client/{client_uuid}/expenditure

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": "fdcf7732-946e-420f-917b-54472155e3bb",
      "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-06-26T11:37:04+01:00",
      "updated_at": "2025-06-26T11:37:04+01:00",
      "life_stage_uuid": "eb7ab9a9-ba01-4452-ad0a-bdf7be59b6d0",
      "life_stage_field_uuid": "e5a37516-0dc7-4266-b42f-c12ee0e8e2b1",
      "life_stage_section_uuid": "c694bf3e-36e2-4c9e-b9ec-65e89c2ee448"
    }
  ]
}