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

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 \
 -X GET https://api.plannrcrm.com/api/v1/client/f6aa1670-dcf0-484e-a0c5-08590fe89a84/expenditure \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200)
{
  "data": [
    {
      "name": "Electricity",
      "uuid": "02bcde05-0b1b-4d67-a425-dea4e08bf27a",
      "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": "2024-11-20T13:24:00+00:00",
      "updated_at": "2024-11-20T13:24:00+00:00",
      "life_stage_uuid": "a56746f3-36a7-4a77-87bb-fc3b1a407528",
      "life_stage_field_uuid": "0d25667d-172a-4f44-9f08-98a8a23d59c1",
      "life_stage_section_uuid": "e95e5e9c-5fc8-4e40-a1ac-1f19cf3fcaf8"
    }
  ]
}