Skip to main content

API R25

· 2 min read
Craig Herrington

Release 25 of the API includes 1 new endpoint and changes to 6 existing endpoints.

Release Date

The UAT API will be updated the on 20-Oct-2025.

The Live API release date is 29-Oct-2025.

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

View Billing Spec

Billing​

NEW POST /v1/api/refunds/return-amount

  • A new endpoint to record a refund into the client account, this can be used for accounts in credit or debit.

CHANGE POST /v1/api/payments

  • Optional field operator allows for the username to be recorded against the payment.
  • Backend change when saving to the database, the note will now be appended to the payment description.

CHANGE GET /v1/api/payments & /v1/api/payments/:payment-uuid

  • payment-method-uuid was returning the wrong value, this has been corrected.
View Calendar Spec

Calendar Management​

CHANGE GET /v1/api/availability/:location-uuid/available

  • To align to a change made within Merlin, a practitioner marked as "on holiday" will be unavailable across all locations.
View Patient Spec

Patient Management​

CHANGE GET /v1/api/genders

  • Endpoints have been incorrectly returning non-animal genders on these endpoints and they are now excluded.

This change also affects:

  • GET /v1/api/genders/:gender-uuid
  • GET /v1/api/species/:species-uuid/genders

If you have any questions please contact us.