Create booking
curl --request POST \
--url https://api.halth.com/v1/organisations/{organisationId}/bookings \
--header 'Content-Type: application/json' \
--data '
{
"locationId": "27",
"providerId": "54",
"appointmentTypeId": "280",
"appointmentTime": "2025-01-01T10:00:00Z",
"client": {
"firstName": "Milo",
"lastName": "Croton",
"mobileNumber": "+61400000000",
"email": "milo@halth.com",
"dateOfBirth": "2000-01-01"
},
"notes": "Sore back for 4 weeks",
"bookingCreditId": "<string>",
"sessionId": "<string>",
"funding": {}
}
'import requests
url = "https://api.halth.com/v1/organisations/{organisationId}/bookings"
payload = {
"locationId": "27",
"providerId": "54",
"appointmentTypeId": "280",
"appointmentTime": "2025-01-01T10:00:00Z",
"client": {
"firstName": "Milo",
"lastName": "Croton",
"mobileNumber": "+61400000000",
"email": "milo@halth.com",
"dateOfBirth": "2000-01-01"
},
"notes": "Sore back for 4 weeks",
"bookingCreditId": "<string>",
"sessionId": "<string>",
"funding": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
locationId: '27',
providerId: '54',
appointmentTypeId: '280',
appointmentTime: '2025-01-01T10:00:00Z',
client: {
firstName: 'Milo',
lastName: 'Croton',
mobileNumber: '+61400000000',
email: 'milo@halth.com',
dateOfBirth: '2000-01-01'
},
notes: 'Sore back for 4 weeks',
bookingCreditId: '<string>',
sessionId: '<string>',
funding: {}
})
};
fetch('https://api.halth.com/v1/organisations/{organisationId}/bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.halth.com/v1/organisations/{organisationId}/bookings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'locationId' => '27',
'providerId' => '54',
'appointmentTypeId' => '280',
'appointmentTime' => '2025-01-01T10:00:00Z',
'client' => [
'firstName' => 'Milo',
'lastName' => 'Croton',
'mobileNumber' => '+61400000000',
'email' => 'milo@halth.com',
'dateOfBirth' => '2000-01-01'
],
'notes' => 'Sore back for 4 weeks',
'bookingCreditId' => '<string>',
'sessionId' => '<string>',
'funding' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.halth.com/v1/organisations/{organisationId}/bookings"
payload := strings.NewReader("{\n \"locationId\": \"27\",\n \"providerId\": \"54\",\n \"appointmentTypeId\": \"280\",\n \"appointmentTime\": \"2025-01-01T10:00:00Z\",\n \"client\": {\n \"firstName\": \"Milo\",\n \"lastName\": \"Croton\",\n \"mobileNumber\": \"+61400000000\",\n \"email\": \"milo@halth.com\",\n \"dateOfBirth\": \"2000-01-01\"\n },\n \"notes\": \"Sore back for 4 weeks\",\n \"bookingCreditId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"funding\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.halth.com/v1/organisations/{organisationId}/bookings")
.header("Content-Type", "application/json")
.body("{\n \"locationId\": \"27\",\n \"providerId\": \"54\",\n \"appointmentTypeId\": \"280\",\n \"appointmentTime\": \"2025-01-01T10:00:00Z\",\n \"client\": {\n \"firstName\": \"Milo\",\n \"lastName\": \"Croton\",\n \"mobileNumber\": \"+61400000000\",\n \"email\": \"milo@halth.com\",\n \"dateOfBirth\": \"2000-01-01\"\n },\n \"notes\": \"Sore back for 4 weeks\",\n \"bookingCreditId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"funding\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halth.com/v1/organisations/{organisationId}/bookings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"locationId\": \"27\",\n \"providerId\": \"54\",\n \"appointmentTypeId\": \"280\",\n \"appointmentTime\": \"2025-01-01T10:00:00Z\",\n \"client\": {\n \"firstName\": \"Milo\",\n \"lastName\": \"Croton\",\n \"mobileNumber\": \"+61400000000\",\n \"email\": \"milo@halth.com\",\n \"dateOfBirth\": \"2000-01-01\"\n },\n \"notes\": \"Sore back for 4 weeks\",\n \"bookingCreditId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"funding\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationId": "<string>",
"location": {
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
},
"providerId": "<string>",
"provider": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationIds": [
"<string>"
],
"deleted": true,
"bookingsEnabled": true,
"mobileNumber": "<string>",
"email": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"profileImageUrl": "<string>",
"locationLinks": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetterFileId": "<string>"
},
"association": {
"registrationLetterFileId": "<string>"
}
}
],
"locations": [
{
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
}
],
"registrations": [
{
"id": "<string>",
"providerId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"ndis": {
"providerNumber": "<string>"
},
"medicare": {
"providerNumber": "<string>"
},
"phi": {
"providerNumber": "<string>"
}
}
]
},
"appointmentTypeId": "<string>",
"appointmentType": {
"id": "<string>",
"name": "<string>",
"durationMinutes": 123,
"price": 123,
"providers": [
"<string>"
],
"locations": [
"<string>"
],
"createdAt": "<string>",
"deleted": true,
"maxAttendees": 123,
"description": "<string>",
"category": "<string>",
"billableItems": [
{
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"id": "<string>",
"itemCode": "<string>",
"serviceItem": {
"id": "<string>",
"itemCode": "<string>",
"category": "<string>",
"description": "<string>"
},
"pmsBillableItemId": "<string>"
}
]
},
"serviceDate": "2023-11-07T05:31:56Z",
"client": {
"id": "<string>",
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"mobileNumber": "<string>",
"email": "<string>",
"pmsPatientId": "<string>",
"pmsCreatedAt": "2023-11-07T05:31:56Z",
"profileImageUrl": "<string>"
},
"clientId": "<string>",
"paid": true,
"invoiced": true,
"adjustments": [
{
"id": "<string>",
"amount": 123,
"balanceEffectIndicator": 123,
"type": "provider_funding",
"description": "<string>"
}
],
"tags": [],
"servicePrice": 123,
"cancelledAt": "2023-11-07T05:31:56Z",
"healthFundCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"healthFundId": "<string>",
"healthFund": {
"name": "<string>",
"capabilities": {}
},
"cardholders": [
{
"referenceNumber": "<string>",
"name": "<string>"
}
],
"fingerprint": "<string>",
"verified": true,
"defaultReferenceNumber": "<string>",
"issueNumber": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"paymentMethod": {
"id": "<string>",
"brand": "<string>",
"last4": "<string>",
"customerId": "<string>"
},
"providerLocationLink": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetterFileId": "<string>"
},
"association": {
"registrationLetterFileId": "<string>"
}
},
"cancellationPolicy": {
"enabled": true,
"rules": {
"clientCancel": {
"enabled": true
},
"clientReschedule": {
"enabled": true
}
},
"fee": {
"amount": 123,
"freeCancellationHours": 123,
"latestNoFeeAt": "2023-11-07T05:31:56Z",
"billable": true,
"percent": 123
}
},
"latestTransaction": {
"id": "<string>",
"businessId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"paymentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123,
"adjustmentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123
}
],
"platformFeeAmount": 123,
"paymentId": "<string>",
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"paymentMethodId": "<string>",
"clientSecret": "<string>"
},
"claimId": "<string>",
"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": {
"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>"
}
},
"medicareClaimId": "<string>",
"medicareClaim": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"type": {},
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"itemsCount": 123,
"mcolTransactionId": "<string>",
"items": [
{
"id": "<string>",
"itemCode": "<string>",
"chargeAmount": 123,
"rebateAmount": 123,
"gapAmount": 123,
"mcolAssessmentCode": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"patientCount": 123,
"quantity": 123
}
],
"paymentStatus": {},
"rules": {
"reversal": {
"enabled": true
}
},
"reference": "<string>",
"patientMedicareCardId": "<string>",
"patientMedicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"claimantMedicareCardId": "<string>",
"claimantMedicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"mcolClaimId": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"transactionId": "<string>"
},
"paymentLinks": [
{
"url": "https://app.halth.com/pay/1234567890",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"events": [
{
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
],
"events": [
{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"createdByMember": {
"id": "<string>",
"emailVerified": true,
"mobileNumberVerified": true,
"createdAt": "2023-11-07T05:31:56Z",
"settings": {
"showPlanHelp": true
},
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"dateOfBirth": "<string>",
"roles": [
"<string>"
],
"profileImageUrl": "<string>",
"activity": [
{
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2023-11-07T05:31:56Z",
"applicationVersion": "<string>",
"platform": "<string>",
"userAgent": "<string>"
}
]
}
}
]
}
],
"transactionItems": [
{
"chargeAmount": 123,
"id": "<string>",
"description": "<string>",
"clinicalCode": "<string>",
"itemCode": "<string>",
"billableItemId": "<string>",
"billableItem": {
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"id": "<string>",
"itemCode": "<string>",
"serviceItem": {
"id": "<string>",
"itemCode": "<string>",
"category": "<string>",
"description": "<string>"
},
"pmsBillableItemId": "<string>"
},
"appointmentTypeId": "<string>"
}
],
"confirmations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"contactValue": "<string>",
"verified": true,
"expiresAt": "2023-11-07T05:31:56Z",
"verificationCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"customer": {
"name": "<string>"
},
"paymentMethodId": "<string>",
"paymentMethod": {
"id": "<string>",
"brand": "<string>",
"last4": "<string>",
"customerId": "<string>"
},
"healthFundCardId": "<string>",
"healthFundCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"healthFundId": "<string>",
"healthFund": {
"name": "<string>",
"capabilities": {}
},
"cardholders": [
{
"referenceNumber": "<string>",
"name": "<string>"
}
],
"fingerprint": "<string>",
"verified": true,
"defaultReferenceNumber": "<string>",
"issueNumber": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"medicareCardId": "<string>",
"medicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"bookingId": "<string>",
"clientName": "<string>",
"client": {
"id": "<string>",
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"mobileNumber": "<string>",
"email": "<string>",
"pmsPatientId": "<string>",
"pmsCreatedAt": "2023-11-07T05:31:56Z",
"profileImageUrl": "<string>"
},
"serviceProvider": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationIds": [
"<string>"
],
"deleted": true,
"bookingsEnabled": true,
"mobileNumber": "<string>",
"email": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"profileImageUrl": "<string>",
"locationLinks": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetterFileId": "<string>"
},
"association": {
"registrationLetterFileId": "<string>"
}
}
],
"locations": [
{
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
}
],
"registrations": [
{
"id": "<string>",
"providerId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"ndis": {
"providerNumber": "<string>"
},
"medicare": {
"providerNumber": "<string>"
},
"phi": {
"providerNumber": "<string>"
}
}
]
},
"location": {
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
},
"clientPlanId": "<string>"
},
"pmsBookingId": "<string>",
"pmsAttendeeId": "<string>"
}Booking
Create booking
Create a new booking
POST
/
v1
/
organisations
/
{organisationId}
/
bookings
Create booking
curl --request POST \
--url https://api.halth.com/v1/organisations/{organisationId}/bookings \
--header 'Content-Type: application/json' \
--data '
{
"locationId": "27",
"providerId": "54",
"appointmentTypeId": "280",
"appointmentTime": "2025-01-01T10:00:00Z",
"client": {
"firstName": "Milo",
"lastName": "Croton",
"mobileNumber": "+61400000000",
"email": "milo@halth.com",
"dateOfBirth": "2000-01-01"
},
"notes": "Sore back for 4 weeks",
"bookingCreditId": "<string>",
"sessionId": "<string>",
"funding": {}
}
'import requests
url = "https://api.halth.com/v1/organisations/{organisationId}/bookings"
payload = {
"locationId": "27",
"providerId": "54",
"appointmentTypeId": "280",
"appointmentTime": "2025-01-01T10:00:00Z",
"client": {
"firstName": "Milo",
"lastName": "Croton",
"mobileNumber": "+61400000000",
"email": "milo@halth.com",
"dateOfBirth": "2000-01-01"
},
"notes": "Sore back for 4 weeks",
"bookingCreditId": "<string>",
"sessionId": "<string>",
"funding": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
locationId: '27',
providerId: '54',
appointmentTypeId: '280',
appointmentTime: '2025-01-01T10:00:00Z',
client: {
firstName: 'Milo',
lastName: 'Croton',
mobileNumber: '+61400000000',
email: 'milo@halth.com',
dateOfBirth: '2000-01-01'
},
notes: 'Sore back for 4 weeks',
bookingCreditId: '<string>',
sessionId: '<string>',
funding: {}
})
};
fetch('https://api.halth.com/v1/organisations/{organisationId}/bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.halth.com/v1/organisations/{organisationId}/bookings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'locationId' => '27',
'providerId' => '54',
'appointmentTypeId' => '280',
'appointmentTime' => '2025-01-01T10:00:00Z',
'client' => [
'firstName' => 'Milo',
'lastName' => 'Croton',
'mobileNumber' => '+61400000000',
'email' => 'milo@halth.com',
'dateOfBirth' => '2000-01-01'
],
'notes' => 'Sore back for 4 weeks',
'bookingCreditId' => '<string>',
'sessionId' => '<string>',
'funding' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.halth.com/v1/organisations/{organisationId}/bookings"
payload := strings.NewReader("{\n \"locationId\": \"27\",\n \"providerId\": \"54\",\n \"appointmentTypeId\": \"280\",\n \"appointmentTime\": \"2025-01-01T10:00:00Z\",\n \"client\": {\n \"firstName\": \"Milo\",\n \"lastName\": \"Croton\",\n \"mobileNumber\": \"+61400000000\",\n \"email\": \"milo@halth.com\",\n \"dateOfBirth\": \"2000-01-01\"\n },\n \"notes\": \"Sore back for 4 weeks\",\n \"bookingCreditId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"funding\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.halth.com/v1/organisations/{organisationId}/bookings")
.header("Content-Type", "application/json")
.body("{\n \"locationId\": \"27\",\n \"providerId\": \"54\",\n \"appointmentTypeId\": \"280\",\n \"appointmentTime\": \"2025-01-01T10:00:00Z\",\n \"client\": {\n \"firstName\": \"Milo\",\n \"lastName\": \"Croton\",\n \"mobileNumber\": \"+61400000000\",\n \"email\": \"milo@halth.com\",\n \"dateOfBirth\": \"2000-01-01\"\n },\n \"notes\": \"Sore back for 4 weeks\",\n \"bookingCreditId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"funding\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halth.com/v1/organisations/{organisationId}/bookings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"locationId\": \"27\",\n \"providerId\": \"54\",\n \"appointmentTypeId\": \"280\",\n \"appointmentTime\": \"2025-01-01T10:00:00Z\",\n \"client\": {\n \"firstName\": \"Milo\",\n \"lastName\": \"Croton\",\n \"mobileNumber\": \"+61400000000\",\n \"email\": \"milo@halth.com\",\n \"dateOfBirth\": \"2000-01-01\"\n },\n \"notes\": \"Sore back for 4 weeks\",\n \"bookingCreditId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"funding\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationId": "<string>",
"location": {
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
},
"providerId": "<string>",
"provider": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationIds": [
"<string>"
],
"deleted": true,
"bookingsEnabled": true,
"mobileNumber": "<string>",
"email": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"profileImageUrl": "<string>",
"locationLinks": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetterFileId": "<string>"
},
"association": {
"registrationLetterFileId": "<string>"
}
}
],
"locations": [
{
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
}
],
"registrations": [
{
"id": "<string>",
"providerId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"ndis": {
"providerNumber": "<string>"
},
"medicare": {
"providerNumber": "<string>"
},
"phi": {
"providerNumber": "<string>"
}
}
]
},
"appointmentTypeId": "<string>",
"appointmentType": {
"id": "<string>",
"name": "<string>",
"durationMinutes": 123,
"price": 123,
"providers": [
"<string>"
],
"locations": [
"<string>"
],
"createdAt": "<string>",
"deleted": true,
"maxAttendees": 123,
"description": "<string>",
"category": "<string>",
"billableItems": [
{
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"id": "<string>",
"itemCode": "<string>",
"serviceItem": {
"id": "<string>",
"itemCode": "<string>",
"category": "<string>",
"description": "<string>"
},
"pmsBillableItemId": "<string>"
}
]
},
"serviceDate": "2023-11-07T05:31:56Z",
"client": {
"id": "<string>",
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"mobileNumber": "<string>",
"email": "<string>",
"pmsPatientId": "<string>",
"pmsCreatedAt": "2023-11-07T05:31:56Z",
"profileImageUrl": "<string>"
},
"clientId": "<string>",
"paid": true,
"invoiced": true,
"adjustments": [
{
"id": "<string>",
"amount": 123,
"balanceEffectIndicator": 123,
"type": "provider_funding",
"description": "<string>"
}
],
"tags": [],
"servicePrice": 123,
"cancelledAt": "2023-11-07T05:31:56Z",
"healthFundCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"healthFundId": "<string>",
"healthFund": {
"name": "<string>",
"capabilities": {}
},
"cardholders": [
{
"referenceNumber": "<string>",
"name": "<string>"
}
],
"fingerprint": "<string>",
"verified": true,
"defaultReferenceNumber": "<string>",
"issueNumber": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"paymentMethod": {
"id": "<string>",
"brand": "<string>",
"last4": "<string>",
"customerId": "<string>"
},
"providerLocationLink": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetterFileId": "<string>"
},
"association": {
"registrationLetterFileId": "<string>"
}
},
"cancellationPolicy": {
"enabled": true,
"rules": {
"clientCancel": {
"enabled": true
},
"clientReschedule": {
"enabled": true
}
},
"fee": {
"amount": 123,
"freeCancellationHours": 123,
"latestNoFeeAt": "2023-11-07T05:31:56Z",
"billable": true,
"percent": 123
}
},
"latestTransaction": {
"id": "<string>",
"businessId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"paymentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123,
"adjustmentTransactions": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"amount": 123
}
],
"platformFeeAmount": 123,
"paymentId": "<string>",
"payment": {
"id": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"paymentMethodId": "<string>",
"clientSecret": "<string>"
},
"claimId": "<string>",
"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": {
"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>"
}
},
"medicareClaimId": "<string>",
"medicareClaim": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"type": {},
"totalChargeAmount": 123,
"totalRebateAmount": 123,
"totalGapAmount": 123,
"itemsCount": 123,
"mcolTransactionId": "<string>",
"items": [
{
"id": "<string>",
"itemCode": "<string>",
"chargeAmount": 123,
"rebateAmount": 123,
"gapAmount": 123,
"mcolAssessmentCode": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"patientCount": 123,
"quantity": 123
}
],
"paymentStatus": {},
"rules": {
"reversal": {
"enabled": true
}
},
"reference": "<string>",
"patientMedicareCardId": "<string>",
"patientMedicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"claimantMedicareCardId": "<string>",
"claimantMedicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"mcolClaimId": "<string>",
"mcolErrorCode": "<string>",
"mcolErrorMessage": "<string>",
"transactionId": "<string>"
},
"paymentLinks": [
{
"url": "https://app.halth.com/pay/1234567890",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"events": [
{
"createdAt": "2023-11-07T05:31:56Z"
}
]
}
],
"events": [
{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"createdByMember": {
"id": "<string>",
"emailVerified": true,
"mobileNumberVerified": true,
"createdAt": "2023-11-07T05:31:56Z",
"settings": {
"showPlanHelp": true
},
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"dateOfBirth": "<string>",
"roles": [
"<string>"
],
"profileImageUrl": "<string>",
"activity": [
{
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2023-11-07T05:31:56Z",
"applicationVersion": "<string>",
"platform": "<string>",
"userAgent": "<string>"
}
]
}
}
]
}
],
"transactionItems": [
{
"chargeAmount": 123,
"id": "<string>",
"description": "<string>",
"clinicalCode": "<string>",
"itemCode": "<string>",
"billableItemId": "<string>",
"billableItem": {
"name": "<string>",
"basePrice": 123,
"totalPrice": 123,
"taxAmount": 123,
"taxRate": 123,
"id": "<string>",
"itemCode": "<string>",
"serviceItem": {
"id": "<string>",
"itemCode": "<string>",
"category": "<string>",
"description": "<string>"
},
"pmsBillableItemId": "<string>"
},
"appointmentTypeId": "<string>"
}
],
"confirmations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"contactValue": "<string>",
"verified": true,
"expiresAt": "2023-11-07T05:31:56Z",
"verificationCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"customer": {
"name": "<string>"
},
"paymentMethodId": "<string>",
"paymentMethod": {
"id": "<string>",
"brand": "<string>",
"last4": "<string>",
"customerId": "<string>"
},
"healthFundCardId": "<string>",
"healthFundCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"healthFundId": "<string>",
"healthFund": {
"name": "<string>",
"capabilities": {}
},
"cardholders": [
{
"referenceNumber": "<string>",
"name": "<string>"
}
],
"fingerprint": "<string>",
"verified": true,
"defaultReferenceNumber": "<string>",
"issueNumber": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"medicareCardId": "<string>",
"medicareCard": {
"id": "<string>",
"memberNumberLast4": "<string>",
"referenceNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"fingerprint": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"verified": true,
"secondInitial": "<string>",
"sex": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"bookingId": "<string>",
"clientName": "<string>",
"client": {
"id": "<string>",
"deleted": true,
"createdAt": "2023-11-07T05:31:56Z",
"memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "<string>",
"mobileNumber": "<string>",
"email": "<string>",
"pmsPatientId": "<string>",
"pmsCreatedAt": "2023-11-07T05:31:56Z",
"profileImageUrl": "<string>"
},
"serviceProvider": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"locationIds": [
"<string>"
],
"deleted": true,
"bookingsEnabled": true,
"mobileNumber": "<string>",
"email": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"profileImageUrl": "<string>",
"locationLinks": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"deleted": true,
"acceptedTerms": true,
"categoryCode": "<string>",
"medicare": {
"suggestedProviderNumber": "<string>",
"providerNumber": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"registrationLetterFileId": "<string>"
},
"association": {
"registrationLetterFileId": "<string>"
}
}
],
"locations": [
{
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
}
],
"registrations": [
{
"id": "<string>",
"providerId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"ndis": {
"providerNumber": "<string>"
},
"medicare": {
"providerNumber": "<string>"
},
"phi": {
"providerNumber": "<string>"
}
}
]
},
"location": {
"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>"
},
"displayName": "<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>",
"merchantId": "<string>",
"capabilities": [
{}
],
"events": {},
"websiteUrl": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"suburb": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"countryCode": "<string>"
}
},
"email": "<string>",
"registrations": [
{
"medicare": {
"minorId": "<string>",
"prodaLocationId": "<string>",
"providerAgreementSubmissionUrl": "<string>",
"isUsingOtherClaimSoftware": true
},
"phi": {
"phiLocationId": "<string>",
"status": "<string>"
}
}
],
"organisationId": "<string>",
"organisation": {
"id": "org_31XEcUshz1ymodA14HALnyP48g1",
"name": "Acme Healthcare",
"slug": "acme-healthcare",
"createdAt": "2023-01-15T10:30:00Z",
"bookingsEnabled": true,
"brandImageUrl": "https://example.com/brand-image.png",
"wordmarkImageUrl": "https://example.com/wordmark-image.png",
"websiteUrl": "https://example.com"
},
"isBookable": true
},
"clientPlanId": "<string>"
},
"pmsBookingId": "<string>",
"pmsAttendeeId": "<string>"
}Path Parameters
The organisation ID
Example:
"org_31XEcUshz1ymodA14HALnyP48g1"
Body
application/json
Location ID
Example:
"27"
Provider ID
Example:
"54"
Appointment type ID
Example:
"280"
Appointment time
Example:
"2025-01-01T10:00:00Z"
Show child attributes
Show child attributes
Notes
Maximum string length:
1000Example:
"Sore back for 4 weeks"
When set, redeem this plan booking credit (session) to cover the booking instead of taking card payment.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
201 - application/json
Show child attributes
Show child attributes
Available options:
confirmed, cancelled Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
pms, halth, unknown Show child attributes
Show child attributes
Normalised attribute tags for the booking
Available options:
transaction_awaiting_payment, payment_method_available, health_fund_card_available Available options:
did_not_arrive, arrived Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
