Create or Update an Expenditure

POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}

This endpoint creates an individual expenditure for a client.

Headers

Authorization string
Content-Type string
Accept string

Path parameters

client_uuid string Required

The uuid of the client.
lifeStage_uuid string Required

The uuid of the parent Life Stage.
lifeStageField_uuid string Required

The uuid of the parent Life Stage Field.

application/json

Body Required

amount integer Required

The amount of the expenditure in pennies.

Responses

200 application/json
Hide response attributes Show response 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.
  
  Additional properties are allowed.
- 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

POST /api/v1/client/{client_uuid}/expenditure/{lifeStage_uuid}/{lifeStageField_uuid}

curl \
 -X POST https://api.plannrcrm.com/api/v1/client/f6aa1670-dcf0-484e-a0c5-08590fe89a84/expenditure/dcf0-484e-a0c5-08590fe89a84-f6aa1670/dcf0-484e-a0c5-08590fe89a84-f6aa1670 \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"amount":50000}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "amount": 50000
}

Response examples (200)

{
  "name": "Electricity",
  "uuid": "0339e33d-0515-4e35-b6ef-1b7af228fe93",
  "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": "4238b34e-7dd9-4048-b745-21e40d095b53",
  "life_stage_field_uuid": "17adc64f-a709-4588-a5de-c5a3f255f154",
  "life_stage_section_uuid": "6183511b-dc40-4478-b75d-a5ce7142499a"
}