Skip to main content
GET
/
v1
/
organisations
/
{organisationId}
/
bookings
List bookings
curl --request GET \
  --url https://api.halth.com/v1/organisations/{organisationId}/bookings
{
  "items": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "locationId": "<string>",
      "status": "confirmed",
      "providerId": "<string>",
      "provider": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "locationIds": [
          "<string>"
        ],
        "deleted": true,
        "mobileNumber": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "title": "Dr",
        "profileImageUrl": "<string>",
        "locationLinks": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "providerId": "<string>",
            "locationId": "<string>",
            "deleted": true,
            "acceptedTerms": true,
            "registrationStatus": "not_started",
            "applicationStatus": "not_started",
            "serviceTypeCode": "<string>",
            "categoryCode": "<string>",
            "medicare": {
              "suggestedProviderNumber": "<string>",
              "providerNumber": "<string>",
              "startDate": "2023-11-07T05:31:56Z",
              "registrationLetter": "<string>"
            },
            "association": {
              "registrationLetter": "<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>"
            },
            "suggestedTaxIdentifier": "<string>",
            "bookingCustomText": "<string>",
            "businessId": "<string>",
            "business": {
              "id": "<string>",
              "name": "<string>",
              "settings": {
                "autoReconciliationEnabled": true
              },
              "taxIdentifier": "<string>",
              "countryCode": "<string>",
              "structure": "public_corporation",
              "merchantId": "<string>",
              "capabilities": [
                {
                  "id": "bookings_client_management",
                  "status": "inactive"
                }
              ]
            }
          }
        ]
      },
      "appointmentTypeId": "<string>",
      "serviceDate": "2023-11-07T05:31:56Z",
      "client": {
        "id": "<string>",
        "deleted": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "dateOfBirth": "<string>",
        "mobileNumber": "<string>",
        "email": "<string>",
        "source": "pms",
        "pmsPatientId": "<string>",
        "pmsCreatedAt": "2023-11-07T05:31:56Z",
        "profileImageUrl": "<string>"
      },
      "clientId": "<string>",
      "source": "pms",
      "paid": true,
      "invoiced": true,
      "adjustments": [
        {
          "id": "<string>",
          "amount": 123,
          "balanceEffectIndicator": 123,
          "type": "provider_funding",
          "description": "<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>"
        },
        "suggestedTaxIdentifier": "<string>",
        "bookingCustomText": "<string>",
        "businessId": "<string>",
        "business": {
          "id": "<string>",
          "name": "<string>",
          "settings": {
            "autoReconciliationEnabled": true
          },
          "taxIdentifier": "<string>",
          "countryCode": "<string>",
          "structure": "public_corporation",
          "merchantId": "<string>",
          "capabilities": [
            {
              "id": "bookings_client_management",
              "status": "inactive"
            }
          ]
        }
      },
      "arrivalStatus": "did_not_arrive",
      "appointmentType": {
        "id": "<string>",
        "name": "<string>",
        "durationMinutes": 123,
        "price": 123,
        "type": "individual",
        "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,
            "type": "service",
            "id": "<string>",
            "itemCode": "<string>",
            "pmsBillableItemId": "<string>"
          }
        ]
      },
      "servicePrice": 123,
      "cancelledAt": "2023-11-07T05:31:56Z",
      "healthFundCard": {
        "id": "<string>",
        "memberNumberLast4": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "healthFundId": "<string>",
        "healthFund": {
          "id": "<string>",
          "name": "<string>",
          "capabilities": {
            "claims": "active",
            "rebatesEstimates": "active"
          }
        },
        "cardholders": [
          "<string>"
        ],
        "fingerprint": "<string>",
        "defaultReferenceNumber": "<string>",
        "issueNumber": "<string>"
      },
      "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,
        "registrationStatus": "not_started",
        "applicationStatus": "not_started",
        "serviceTypeCode": "<string>",
        "categoryCode": "<string>",
        "medicare": {
          "suggestedProviderNumber": "<string>",
          "providerNumber": "<string>",
          "startDate": "2023-11-07T05:31:56Z",
          "registrationLetter": "<string>"
        },
        "association": {
          "registrationLetter": "<string>"
        }
      },
      "cancellationPolicy": {
        "enabled": true,
        "rules": {
          "clientCancel": {
            "enabled": true,
            "reason": "booking_paid"
          },
          "clientReschedule": {
            "enabled": true,
            "reason": "booking_paid"
          }
        },
        "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",
        "status": "pending",
        "amount": 123,
        "currency": "<string>",
        "paymentTransactions": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "source": "<string>",
            "amount": 123,
            "status": "pending",
            "paymentId": "<string>",
            "payment": {},
            "claimId": "<string>",
            "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"
              }
            }
          }
        ],
        "transactionItems": [
          {
            "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>"
          }
        ],
        "confirmations": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "contactType": "mobile",
            "contactValue": "<string>",
            "verified": true,
            "action": "claim_confirmation",
            "expiresAt": "2023-11-07T05:31:56Z",
            "verificationCode": "<string>",
            "verifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "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": {
            "id": "<string>",
            "name": "<string>",
            "capabilities": {
              "claims": "active",
              "rebatesEstimates": "active"
            }
          },
          "cardholders": [
            "<string>"
          ],
          "fingerprint": "<string>",
          "defaultReferenceNumber": "<string>",
          "issueNumber": "<string>"
        },
        "bookingId": "<string>",
        "customer": {
          "name": "<string>"
        }
      },
      "pmsBookingId": "<string>",
      "pmsAttendeeId": "<string>"
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Path Parameters

organisationId
string
required

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

serviceDateMin
string<date-time>
serviceDateMax
string<date-time>
cancelledAtMin
string<date-time>
clientId
string
pmsBookingId
string
paid
boolean
invoiced
boolean
status
enum<string>[]
Available options:
confirmed,
cancelled
expand
enum<string>[]
Available options:
paymentMethod,
healthFundCard,
cancellationPolicy,
latestTransaction,
latestTransaction.transactionItems.billableItem,
location.business.capabilities,
providerLocationLink,
pmsAttendeeId
location
string[]

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10