# HaltH

## Docs

- [List appointment types](https://docs.halth.com/api-reference/appointment-type/list-appointment-types.md): Get a paged list of appointment types for an organisation
- [Create bank account](https://docs.halth.com/api-reference/bank-account/create-bank-account.md): Create a new bank account for a business
- [Get decrypted bank account data](https://docs.halth.com/api-reference/bank-account/get-decrypted-bank-account-data.md): Get decrypted bank account data for a business
- [List bank accounts](https://docs.halth.com/api-reference/bank-account/list-bank-accounts.md): Get a paged list of bank accounts for a business
- [List billable items](https://docs.halth.com/api-reference/billable-item/list-billable-items.md): Get a paged list of billable items
- [Reconcile booking](https://docs.halth.com/api-reference/booking-reconciliation/reconcile-booking.md): Reconcile a booking. Write an invoice into the connected PMS. For Cliniko, the booking will simply be marked as invoiced.
- [Get booking settings](https://docs.halth.com/api-reference/booking-settings/get-booking-settings.md): Get the booking settings for an organisation
- [Update booking settings](https://docs.halth.com/api-reference/booking-settings/update-booking-settings.md): Update the booking settings for an organisation
- [Create booking](https://docs.halth.com/api-reference/booking/create-booking.md): Create a new booking
- [Get booking availability](https://docs.halth.com/api-reference/booking/get-booking-availability.md): Get available dates and times to make a booking
- [Get booking by ID](https://docs.halth.com/api-reference/booking/get-booking-by-id.md): Get a single booking by ID
- [Get booking data](https://docs.halth.com/api-reference/booking/get-booking-data.md): Get a public-facing summary of an organisation, locations, providers, services, and booking settings.
- [List bookings](https://docs.halth.com/api-reference/booking/list-bookings.md): Get a paged list of bookings for an organisation
- [Update booking](https://docs.halth.com/api-reference/booking/update-booking.md): Update an existing booking
- [Create billing session](https://docs.halth.com/api-reference/business-billing/create-billing-session.md): Create a billing session for a business to manage their subscriptions
- [Create subscription](https://docs.halth.com/api-reference/business-billing/create-subscription.md): Create a subscription for a business
- [List subscriptions](https://docs.halth.com/api-reference/business-billing/list-subscriptions.md): List subscriptions for a business
- [Search for a business](https://docs.halth.com/api-reference/business-search/search-for-a-business.md): Search the local business register for a business
- [Retrieve business settings](https://docs.halth.com/api-reference/business-settings/retrieve-business-settings.md): Retrieve the settings for a business
- [Update business settings](https://docs.halth.com/api-reference/business-settings/update-business-settings.md): Update the settings for a business
- [Create business](https://docs.halth.com/api-reference/business/create-business.md): Create a new business
- [Get business by ID](https://docs.halth.com/api-reference/business/get-business-by-id.md): Get a single business by ID
- [Get business capabilities](https://docs.halth.com/api-reference/business/get-business-capabilities.md): Describes the availablility and status of business features
- [List businesses](https://docs.halth.com/api-reference/business/list-businesses.md): Get a paged list of businesses for an organisation
- [Send business notification](https://docs.halth.com/api-reference/business/send-business-notification.md): Send a notification to the business owner
- [Update business](https://docs.halth.com/api-reference/business/update-business.md): Update an existing business
- [List calendar events](https://docs.halth.com/api-reference/calendar-event/list-calendar-events.md): Get a paged list of bookings for an organisation
- [Invite a client to a business](https://docs.halth.com/api-reference/client-invites/invite-a-client-to-a-business.md): Invite a client to a business
- [Create client health fund card](https://docs.halth.com/api-reference/client-wallet/create-client-health-fund-card.md): Create health fund card and attach to client
- [Create client payment method](https://docs.halth.com/api-reference/client-wallet/create-client-payment-method.md): Create payment method and attach to client
- [Create client wallet card](https://docs.halth.com/api-reference/client-wallet/create-client-wallet-card.md): Create a new wallet card for the client
- [Delete client wallet card](https://docs.halth.com/api-reference/client-wallet/delete-client-wallet-card.md): Delete a wallet card from the client
- [Get client wallet](https://docs.halth.com/api-reference/client-wallet/get-client-wallet.md): Get wallet for client
- [Create client](https://docs.halth.com/api-reference/client/create-client.md): Create a new client in the organisation. The client will be created in the PMS system if available.
- [Create client referral](https://docs.halth.com/api-reference/client/create-client-referral.md): Create a new referral for a client.
- [Get client by ID](https://docs.halth.com/api-reference/client/get-client-by-id.md)
- [List client referrals](https://docs.halth.com/api-reference/client/list-client-referrals.md): Get a paged list of referrals for a client
- [List clients](https://docs.halth.com/api-reference/client/list-clients.md): Get a paged list of clients for an organisation
- [Update client](https://docs.halth.com/api-reference/client/update-client.md)
- [List credit transactions](https://docs.halth.com/api-reference/credits/list-credit-transactions.md): List the credit transactions for a business
- [Retrieve credit balance](https://docs.halth.com/api-reference/credits/retrieve-credit-balance.md): Retrieve the credit balance for a business
- [List providers](https://docs.halth.com/api-reference/external-provider/list-providers.md): Get a paged list of external providers for an organisation
- [Create funding estimate](https://docs.halth.com/api-reference/funding/create-funding-estimate.md): Check all available funding sources with the details provided.
- [Create health fund card](https://docs.halth.com/api-reference/health-fund-card/create-health-fund-card.md): Create a new health fund card for private health insurance claiming.
- [List health funds](https://docs.halth.com/api-reference/health-fund/list-health-funds.md): Get a paged list of all health funds
- [Health check](https://docs.halth.com/api-reference/health/health-check.md): Check the status of the service
- [Create a new location](https://docs.halth.com/api-reference/location/create-a-new-location.md): Create a new location and allcoate a Minor ID.
- [Create registration](https://docs.halth.com/api-reference/location/create-registration.md): Create a registration for a location
- [Get a location by ID](https://docs.halth.com/api-reference/location/get-a-location-by-id.md): Get a location by ID.
- [Get a paged list of locations](https://docs.halth.com/api-reference/location/get-a-paged-list-of-locations.md): Get a paged list of locations.
- [Get location](https://docs.halth.com/api-reference/location/get-location.md): Get a location for an organisation
- [List locations](https://docs.halth.com/api-reference/location/list-locations.md): Get a paged list of locations for an organisation
- [Update location](https://docs.halth.com/api-reference/location/update-location.md): Update a location for an organisation
- [Update registration](https://docs.halth.com/api-reference/location/update-registration.md): Update a registration for a location
- [Create Medicare card](https://docs.halth.com/api-reference/medicare-card/create-medicare-card.md): Create a new Medicare card for Medicare claiming.
- [List Medicare cards](https://docs.halth.com/api-reference/medicare-card/list-medicare-cards.md): Get a paged list of Medicare cards.
- [Verify an existing Medicare card](https://docs.halth.com/api-reference/medicare-card/verify-an-existing-medicare-card.md): Verify an existing Medicare card.
- [Cancel a Medicare claim](https://docs.halth.com/api-reference/medicare-claim/cancel-a-medicare-claim.md): Cancel a Medicare claim
- [Create a Medicare claim](https://docs.halth.com/api-reference/medicare-claim/create-a-medicare-claim.md): Create a Medicare claim for a patient
- [Create a Medicare claim statement](https://docs.halth.com/api-reference/medicare-claim/create-a-medicare-claim-statement.md): Create a Medicare claim statement
- [List Medicare claims](https://docs.halth.com/api-reference/medicare-claim/list-medicare-claims.md): Get a paged list of Medicare claims
- [Resubmit a Medicare claim](https://docs.halth.com/api-reference/medicare-claim/resubmit-a-medicare-claim.md): Resubmit a Medicare claim for manual review
- [Submit a Medicare claim](https://docs.halth.com/api-reference/medicare-claim/submit-a-medicare-claim.md): Submit a Medicare claim that was previously created but not submitted
- [List service items](https://docs.halth.com/api-reference/medicare-service-item/list-service-items.md): Get a paged list of service items
- [Update service items](https://docs.halth.com/api-reference/medicare-service-item/update-service-items.md): Update the new list of service items
- [List Medicare card verifications](https://docs.halth.com/api-reference/medicare-verification/list-medicare-card-verifications.md): List all verifications for a Medicare card.
- [Verify medicare card](https://docs.halth.com/api-reference/medicare-verification/verify-medicare-card.md): Verify a Medicare card details. Card details will not be saved for future use.
- [Cancel booking](https://docs.halth.com/api-reference/member-booking/cancel-booking.md): Cancel a booking
- [Get booking receipt](https://docs.halth.com/api-reference/member-booking/get-booking-receipt.md): Get the transaction receipt for a booking
- [List member bookings](https://docs.halth.com/api-reference/member-booking/list-member-bookings.md): Get a paged list of bookings for a member
- [List past member bookings](https://docs.halth.com/api-reference/member-booking/list-past-member-bookings.md): Get a paged list of past bookings for a member
- [Update booking](https://docs.halth.com/api-reference/member-booking/update-booking.md): Update an existing booking
- [List health team ](https://docs.halth.com/api-reference/member-features/list-health-team.md): Get a paged list of providers the member has visited
- [Create member health fund card](https://docs.halth.com/api-reference/member-wallet/create-member-health-fund-card.md): Create health fund card and attach to member
- [Create member payment method](https://docs.halth.com/api-reference/member-wallet/create-member-payment-method.md): Create payment method and attach to member
- [Create member wallet card](https://docs.halth.com/api-reference/member-wallet/create-member-wallet-card.md): Create a new wallet card for the member
- [Create payment session](https://docs.halth.com/api-reference/member-wallet/create-payment-session.md): Create a payment session for a member
- [Delete health fund card](https://docs.halth.com/api-reference/member-wallet/delete-health-fund-card.md): Delete a health fund card from the member wallet
- [Delete member wallet card](https://docs.halth.com/api-reference/member-wallet/delete-member-wallet-card.md): Delete a wallet card from the member wallet
- [Get member wallet](https://docs.halth.com/api-reference/member-wallet/get-member-wallet.md): Get wallet for a member
- [List member health fund cards](https://docs.halth.com/api-reference/member-wallet/list-member-health-fund-cards.md): List health fund cards for a member
- [Create new member](https://docs.halth.com/api-reference/member/create-new-member.md): Create a new member
- [Delete member](https://docs.halth.com/api-reference/member/delete-member.md): Delete a member
- [Get my member](https://docs.halth.com/api-reference/member/get-my-member.md): Get the member details for the current user
- [Update member](https://docs.halth.com/api-reference/member/update-member.md): Update a member
- [Create merchant](https://docs.halth.com/api-reference/onboarding/create-merchant.md): Create a merchant for a business
- [Create onboarding session](https://docs.halth.com/api-reference/onboarding/create-onboarding-session.md): Create an onboarding session for a business
- [List organisation members](https://docs.halth.com/api-reference/organisation-member-link/list-organisation-members.md): Get a paged list of organisation members
- [Create organisation](https://docs.halth.com/api-reference/organisation/create-organisation.md): Create a new organisation
- [Delete organisation](https://docs.halth.com/api-reference/organisation/delete-organisation.md): Delete a single organisation by ID
- [Get organisation](https://docs.halth.com/api-reference/organisation/get-organisation.md): Get a single organisation by ID
- [List organisations](https://docs.halth.com/api-reference/organisation/list-organisations.md): Get a paged list of organisations
- [Update organisation](https://docs.halth.com/api-reference/organisation/update-organisation.md): Update a single organisation by ID
- [Create payment method](https://docs.halth.com/api-reference/payment-method/create-payment-method.md): Create a new payment method
- [Create payout session](https://docs.halth.com/api-reference/payout/create-payout-session.md): Create a payout session for a business
- [Create PMS integration](https://docs.halth.com/api-reference/pms-integration/create-pms-integration.md): Create a new PMS integration. The API key will be validated with the PMS and data will be synced asynchronously.
- [List PMS integrations](https://docs.halth.com/api-reference/pms-integration/list-pms-integrations.md): Get a paged list of PMS integrations for an organisation
- [Sync PMS integration](https://docs.halth.com/api-reference/pms-integration/sync-pms-integration.md): Trigger a sync of the PMS integration data. This action will be queued and executed asynchronously.
- [List all devices](https://docs.halth.com/api-reference/proda-device/list-all-devices.md): Get a paged list of devices.
- [List provider funding rules](https://docs.halth.com/api-reference/provider-funding-rule/list-provider-funding-rules.md): List all provider funding rules for an organisation
- [Update provider funding rules](https://docs.halth.com/api-reference/provider-funding-rule/update-provider-funding-rules.md): Update provider funding rules for an organisation
- [Get provider](https://docs.halth.com/api-reference/provider/get-provider.md): Get a single provider by ID
- [List providers](https://docs.halth.com/api-reference/provider/list-providers.md): Get a paged list of providers for an organisation
- [Update provider](https://docs.halth.com/api-reference/provider/update-provider.md): Update a provider
- [Update provider location link](https://docs.halth.com/api-reference/provider/update-provider-location-link.md): Update a provider location link
- [Create a rebate estimate](https://docs.halth.com/api-reference/rebate-estimate/create-a-rebate-estimate.md): Create a rebate estimate for a list of items
- [Get v1receiptstransactions](https://docs.halth.com/api-reference/receipt/get-v1receiptstransactions.md)
- [List service items](https://docs.halth.com/api-reference/service-item/list-service-items.md): Item that can be claimed with Medicare or Private Health Insurance
- [Get transaction reconciliation](https://docs.halth.com/api-reference/transaction-reconciliation/get-transaction-reconciliation.md)
- [Confirm transaction](https://docs.halth.com/api-reference/transaction/confirm-transaction.md): Confirm a transaction
- [Create claim for transaction](https://docs.halth.com/api-reference/transaction/create-claim-for-transaction.md): Create a claim for a transaction
- [Create transaction](https://docs.halth.com/api-reference/transaction/create-transaction.md): Create a new transaction
- [Get transaction by ID](https://docs.halth.com/api-reference/transaction/get-transaction-by-id.md): Get a transaction by ID
- [List transactions](https://docs.halth.com/api-reference/transaction/list-transactions.md): Get a paged list of transactions for a business
- [Request confirmation for transaction](https://docs.halth.com/api-reference/transaction/request-confirmation-for-transaction.md): Request a confirmation for a transaction from the client
- [Retrieve transaction receipt](https://docs.halth.com/api-reference/transaction/retrieve-transaction-receipt.md): Retrieve the receipt for a transaction
- [Reverse payment transaction](https://docs.halth.com/api-reference/transaction/reverse-payment-transaction.md): Reverse a payment transaction
- [Reverse transaction](https://docs.halth.com/api-reference/transaction/reverse-transaction.md): Reverse a transaction
- [Send transaction receipt](https://docs.halth.com/api-reference/transaction/send-transaction-receipt.md): Send a receipt for a transaction
- [Get user auth details](https://docs.halth.com/api-reference/user/get-user-auth-details.md)
- [Embed](https://docs.halth.com/embed/overview.md)
- [Licence Terms](https://docs.halth.com/legal/api/license-terms.md): Last Updated: October 2025
- [Privacy Policy](https://docs.halth.com/legal/platform/privacy-policy.md): Last Updated: May 2025
- [Terms of Service](https://docs.halth.com/legal/platform/terms-of-service.md): Last updated: December 2025
- [Analytics](https://docs.halth.com/platform/guides/booking-analytics.md): Set up conversion tracking for your booking page.
- [Creating a booking](https://docs.halth.com/platform/guides/booking-create.md)
- [Verify a client](https://docs.halth.com/platform/guides/client-verfication-create.md)
- [Creating a funding estimate](https://docs.halth.com/platform/guides/funding-estimate-create.md)
- [Introduction](https://docs.halth.com/platform/guides/introduction.md)
- [Member authentication](https://docs.halth.com/platform/guides/member-authentication.md)
- [Create a Transaction](https://docs.halth.com/platform/guides/transaction-create.md)

## OpenAPI Specs

- [api-yaml](https://api.halth.com/v1/api-yaml)
- [openapi](https://docs.halth.com/medicare/openapi.yaml)