List of the NDIA's APIs

This article provides a list of APIs provided by the NDIS that can be accessed through quickclaim's NDIS API package.

The table below comes from Appendix 1 of the NDIA Digital Providers Questionnaire, which can be found on the NDIS's website, here.

Documentation to accompany this list is available upon application.

 

API Name

Description

1 Payment Request Creation Single

Submit a single payment request for one service booking

2 Payment Request Creation Batch

Submit a set of payment requests for multiple service bookings and/or multiple participants

3

Payment Request List All

Retrieve a list of all payment requests made by the provider

4

Payment Request List Specific

Retrieve a single payment request made by the provider

5

Payment Request List Specific Batch            

Retrieve a list of all payments requests submitted using Post Batch payment request

6

Service Booking Creation

Places a service booking against a participant’s funded supports. This allows the provider to make a service booking for a support category or support item.

7

Service Booking Update Quantity and Amount

Provider can update the current quantity and allocated amount of an existing service booking

8

Service Booking Extend End Date

Extends the ending date of an existing service booking

9

Service Booking Reduce End Date

Reduces the ending date of an existing service booking

10

Service Booking Update Status

This API updates the status of an existing Service Booking in the Participants plan

11

Service Booking List All

Retrieves a list of all the provider’s service bookings

12

Service Booking List Specific

Retrieves a specific service booking assigned to the provider

13

Service Booking Delete

Deletes a specific service booking assigned to the provider

14

Plan Retrieval

Retrieves the appropriate approved plans required for service bookings

15

Plan Retrieval - Plan Goals

Retrieves Participant goal and Nominee details for approved plans

16

Quotation List All

Retrieves a summary of all quotations for the provider along with current status on each

17

Quotation Response

Allows the provider to respond to a specific request for a quote from NDIA

18

Notification List All

Retrieves a list of all the notifications that a provider has subscribed to receive

19

Notification Subscribe

Enables the provider to subscribe to a type of notification

20

Notification Unsubscribe

Enables the provider to unsubscribe from a previously subscribed type of notification

21

Reference Data All

Retrieves a list of all the required datasets and parameters for the developer to know

22

Reference Data Attribute

Retrieves values for a specific attribute that needs to be passed into other APIs

23

Reference Data Sub-attribute

Retrieves values for a specific sub attribute data that needs to be passed into other APIs

24

Product Catalogue View

Retrieves NDIA's Product Catalogue details

25

Upload File

Enables the provider to upload a file as a supporting document