Skip to main content

API R32

· 2 min read
Simon Fern

Release 32 of the API includes 7 new endpoints and changes to 3 existing endpoints.

Release Date

The UAT API will be updated on 27-Aug-2026.

The Live API release date is 15-Sep-2026.

Times may change without notice, no downtime of the API is expected.

View Account Spec

Account Management​

NEW GET /v1/api/accounts/notes & /v1/api/accounts/:account-uuid/notes

  • List account notes with pagination. Results are sorted by note-date, most recent first.
  • Optional query parameters search-term and search-operation (equals, contains, startswith, endswith) filter by note content.
  • The account-wide list supports optional include-deactivated to exclude notes for deactivated accounts.

NEW POST /v1/api/accounts/:account-uuid/notes

  • Create an account note for the specified account.

NEW GET /v1/api/accounts/notes/:note-uuid

  • Retrieve a single account note by UUID.

NEW PATCH /v1/api/accounts/notes/:note-uuid

  • Update an account note. Only fields supplied in the request body are changed.

NEW DELETE /v1/api/accounts/notes/:note-uuid

  • Permanently delete an account note.
View Billing Spec

Billing​

NEW GET /v1/api/estimates/patient/:patient-uuid/estimate/:estimate-uuid

  • Retrieve an estimate and its line items for the specified patient.

CHANGE POST /v1/api/payments

  • Optional fields payment-provider and provider-transaction-id added for integrated card payments. Values are persisted on the payment record.
  • payment-provider — reference to the payment processor or service provider, used for practice reporting.
  • provider-transaction-id — unique reference from the payment provider for the transaction, used for reporting purposes.

CHANGE POST /v1/api/refunds/return-payment & /v1/api/refunds/return-amount

  • Optional fields completion-mode, payment-provider, and provider-transaction-id added for provider reporting on integrated refunds.
  • payment-provider — reference to the payment processor or service provider, used for practice reporting.
  • provider-transaction-id — unique reference from the payment provider for the transaction, used for reporting purposes.
  • completion-mode — indicates how the refund was completed, used for practice reporting and matching:
    • REFERENCED — linked to an original payment; no card was required for the refund.
    • UNREFERENCED — not linked to an original payment; a card was presented.
    • OFFLINE — refund recorded for reporting; completed manually through non-integrated workflows.

If you have any questions please contact us.