This document is designed for software developers who want to use quickclaim APIs within their apps. API definitions and examples are described in this document.
Introduction
This document describes the quickclaim commonly used API. Audience of this document is software developers. We have prepared a sandbox with mock data so you can start testing the APIs and get a better understanding of their functionalities.
You can access quickclaim's complete API documentation on our gitHub site at: https://github.com/quickclaim-io/public-api
NDIS objects
Before diving into the APIs it's important you understand the main objects and their role in the NDIS payment scheme. Below is a high level definition of these objects:
Organisation: This is your main account that holds all of your data and configurations. In quickclaim, organisations are separated and do not share any data or processes. This is how we ensure our customers are getting a safe environment without having any overlap with other customers. This architecture is fundamental to our security controls and design under ISO 27001.
If you are a channel partner you can create organisation for each of your customers to maintain the highest level of security.
In this sandbox we have provided you with an Organisation called sandbox. This organisation is connected to the NDIS Mock Data. From time to time we may reset the data in this organisation.
NOTE: Please ensure no actual customer data data is added into this environment.
APIs
NDIS commonly used APIs
- GET /plan / {ndisNumber}
- GET /participant
- POST /participant
- GET /serviceBooking
- GET /serviceBookingLive/ {ndisNumber}
- POST /serviceBooking
- POST /claim (bulkClaim)
- GET /claim (batch)
- GET /claim/{PRN}
Here is a Postman collection with the commonly used APIs. **link**
API base url and Authentication
Add this base you url at beginning of all the endpoints. The base url for the sandbox is:
https://stage-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. Credentials for the sandbox are:
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.
Add the org-id and x-api-key to the headers of your calls.
GET /plan/{ndisNumber}
This endpoint gets the Participant plans from NDIS.
var options = {
method: "GET",
url: "https://stage-api.quickclaim.io/public/plan/430000015",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
}
};
Response is like:
200 - {
"version": "3.0.1",
"data": {
"participant":
{
"ndisNumber": "430000020",
"participantName": "Howard Germany"
},
"plans": [
{
"planNumber": 1080277,
"startDate": "2017-03-26",
"endDate": "2022-03-26"
},
{
"planNumber": 1080255,
"startDate": "2022-03-26",
"endDate": "2024-03-26"
}
]
}
}
GET /participant
This endpoint returns list of Participants from quickclaim database. You can query the Participant list by using the optional filters as a path parameter. The available filters are:
- ndisNumber
- clientNumber
- participantName
To have more than one filter use "&" to concatenate your second filter in the url.
Sample call to get list of all participants:
var options = {
method: "GET",
url: "https://stage-api.quickclaim.io/public/participant",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
}
};
Sample call to get a list of participant with multiple filters:
var options = {
method: "GET",
url: "https://stage-api.quickclaim.io/public/participant?ndisNumber=43000&participantName=Ross",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
}
};
Sample response is like:
{
"version": "3.0.1",
"data": [
{
"participantId": 17270,
"orgId": 11234,
"firstName": "Phoebe",
"lastName": "Buffay",
"clientNumber": "5393392",
"ndisNumber": "430000015",
"createDate": "2022-01-04T04:54:21.000Z",
"modifyDate": "2022-01-26T05:52:32.000Z",
"isDeleted": 0,
"defaultLocationName": "Dionysius",
"defaultLocationId": 21,
"regoId": 28,
"ndisRego": 4050000001,
"isValidated": 1,
"financialContactId": null,
"financialContactCompany": null,
"isActive": 1
},
{
"participantId": 17271,
"orgId": 11234,
"firstName": "Albert",
"lastName": "Einstein",
"clientNumber": "1592154",
"ndisNumber": "430000016",
"createDate": "2022-01-04T04:54:21.000Z",
"modifyDate": "2022-01-26T05:52:32.000Z",
"isDeleted": 0,
"defaultLocationName": "Dionysius",
"defaultLocationId": 21,
"regoId": 28,
"ndisRego": 4050000001,
"isValidated": 0,
"financialContactId": null,
"financialContactCompany": null,
"isActive": 1
},
{
"participantId": 17272,
"orgId": 11234,
"firstName": "Michael",
"lastName": "Jordan",
"clientNumber": "345508",
"ndisNumber": "430000017",
"createDate": "2022-01-04T04:54:21.000Z",
"modifyDate": "2022-01-26T05:52:32.000Z",
"isDeleted": 0,
"defaultLocationName": "Dionysius",
"defaultLocationId": 21,
"regoId": 28,
"ndisRego": 4050000001,
"isValidated": 0,
"financialContactId": null,
"financialContactCompany": null,
"isActive": 1
},
{
"participantId": 17273,
"orgId": 11234,
"firstName": "Barack",
"lastName": "Obama",
"clientNumber": "2191675",
"ndisNumber": "430000018",
"createDate": "2022-01-04T04:54:21.000Z",
"modifyDate": "2022-01-26T05:52:32.000Z",
"isDeleted": 0,
"defaultLocationName": "Dionysius",
"defaultLocationId": 21,
"regoId": 28,
"ndisRego": 4050000001,
"isValidated": 0,
"financialContactId": null,
"financialContactCompany": null,
"isActive": 1
},
{
"participantId": 17274,
"orgId": 11234,
"firstName": "Beyonce",
"lastName": "Knowles",
"clientNumber": "2900358",
"ndisNumber": "430000019",
"createDate": "2022-01-04T04:54:21.000Z",
"modifyDate": "2022-01-26T05:52:32.000Z",
"isDeleted": 0,
"defaultLocationName": "Dionysius",
"defaultLocationId": 21,
"regoId": 28,
"ndisRego": 4050000001,
"isValidated": 0,
"financialContactId": null,
"financialContactCompany": null,
"isActive": 1
},
{
"participantId": 1,
"orgId": 11234,
"firstName": "Alfie",
"lastName": "R. Far",
"clientNumber": "007007",
"ndisNumber": "430000987",
"createDate": "2023-08-04T05:46:56.000Z",
"modifyDate": "2023-08-04T05:46:56.000Z",
"isDeleted": 0,
"defaultLocationName": null,
"defaultLocationId": null,
"regoId": 28,
"ndisRego": 4050000001,
"isValidated": 0,
"financialContactId": null,
"financialContactCompany": null,
"isActive": 1
},
{
"participantId": 17275,
"orgId": 11234,
"firstName": "Howadrd",
"lastName": "Germany",
"clientNumber": "123456",
"ndisNumber": "430000020",
"createDate": "2023-08-04T00:21:04.000Z",
"modifyDate": "2023-08-04T00:22:54.000Z",
"isDeleted": 0,
"defaultLocationName": null,
"defaultLocationId": null,
"regoId": 28,
"ndisRego": 4050000001,
"isValidated": 1,
"financialContactId": null,
"financialContactCompany": null,
"isActive": 1
}
]
}
POST /participant
This endpoint insert or update a Participant to the quickclaim database. ndisNumber is ID of the participant, if this ID exist in the database the record gets updated. Otherwise the record is added to the database.
var options = {
method: "POST",
url: "https://stage-api.quickclaim.io/public/participant",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
},
body:
{
"ndisNumber": "430000020",
"firstName": "Howard", //optional
"lastName": "Germany", //optional but for getting plan info you need it.
"dob": "1967-05-12", //optional but for getting plan info you need it.
"clientNumber": "1323456" //optional
}
};
On insert the successful response is like:
200 - {
"version": "3.0.1",
"data":
{
"participantId": 454
},
"message": "Participant has been added successfully to the database."
}
On update the successful response is like:
200 - {
"version": "3.0.1",
"message": "The participant has been updated successfully."
}
GET /serviceBooking
This endpoint returns service bookings from quickclaim database. You can get older service bookings by setting showOld parameter.
Sample call to get a list of service bookings:
var options = {
method: "GET",
url: "https://stage-api.quickclaim.io/public/serviceBooking?showOld=1",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
}
};
Query parameters:
You can filter the response data using query parameters filter. The below parameters are available in this API:
participantName
ndisNumber
supportItem
supportCategory
sbFrom (Example: https://stage-api.quickclaim.io/public/serviceBooking?showOld=1&sbFrom=2021-08-10)
sbTo (Example: https://stage-api.quickclaim.io/public/serviceBooking?showOld=1&sbTo=2021-08-10)
planNumber
Sample response is like:
{
version: "3.0.1",
data: [
{
"sbHeaderId": "SBH-2739779",
"serviceBookingId": 3198161,
"serviceBookingNumber": 50021652,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17271,
"participantName": "Albert Einstein",
"ndisNumber": "430000020",
"clientNumber": "1592154",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"status": "Approved",
"startDate": "2021-03-26",
"endDate": "2021-03-31",
"note": "",
"supportCategoryApi": "DAILY_ACTIVITIES",
"supportCategory": "01-Assistance with daily life",
"supportItem": "",
"supportItemName": "",
"unit": 1,
"rate": 174.08,
"amount": 174.08,
"remaining": 174.08,
"isUsed": 0,
"daysLeft": -856,
"isOld": 1,
"createDate": "2022-11-03T00:10:02.000Z",
"createBy": null,
"modifyDate": "2022-11-06T10:05:39.000Z",
"modifyBy": "auth0|634e75dbd1e1fd7e8a7f3224",
"ndisRefreshDate": "2022-11-06T10:05:39.000Z",
"isDeleted": 0,
"isCancelled": 0,
"refresh": "268 d"
},
{
"sbHeaderId": "SBH-2739776",
"serviceBookingId": 3198160,
"serviceBookingNumber": 50021100,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17271,
"participantName": "Albert Einstein",
"ndisNumber": "430000020",
"clientNumber": "1592154",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"status": "Approved",
"startDate": "2021-03-01",
"endDate": "2021-03-07",
"note": "",
"supportCategoryApi": "SOCIAL_COMMUNITY_CIVIC",
"supportCategory": "04-Assistance with social and community participation",
"supportItem": "",
"supportItemName": "",
"unit": 1,
"rate": 56,
"amount": 56,
"remaining": 56,
"isUsed": 0,
"daysLeft": -880,
"isOld": 1,
"createDate": "2022-11-03T00:10:01.000Z",
"createBy": null,
"modifyDate": "2022-11-06T10:05:39.000Z",
"modifyBy": "auth0|634e75dbd1e1fd7e8a7f3224",
"ndisRefreshDate": "2022-11-06T10:05:39.000Z",
"isDeleted": 0,
"isCancelled": 0,
"refresh": "268 d"
},
{
"sbHeaderId": "SBH-2739775",
"serviceBookingId": 3198159,
"serviceBookingNumber": 50021096,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17273,
"participantName": "Barack Obama",
"ndisNumber": "430000020",
"clientNumber": "2191675",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"status": "Approved",
"startDate": "2021-10-16",
"endDate": "2021-10-23",
"note": "",
"supportCategoryApi": "SOCIAL_COMMUNITY_CIVIC",
"supportCategory": "04-Assistance with social and community participation",
"supportItem": "",
"supportItemName": "",
"unit": 1,
"rate": 56,
"amount": 56,
"remaining": 56,
"isUsed": 0,
"daysLeft": -650,
"isOld": 1,
"createDate": "2022-11-03T00:10:01.000Z",
"createBy": null,
"modifyDate": "2022-11-06T10:05:39.000Z",
"modifyBy": "auth0|634e75dbd1e1fd7e8a7f3224",
"ndisRefreshDate": "2022-11-06T10:05:39.000Z",
"isDeleted": 0,
"isCancelled": 0,
"refresh": "268 d"
},
{
"sbHeaderId": "SBH-2739771",
"serviceBookingId": 3198158,
"serviceBookingNumber": 50021091,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17273,
"participantName": "Barack Obama",
"ndisNumber": "430000020",
"clientNumber": "2191675",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"status": "Approved",
"startDate": "2021-11-01",
"endDate": "2021-11-05",
"note": "",
"supportCategoryApi": "SOCIAL_COMMUNITY_CIVIC",
"supportCategory": "04-Assistance with social and community participation",
"supportItem": "04_153_0104_6_1",
"supportItemName": "Group Activities In The Community - 1:5 - Complex - Saturday",
"unit": 8,
"rate": 7,
"amount": 56,
"remaining": 56,
"isUsed": 0,
"daysLeft": -637,
"isOld": 1,
"createDate": "2022-11-03T00:10:01.000Z",
"createBy": null,
"modifyDate": "2022-11-06T10:05:39.000Z",
"modifyBy": "auth0|634e75dbd1e1fd7e8a7f3224",
"ndisRefreshDate": "2022-11-06T10:05:39.000Z",
"isDeleted": 0,
"isCancelled": 0,
"refresh": "268 d"
},
{
"sbHeaderId": "SBH-2739770",
"serviceBookingId": 3198157,
"serviceBookingNumber": 50021069,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17273,
"participantName": "Barack Obama",
"ndisNumber": "430000020",
"clientNumber": "2191675",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"status": "Approved",
"startDate": "2021-11-01",
"endDate": "2021-11-05",
"note": "",
"supportCategoryApi": "SOCIAL_COMMUNITY_CIVIC",
"supportCategory": "04-Assistance with social and community participation",
"supportItem": "04_153_0104_6_1",
"supportItemName": "Group Activities In The Community - 1:5 - Complex - Saturday",
"unit": 8,
"rate": 7,
"amount": 56,
"remaining": 56,
"isUsed": 0,
"daysLeft": -637,
"isOld": 1,
"createDate": "2022-11-03T00:10:01.000Z",
"createBy": null,
"modifyDate": "2022-11-06T10:05:39.000Z",
"modifyBy": "auth0|634e75dbd1e1fd7e8a7f3224",
"ndisRefreshDate": "2022-11-06T10:05:39.000Z",
"isDeleted": 0,
"isCancelled": 0,
"refresh": "268 d"
},
{
"sbHeaderId": "SBH-2739769",
"serviceBookingId": 3198156,
"serviceBookingNumber": 50021005,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17273,
"participantName": "Barack Obama",
"ndisNumber": "430000020",
"clientNumber": "2191675",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"status": "Approved",
"startDate": "2021-09-21",
"endDate": "2021-10-01",
"note": "",
"supportCategoryApi": "SOCIAL_COMMUNITY_CIVIC",
"supportCategory": "04-Assistance with social and community participation",
"supportItem": "04_153_0104_6_1",
"supportItemName": "Group Activities In The Community - 1:5 - Complex - Saturday",
"unit": 10,
"rate": 9,
"amount": 90,
"remaining": 90,
"isUsed": 0,
"daysLeft": -672,
"isOld": 1,
"createDate": "2022-11-03T00:10:01.000Z",
"createBy": null,
"modifyDate": "2022-11-06T10:05:39.000Z",
"modifyBy": "auth0|634e75dbd1e1fd7e8a7f3224",
"ndisRefreshDate": "2022-11-06T10:05:39.000Z",
"isDeleted": 0,
"isCancelled": 0,
"refresh": "268 d"
},
{
"sbHeaderId": "SBH-2739767",
"serviceBookingId": 3198155,
"serviceBookingNumber": 50020992,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17273,
"participantName": "Barack Obama",
"ndisNumber": "430000020",
"clientNumber": "2191675",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"status": "Approved",
"startDate": "2021-07-16",
"endDate": "2021-08-20",
"note": "",
"supportCategoryApi": "SOCIAL_COMMUNITY_CIVIC",
"supportCategory": "04-Assistance with social and community participation",
"supportItem": "04_153_0104_6_1",
"supportItemName": "Group Activities In The Community - 1:5 - Complex - Saturday",
"unit": 4,
"rate": 5,
"amount": 20,
"remaining": 20,
"isUsed": 0,
"daysLeft": -714,
"isOld": 1,
"createDate": "2022-11-03T00:10:01.000Z",
"createBy": null,
"modifyDate": "2022-11-06T10:05:39.000Z",
"modifyBy": "auth0|634e75dbd1e1fd7e8a7f3224",
"ndisRefreshDate": "2022-11-06T10:05:39.000Z",
"isDeleted": 0,
"isCancelled": 0,
"refresh": "268 d"
} ],
};
GET / serviceBookingLive/ {ndisNumber}
This endpoint returns service bookings from quickclaim database based on the NDIS Number.
Sample call to get a list of service bookings:
var options = {
method: "GET",
url: "https://stage-api.quickclaim.io/public/serviceBookingLive/430000020",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
}
};
Sample response is like:
{
"version": "3.0.1",
"data": [
{
"sbHeaderId": "SBH-2740019",
"serviceBookingId": 3198394,
"serviceBookingNumber": 50050066,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17275,
"participantName": "Howadrd Germany",
"ndisNumber": "430000020",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"virtualStatus": "Inactive",
"status": "Approved",
"startDate": "2022-08-01T00:00:00.000Z",
"endDate": "2022-12-31T00:00:00.000Z",
"note": "",
"supportCategoryApi": "DAILY_ACTIVITIES",
"supportCategory": "01-Assistance with daily life",
"supportItem": "default description for mock test",
"supportItemName": "default description for mock test",
"unit": 1,
"rate": 12500,
"amount": 12500,
"remaining": 12500,
"isUsed": 0,
"daysLeft": -216,
"isOld": 1,
"createDate": "2023-08-04T01:20:18.000Z",
"modifyDate": "2023-08-04T07:05:05.000Z",
"modifyBy": "SYSTEM",
"ndisRefreshDate": "2023-08-04T07:05:05.000Z",
"isDeleted": 0,
"isCancelled": 0,
"clientNumber": "123456",
"refresh": "0 m"
},
{
"sbHeaderId": "SBH-2740026",
"serviceBookingId": 3198396,
"serviceBookingNumber": 50050073,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17275,
"participantName": "Howadrd Germany",
"ndisNumber": "430000020",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"virtualStatus": "Inactive",
"status": "Approved",
"startDate": "2022-08-01T00:00:00.000Z",
"endDate": "2022-12-31T00:00:00.000Z",
"note": "",
"supportCategoryApi": "DAILY_ACTIVITIES",
"supportCategory": "01-Assistance with daily life",
"supportItem": "default description for mock test",
"supportItemName": "default description for mock test",
"unit": 1,
"rate": 12500,
"amount": 12500,
"remaining": 12500,
"isUsed": 0,
"daysLeft": -216,
"isOld": 1,
"createDate": "2023-08-04T01:20:19.000Z",
"modifyDate": "2023-08-04T07:05:06.000Z",
"modifyBy": "SYSTEM",
"ndisRefreshDate": "2023-08-04T07:05:06.000Z",
"isDeleted": 0,
"isCancelled": 0,
"clientNumber": "123456",
"refresh": "0 m"
},
{
"sbHeaderId": "SBH-2740025",
"serviceBookingId": 3198397,
"serviceBookingNumber": 50050072,
"regoId": 28,
"ndisRego": 4050000001,
"orgId": 11234,
"participantId": 17275,
"participantName": "Howadrd Germany",
"ndisNumber": "430000020",
"planNumber": 1080277,
"bookingType": "Standard Booking",
"virtualStatus": "Inactive",
"status": "Approved",
"startDate": "2022-08-01T00:00:00.000Z",
"endDate": "2022-12-31T00:00:00.000Z",
"note": "",
"supportCategoryApi": "DAILY_ACTIVITIES",
"supportCategory": "01-Assistance with daily life",
"supportItem": "default description for mock test",
"supportItemName": "default description for mock test",
"unit": 1,
"rate": 12500,
"amount": 12500,
"remaining": 12500,
"isUsed": 0,
"daysLeft": -216,
"isOld": 1,
"createDate": "2023-08-04T01:20:19.000Z",
"modifyDate": "2023-08-04T07:05:06.000Z",
"modifyBy": "SYSTEM",
"ndisRefreshDate": "2023-08-04T07:05:06.000Z",
"isDeleted": 0,
"isCancelled": 0,
"clientNumber": "123456",
"refresh": "0 m"
} ...
]
}
POST /serviceBooking
This endpoint create a service booking on NDIS. To simplify the process for each service booking you can only add one line of support. Support can be booked either at Category or Item level. If adding the service booking at Category level you should add categoryCode, but no need to add the supportItem field. However for service bookings at Support level you must add both categoryCode and supportItem fields.
var options = {
method: "POST",
url: "https://stage-api.quickclaim.io/public/serviceBooking",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
},
body:
{
"ndisNumber" : "430000020",
"ndisRego": 4050000001, //NDIS Provider Registration Number
"startDate": "2018-07-30",
"endDate": "2020-07-30",
"categoryCode": "04", //One of the 01 to 15
"supportItem": "04_153_0104_6_1", //optional
"bookingType": "Standard Booking", //one of the "Standard Booking" or "Plan Managed"
"quantity": 4,
"rate": 84,
"note": "Add your optional note here"
}
};
Sample responce is like:
{
"version": "3.0.1",
"data": {
"serviceBookingNumber": 50050075
}
}
This endpoint used to submit a bulk claim request to NDIS, specifically for a batch of payment requests.
The request body contains a "batchReferenceName" along with an array of "bulkPaymentRequest" objects. Each object represents a payment request with the following attributes:
var options = {
method: "POST",
url: "https://stage-api.quickclaim.io/public/bulkClaim",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
},
body: {
"batchReferenceName":"test",
"bulkPaymentRequest": [
{
"refDocNo":"ABCD1234",
"supportItem":"05_220627230_0122_1_2",
"ndisNumber":"431234567",
"rate":34,
"quantity": 3,
"taxCode":"P2",
"claimType":"TRAN",
"claimReason":"NSDO",
"startDate":"2022-04-12",
"endDate":"2023-05-17"
},
{
"refDocNo":"ABCD1234",
"supportItem":"05_220627230_0122_1_2",
"ndisNumber":"431234567",
"rate":34,
"quantity": 3,
"taxCode":"P2",
"claimType":"TRAN",
"claimReason":"NSDO",
"startDate":"2022-04-12",
"endDate":"2023-05-17"
}
]
}
};
Sample responce is like:
{
"version": "3.0.1",
"data": {
"success": true
}
}
GET /claim (batch)
GET /claim/{PRN}
This endpoint used to retrieve a list of claims associated with a specific batch reference name.
The query parameter "batchReferenceName" is included in the URL to specify the batch for which you want to retrieve the associated claims.
Upon making this request, the API will return a list of claims that are linked to the specified batch reference name. Each claim will likely have various attributes and details that describe the payment request and its associated information.
var options = {
method: "GET",
url: "https://stage-api.quickclaim.io/public/claimsByBatch?batchReferenceName=test",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY"
}
};
Sample response is like:
{
"version": "3.0.1",
"data": {
"success": true,
"result": [
{
"claim_number": 123456789,
"participant": 431234567,
"invoice_number": "9876544321",
"participant_name": "James Band",
"product_category": "DAILY_ACTIVITIES",
"submit_date": "2022-08-08",
"start_date": "2022-07-15",
"end_date": "2022-07-15",
"claim_status": "41",
"service_agreement": 0,
"ref_doc_no": "ABC1234",
"abn_provider": 12343456,
"exemption_reason": "",
"reject_reason_code": ""
},
{
"claim_number": 123456789,
"participant": 431234567,
"invoice_number": "9876544321",
"participant_name": "James Band",
"product_category": "DAILY_ACTIVITIES",
"submit_date": "2022-08-08",
"start_date": "2022-07-15",
"end_date": "2022-07-15",
"claim_status": "41",
"service_agreement": 0,
"ref_doc_no": "ABC1234",
"abn_provider": 12343456,
"exemption_reason": "",
"reject_reason_code": ""
},
{
"claim_number": 123456789,
"participant": 431234567,
"invoice_number": "9876544321",
"participant_name": "James Band",
"product_category": "DAILY_ACTIVITIES",
"submit_date": "2022-08-08",
"start_date": "2022-07-15",
"end_date": "2022-07-15",
"claim_status": "41",
"service_agreement": 0,
"ref_doc_no": "ABC1234",
"abn_provider": 12343456,
"exemption_reason": "",
"reject_reason_code": ""
},
{
"claim_number": 123456789,
"participant": 431234567,
"invoice_number": "9876544321",
"participant_name": "James Band",
"product_category": "DAILY_ACTIVITIES",
"submit_date": "2022-08-08",
"start_date": "2022-07-15",
"end_date": "2022-07-15",
"claim_status": "41",
"service_agreement": 0,
"ref_doc_no": "ABC1234",
"abn_provider": 12343456,
"exemption_reason": "",
"reject_reason_code": ""
},
{
"claim_number": 123456789,
"participant": 431234567,
"invoice_number": "9876544321",
"participant_name": "James Band",
"product_category": "DAILY_ACTIVITIES",
"submit_date": "2022-08-08",
"start_date": "2022-07-15",
"end_date": "2022-07-15",
"claim_status": "41",
"service_agreement": 0,
"ref_doc_no": "ABC1234",
"abn_provider": 12343456,
"exemption_reason": "",
"reject_reason_code": ""
},
{
"claim_number": 123456789,
"participant": 431234567,
"invoice_number": "9876544321",
"participant_name": "James Band",
"product_category": "DAILY_ACTIVITIES",
"submit_date": "2022-08-08",
"start_date": "2022-07-15",
"end_date": "2022-07-15",
"claim_status": "41",
"service_agreement": 0,
"ref_doc_no": "ABC1234",
"abn_provider": 12343456,
"exemption_reason": "",
"reject_reason_code": ""
},
{
"claim_number": 123456789,
"participant": 431234567,
"invoice_number": "9876544321",
"participant_name": "James Band",
"product_category": "DAILY_ACTIVITIES",
"submit_date": "2022-08-08",
"start_date": "2022-07-15",
"end_date": "2022-07-15",
"claim_status": "41",
"service_agreement": 0,
"ref_doc_no": "ABC1234",
"abn_provider": 12343456,
"exemption_reason": "",
"reject_reason_code": ""
}
]
}
}
GET /claim/{PRN}
This endpoint used to retrieve information about a specific claim based on the provided Payment Request Number (PRN).
"ndisNumber": This should be replaced with the NDIS participant's number in the header for filtering and retrieving information about the specific claim associated with that participant.var options = {
method: "GET",
url: "https://stage-api.quickclaim.io/public/claimByPrn/123456789",
headers:
{
org-id: YOUR_ORGANIZATION_ID,
x-api-key: "YOUR_X-API-KEY",
ndisNumber: "PARTICIPANT_NDIS_NUMBER"
}
};
Sample response is like:
{
"version": "3.0.1",
"data": {
"claim_number": 123456789,
"claimed_amount": 2.3,
"participant": 431234567,
"participant_name": "James Band",
"invoice_number": "5773758535041024",
"claim_status": "41",
"start_date": "2019-06-03",
"end_date": "2019-06-03",
"product_category": "HOME_MODIFICATIONS",
"product_category_item": "1112222333344455",
"product_description": "Incontinence",
"claim_type": "TRAN",
"claim_reason": "NSDO",
"amount": 25.25,
"quantity": 1.5,
"tax_code": "P5",
"plan_id": 12345678,
"service_agreement": 987654321,
"inkind_flag": true,
"submit_date": "2019-06-03",
"submit_by": "TEST",
"reject_reason_code": "",
"paid_date": "2019-06-03",
"abn_provider": 60006000014,
"exemption_reason": "EXCLS",
"ref_doc_no": "test_1234",
"clearing_number": "12234"
}
}