Skip to main content
POST
/
v1
/
funding
/
estimates
Create funding estimate
curl --request POST \
  --url https://api.halth.com/v1/funding/estimates \
  --header 'Content-Type: application/json' \
  --data '
{
  "countryCode": "AU",
  "organisationId": "<string>",
  "items": [
    {
      "chargeAmount": 123,
      "id": "<string>",
      "description": "<string>",
      "clinicalCode": "<string>",
      "itemCode": "<string>",
      "billableItemId": "<string>",
      "appointmentTypeId": "<string>"
    }
  ],
  "useCache": true
}
'
{
  "totalGapAmount": 100,
  "totalRebateAmount": 123,
  "totalChargeAmount": 123,
  "items": [
    {
      "id": "<string>",
      "funding": [
        {
          "fundingAmount": 123,
          "claimResponse": {}
        }
      ],
      "totalFundingAmount": 123
    }
  ],
  "phi": {
    "message": "<string>",
    "response": {},
    "claim": {
      "id": "<string>",
      "referenceNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "isRebateEstimate": true,
      "totalChargeAmount": 123,
      "totalRebateAmount": 123,
      "totalGapAmount": 123,
      "providerNumber": "<string>",
      "items": [
        {
          "id": "<string>",
          "chargeAmount": 123,
          "itemCode": "<string>",
          "serviceDate": "2023-11-07T05:31:56Z",
          "patientReferenceNumber": "<string>",
          "rebateAmount": 123,
          "serviceReference": "<string>",
          "itemDescription": "<string>",
          "itemName": "<string>",
          "response": {
            "statusCode": "<string>",
            "responseCode": "<string>"
          }
        }
      ],
      "device": {
        "terminalId": "<string>"
      },
      "serviceType": {
        "code": "<string>",
        "name": "<string>"
      },
      "healthFund": {
        "id": "<string>",
        "name": "<string>",
        "capabilities": {}
      },
      "rules": {
        "reversal": {
          "enabled": true
        }
      },
      "cancelledAt": "2023-11-07T05:31:56Z",
      "voidedAt": "2023-11-07T05:31:56Z",
      "response": {
        "statusCode": "<string>",
        "responseCode": "<string>",
        "freeText": "<string>"
      },
      "payment": {
        "paymentAmount": 123,
        "bankAccountNumberLast4": "<string>",
        "bankAccountBsb": "<string>",
        "paymentDate": "2023-11-07T05:31:56Z",
        "paymentReference": "<string>"
      },
      "provider": {
        "providerNumber": "<string>",
        "name": "<string>",
        "categoryCode": "<string>"
      }
    }
  },
  "medicare": {
    "message": "<string>",
    "response": {}
  }
}

Body

application/json
countryCode
enum<string>
required

The country code where the transactions is occurring

Available options:
AU
Example:

"AU"

transactionType
enum<string>
required
Available options:
standard,
late_cancellation,
no_show
organisationId
string
required
items
object[]
required
Required array length: 1 - 100 elements
useCache
boolean
default:false
deprecated

Use cacheControl instead. Whether to use similar claims to create the funding estimate. Prevents duplicate claims hitting the health funds and going through the claim and void process.

Example:

true

serviceProvider
object
phi
object
invite
object

Response

201 - application/json
totalGapAmount
number
required

The total gap amount for the funding estimate

Example:

100

totalRebateAmount
number
required
totalChargeAmount
number
required
items
object[]
required
phi
object
medicare
object