Release Notes

ezyVet version 43.9

v1/externalprescription endpoint

Changes to:

• PATCH /v1/externalprescription

Overview

• date_of_prescription Is No Longer Required

  • API users are no longer required to include the date_of_prescription field when performing a PATCH request on an existing prescription record.
  • PATCH requests without date_of_prescription will continue to function as expected.
  • This change reduces the need for clients to pass through unchanged values.

• date_of_prescription Will Be Ignored if Provided If a PATCH request includes the date_of_prescription parameter:

  • The system will accept the request without throwing validation errors.
  • However, the value will not be used to update the prescription record.
  • The original prescription date will remain unchanged.

Reason for Change

This update prevents accidental modification of the original prescription date, ensuring data integrity while maintaining backward compatibility for clients who continue sending the field.

Impact on Clients

No action is required for existing integrators.

API users may continue to include date_of_prescription in PATCH requests, but should no longer rely on it for updates.

ezyVet version 43.8

v1/externalprescription endpoint

Changes to:

• POST /v1/externalprescription
• PATCH /v1/externalprescription

Data Model Changes

• New attribute: external_prescription_item_list.date_of_lastdispense INT NULL
• New attribute: external_prescription_item_list.status ENUM NULL
  • CANCELLED_DR,DECLINED_DR,CANCELLED_CLIENT,DECLINED_CLIENT,PENDING,CURRENT
• New attribute: external_prescription_item_list.status_date INT NULL

POST Rules

• Client payload must NOT include item external_prescription_item_list.status or external_prescription_item_list.status_date.

If present → error: "status or status_date are not allowed on POST, use PATCH instead."

• If item date_of_lastdispense is present (or backfilled by root): status = CURRENT; status_date = item’s date_of_lastdispense.

Otherwise: status = PENDING; status_date = date_of_prescription.

PATCH Rules

• If no item provides a status, at least one item must provide date_of_lastdispense; otherwise:

  • Error: "date_of_lastdispense is required when status is not provided."
  • Important: If any item provides Declined/Cancelled status, the above per-item date_of_lastdispense requirement is not enforced for items without status (partial updates accepted).

• Allowed statuses on PATCH: DECLINED_DR, DECLINED_CLIENT, CANCELLED_DR, CANCELLED_CLIENT

• status_date: Required and numeric when status is Declined or Cancelled.

• Error: "status_date is required and must be numeric when status is Declined or Cancelled."

Status transition rules (per item):

• Determination of current (from) status is based on matching the item’s external_product_reference to the existing active externalprescriptionitem row.

• Declined allowed only from Pending or null. Error: "Only Pending items can be changed to Declined."

• Cancelled allowed only from Current.Error: "Only Dispensed items can be changed to Cancelled."

• If client provides root date_of_lastdispense: only items with empty date_of_lastdispense get the root date.

Deprecation

• Root-level date_of_lastdispense is deprecated; continue supporting for backward compatibility.
• date_of_lastdispense is optional on POST; conditionally required on PATCH only when no status is provided anywhere.
• Prefer using item-level date_of_lastdispense.

ezyVet version 42.9

V2 API

• Updated the Wellness Plan Membership V2 endpoint:
  • Added support for reference (payment reference) as a query parameter.
  • Enhanced PATCH operation to support status for locking memberships.

ezyVet version 42.7

V1 API

• Updated the blood_pressure field in the HealthStatus V1 endpoints to accept both num & string instead of num for GET, POST, and PATCH operations.

ezyVet version 42.4

V2 API

• Added hospital_uid field to the Separation V2 endpoint when returning department ownership separations.

ezyVet version 42

V2 API

• Added ownership_id and ownership_uid fields to the Product Supplier endpoint.

ezyVet version 41.7

V2 API

• Added type query parameter to the Separation V2 endpoint.
  • Use the type query parameter to query Separation V2 records by type.

ezyVet version 40.3

V1 API

• Added External Prescription DELETE endpoint.

ezyVet version 40.2

V1 API

• Added External Prescription POST and PATCH endpoint.

ezyVet version 40

V2 API

• Exposed GET endpoint for Estimate V2

ezyVet version 39.6

• Exposed GET endpoint for Resource V2 endpoint.
• Exposed GET endpoint for Separation V2 endpoint.

ezyVet version 39.0

V1 API

• Added date_of_birth field to the Contact V1 endpoint.
• Added driver_license_number field to the Contact V1 endpoint.
• Added driver_license_ field to the Contact V1 endpoint.
• Added driver_license_ field to the Contact V1 endpoint.
• Added serial_number field to the PrescriptionItem V1 endpoint.

ezyVet version 38.6

V2 API

• Exposed GET endpoint for Prescription V2.
• Exposed GET and POST endpoint for Contactdetail V2.
• Updated GET for GET endpoint for Contact V2.

ezyVet version 38.1

V2 API

• Exposed GET endpoint for Contact V2.

ezyVet version 37.9

V2 API

• Exposed GET endpoint for Appointment Type V2
• Universal identifiers have been added to Appointment Type V2

ezyVet version 37.5

V1 API

• Exposed POST and PATCH for the vaccination endpoint, partners will now be able to use these operations.
• Added value_cleaned field to the contactdetail endpoint.
  • Use the value_cleaned field to find the value of a ContactDetail where prefixes are added and special characters are stripped from phone numbers.
  • Use the value_cleaned query parameter to query ContactDetail records by phone numbers without any special characters or formatting.

ezyVet version 36.8

V1 API

• Exposed POST, PATCH and DELETE for the address endpoint, partners will now be able to use these operations.

V2 API

• Added validation to appointment V2 endpoint to check that the query has the sales_resource present in the list of resources when attempting to POST or PATCH.

ezyVet version 36.7

V1 and V2 API

• Added the barcode endpoint
  • Use the for_type to find the type of record that the Barcode is for. EG: "product".
  • Use the for_id to find the ID of the record that the Barcode is for.
• Added the website field to the contact endpoint

ezyVet version 36.6

V1 API

• Added contact_id to the separation endpoint.

ezyVet version 36.4

V1 and V2 API

• Added a date field to the invoiceline and invoicelineV2 endpoints.
  • Use the date field to know the date the the product on the invoiceline was administered on the related clinical record.
• Added preferred and subscription_groups fields to the contactdetail endpoint.
  • Use the preferred field to find which ContactDetail is a preferred contact method for the related Contact
  • Use the subscription_groups field to find a list of subscription groups that the ContactDetail is subscribed

ezyVet version 36.2

V2 API

• When you change an ezyVet Go calendar, the applicable changes sync to ezyVet
• Added the expected_price field to the productsupplier endpoint
• You can update product prices that have a maximum of four digits after the decimal point.
• Added a date field to the stocktransaction endpoint.
  • Use the date field to know the date of an inventory transaction.

ezyVet version 36.1

V2 API

• Increased the possible inventory locations that you can use with the invoiceline endpoint.

ezyVet version 35.9

V2 API

• Fixed an issue where Email/SMS communications created by the API wouldn't send

ezyVet version 35.4

V1 API

• Fixed an issue where the invoice was not showing credit invoices as linked records.
  • The linked_payments field now also shows credit invoices with a new parameter type specifying invoice or payment.

V2 API

• Added the linked_payments field to the invoiceV2 endpoint