Budget APIs

Here is the documentation of quickclaim and NDIS budget APIs

APIs:

GET /paceBudget/{ndisNumber}
Get/budget
Post/budget (TBA)
Put/budget (TBA)
Delete/budget (TBA)

API base url and Authentication

Add this base you url at beginning of all the endpoints. The base url is:

https://api.quickclaim.io/public/

All APIs have the same authentication method which is a pair of org-id and x-api-key in the header of the call.

org-id: YOUR_ORGANIZATION_ID
x-api-key: YOUR_X-API-KEY

Please note that your credentials are global and the same across all the products. You can access your credentials from the quickclaim app under the integration page.

https://app.quickclaim.io/app/integration

GET /paceBudget/{ndisNumber}

This API retrieves a participant’s PACE budget directly from the NDIS. It only returns data for participants with a PACE plan. Please note that prior to calling this API you must add a Participant to the quickclaim database first, using POST /participant API. After a participant is added you can always call this API using the ndisNumber.

var options = { 
   method: "GET", 
   url: "https://api.quickclaim.io/public/paceBudget/{NDIS_NUMBER}", 
   headers: 
     {
        org-id: YOUR_ORGANIZATION_ID, 
        x-api-key: "YOUR_X-API-KEY" 
     }
};

Response example:

200 - {
    "version": "3.0.1",
    "data": [
        {
            "budgetId": 337,
            "orgId": 19,
            "type": "PACE",
            "participantId": 1,
            "startDate": "2023-06-27",
            "endDate": "2026-06-27",
            "management": "Plan-managed",
            "support": "Core",
            "categoryCode": "01",
            "paceCategoryCode": "01C",
            "supportCategoryApi": "DAILY_ACTIVITIES",
            "supportCategoryPace": "Home and Living",
            "supportCategoryShortNamePace": "01C-Home and living",
            "supportCategory": "Home and Living",
            "spentAmount": 0,
            "allocatedAmount": 0,
            "remainingAmount": 78000,
            "approvedAmount": 78000,
            "quoteableItem": 0,
            "inKind": 0,
            "quoteApproved": 0,
            "daysLeft": 1058,
            "budgetRefreshDate": 0,
            "isDeleted": 0,
            "participantName": "Ross Geller",
            "ndisNumber": "430000001"
        }
    ]
}

GET /budget

This API retrieves all budgets from the quickclaim database ("PACE" and "MANUAL").

With quickclaim, you can add and maintain your internal budget as a MANUAL budget.

Note: PACE budgets can be up to 48 hours behind. If you need a live budget use GET /paceBudget/{ndisNumber} API.

Query parameters:

You can filter the response data using query parameters filter. The below parameters are available in this API:

participantId
participantName
ndisNumber
startDate
endDate
category
type: ("PACE" OR "MANUAL")

API call example:

var options = { 
   method: "GET", 
   url: "https://api.quickclaim.io/public/budget", 
   headers: 
     {
        org-id: YOUR_ORGANIZATION_ID, 
        x-api-key: "YOUR_X-API-KEY" 
     }
};

Response example:

200 - {
    "version": "3.0.1",
    "data": [
        {
            "budgetId": 335,
            "orgId": 19,
            "type": "MANUAL",
            "participantId": 82,
            "startDate": "2023-01-01",
            "endDate": "2024-12-01",
            "management": "Self-managed",
            "support": "Core",
            "categoryCode": "01",
            "paceCategoryCode": "01D",
            "supportCategoryApi": "DAILY_ACTIVITIES",
            "supportCategoryPace": "Specialised Disability Accommodation (SDA)",
            "supportCategoryShortNamePace": "01D-SDA",
            "supportCategory": "Specialised Disability Accommodation (SDA)",
            "spentAmount": 0,
            "allocatedAmount": 0,
            "remainingAmount": null,
            "approvedAmount": 20000,
            "quoteableItem": null,
            "inKind": null,
            "quoteApproved": null,
            "daysLeft": 485,
            "budgetRefreshDate": 0,
            "isDeleted": 0,
            "participantName": "Monica Geller",
            "ndisNumber": "430000002"
        }
    ]
}

API call example with query parameters:

var options = { 
   method: "GET", 
   url: "https://api.quickclaim.io/public/budget&participantId=82&startDate=2023-01-01", 
   headers: 
     {
        org-id: YOUR_ORGANIZATION_ID, 
        x-api-key: "YOUR_X-API-KEY" 
     }
};