Skip to main content

API R19

· 2 min read
Craig Herrington

Release 19 of the API includes 1 new endpoints and 11 changes to an existing endpoints.

Release Date

The UAT API will be updated the week of 14-April-2025.

The Live API release date is TBC (expected w/c 21-April-2025)

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

View Billing Spec

Billing​

CHANGE GET /v1/api/invoices/invoice-contents/deleted

  • New query parameter location-uuid added for filtering.

CHANGE GET /v1/api/invoices/invoice-contents

  • New query parameter location-uuid added for filtering.
View Clinical Spec

Clinical​

NEW POST /v1/api/billable-records/manual-no-cost

  • This new endpoint allows the addition of a zero cost ad-hoc treatment to pre-invoice; This record type will appear on the invoice and can be used to provide some additional treatment context.

CHANGE POST /v1/api/billable-records

  • billing-uuid is now optional; this will auto-resolve based on patient-uuid.
  • sell-as-wholepack field has been added with default: false
  • Removed some unused fields marked for future use.

CHANGE POST /v1/api/clinical-notes

  • Now includes validation for special "Prospect" account types as these are not allowed clinical notes.
  • Use of this endpoint will trigger a UI refresh within Merlin.

CHANGE PATCH /v1/api/clinical-notes

  • location-uuid has been removed from the field list.
  • Use of this endpoint will trigger a UI refresh within Merlin.

CHANGE DELETE /v1/api/clinical-notes

  • Use of this endpoint will trigger a UI refresh within Merlin.
View Formulary Spec

Formulary Management​

CHANGE GET /v1/api/stock & /v1/api/stock/:formulary-uuid

  • manufacturer-uuid added to GET methods.
View Patient Spec

Patient Management​

CHANGE POST /v1/api/patient

  • status-food-chain is now nullable; a NULL value means unknown.

CHANGE PATCH /v1/api/patient

  • status-food-chain is now nullable; a NULL value means unknown.

CHANGE GET /v1/api/patient

  • status-food-chain is now nullable; a NULL value means unknown.

If you have any questions please contact us.