Skip to main content
POST
/
v1
/
organisations
/
{organisationId}
/
locations
/
{locationId}
/
registrations
Create registration
curl --request POST \
  --url https://api.halth.com/v1/organisations/{organisationId}/locations/{locationId}/registrations \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "medicare"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "timeZone": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "suburb": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "country": "<string>",
    "countryCode": "<string>"
  },
  "suggestedTaxIdentifier": "<string>",
  "bookingCustomText": "<string>",
  "businessId": "<string>",
  "business": {
    "id": "<string>",
    "name": "<string>",
    "settings": {
      "autoReconciliationEnabled": true,
      "autoInviteClientsEnabled": true
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "taxIdentifier": "<string>",
    "countryCode": "<string>",
    "structure": "public_corporation",
    "merchantId": "<string>",
    "capabilities": [
      {
        "id": "bookings_client_funding_phi",
        "status": "inactive"
      }
    ]
  },
  "email": "<string>",
  "registrations": [
    {
      "type": "medicare",
      "medicare": {
        "minorId": "<string>",
        "prodaLocationId": "<string>",
        "status": "<string>"
      },
      "phi": {
        "phiLocationId": "<string>",
        "status": "<string>"
      }
    }
  ]
}

Path Parameters

organisationId
string
required
locationId
string
required

Body

application/json
type
enum<string>
required

The type of registration to create

Available options:
medicare,
phi

Response

201 - application/json
id
string
required
name
string
required
createdAt
string<date-time>
required
timeZone
string
required
address
object
required
suggestedTaxIdentifier
string
bookingCustomText
string
businessId
string
business
object
email
string
registrations
object[]