Design

View the Invoicing API design here.

Comments

To comment or give feedback on our Invoicing API go to the Invoicing API forum.

Summary

See "Provider API User Interface - Introduction" within API Overview Documentation.

Benefits

Makes it easier for the Provider to do things right first time.

Allows the software vendor to add value:

• Provides 'intertactions' in a way that flow within your application.
• Extract and automate an API request from your stated database.

Authentication and access

Our APIs need an API key as well as a valid Helath Secure Digital Certificate to submit requests in production and compliance environments. The Health Secure Digital Certificate is the same certificate Providers use to submit payloads using the current SOAP service. This certificate is used to authenticate who the user submitting the request is. We need to authorise the certificate, contact Digital Operations to make sure the certificate is set up.

Specific terms of use

Any registered health practitioner treating a patient for an injury we cover can submit an invoice. More information can be found on our Paying for patient treatment page.

Throttling and non-functional requirements

1. We've applied throttling to these APIs to prtect against DDoS attacks. We've applied a limit of 30 requests per second per API key.

2. These APIs will be available 23.5 x 6.5 which is figurative only and indicates that there's some time needed for planned maintenance windows and emergency fixes.

Testing

Formally, testing is not available until late March 2018; however, we are supporting a very limited number of software vendors due to special circumstances. To negotiate this possibility contact the digital operations team via the contact us form.
When testing, please use your own digital certificate and test vendor ID and provider ID details when submitting to the compliance/sandpit environment. Each digital certificate will have specific permissions that it can access. If you do not have a digital certificate available or have not been issued a test vendor ID and/or a provider ID then contact the digital operations team via the contact us form.
The developer digital certificate, test provider ID, vendor ID and claim numbers will not be able to be used for production/live submissions.

Suggested scenarios to test

To be developed.

Production requirements

Once you've completed testing of your app in our compliance environment and want to put it into production, then you need to send a message requesting production access:

• Contact the Digital Operations team at ACC via the contact us form.
• Complete the Name, Email and Message fields in the form.
• Select 'Request for production access' in the 'What are you contacting us about' field.

We'll contact you to discuss the process of getting your app into production as some apps will require certain criteria and testing scenarios to be completed before this access can be approved. The testing scenarios can be found on our scenarios page but there may be further testing and requirements which will be at ACC's discretion.