Get all expenditures including totals for a client

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

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

Path parameters

Query parameters

Responses

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

      Additional properties are allowed.
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 {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "name": "Electricity",
      "uuid": "40cfaa58-bc07-4147-9a6d-77e359575fa7",
      "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-02-20T10:13:01+00:00",
      "updated_at": "2025-02-20T10:13:01+00:00",
      "life_stage_uuid": "3c6bf55a-89a1-4eff-9104-6cd28192d6f8",
      "life_stage_field_uuid": "623d4ec3-64ce-4898-86b2-16ed27f88653",
      "life_stage_section_uuid": "f1e65ec7-756c-435f-89a0-6c7ea9e9aa98"
    }
  ]
}