List NDIS Plan Budgets

get/public/v1/ndis-plans/{plan}/budgets

Amounts are integer cents. A budget with no support category is flexible funding and returns support_category as null.

get/public/v1/ndis-plans/{plan}/budgets

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/ndis-plans/{plan}/budgets' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "amount": 1500000,
      "management_type": "ndia",
      "stated": false,
      "description": "Support Coordination",
      "support_category": {
        "name": "Support Coordination",
        "prefix": "07",
        "group": "Capacity"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

planstringrequired
The plan UUID

Query parameters

page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of PlanBudgetResource

dataobject[]required
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
- amountintegerrequired
  Example:1500000
- management_typeenum<string>required
  Available options:planselfndiaunknown
- statedbooleanrequired
  Example:false
- descriptionstring | nullrequired
  Example:Support Coordination
- support_categoryobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  namestringrequired
  Example:Support Coordination
  prefixstringrequired
  Example:07
  groupstringrequired
  Example:Capacity
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Query parameters

Response

Errors