Billing​

NEW GET /v1/api/payment-terms & /v1/api/payment-terms/:payment-term-uuid

• Retrieve payment terms. The list endpoint supports optional query parameter is-active to filter by active status.
• Some default payment terms exist in the system but are not active by default; use is-active to include or exclude them as needed.
• Each payment term includes payment-term-uuid, term-code, term-name, term-days, end-of-month, and is-active.

CHANGE POST /v1/api/payments

• Optional fields allocation-insured and allocation-uninsured added. When supplied, the payment is allocated only to the specified insured and uninsured amounts. Both values can be provided.

CHANGE GET /v1/api/invoices & /v1/api/:billing-uuid/invoices

• New query filters: contact-uuid, due-date-start, due-date-end, modified-date-start, modified-date-end, and unpaid-only.
• Results can now include deleted invoices. Query parameter deleted supports IncludeDeleted, ExcludeDeleted, and DeletedOnly. The dedicated deleted-invoices endpoint will be deprecated in a future release.
• Query parameter has-balance-on filters by balance type: Invoice (any outstanding balance on the invoice), Uninsured (outstanding uninsured balance), or Insured (outstanding insured balance).
• Invoice responses now include invoice-due-date, payment-term-uuid, payment-term-name, contact-uuid, location-uuid, balance-outstanding, balance-insured, balance-uninsured, and deleted-date.

CHANGE GET /v1/api/invoices/:invoice-uuid

• Invoice responses now include invoice-due-date, payment-term-uuid, payment-term-name, contact-uuid, location-uuid, balance-outstanding, balance-insured, balance-uninsured, and deleted-date, including when the invoice has been deleted.

If you have any questions please contact us.

Account Management​

CHANGE GET /v1/api/accounts & /v1/api/accounts/:account-uuid

• The response for each account now includes payment-term-uuid and payment-term-name where payment terms apply.

CHANGE POST /v1/api/accounts

• Optional field payment-term-uuid added. When omitted, the default payment term from the client category may be applied; when supplied, it must reference an existing active payment term.
• Creating an account when the contact is deactivated now returns HTTP 422 with message Contact is deactivated.
• Creating an account when an account already exists for that contact (including when the contact is deactivated) now returns HTTP 422 with message An account already exists for contact instead of overwriting the existing account.

CHANGE PATCH /v1/api/accounts/:account-uuid

• Optional field payment-term-uuid added. When supplied, it must be an active payment term.

Billing​

NEW POST /v1/api/subscriptions/end

• Ends an active pet health care plan subscription for a patient on an account. Where money is still owed on the plan, write-off details can be supplied to close out the balance.

NEW POST /v1/api/subscriptions/suspend

• Suspends or resumes a pet health care plan subscription.

CHANGE GET /v1/api/subscriptions

• Optional query parameter include-balance added (default false). Set it true to include pet-plan-balance on each subscription where applicable for pet health care plans.

If you have any questions please contact us.

Billing​

FIX GET /v1/api/{billing-uuid}/invoices

• Resolved an issue where fully credited invoice items were incorrectly appearing as outstanding when using the unpaid-only filter. The calculation for determining unpaid status now correctly handles credited items.

Contact Management​

CHANGE GET /v1/api/contacts/addresses

• New optional query parameter include-deactivated-contacts added. Default value is true. When set to false, inactive contacts are excluded from results.

This change also affects:

• GET /v1/api/contacts/emails
• GET /v1/api/contacts/notes
• GET /v1/api/contacts/numbers

CHANGE GET /v1/api/contacts/:contact-uuid/communication-preferences

• New optional query parameters communication-type-uuid and communication-channel-uuid added. These allow filtering communication preferences by specific type and channel.

If you have any questions please contact us.

Billing​

FIX GET /v1/api/payments

• Performance improvement for this endpoint with allocation is requested in the response.

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

• Resolved a payment allocation issue

If you have any questions please contact us.

Communication and Documents​

FIX POST /v1/api/documents/upload

• Fixed an issue where some document upload requests could hang indefinitely without completing. This was caused by a change in HTTP client behavior in the underlying framework. The endpoint now properly handles all upload requests and will complete or return an error response in a timely manner.

If you have any questions please contact us.

Billing​

NEW GET /v1/api/insurance/claim-items/patient/:patient-uuid

• A new endpoint to retrieve a list of all insurance items against a patient. Optional query parameter insurance-claim-ref can be provided to filter items by claim reference.
• New scope required: billing-acc:insurance:read

CHANGE GET /v1/api/payments

• The endpoint now excludes returned payments from the response, returning only active payments.

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

• New optional query parameter insurance-claim-ref added. When provided, only invoice contents with a matching insurance claim reference will be returned. A value of 0 will return a 400 error.

Clinical Management​

NEW GET /v1/api/clinical-documents

• A new endpoint to retrieve a list of clinical history documents. Supports optional query parameters for patient-uuid, modified-start, and modified-end for filtering.
• Uses existing scope: clinical:history:read

Communication and Documents​

NEW GET /v1/api/documents/:document-uuid/content

• A new endpoint to retrieve the file content of a document as an octet stream.
• New scope required: document-mgt:docs-contents:read
• Note: This endpoint is rate limited and may return status code 429 (Too Many Requests) if the rate limit is exceeded.

Patient Management​

CHANGE GET /v3/api/patient-subsidy-categories

• Resolved an issue where the V3 API behavior did not align with the Merlin UI.

If you have any questions please contact us.

Multiple Domain Deployment​

• There are changes to the following domains for architectural updates during this release without any schema changes:
  • Account
  • Billing
  • Calendar
  • Clinical
  • Communications
  • Contact
  • Formulary
  • Inventory
  • Location
  • Patient
  • Reminders

Billing​

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

• The endpoint now validates and returns a useful error message when attempting to return a payment that has already been returned, instead of returning a 500 error.

Calendar Management​

CHANGE GET /v1/api/appointments/deleted & /v1/api/tasks/deleted

• Performance improvement when using the include-last-status=true query parameter. The query has been optimized for better performance.

If you have any questions please contact us.

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.

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.

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

Formulary Management​

CHANGE GET /v1/api/services

• This endpoint was incorrectly excluding the discount formulary type, these are now included.

If you have any questions please contact us.

Clinical​

CHANGE GET /v1/api/advanced-prescriptions

• added 2 query parameters: modified-start and modified-end to allow for delta searches

Communication and Documents​

CHANGE POST /v1/api/communications-logs

• Resolved an issue with sent-date not resolving to the current date and time if not provided

Patient Management​

CHANGE POST /v1/api/patients/:patient-uuid/eligibility-activation

• For charity systems this endpoint is now returning the correct messages when the activation limit has been met.

If you have any questions please contact us.

Multiple Domain Deployment​

• There is a change to the following domains for architectural changes during this release without any schema changes:
  • Accounts
  • Billing
  • Clinical
  • Contact
  • Formulary
  • Inventory
  • Location
  • Patient
  • Reminders

Account Management​

CHANGE GET /v1/api/accounts

• The field last-visit-date was incorrectly returning a date for when client details were last checked, this has been corrected in the API as part of this release.
• If you conduct delta checks against modified date, this change will not be updating the modified date.
• A new field last-checked-date has been added which presents the date recorded in Merlin for when a user confirms they last checked the clients details.

Clinical​

CHANGE POST /v1/api/clinical-notes

• Resolved an issue where a protocol question has mandatory free-text with allowed free-text is set to false.

Formulary Management​

CHANGE POST & PATCH /v1/api/service

• Resolved several issues with the discount formulary type entities being submitted via POST and PATCH requests.
• Note: The guidance for "fixed price" discounts now requires the net-price to also be supplied along with the overwrite-price and overwrite-price-enabled fields.

If you have any questions please contact us.

Calendar Management​

CHANGE GET /v1/api/tasks

• added 2 new query parameters:
  • modified-start
  • modified-end
• added field to content booked-date to show when the task was created.

NEW GET /v1/api/tasks/deleted

• New endpoint added to retrieve deleted tasks.

Clinical​

CHANGE POST /v1/api/billable-records

• Added new object to the payload to allow batch submission without specifying the batch-uuid.
  • batch-uuid or batch-manual can be provided not both.
  • batch-uuid and batch-manual are not required.
  • batch-manual object requires the batch-string with batch-expiry-date as optional

Communication and Documents​

CHANGE POST /v1/api/communications-logs

• Resolved an issue with the page and size query parameters were being ignored.

If you have any questions please contact us.

Calendar Management​

CHANGE GET /v1/api/availability/{location-uuid}/available

• Resolved a scenario where a slot containing an appointment booking could be returned as available.

Clinical​

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

• Some validation criteria have been amended to be more flexible.

Communication and Documents​

CHANGE POST /v1/api/communications-logs

• Resolved an issue where communication logs entries were not added if the optional sender-contact-uuid field was not specified.

If you have any questions please contact us.

Authentication Token​

CHANGE POST /oauth/token

• expires_in is now recalculated upon token retrieval from the cache so you can use for token expiry.

Communication and Documents​

NEW POST /v1/api/communication-logs/:log-uuid/status

• This new endpoint will allow recording of the delivery status for each receipient of a communication.

CHANGE POST /v1/api/communications-logs

• content-recipient-cc field added to supply a comma seperated list of receipients copied in communications.
• document-template-uuid field added to supply reference to a template originating from Merlin.
• sender-contact-uuid field added to supply a user's reference for the communication log.
• error-message field added to supply a user friendly message to explain why a communication failed.

Formulary Management​

CHANGE PATCH /v1/api/:formulary-uuid/dispensing-notes

• Corrected the patch method to not be destructive to existing notes; The endpoint will now correctly update or append supplied dispensing notes.

CHANGE GET /v1/api/:formulary-uuid/send-to-actions

• Corrected the GET method to return the uuid values.

If you have any questions please contact us.

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.

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.

Formulary Management​

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

• manufacturer-uuid added to GET methods.

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.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

Communications​

CHANGE POST /v1/api/communication-logs

• New field service-provider-reference is used to store a transaction a unique transaction identifier.

If you have any questions please contact us.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

Clinical​

NEW GET /v1/api/clinical-notes/search

• This now allows searching of saved clinical notes by providing optional parameters from location, dates, patient, practitioner, appointment or account UUID's.

NEW GET /v1/api/clinical-notes

• Retrieve clinical notes by providing a list of clinical note uuid's (max 10).

NEW GET /v1/api/clinical-notes/{clinical-note-uuid}

• Retrieve clinical note by the specific note uuid.

NEW DELETE /v1/api/clinical-notes/{clinical-note-uuid}

• Delete a clinical note by the specific note uuid.

NEW PATCH /v1/api/clinical-notes

• Update the clinical note, this API requires the supply of the modified date of the clinical record to validate your delta of the record is the latest state.

CHANGE POST /v1/api/clinical-notes

• Added additional fields:
  • external-url-key Will restrict ownership of the note to your app, contact MWI Support to register a unique key within the tenant.
  • billing-uuid requirement has been removed.
  • clinical-date is no longer mandatory and will default to the current date and time.
  • answer-free-text has the maximum length defined.

Communications​

NEW GET /v1/api/document-templates/{document-template-uuid}/content

• Response streams the template docx document.

NEW GET /v1/api/sms-templates

• Returns all SMS template content.

NEW GET /v1/api/sms-templates/{sms-uuid}

• Returns the specific SMS template content.

CHANGE GET /v1/api/document-templates

• New ENUM type added for PAYMENT-LINKS

If you have any questions please contact us.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

All Domains​

Framework maintenance across all domains has occured and all services will be updated during this release.

Account Management​

• Maintenance on event messaging; no functional changes with API's.

Billing​

NEW POST /v1/api/payments/payment-methods

• New endpoint allowing the submission of new payment methods.

Calendar Management​

• Maintenance on event messaging; no functional changes with API's.

CHANGE GET /v1/api/availability/{location-uuid}/available

• Resolved a scenario which can cause an internal server error.

Communications and Documents​

CHANGE POST /v1/api/communication-logs

• Resolved internal server error when linking an uploaded document to the communication log.

Contact Management​

NEW GET /v1/api/contact/names

• This new endpoint will allow searching of client's by name using various wildcard options.

If you have any questions please contact us.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

All Domains​

Framework maintenance across all domains has occured and all services will be updated during this release.

Billing​

CHANGE POST /v1/api/payments

• Updated validation with correct error message when invoice-uuid's supplied are not for the supplied billing-uuid.

Calendar Management​

• Improved validation messages when booking appointments, tasks or unavailability for clarity.

CHANGE POST /v1/api/availability

• Added a payload field for unavailability-reason, which when provided will block the entire availability range with unavailble blocks upon creation.

CHANGE DELETE /v1/api/availability

• Added a payload field for delete-unavailability, when true this will delete all blocks at the time of deletion; If false and an unavailability block is present the request will fail.

NEW POST /v1/api/availability/blocks

• New endpoint allow blocking availbility slots to block from usage in appointment booking.

NEW DELETE /v1/api/availability/blocks

• New endpoint allow deletion of availability blocking.

CHANGE POST /v1/api/appointments

• Added a payload field for booked-by

Clinical​

CHANGE GET /v1/api/vital-metric/weight

• Added handling of a internal server error.

Communications and Documents​

CHANGE POST /v1/api/communication-logs

• Resolved internal server error occured when linking an uploaded document to the communication log.

CHANGE POST /v1/api/documents/upload

• Incorrectly returned internal server error will now show correct validation message when unsupported characters are found in the file name.

Contact Management​

NEW GET /v1/api/contact/addresses

• This new endpoint will allow searching of client's by their mailing addresses.
• All query parameters are STARTSWITH operations while searching.

NEW PATCH /v1/api/contact/addresses

• This new endpoint will allow searching of client's by their mailing addresses.
• All query parameters are STARTSWITH operations while searching.

If you have any questions please contact us.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

Billing​

NEW GET /v1/api/:billing-uuid/invoices

• New endpoint to return all invoices for an account with a filter option for unpaid-only.

CHANGE POST /v1/api/payments

• Added new payload field isDeposit to allow recording of payments in advance of treatment without automatic allocation.

Calendar Management​

CHANGE GET /v1/api/appointments/:appointment-uuid/statuses

• Added display-order with priority in ascending order
• Added the denormalised status description.

Clinical​

NEW GET /v1/api/prescriptions/deleted

• New endpoint to retrived deleted product prescriptions (basic prescriptions).

CHANGE GET /v1/api/prescriptions

• Added modified-start and modified-end query parameters.

NEW GET /v1/api/advanced-prescriptions

• New endpoint retrieve a range of advanced prescriptions (active ingredient prescription).

NEW GET /v1/api/advanced-prescriptions/:adv-prescription-uuid

• New endpoint retrieve an advanced prescriptions (active ingredient prescription).

NEW GET /v1/api/advanced-prescriptions/action-history

• New endpoint retrieve the activity on an a range of advanced prescriptions (active ingredient prescription).

NEW GET /advanced-prescriptions/:adv-prescription-uuid/action-history

• New endpoint retrieve the activity on an advanced prescription (active ingredient prescription).

Formulary Management​

CHANGE GET /v1/api/stock

• Added modified-date to the body.

CHANGE GET /v1/api/services

• Added modified-date to the body.

Patient Management​

CHANGE GET /v1/api/patients/{patient-uuid}/eligibility-activation

• A defect 🐛 has been fixed, this was incorrectly responding that eligibility was already active.

Reminders​

NEW GET /v1/api/treatment-reminders/deleted

• A new endpoint which will return deleted treatment reminders (compliance reminders).
• Includes query parameters allowing for delta requests on reminder date and deleted date.

If you have any questions please contact us.

We will continue to release new endpoints, if you have any capabilities you want to see, please speak to us.

All Domains​

• Update to all services from code maintenance.

Billing​

• CHANGE GET /invoices - Added 3 new fields for insured totals (Net, Tax and Gross) where an insurance activity is recorded against the invoice.
• OPTIMISED GET /payments - Performance has been improved when requesting using the modified dates.
• CHANGE GET /subscriptions - Added new modified date query parameters

Calendar Management​

• CHANGE GET /availability - Resolved issued which could present a blocked slot as available.
• CHANGE POST /appointments - Resolved issue which could allow booking of appointment into a blocked slot.
• OPTIMISED GET /appointments - Improved Performance for requests with large results.
• OPTIMISED GET /appointments/deleted - Improved Performance for requests with large results.

Clinical​

• CHANGE GET /vital-metrics/weight - The weight field now allows up to 8 decimal places to be returned for precise conversion.
• CHANGE POST /vital-metrics/weight - The weight field now allows up to 8 decimal places to be submitted for precise conversion.
• CHANGE GET /history - 4 new fields added with label instructions when available:
  • dispense-instruction
  • dispense-additional-information
  • dispense-commence-date
  • dispense-practitioner-uuid
• NEW GET /advanced-prescriptions/suspend-reasons - New endpoint with reasons against advanced prescriptions, this is related to other upcoming advanced prescription endpoints.
• NEW GET /advanced-prescriptions/suspend-reasons/:uuid - New endpoint.

Contact Management​

• CHANGE POST contacts/:uuid/eligibility-registration - Resolved issue for charity eligibility registration causing a 500 error.
• CHANGE GET /contacts/:uuid/data-consent - Now returns all data consent history records not only the 'client terms' records.
• CHANGE GET /contacts/numbers - Multiple changes have been implemented to support international numbers
  • clean-numbers now marked as deprecated but still provides data as before.
  • New fields added:
    • country-iso - Shows the 2 character ISO code for the country.
    • country-code - The country's calling code e.g. 44
    • e164 - The number formatted in e164 format.
    • international - The number formatted in the international format.
    • note - The number field no longer accepted non-numeric characters, these are now stored in this field.
  • number field now shows a formatted number in the national format.
  • Added query parameter search-field which allows you to search by clean-number (default), number and e164 fields.
• CHANGE GET /contacts/:uuid/numbers - Added new fields as above but does not include the query paramter.
• CHANGE POST /contacts/:uuid/numbers - Added new fields and validation requirements:
  • New fields added:
    • country-iso - Optional if e164 number is provided otherwise recommended to supply as system default will be used.
    • e164 - Optional - Will take priority during validation.
    • notes - Optional for any user notes.

Formulary Management​

• CHANGE GET /stock & GET /services - Added query parameters to filter by:
  • code
  • description
  • formulary-type-uuid
  • treatment-category-uuid
  • legal-category-uuid
  • formulary-group-uuid
  • healthplan-group-uuid
  • location-uuid - This will filter out records hidden at this location (location-deviations).
• OPTIMISED GET /location-deviations - Improved performance when filtering with location and/or formulary uuid's.
• CHANGE GET, POST & PATCH /stock - Added new fields for prescription preferences:
  • prescription-instruction-prefix-uuid
  • prescription-measure-uuid
  • prescription-frequency-measure
  • prescription-written-not-allowed
  • prescription-advanced-calculate-dosage
  • prescription-advanced-child-mandatory
  • prescription-advanced-dispense-suggested
  • marketing-authorisation-number
• NEW GET /active-ingredient-measures - New endpoint for measures used for advanced prescriptions.
• NEW GET /active-ingredient-measures/:uuid - New endpoint.
• NEW GET /active-ingredients - New endpoint with active ingredients for advanced prescriptions.
• NEW GET /active-ingredients/:uuid - New endpoint.
• NEW GET /:formulary-uuid/active-ingredients - New endpoint for retrieving active ingredients assigned to a formulary stock record.
• NEW POST /:formulary-uuid/active-ingredients - New endpoint to assigning active ingredients with measures and strengths to a stock record.
• NEW PATCH /:formulary-uuid/active-ingredients/:active-ingredient-uuid - New endpoint to update the active ingredient on the specified stock record.
• NEW DELETE /:formulary-uuid/active-ingredients/:active-ingredient-uuid - New endpoint to remove the ingredient from a stock record.

Patient Management​

• OPTIMISED GET /patients - Improved performance of this endpoint.

If you have any questions please contact us.