Budget APIs

quickclaim provides Public and Native APIs for retrieving participant budget information.

The correct option depends on:

• Your quickclaim version
• Whether the participant has a PACE or non-PACE plan
• Whether you need stored or live NDIS data
• Whether you want a simplified or NDIA-defined response structure

Compare budget options

Budget option	Availability	Data source	Purpose
Public GET /budget	quickclaim v1	Stored quickclaim data	Retrieve stored PACE and manual budgets
Public GET /paceBudget/{ndisNumber}	quickclaim v1	Live NDIS request	Retrieve the participant’s current PACE budget
Native PACE Budget 5.0	quickclaim v1 and v2	Live NDIS request	Retrieve a PACE budget using the NDIA-defined structure
Native PACE Historical 4.0	quickclaim v1 and v2	Live NDIS request	Retrieve applicable historical PACE budget information
Native Budget 4.0	quickclaim v1 and v2	Live NDIS request	Retrieve a non-PACE budget

Public stored budgets

Use the following Public endpoint to retrieve budgets stored in quickclaim:

GET /budget

This endpoint can return:

• PACE budgets maintained in quickclaim
• MANUAL budgets created and maintained in quickclaim

Because the data is stored in quickclaim, its freshness depends on the applicable background refresh schedule.

Use this endpoint when:

• Your organisation uses quickclaim v1.
• You need to retrieve stored budget information.
• You do not require a new live NDIS response.
• You need access to manual budgets maintained in quickclaim.

For filters, response fields and examples, see the quickclaim Public API documentation.

Public live PACE budget

Use the following Public endpoint to retrieve a participant’s PACE budget through a live NDIS request:

GET /paceBudget/{ndisNumber}

This endpoint:

• Is available to quickclaim v1 organisations only
• Supports participants with PACE plans
• Uses PACE Budget version 5.0 internally
• Returns a simplified quickclaim response structure

The participant must already exist in quickclaim before this endpoint is called.

Use this endpoint when you need current PACE budget information but prefer the simplified Public API structure.

For the complete request and response definition, see the quickclaim Public API documentation.

Native PACE Budget

Use PACE Budget 5.0 when you need to retrieve a PACE budget using the Native NDIS API structure.

Native PACE Budget:

• Is available to quickclaim v1 and v2 organisations
• Sends the request directly to the live NDIS
• Uses the NDIA-defined request and response structure
• Requires Native API production access and permissions

Download the PACE Budget 5.0 YAML specification

PACE Budget requests must use version 5.0.

Native PACE Historical

Use PACE Historical 4.0 when you need historical PACE budget information supported by this API.

Download the PACE Historical 4.0 YAML specification

Review the specification to confirm the required participant details, headers and supported response data.

Native non-PACE Budget

Use Budget 4.0 for participants with non-PACE plans.

Download the non-PACE Budget 4.0 YAML specification

Do not use the non-PACE Budget API for a participant with a PACE plan.

If you need to determine the participant’s plan type, use the applicable Participant Plan Type API.

Download the Participant Plan Type 4.0 YAML specification

Testing and authentication

Public Budget APIs can be tested using the quickclaim stage environment and stage credentials.

Native Budget APIs operate against the live NDIS environment only. The NDIS does not provide a Native API sandbox.

Native v1 and v2 use different base URLs and authentication methods. Review Native API Reference before making a Native Budget request.

Before requesting a live budget

Confirm that:

1. You have selected the correct PACE or non-PACE API.
2. You are using the required API version.
3. The participant details are correct.
4. Your organisation has authority to access the participant.
5. All required headers and request fields are included.
6. Your application can handle rate limits and NDIS error responses.

Review Errors and Limits for rate-limit and retry guidance.

Contact support@quickclaim.io if you need help selecting the correct Budget API or confirming participant access requirements.