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",
  "transactionType": "standard",
  "organisationId": "<string>",
  "items": [
    {
      "id": "<string>",
      "type": "charge",
      "chargeAmount": 123,
      "description": "<string>",
      "clinicalCode": "<string>",
      "itemCode": "<string>",
      "billableItemId": "<string>",
      "billableItem": {
        "name": "<string>",
        "basePrice": 123,
        "totalPrice": 123,
        "taxAmount": 123,
        "taxRate": 123,
        "type": "service",
        "id": "<string>",
        "itemCode": "<string>",
        "pmsBillableItemId": "<string>"
      },
      "appointmentTypeId": "<string>"
    }
  ],
  "serviceProvider": {
    "locationId": "<string>",
    "providerId": "<string>"
  },
  "phi": {
    "healthFundCardId": "<string>",
    "patient": {
      "referenceNumber": "<string>"
    }
  },
  "invite": {
    "inviteCode": "<string>"
  }
}
'
{
  "items": [
    {
      "id": "<string>",
      "funding": [
        {
          "source": "phi",
          "fundingAmount": 123
        }
      ],
      "totalFundingAmount": 123
    }
  ],
  "phi": {
    "claim": {
      "id": "<string>",
      "referenceNumber": "<string>",
      "status": "created",
      "createdAt": "2023-11-07T05:31:56Z",
      "isRebateEstimate": true,
      "totalChargeAmount": 123,
      "totalRebateAmount": 123,
      "totalGapAmount": 123,
      "serviceTypeCode": "F",
      "providerNumber": "<string>",
      "items": [
        {
          "id": "<string>",
          "chargeAmount": 123,
          "itemCode": "<string>",
          "serviceDate": "2023-11-07T05:31:56Z",
          "rebateAmount": 123,
          "serviceReference": "<string>",
          "patient": {
            "referenceNumber": "<string>"
          },
          "itemDescription": "<string>",
          "itemName": "<string>",
          "response": {
            "statusCode": "<string>"
          }
        }
      ],
      "device": {
        "terminalId": "<string>"
      },
      "serviceType": {
        "code": "<string>",
        "name": "<string>"
      },
      "healthFund": {
        "id": "<string>",
        "name": "<string>",
        "capabilities": {
          "claims": "active",
          "rebatesEstimates": "active"
        }
      },
      "cancelledAt": "2023-11-07T05:31:56Z",
      "voidedAt": "2023-11-07T05:31:56Z",
      "response": {
        "statusCode": "<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>",
        "serviceTypeCode": "F"
      }
    }
  }
}

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
serviceProvider
object
phi
object
invite
object

Response

201 - application/json
items
object[]
required
phi
object