CAcaresquare

Get Budget and Bookings Combined (POST)

Retrieve combined budget and bookings information for a participant using POST request body. For pace plans, bookings are excluded as per business rules.

post/api/v1/participant_info/budget-bookings

Request

  • Base URL
    https://api.caresquare.com.au (the document declares no server; this is the origin it was published from)
  • URL
    https://api.caresquare.com.au/api/v1/participant_info/budget-bookings
  • Auth
    none declared

Request body

participant_idstring required

Participant ID

Example request

{
  "participant_id": "participant_123"
}

Response

Successful Response

budgetobject[] required

Budget data with integrated bookings information

plan_informationobject required

Plan information including dates and usage

bookingsobject[] required

Service bookings data (empty for pace plans)

total_bookingsinteger required

Total number of bookings

is_pace_planboolean required

Whether this is a pace plan

messagestring nullable

Additional information about the response

Changes

No recorded changes to this operation across all 19 revisions of this API.