NDIS Invoice Plan Managers

Finding a Plan Manager

GET /approvingproviders/?search={search}&offset={offset}&pageSize={pageSize}

This resource will return a list of all plan managers known by HICAPS. The details of an individual plan manager must be used when submitting to that plan manager.

Query Parameters

Example Search Response

{
  "items": [
    {
      "name": "Integrated Plan Manager",
      "email": "admin@integrated-plan-manager.com",
      "programCode": "ndis-planmanaged-integratedplanmanager"
    },
    {
      "name": "Non-integrated Plan Manager",
      "email": "admin@non-integrated-plan-manager.com",
      "programCode": "ndis-planmanaged-email"
    }
  ]
}

Submitting with a Search API result

Submitting an invoice is done via the Provider API detailed here.

To correctly route the invoice to the plan manager using the information in the search response the following information needs to be submitted as part of the invoice payload:

1. program must be set to to the value of programCode as indicated in the search response above. Each plan manager will have a unique programCode and any value other than ndis-planmanaged-email indicates that the plan manager will receive the invoice directly via a webhook.
2. email and name must contain the corresponding values from the search response above.

Example Invoice Payload

{
  "program": "ndis-planmanaged-integratedplanmanager",
  "invoiceCustomFields" : {
        "ndis" : {
            "planManager": {
                "name": "Integrated Plan Manager",
                "email": "admin@integrated-plan-manager.com",
            }
        }
    },
}

Submitting when the Search API does not return a result

If the search API above does not return the plan manager you are looking for, you can enter their contact details directly into the invoice payload and the invoice will be sent as a PDF attachment via email to the address provided.

Submitting an invoice is done via the Provider API detailed here.

To correctly route the invoice to the plan manager via email the following information needs to be submitted as part of the invoice payload:

1. program must be set to ndis-planmanaged-email.
2. email must contain the destination email address.

Example Invoice Payload

{
  "program": "ndis-planmanaged-email",
  "invoiceCustomFields" : {
        "ndis" : {
            "planManager": {
                "name": "Another plan manager",
                "email": "admin@unknown-plan-manager.com",
            }
        }
    },
}

In this case, the ndis-planmanaged-email program code indicates to HICAPS that the invoice is to be sent via email to the address provided, e.g. admin@unknown-plan-manager.com.

Approving as an Integrated Plan Manager

Invoices are received via webhooks as detailed here.

Integrated plan managers should provisionally approve an invoice by updating each claim on the invoice as provisionallyApproved. This will cause the invoice to be submitted to the NDIS and on approval by the NDIS, HICAPS will update the invoice status to approved.

Invoices are approved via the program API as detailed here.

Example Invoice Approval

{
    "claimStatuses": [
        {
            "claimId": "ef5bc5d2-943e-473c-bfc4-dab2e252a000",
            "state": "provisionallyApproved"
        },
        {
            "claimId": "ac2a7251-149e-4e5a-b526-bbc9e256723b",
            "state": "provisionallyApproved"
        }
    ]
}

Rejecting an Invoice

Invoices are approved via the program API as detailed here.

Example Invoice Rejection

{
    "claimStatuses": [
        {
            "claimId": "ac2a7251-149e-4e5a-b526-bbc9e256723b",
            "benefit": 0,
            "state": "rejected",
			"statusTitle": "Invalid item code",
            "statusDescription": "Item code 12345 is not allowed for this participant"
        },
    ]
}