{ "components": { "schemas": { "APIConnectFileStatus": { "enum": [ "PENDING", "SUCCESS", "ERROR" ], "title": "APIConnectFileStatus", "type": "string" }, "AddressDetailPathParamsSchema": { "description": "Schema for the AddressDetailExternalAPIController path parameters", "properties": { "address_id": { "description": "The ID of the address.", "title": "Address Id", "type": "integer" } }, "required": [ "address_id" ], "title": "AddressDetailPathParamsSchema", "type": "object" }, "AddressListQueryParamsSchema": { "description": "Schema for the AddressListExternalAPIController query parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to addresses for the clinic client with this ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to addresses for the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Filter by active status. Defaults to true (only active addresses). Set to false to include only deactivated addresses, or omit to return all regardless of active status.", "title": "Is Active" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "AddressListQueryParamsSchema", "type": "object" }, "AppointmentAlertTag": { "enum": [ "CONTAGIOUS" ], "title": "AppointmentAlertTag", "type": "string" }, "AppointmentCancelationReason": { "enum": [ "PATIENT_SEEN_ELSEWHERE", "CONCERN_RESOLVED", "PENDING_RESCHEDULE", "NO_LONGER_NEEDED", "WILL_RESCHEDULE", "DOCTOR_UNAVAILABLE", "CLINIC_SCHEDULE_CHANGE", "CREATED_IN_ERROR", "DUPLICATE", "WRONG_PATIENT", "WRONG_DATE_OR_TIME", "UNKNOWN", "OTHER", "NO_SHOW" ], "title": "AppointmentCancelationReason", "type": "string" }, "AppointmentCanceledWebhookPayload": { "properties": { "data": { "description": "Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.\n\nUnlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.", "properties": { "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this appointment belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "const": "", "type": "string" } ], "description": "The reason for cancelation or no-show, if applicable.", "title": "Cancelation Reason" }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text explanation of the cancelation, if one was provided.", "title": "Cancelation Reason Other" }, "client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Client Id" }, "clinic_notes": { "anyOf": [ {}, { "type": "null" } ], "description": "JSON structured notes for clinic use.", "title": "Clinic Notes" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this appointment.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "id": { "description": "The unique identifier for the appointment.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind.label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The appointment kind (type of appointment).", "title": "Kind.Label" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the medical record associated with this appointment, if any.", "title": "Medical Record Id" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Patient Id" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason for this appointment.", "title": "Reason" }, "resource.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource.Name" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "room.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the room assigned to this appointment, if any.", "title": "Room.Name" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar.clinic_id", "calendar_id", "resource_id", "room_id", "patient_id", "client_id", "start_datetime", "end_datetime", "status", "clinic_notes", "reason", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags", "cancelation_reason", "cancelation_reason_other" ], "title": "Appointment", "type": "object" }, "type": { "const": "appointment.canceled", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "appointment.canceled payload", "type": "object" }, "AppointmentCompletedWebhookPayload": { "properties": { "data": { "description": "Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.\n\nUnlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.", "properties": { "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this appointment belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "const": "", "type": "string" } ], "description": "The reason for cancelation or no-show, if applicable.", "title": "Cancelation Reason" }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text explanation of the cancelation, if one was provided.", "title": "Cancelation Reason Other" }, "client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Client Id" }, "clinic_notes": { "anyOf": [ {}, { "type": "null" } ], "description": "JSON structured notes for clinic use.", "title": "Clinic Notes" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this appointment.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "id": { "description": "The unique identifier for the appointment.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind.label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The appointment kind (type of appointment).", "title": "Kind.Label" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the medical record associated with this appointment, if any.", "title": "Medical Record Id" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Patient Id" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason for this appointment.", "title": "Reason" }, "resource.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource.Name" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "room.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the room assigned to this appointment, if any.", "title": "Room.Name" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar.clinic_id", "calendar_id", "resource_id", "room_id", "patient_id", "client_id", "start_datetime", "end_datetime", "status", "clinic_notes", "reason", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags", "cancelation_reason", "cancelation_reason_other" ], "title": "Appointment", "type": "object" }, "type": { "const": "appointment.completed", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "appointment.completed payload", "type": "object" }, "AppointmentCreateSchema": { "description": "Schema for the AppointmentCreateExternalAPIController request body", "properties": { "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "client_id": { "description": "The ID of the clinic client responsible for the appointment.", "title": "Client Id", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted datetime for when the appointment ends.", "format": "date-time", "title": "End Datetime", "type": "string" }, "kind_id": { "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id", "type": "integer" }, "patient_id": { "description": "The ID of the clinic patient this appointment is for.", "title": "Patient Id", "type": "integer" }, "reason": { "default": "", "description": "The reason for this appointment.", "title": "Reason", "type": "string" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "start_datetime": { "description": "ISO 8601 formatted datetime for when the appointment starts.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "calendar_id", "kind_id", "patient_id", "client_id", "start_datetime", "end_datetime" ], "title": "AppointmentCreateSchema", "type": "object" }, "AppointmentCreatedWebhookPayload": { "properties": { "data": { "description": "Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.\n\nUnlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.", "properties": { "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this appointment belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "const": "", "type": "string" } ], "description": "The reason for cancelation or no-show, if applicable.", "title": "Cancelation Reason" }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text explanation of the cancelation, if one was provided.", "title": "Cancelation Reason Other" }, "client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Client Id" }, "clinic_notes": { "anyOf": [ {}, { "type": "null" } ], "description": "JSON structured notes for clinic use.", "title": "Clinic Notes" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this appointment.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "form_requests": { "description": "Auto-created form requests linked to this appointment.", "items": { "$ref": "#/components/schemas/ExternalAppointmentCreatedWebhookFormRequestSchema" }, "title": "Form Requests", "type": "array" }, "id": { "description": "The unique identifier for the appointment.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind.label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The appointment kind (type of appointment).", "title": "Kind.Label" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the medical record associated with this appointment, if any.", "title": "Medical Record Id" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Patient Id" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason for this appointment.", "title": "Reason" }, "resource.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource.Name" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "room.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the room assigned to this appointment, if any.", "title": "Room.Name" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar.clinic_id", "calendar_id", "resource_id", "room_id", "patient_id", "client_id", "start_datetime", "end_datetime", "status", "clinic_notes", "reason", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags", "cancelation_reason", "cancelation_reason_other" ], "title": "AppointmentCreated", "type": "object" }, "type": { "const": "appointment.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "appointment.created payload", "type": "object" }, "AppointmentDeletedWebhookPayload": { "properties": { "data": { "description": "Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.\n\nUnlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.", "properties": { "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this appointment belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "const": "", "type": "string" } ], "description": "The reason for cancelation or no-show, if applicable.", "title": "Cancelation Reason" }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text explanation of the cancelation, if one was provided.", "title": "Cancelation Reason Other" }, "client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Client Id" }, "clinic_notes": { "anyOf": [ {}, { "type": "null" } ], "description": "JSON structured notes for clinic use.", "title": "Clinic Notes" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this appointment.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "id": { "description": "The unique identifier for the appointment.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind.label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The appointment kind (type of appointment).", "title": "Kind.Label" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the medical record associated with this appointment, if any.", "title": "Medical Record Id" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Patient Id" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason for this appointment.", "title": "Reason" }, "resource.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource.Name" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "room.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the room assigned to this appointment, if any.", "title": "Room.Name" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar.clinic_id", "calendar_id", "resource_id", "room_id", "patient_id", "client_id", "start_datetime", "end_datetime", "status", "clinic_notes", "reason", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags", "cancelation_reason", "cancelation_reason_other" ], "title": "Appointment", "type": "object" }, "type": { "const": "appointment.deleted", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "appointment.deleted payload", "type": "object" }, "AppointmentDetailPathParamsSchema": { "description": "Schema for the AppointmentDetailExternalAPIController path parameters", "properties": { "appointment_id": { "description": "The ID of the appointment to fetch", "title": "Appointment Id", "type": "integer" } }, "required": [ "appointment_id" ], "title": "AppointmentDetailPathParamsSchema", "type": "object" }, "AppointmentHistoryList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalAppointmentHistorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "AppointmentHistoryList", "type": "object" }, "AppointmentHistoryPathParamsSchema": { "description": "Schema for the AppointmentHistoryExternalAPIController path parameters", "properties": { "appointment_id": { "description": "The ID of the appointment to fetch history for", "title": "Appointment Id", "type": "integer" } }, "required": [ "appointment_id" ], "title": "AppointmentHistoryPathParamsSchema", "type": "object" }, "AppointmentKindDetailPathParamsSchema": { "description": "Schema for the AppointmentKindDetailExternalAPIController path parameters", "properties": { "appointment_kind_id": { "description": "The ID of the appointment kind to fetch", "title": "Appointment Kind Id", "type": "integer" } }, "required": [ "appointment_kind_id" ], "title": "AppointmentKindDetailPathParamsSchema", "type": "object" }, "AppointmentKindList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalAppointmentKindSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "AppointmentKindList", "type": "object" }, "AppointmentKindListQueryParamsSchema": { "description": "Schema for the AppointmentKindListExternalAPIController query parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "AppointmentKindListQueryParamsSchema", "type": "object" }, "AppointmentList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalAppointmentSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "AppointmentList", "type": "object" }, "AppointmentListQueryParamsSchema": { "description": "Schema for the AppointmentListExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments for the clinic client with this ID", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments for the clinic with this ID", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments for the clinic patient with this ID", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "end_datetime__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to appointments ending on or before this datetime. If both end_datetime__lte and start_datetime__gte are provided, end_datetime__lte must be greater than start_datetime__gte.", "title": "End Datetime Lte" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments assigned to the calendar resource with this ID.", "title": "Resource Id" }, "start_datetime__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to appointments starting on or after this datetime. If both end_datetime__lte and start_datetime__gte are provided, end_datetime__lte must be greater than start_datetime__gte.", "title": "Start Datetime Gte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentStatus" }, { "type": "null" } ], "description": "When provided, filters to appointments with this status." } }, "title": "AppointmentListQueryParamsSchema", "type": "object" }, "AppointmentStartedWebhookPayload": { "properties": { "data": { "description": "Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.\n\nUnlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.", "properties": { "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this appointment belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "const": "", "type": "string" } ], "description": "The reason for cancelation or no-show, if applicable.", "title": "Cancelation Reason" }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text explanation of the cancelation, if one was provided.", "title": "Cancelation Reason Other" }, "client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Client Id" }, "clinic_notes": { "anyOf": [ {}, { "type": "null" } ], "description": "JSON structured notes for clinic use.", "title": "Clinic Notes" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this appointment.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "id": { "description": "The unique identifier for the appointment.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind.label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The appointment kind (type of appointment).", "title": "Kind.Label" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the medical record associated with this appointment, if any.", "title": "Medical Record Id" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Patient Id" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason for this appointment.", "title": "Reason" }, "resource.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource.Name" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "room.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the room assigned to this appointment, if any.", "title": "Room.Name" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar.clinic_id", "calendar_id", "resource_id", "room_id", "patient_id", "client_id", "start_datetime", "end_datetime", "status", "clinic_notes", "reason", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags", "cancelation_reason", "cancelation_reason_other" ], "title": "Appointment", "type": "object" }, "type": { "const": "appointment.started", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "appointment.started payload", "type": "object" }, "AppointmentStatus": { "enum": [ "CREATING", "CLIENT_CREATING", "UNSCHEDULED", "UNCONFIRMED", "CONFIRMED", "DROPPED_OFF", "CHECKED_IN", "IN_PROGRESS", "READY_TO_GO", "COMPLETED", "NO_SHOW", "CANCELED", "IMPORTED", "CLIENT_REQUESTED" ], "title": "AppointmentStatus", "type": "string" }, "AppointmentUpdatePathParamsSchema": { "description": "Schema for the AppointmentUpdateExternalAPIController path parameters", "properties": { "appointment_id": { "description": "The ID of the appointment to update", "title": "Appointment Id", "type": "integer" } }, "required": [ "appointment_id" ], "title": "AppointmentUpdatePathParamsSchema", "type": "object" }, "AppointmentUpdateSchema": { "description": "Schema for the AppointmentUpdateExternalAPIController request body", "properties": { "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "type": "null" } ], "description": "Required when status is CANCELED or NO_SHOW. Canceled appointments use the clinic cancel list. No-show appointments must use NO_SHOW.", "examples": [ "PATIENT_SEEN_ELSEWHERE" ] }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional explanation when cancelation_reason is OTHER. Not required. Rejected when sent with any other reason.", "title": "Cancelation Reason Other" }, "custom_message": { "default": "", "description": "Custom message to include in the client notification. Only used if should_notify_client is true.", "title": "Custom Message", "type": "string" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends. Must be provided together with start_datetime.", "title": "End Datetime" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) to assign to this appointment.", "title": "Resource Id" }, "should_notify_client": { "default": false, "description": "Whether to send a notification to the client about this update.", "title": "Should Notify Client", "type": "boolean" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts. Must be provided together with end_datetime.", "title": "Start Datetime" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentStatus" }, { "type": "null" } ], "description": "The status of the appointment", "examples": [ "CONFIRMED" ] } }, "title": "AppointmentUpdateSchema", "type": "object" }, "AppointmentUpdatedWebhookPayload": { "properties": { "data": { "description": "Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.\n\nUnlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.", "properties": { "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this appointment belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "const": "", "type": "string" } ], "description": "The reason for cancelation or no-show, if applicable.", "title": "Cancelation Reason" }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text explanation of the cancelation, if one was provided.", "title": "Cancelation Reason Other" }, "client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Client Id" }, "clinic_notes": { "anyOf": [ {}, { "type": "null" } ], "description": "JSON structured notes for clinic use.", "title": "Clinic Notes" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this appointment.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "id": { "description": "The unique identifier for the appointment.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind.label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The appointment kind (type of appointment).", "title": "Kind.Label" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the medical record associated with this appointment, if any.", "title": "Medical Record Id" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Patient Id" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason for this appointment.", "title": "Reason" }, "resource.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource.Name" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "room.name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the room assigned to this appointment, if any.", "title": "Room.Name" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar.clinic_id", "calendar_id", "resource_id", "room_id", "patient_id", "client_id", "start_datetime", "end_datetime", "status", "clinic_notes", "reason", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags", "cancelation_reason", "cancelation_reason_other" ], "title": "Appointment", "type": "object" }, "type": { "const": "appointment.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "appointment.updated payload", "type": "object" }, "AssessmentDetailPathParamsSchema": { "description": "Schema for the AssessmentDetailExternalAPIController path parameters", "properties": { "assessment_id": { "description": "The ID of the assessment to retrieve.", "title": "Assessment Id", "type": "integer" } }, "required": [ "assessment_id" ], "title": "AssessmentDetailPathParamsSchema", "type": "object" }, "AssessmentList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalAssessmentSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "AssessmentList", "type": "object" }, "AssessmentListQueryParamsSchema": { "description": "Schema for the AssessmentListExternalAPIController query parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to assessments associated with the medical record with the given ID.", "title": "Medical Record Id" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to assessments associated with the patient with the given ID.", "title": "Patient Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "AssessmentListQueryParamsSchema", "type": "object" }, "CalendarAvailabilityListQueryParamsSchema": { "properties": { "appointment_kind_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter by appointment kind by ID. Accepts multiple IDs. Controls slot duration and designation filtering; each requested kind produces its own set of response entries. When omitted, a single kind-less pass is returned at the calendar's default duration.", "title": "Appointment Kind Ids" }, "calendar_resource_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter to specific calendar resources by ID. Accepts multiple IDs. When omitted, availability is returned for every resource on the calendar.", "title": "Calendar Resource Ids" }, "duration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overrides the appointment kind's default duration, in minutes. When provided it applies to every requested kind. Must be a positive multiple of the calendar's block increment.", "title": "Duration" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "End date for fetching availability. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 7 days after `start_date`. Defaults to `start_date` if omitted. Format: YYYY-MM-DD", "title": "End Date" }, "start_date": { "description": "Required. Start date for fetching availability. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 7 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, "required": [ "start_date" ], "title": "CalendarAvailabilityListQueryParamsSchema", "type": "object" }, "CalendarAvailabilityPaginatedListQueryParamsSchema": { "properties": { "appointment_kind_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter by appointment kind by ID. Accepts multiple IDs. Controls slot duration and designation filtering; each requested kind produces its own set of response entries. When omitted, a single kind-less pass is returned at the calendar's default duration.", "title": "Appointment Kind Ids" }, "calendar_resource_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter to specific calendar resources by ID. Accepts multiple IDs. When omitted, availability is returned for every resource on the calendar.", "title": "Calendar Resource Ids" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token from a previous response's next page URL. Fetches slots after the last slot of the previous page. Omit to start from the first page.", "title": "Cursor" }, "duration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overrides the appointment kind's default duration, in minutes. When provided it applies to every requested kind. Must be a positive multiple of the calendar's block increment.", "title": "Duration" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "End date for fetching availability. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 7 days after `start_date`. Defaults to `start_date` if omitted. Format: YYYY-MM-DD", "title": "End Date" }, "limit": { "default": 1000, "description": "The maximum number of appointment slots to return per page, counted by summing nested slots across every resource/kind entry on that page. A resource/kind group that spans a page boundary is split, and only the slots on this page count toward the limit. Defaults to 1000; the maximum is 5000.", "maximum": 5000, "minimum": 1, "title": "Limit", "type": "integer" }, "start_date": { "description": "Required. Start date for fetching availability. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 7 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, "required": [ "start_date" ], "title": "CalendarAvailabilityPaginatedListQueryParamsSchema", "type": "object" }, "CalendarDesignationBlockListQueryParamsSchema": { "properties": { "calendar_id": { "description": "Required. The ID of the calendar to fetch designation blocks for", "title": "Calendar Id", "type": "integer" }, "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional. The ID of the calendar resource to fetch designation blocks for", "title": "Calendar Resource Id" }, "end_date": { "description": "Required. End date for fetching designation blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_date`. Format: YYYY-MM-DD", "title": "End Date", "type": "string" }, "start_date": { "description": "Required. Start date for fetching designation blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, "required": [ "calendar_id", "start_date", "end_date" ], "title": "CalendarDesignationBlockListQueryParamsSchema", "type": "object" }, "CalendarDesignationCreatedWebhookPayload": { "properties": { "data": { "properties": { "appointment_kind_ids": { "description": "The IDs of the appointment kinds this designation is reserved for.", "items": { "type": "integer" }, "title": "Appointment Kind Ids", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this designation belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "duration_minutes": { "description": "Duration of the designation in minutes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the designation in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar designation.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Display name for this designation.", "title": "Name", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_designation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "If this is an exception to a recurring designation, the ID of the parent.", "title": "Recurring Designation Id" }, "resource_id": { "description": "The ID of the calendar resource this designation is assigned to.", "title": "Resource Id", "type": "integer" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the designation in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "calendar.clinic_id", "resource_id", "name", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarDesignationSchema", "type": "object" }, "type": { "const": "calendar_designation.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_designation.created payload", "type": "object" }, "CalendarDesignationDeletedWebhookPayload": { "properties": { "data": { "properties": { "appointment_kind_ids": { "description": "The IDs of the appointment kinds this designation is reserved for.", "items": { "type": "integer" }, "title": "Appointment Kind Ids", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this designation belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "duration_minutes": { "description": "Duration of the designation in minutes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the designation in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar designation.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Display name for this designation.", "title": "Name", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_designation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "If this is an exception to a recurring designation, the ID of the parent.", "title": "Recurring Designation Id" }, "resource_id": { "description": "The ID of the calendar resource this designation is assigned to.", "title": "Resource Id", "type": "integer" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the designation in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "calendar.clinic_id", "resource_id", "name", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarDesignationSchema", "type": "object" }, "type": { "const": "calendar_designation.deleted", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_designation.deleted payload", "type": "object" }, "CalendarDesignationDetailPathParamsSchema": { "properties": { "calendar_designation_id": { "description": "The ID of the calendar designation to fetch.", "title": "Calendar Designation Id", "type": "integer" } }, "required": [ "calendar_designation_id" ], "title": "CalendarDesignationDetailPathParamsSchema", "type": "object" }, "CalendarDesignationListQueryParamsSchema": { "properties": { "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar designations assigned to the calendar resource with this ID.", "title": "Calendar Resource Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar designations belonging to the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CalendarDesignationListQueryParamsSchema", "type": "object" }, "CalendarDesignationUpdatedWebhookPayload": { "properties": { "data": { "properties": { "appointment_kind_ids": { "description": "The IDs of the appointment kinds this designation is reserved for.", "items": { "type": "integer" }, "title": "Appointment Kind Ids", "type": "array" }, "calendar.clinic_id": { "description": "The ID of the clinic this designation belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "duration_minutes": { "description": "Duration of the designation in minutes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the designation in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar designation.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Display name for this designation.", "title": "Name", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_designation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "If this is an exception to a recurring designation, the ID of the parent.", "title": "Recurring Designation Id" }, "resource_id": { "description": "The ID of the calendar resource this designation is assigned to.", "title": "Resource Id", "type": "integer" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the designation in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "calendar.clinic_id", "resource_id", "name", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarDesignationSchema", "type": "object" }, "type": { "const": "calendar_designation.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_designation.updated payload", "type": "object" }, "CalendarDetailPathParamsSchema": { "description": "Schema for the CalendarDetailExternalAPIController path parameters", "properties": { "calendar_id": { "description": "The ID of the calendar to fetch.", "title": "Calendar Id", "type": "integer" } }, "required": [ "calendar_id" ], "title": "CalendarDetailPathParamsSchema", "type": "object" }, "CalendarEventBlockListQueryParamsSchema": { "properties": { "calendar_id": { "description": "Required. The ID of the calendar to fetch event blocks for", "title": "Calendar Id", "type": "integer" }, "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional. The ID of the calendar resource to fetch event blocks for", "title": "Calendar Resource Id" }, "end_date": { "description": "Required. End date for fetching event blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_date`. Format: YYYY-MM-DD", "title": "End Date", "type": "string" }, "start_date": { "description": "Required. Start date for fetching event blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, "required": [ "calendar_id", "start_date", "end_date" ], "title": "CalendarEventBlockListQueryParamsSchema", "type": "object" }, "CalendarEventCreatedWebhookPayload": { "properties": { "data": { "properties": { "calendar.clinic_id": { "description": "The ID of the clinic this calendar event belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_resource_ids": { "description": "The IDs of the calendar resources this event is assigned to.", "items": { "type": "integer" }, "title": "Calendar Resource Ids", "type": "array" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Plain-text description of the event.", "title": "Description" }, "duration_minutes": { "description": "Duration of the event in minutes, computed from start and end datetimes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the event in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar event.", "title": "Id", "type": "integer" }, "is_applicable_to_all_resources": { "description": "Whether this event applies to all resources on the calendar.", "title": "Is Applicable To All Resources", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "kind.slug": { "description": "The slug identifier of the calendar event kind.", "title": "Kind.Slug", "type": "string" }, "kind_id": { "description": "The ID of the calendar event kind.", "title": "Kind Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_event_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "If this event is an exception to a recurring series, the ID of the parent recurring event.", "title": "Recurring Event Id" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "should_block_appointments": { "description": "Whether this event prevents appointments from being scheduled during its time window.", "title": "Should Block Appointments", "type": "boolean" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the event in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "calendar.clinic_id", "is_applicable_to_all_resources", "kind_id", "kind.slug", "description", "should_block_appointments", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarEventSchema", "type": "object" }, "type": { "const": "calendar_event.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_event.created payload", "type": "object" }, "CalendarEventDeletedWebhookPayload": { "properties": { "data": { "properties": { "calendar.clinic_id": { "description": "The ID of the clinic this calendar event belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_resource_ids": { "description": "The IDs of the calendar resources this event is assigned to.", "items": { "type": "integer" }, "title": "Calendar Resource Ids", "type": "array" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Plain-text description of the event.", "title": "Description" }, "duration_minutes": { "description": "Duration of the event in minutes, computed from start and end datetimes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the event in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar event.", "title": "Id", "type": "integer" }, "is_applicable_to_all_resources": { "description": "Whether this event applies to all resources on the calendar.", "title": "Is Applicable To All Resources", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "kind.slug": { "description": "The slug identifier of the calendar event kind.", "title": "Kind.Slug", "type": "string" }, "kind_id": { "description": "The ID of the calendar event kind.", "title": "Kind Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_event_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "If this event is an exception to a recurring series, the ID of the parent recurring event.", "title": "Recurring Event Id" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "should_block_appointments": { "description": "Whether this event prevents appointments from being scheduled during its time window.", "title": "Should Block Appointments", "type": "boolean" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the event in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "calendar.clinic_id", "is_applicable_to_all_resources", "kind_id", "kind.slug", "description", "should_block_appointments", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarEventSchema", "type": "object" }, "type": { "const": "calendar_event.deleted", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_event.deleted payload", "type": "object" }, "CalendarEventDetailPathParamsSchema": { "properties": { "calendar_event_id": { "description": "The ID of the calendar event to fetch.", "title": "Calendar Event Id", "type": "integer" } }, "required": [ "calendar_event_id" ], "title": "CalendarEventDetailPathParamsSchema", "type": "object" }, "CalendarEventKindDetailPathParamsSchema": { "description": "Schema for the CalendarEventKindDetailExternalAPIController path parameters", "properties": { "calendar_event_kind_id": { "description": "The ID of the calendar event kind to fetch", "title": "Calendar Event Kind Id", "type": "integer" } }, "required": [ "calendar_event_kind_id" ], "title": "CalendarEventKindDetailPathParamsSchema", "type": "object" }, "CalendarEventKindListQueryParamsSchema": { "description": "Schema for the CalendarEventKindListExternalAPIController query parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CalendarEventKindListQueryParamsSchema", "type": "object" }, "CalendarEventListQueryParamsSchema": { "properties": { "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar events assigned to the calendar resource with this ID.", "title": "Calendar Resource Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar events belonging to the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CalendarEventListQueryParamsSchema", "type": "object" }, "CalendarEventUpdatedWebhookPayload": { "properties": { "data": { "properties": { "calendar.clinic_id": { "description": "The ID of the clinic this calendar event belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_resource_ids": { "description": "The IDs of the calendar resources this event is assigned to.", "items": { "type": "integer" }, "title": "Calendar Resource Ids", "type": "array" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Plain-text description of the event.", "title": "Description" }, "duration_minutes": { "description": "Duration of the event in minutes, computed from start and end datetimes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the event in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar event.", "title": "Id", "type": "integer" }, "is_applicable_to_all_resources": { "description": "Whether this event applies to all resources on the calendar.", "title": "Is Applicable To All Resources", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "kind.slug": { "description": "The slug identifier of the calendar event kind.", "title": "Kind.Slug", "type": "string" }, "kind_id": { "description": "The ID of the calendar event kind.", "title": "Kind Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_event_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "If this event is an exception to a recurring series, the ID of the parent recurring event.", "title": "Recurring Event Id" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "should_block_appointments": { "description": "Whether this event prevents appointments from being scheduled during its time window.", "title": "Should Block Appointments", "type": "boolean" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the event in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "calendar.clinic_id", "is_applicable_to_all_resources", "kind_id", "kind.slug", "description", "should_block_appointments", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarEventSchema", "type": "object" }, "type": { "const": "calendar_event.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_event.updated payload", "type": "object" }, "CalendarKindPreferenceDetailPathParamsSchema": { "description": "Schema for the CalendarKindPreferenceDetailExternalAPIController path parameters", "properties": { "calendar_kind_preference_id": { "description": "The ID of the calendar kind preference to fetch", "title": "Calendar Kind Preference Id", "type": "integer" } }, "required": [ "calendar_kind_preference_id" ], "title": "CalendarKindPreferenceDetailPathParamsSchema", "type": "object" }, "CalendarKindPreferenceList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarKindPreferenceSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "CalendarKindPreferenceList", "type": "object" }, "CalendarKindPreferenceListQueryParamsSchema": { "description": "Schema for the CalendarKindPreferenceListExternalAPIController query parameters", "properties": { "appointment_kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the appointment kind to fetch calendar kind preferences for", "title": "Appointment Kind Id" }, "calendar_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar to fetch calendar kind preferences for", "title": "Calendar Id" }, "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource to fetch calendar kind preferences for", "title": "Calendar Resource Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to fetch calendar kind preferences for", "title": "Clinic Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_client_bookable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the calendar kind preference is client bookable", "title": "Is Client Bookable" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "species": { "default": [], "description": "The species to fetch calendar kind preferences for, this is filtering across the resources allowed species list", "items": { "enum": [ "CANINE", "FELINE", "EQUINE", "AVIAN", "BOVINE", "FERRET", "RABBIT", "RODENT", "REPTILE", "AMPHIBIAN", "FISH", "PORCINE", "CAPRINE", "SHEEP", "CAMELID", "RATITE", "MARSUPIAL", "MUSTELID", "CERVID", "PROCYONIDAE", "ERINACEIDAE", "MEPHITIDAE", "OTHER", "UNSPECIFIED" ], "title": "PatientKind", "type": "string" }, "title": "Species", "type": "array" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CalendarKindPreferenceListQueryParamsSchema", "type": "object" }, "CalendarList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "CalendarList", "type": "object" }, "CalendarListQueryParamsSchema": { "description": "Schema for the CalendarListExternalAPIController query parameters", "properties": { "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to calendars for this clinic.", "title": "Clinic Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CalendarListQueryParamsSchema", "type": "object" }, "CalendarResourceCreatedWebhookPayload": { "properties": { "data": { "description": "Calendar resource represents a provider, room, or similar for a calendar.", "properties": { "calendar.clinic_id": { "description": "The ID of the clinic this resource belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this resource belongs to.", "title": "Calendar Id", "type": "integer" }, "can_client_double_book": { "description": "Whether this resource can be double booked from the client side.", "title": "Can Client Double Book", "type": "boolean" }, "can_double_book": { "description": "Whether this resource can be double booked from the clinic side.", "title": "Can Double Book", "type": "boolean" }, "clinic_user": { "anyOf": [ { "$ref": "#/components/schemas/ExternalCalendarResourceClinicUserSchema" }, { "type": "null" } ], "description": "The clinic user associated with this resource, if any." }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "description": "The unique identifier for this calendar resource object.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_imported": { "description": "Whether this resource was created via import from the legacy PIMS.", "title": "Is Imported", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of this resource.", "title": "Name" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar_id", "calendar.clinic_id", "clinic_user", "name", "can_double_book", "can_client_double_book", "is_imported" ], "title": "Calendar Resource", "type": "object" }, "type": { "const": "calendar_resource.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_resource.created payload", "type": "object" }, "CalendarResourceDeletedWebhookPayload": { "properties": { "data": { "description": "Calendar resource represents a provider, room, or similar for a calendar.", "properties": { "calendar.clinic_id": { "description": "The ID of the clinic this resource belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this resource belongs to.", "title": "Calendar Id", "type": "integer" }, "can_client_double_book": { "description": "Whether this resource can be double booked from the client side.", "title": "Can Client Double Book", "type": "boolean" }, "can_double_book": { "description": "Whether this resource can be double booked from the clinic side.", "title": "Can Double Book", "type": "boolean" }, "clinic_user": { "anyOf": [ { "$ref": "#/components/schemas/ExternalCalendarResourceClinicUserSchema" }, { "type": "null" } ], "description": "The clinic user associated with this resource, if any." }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "description": "The unique identifier for this calendar resource object.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_imported": { "description": "Whether this resource was created via import from the legacy PIMS.", "title": "Is Imported", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of this resource.", "title": "Name" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar_id", "calendar.clinic_id", "clinic_user", "name", "can_double_book", "can_client_double_book", "is_imported" ], "title": "Calendar Resource", "type": "object" }, "type": { "const": "calendar_resource.deleted", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_resource.deleted payload", "type": "object" }, "CalendarResourceDetailPathParamsSchema": { "description": "Schema for the CalendarResourceDetailExternalAPIController path parameters", "properties": { "calendar_resource_id": { "description": "The ID of the calendar resource to fetch", "title": "Calendar Resource Id", "type": "integer" } }, "required": [ "calendar_resource_id" ], "title": "CalendarResourceDetailPathParamsSchema", "type": "object" }, "CalendarResourceListQueryParamsSchema": { "description": "Schema for the CalendarResourceListExternalAPIController query parameters", "properties": { "calendar_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters the resources for the calendar with this ID", "title": "Calendar Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters the resources for the clinic with this ID", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CalendarResourceListQueryParamsSchema", "type": "object" }, "CalendarResourceUpdatedWebhookPayload": { "properties": { "data": { "description": "Calendar resource represents a provider, room, or similar for a calendar.", "properties": { "calendar.clinic_id": { "description": "The ID of the clinic this resource belongs to.", "title": "Calendar.Clinic Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this resource belongs to.", "title": "Calendar Id", "type": "integer" }, "can_client_double_book": { "description": "Whether this resource can be double booked from the client side.", "title": "Can Client Double Book", "type": "boolean" }, "can_double_book": { "description": "Whether this resource can be double booked from the clinic side.", "title": "Can Double Book", "type": "boolean" }, "clinic_user": { "anyOf": [ { "$ref": "#/components/schemas/ExternalCalendarResourceClinicUserSchema" }, { "type": "null" } ], "description": "The clinic user associated with this resource, if any." }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "description": "The unique identifier for this calendar resource object.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_imported": { "description": "Whether this resource was created via import from the legacy PIMS.", "title": "Is Imported", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of this resource.", "title": "Name" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar_id", "calendar.clinic_id", "clinic_user", "name", "can_double_book", "can_client_double_book", "is_imported" ], "title": "Calendar Resource", "type": "object" }, "type": { "const": "calendar_resource.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "calendar_resource.updated payload", "type": "object" }, "CalendarRoomDetailPathParamsSchema": { "description": "Schema for the CalendarRoomDetailExternalAPIController path parameters", "properties": { "calendar_room_id": { "description": "The ID of the calendar room to fetch", "title": "Calendar Room Id", "type": "integer" } }, "required": [ "calendar_room_id" ], "title": "CalendarRoomDetailPathParamsSchema", "type": "object" }, "CalendarRoomListQueryParamsSchema": { "description": "Schema for the CalendarRoomListExternalAPIController query parameters", "properties": { "calendar_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar to fetch calendar rooms for", "title": "Calendar Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to fetch calendar rooms for", "title": "Clinic Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CalendarRoomListQueryParamsSchema", "type": "object" }, "Calendar_ResourceList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarResourceSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "Calendar ResourceList", "type": "object" }, "CareBenefitCategory": { "enum": [ "PREVENTATIVE_AND_WELLNESS", "DIAGNOSTIC_AND_MONITORING", "ROUTINE_AND_CONVENIENCE", "DENTAL_AND_SPECIALIZED", "FOOD_AND_NUTRITION" ], "title": "CareBenefitCategory", "type": "string" }, "CareBenefitKind": { "enum": [ "UNLIMITED", "POINTS", "DISCOUNT" ], "title": "CareBenefitKind", "type": "string" }, "CareBenefitListQueryParamsSchema": { "description": "Schema for the CareBenefitListExternalAPIController path parameters", "properties": { "care_plan_id": { "description": "Filter to care benefits for the care plan with this ID", "title": "Care Plan Id", "type": "integer" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "required": [ "care_plan_id" ], "title": "CareBenefitListQueryParamsSchema", "type": "object" }, "CareBenefitStatus": { "enum": [ "ACTIVE", "INACTIVE" ], "title": "CareBenefitStatus", "type": "string" }, "CarePatientInvoiceItemKind": { "enum": [ "ENROLLMENT", "RECURRING", "TERMINATION", "SETTLEMENT", "IMPORTED" ], "title": "CarePatientInvoiceItemKind", "type": "string" }, "CarePlanDetailPathParamsSchema": { "description": "Schema for the CarePlanDetailExternalAPIController path parameters", "properties": { "care_plan_id": { "description": "The ID of the care plan to fetch", "title": "Care Plan Id", "type": "integer" } }, "required": [ "care_plan_id" ], "title": "CarePlanDetailPathParamsSchema", "type": "object" }, "CarePlanKind": { "enum": [ "CORE", "ADD_ON", "SERVICE_PACKAGE" ], "title": "CarePlanKind", "type": "string" }, "CarePlanListQueryParamsSchema": { "description": "Schema for the CarePlanListExternalAPIController path parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "type": "null" } ], "description": "When provided, filters to care plans for this species of patient" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "CarePlanListQueryParamsSchema", "type": "object" }, "CarePlanStatus": { "enum": [ "ACTIVE", "INACTIVE" ], "title": "CarePlanStatus", "type": "string" }, "CheckoutLinkListQueryParamsSchema": { "description": "Schema for the CheckoutLinkListExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to checkout links for this clinic client", "title": "Clinic Client Id" }, "clinic_id": { "description": "Required. Filters to checkout links for this clinic", "title": "Clinic Id", "type": "integer" }, "end_date__lte": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to checkout links sent on or prior to this date. This will be translated to a datetime representing the end of the day in the clinic's timezone. Format: YYYY-MM-DD", "title": "End Date Lte" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "start_date__gte": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to checkout links sent on or after this date. This will be translated to a datetime representing the start of the day in the clinic's timezone. Format: YYYY-MM-DD", "title": "Start Date Gte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "required": [ "clinic_id" ], "title": "CheckoutLinkListQueryParamsSchema", "type": "object" }, "ClientCommunicationNumberDetailPathParamsSchema": { "properties": { "client_communication_number_id": { "title": "Client Communication Number Id", "type": "integer" } }, "required": [ "client_communication_number_id" ], "title": "ClientCommunicationNumberDetailPathParamsSchema", "type": "object" }, "ClientCommunicationNumberListQueryParamsSchema": { "description": "Schema for the ClientCommunicationNumberListExternalAPIController query parameters.", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to phone numbers for the clinic client with this ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to phone numbers for the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClientCommunicationNumberListQueryParamsSchema", "type": "object" }, "ClientEmailAddressDetailPathParamsSchema": { "properties": { "client_email_address_id": { "title": "Client Email Address Id", "type": "integer" } }, "required": [ "client_email_address_id" ], "title": "ClientEmailAddressDetailPathParamsSchema", "type": "object" }, "ClientEmailAddressListQueryParamsSchema": { "description": "Schema for the ClientEmailAddressListExternalAPIController query parameters.", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to email addresses for the clinic client with this ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to email addresses for the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClientEmailAddressListQueryParamsSchema", "type": "object" }, "ClientInvoiceBillingStatus": { "enum": [ "IN_PROGRESS", "READY_FOR_PAYMENT", "PAYMENT_DUE", "PAID", "COLLECTIONS", "NOT_RENDERED", "DISPUTE", "IMPORTED" ], "title": "ClientInvoiceBillingStatus", "type": "string" }, "ClientInvoiceItemKind": { "enum": [ "IN_CLINIC", "TAKE_HOME" ], "title": "ClientInvoiceItemKind", "type": "string" }, "ClientInvoiceStatus": { "enum": [ "IN_PROGRESS", "READY_FOR_PAYMENT", "FINALIZED", "LOCKED", "IMPORTED" ], "title": "ClientInvoiceStatus", "type": "string" }, "ClientOnboardingQueryParamsSchema": { "description": "Schema for the ClientOnboardingListExternalAPIController query parameters", "properties": { "created__gte": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to onboardings created on or after this date", "title": "Created Gte" }, "created__lte": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to onboardings created on or before this date", "title": "Created Lte" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClientOnboardingQueryParamsSchema", "type": "object" }, "ClientPaymentStatus": { "enum": [ "PENDING", "COMPLETED", "CANCELED", "FAILED", "VOIDED" ], "title": "ClientPaymentStatus", "type": "string" }, "ClinicBundlePriceOverridePathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic whose bundle price override is updated.", "title": "Clinic Id", "type": "integer" }, "group_bundle_id": { "description": "The ID of the organization bundle (group bundle) whose clinic override is updated.", "title": "Group Bundle Id", "type": "integer" } }, "required": [ "clinic_id", "group_bundle_id" ], "title": "ClinicBundlePriceOverridePathParamsSchema", "type": "object" }, "ClinicBundlePriceOverrideUpdateSchema": { "properties": { "fixed_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Fixed price in cents. Omit or set null when using pass-through pricing.", "title": "Fixed Price" }, "is_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the clinic bundle enrollment is enabled at this clinic. When omitted on create, enrollment is enabled; when omitted on update, the existing enrollment state is unchanged.", "title": "Is Enabled" }, "is_pass_through_pricing": { "description": "Whether the override should use pass-through pricing.", "title": "Is Pass Through Pricing", "type": "boolean" }, "name": { "description": "Display name for this clinic bundle price override.", "title": "Name", "type": "string" } }, "required": [ "is_pass_through_pricing", "name" ], "title": "ClinicBundlePriceOverrideUpdateSchema", "type": "object" }, "ClinicCarePlanPricePathParamsSchema": { "description": "Schema for the ClinicCarePlanPriceListExternalAPIController path parameters", "properties": { "clinic_id": { "description": "The ID of the clinic to fetch care plan prices for", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ClinicCarePlanPricePathParamsSchema", "type": "object" }, "ClinicCarePlanQueryParamsSchema": { "properties": { "billing_frequency": { "anyOf": [ { "$ref": "#/components/schemas/ExternalBillingFrequency" }, { "type": "null" } ], "description": "When provided, filters to care plans by billing frequency. `MONTHLY` returns plans with a monthly default duration. `ANNUAL` returns plans with a yearly default duration." }, "clinic_id": { "description": "Filters to care plans for the clinic with this ID", "title": "Clinic Id", "type": "integer" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "type": "null" } ], "description": "When provided, filters to care plans for this species of patient" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "required": [ "clinic_id" ], "title": "ClinicCarePlanQueryParamsSchema", "type": "object" }, "ClinicClientCreatedWebhookPayload": { "properties": { "data": { "properties": { "calendar_notes": { "description": "The notes on the client.", "title": "Calendar Notes", "type": "string" }, "can_be_called": { "description": "Whether the clinic can call the client.", "title": "Can Be Called", "type": "boolean" }, "clinic_id": { "description": "The ID of the clinic this client belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "has_unread_messages_for_clinic": { "description": "Whether there are unread inbound messages from the client (for clinic's perspective)", "title": "Has Unread Messages For Clinic", "type": "boolean" }, "id": { "description": "The ID of the clinic client", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the client is active.", "title": "Is Active", "type": "boolean" }, "is_co_ownership_client": { "description": "Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client.", "title": "Is Co Ownership Client", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_email_unsubscribed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file.", "title": "Is Email Unsubscribed" }, "is_subscribed": { "description": "Whether the client is subscribed to receive info from the clinic.", "title": "Is Subscribed", "type": "boolean" }, "last_visit_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date of the client's most recent appointment or invoice.", "title": "Last Visit Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic client in the clinic's PIMS.", "title": "Pim Id" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "default": null, "description": "The primary address of the clinic client." }, "primary_client_user.first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "Primary Client User.First Name" }, "primary_client_user.last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "Primary Client User.Last Name" }, "primary_client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields.", "title": "Primary Client User Id" }, "primary_communication_number_int": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Primary Communication Number Int" }, "primary_email_address_str": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Primary Email Address Str" }, "primary_payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the primary payment method of the clinic client", "title": "Primary Payment Method Id" }, "universal_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization client ID corresponding to this clinic client.", "title": "Universal Client Id" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "pim_id", "universal_client_id", "is_email_unsubscribed", "is_active", "external_id", "can_be_called", "is_subscribed", "has_unread_messages_for_clinic", "last_visit_date", "calendar_notes", "is_co_ownership_client", "primary_client_user_id" ], "title": "ExternalClinicClientSchema", "type": "object" }, "type": { "const": "clinic_client.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "clinic_client.created payload", "type": "object" }, "ClinicClientDetailPathParamsSchema": { "description": "Schema for the ClinicClientDetailExternalAPIController path parameters", "properties": { "clinic_client_id": { "description": "The ID of the client to fetch", "title": "Clinic Client Id", "type": "integer" } }, "required": [ "clinic_client_id" ], "title": "ClinicClientDetailPathParamsSchema", "type": "object" }, "ClinicClientListQueryParamsSchema": { "description": "Schema for the ClinicClientListExternalAPIController path parameters", "properties": { "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clients for the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to clients with this exact email address", "title": "Email" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "organization_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clients associated with the organization client ID.", "title": "Organization Client Id" }, "phone_number": { "anyOf": [ { "maximum": 9999999999, "minimum": 1000000000, "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to clients with this exact 10-digit phone number", "title": "Phone Number" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicClientListQueryParamsSchema", "type": "object" }, "ClinicClientSearchQueryParamsSchema": { "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose email matches this value. Automatically trimmed and lowercased. Requires `email_operator` when provided.", "title": "Email" }, "email_operator": { "anyOf": [ { "$ref": "#/components/schemas/EmailOperator" }, { "type": "null" } ], "description": "The match mode to use for the `email` field." }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filters to clients with the given active status.", "title": "Is Active" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose name matches this value. Automatically trimmed and lowercased. Requires `name_operator` when provided.", "title": "Name" }, "name_operator": { "anyOf": [ { "$ref": "#/components/schemas/NameOperator" }, { "type": "null" } ], "description": "The match mode to use for the `name` field." }, "page": { "default": 1, "description": "The page number to return.", "minimum": 1, "title": "Page", "type": "integer" }, "page_size": { "default": 20, "description": "The number of results per page.", "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose phone number matches this value. Non-numeric characters are automatically stripped. Requires `phone_number_operator` when provided.", "title": "Phone Number" }, "phone_number_operator": { "anyOf": [ { "$ref": "#/components/schemas/PhoneNumberOperator" }, { "type": "null" } ], "description": "The match mode to use for the `phone_number` field." }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose zip code matches this value. Automatically trimmed and lowercased. Requires `zip_code_operator` when provided.", "title": "Zip Code" }, "zip_code_operator": { "anyOf": [ { "$ref": "#/components/schemas/ZipCodeOperator" }, { "type": "null" } ], "description": "The match mode to use for the `zip_code` field." } }, "title": "ClinicClientSearchQueryParamsSchema", "type": "object" }, "ClinicClientUpdatedWebhookPayload": { "properties": { "data": { "properties": { "calendar_notes": { "description": "The notes on the client.", "title": "Calendar Notes", "type": "string" }, "can_be_called": { "description": "Whether the clinic can call the client.", "title": "Can Be Called", "type": "boolean" }, "clinic_id": { "description": "The ID of the clinic this client belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "has_unread_messages_for_clinic": { "description": "Whether there are unread inbound messages from the client (for clinic's perspective)", "title": "Has Unread Messages For Clinic", "type": "boolean" }, "id": { "description": "The ID of the clinic client", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the client is active.", "title": "Is Active", "type": "boolean" }, "is_co_ownership_client": { "description": "Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client.", "title": "Is Co Ownership Client", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_email_unsubscribed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file.", "title": "Is Email Unsubscribed" }, "is_subscribed": { "description": "Whether the client is subscribed to receive info from the clinic.", "title": "Is Subscribed", "type": "boolean" }, "last_visit_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date of the client's most recent appointment or invoice.", "title": "Last Visit Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic client in the clinic's PIMS.", "title": "Pim Id" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "default": null, "description": "The primary address of the clinic client." }, "primary_client_user.first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "Primary Client User.First Name" }, "primary_client_user.last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "Primary Client User.Last Name" }, "primary_client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields.", "title": "Primary Client User Id" }, "primary_communication_number_int": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Primary Communication Number Int" }, "primary_email_address_str": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Primary Email Address Str" }, "primary_payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the primary payment method of the clinic client", "title": "Primary Payment Method Id" }, "universal_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization client ID corresponding to this clinic client.", "title": "Universal Client Id" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "pim_id", "universal_client_id", "is_email_unsubscribed", "is_active", "external_id", "can_be_called", "is_subscribed", "has_unread_messages_for_clinic", "last_visit_date", "calendar_notes", "is_co_ownership_client", "primary_client_user_id" ], "title": "ExternalClinicClientSchema", "type": "object" }, "type": { "const": "clinic_client.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "clinic_client.updated payload", "type": "object" }, "ClinicClientUserDetailPathParamsSchema": { "description": "Path parameters for ClientUser detail/patch endpoints", "properties": { "clinic_client_user_id": { "description": "The ID of the clinic client user to retrieve or update", "title": "Clinic Client User Id", "type": "integer" } }, "required": [ "clinic_client_user_id" ], "title": "ClinicClientUserDetailPathParamsSchema", "type": "object" }, "ClinicClientUserListQueryParamsSchema": { "description": "Query parameters for ClientUser list endpoint", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clinic client users associated with the clinic client with the given ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clinic client users for the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to clinic client users with this exact primary email address.", "title": "Email" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to clinic client users with this exact 10-digit primary phone number.", "title": "Phone Number" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicClientUserListQueryParamsSchema", "type": "object" }, "ClinicDetailPathParamsSchema": { "description": "Schema for the ClinicDetailExternalAPIController path parameters", "properties": { "clinic_id": { "description": "The ID of the clinic to fetch", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ClinicDetailPathParamsSchema", "type": "object" }, "ClinicEffectiveInventoryPreference": { "properties": { "grade": { "anyOf": [ { "$ref": "#/components/schemas/InventoryGrade" }, { "const": "", "type": "string" } ], "description": "The grade (importance) assigned to this type of inventory by this clinic", "title": "Grade" }, "is_enabled": { "description": "Whether this inventory code is enabled for this clinic", "title": "Is Enabled", "type": "boolean" }, "min_quantity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The minimum quantity below which the clinic considers this inventory to be out of stock", "title": "Min Quantity" }, "name": { "description": "The name assigned to this type of inventory for this clinic", "title": "Name", "type": "string" }, "reorder_point": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The quantity of this inventory at which a reorder should be made", "title": "Reorder Point" }, "should_track_lot_number": { "description": "Whether use of this inventory requires lot numbers to be tracked", "title": "Should Track Lot Number", "type": "boolean" }, "target_quantity": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The quantity this inventory should be replenished to on reorder", "title": "Target Quantity" }, "unit_of_measure": { "$ref": "#/components/schemas/InventoryUnitOfMeasure", "description": "The settings for how units of this inventory are measured for this clinic" }, "unit_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The unit price of this inventory, in cents", "title": "Unit Price" } }, "required": [ "is_enabled", "name", "unit_of_measure", "grade", "min_quantity", "reorder_point", "target_quantity", "should_track_lot_number", "unit_price" ], "title": "ClinicEffectiveInventoryPreference", "type": "object" }, "ClinicGroupServicePricingListPathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to fetch group service prices for.", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ClinicGroupServicePricingListPathParamsSchema", "type": "object" }, "ClinicGroupServicePricingListQueryParamsSchema": { "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "group_service_codes": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, only return prices for group services with these service codes.", "title": "Group Service Codes" }, "group_service_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, only return prices for group services with these IDs.", "title": "Group Service Ids" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "service_pricing_category_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, only return prices for group services with these service pricing category IDs.", "title": "Service Pricing Category Ids" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicGroupServicePricingListQueryParamsSchema", "type": "object" }, "ClinicInventoryCodeDetailPathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to fetch an inventory code for", "title": "Clinic Id", "type": "integer" }, "inventory_code_id": { "description": "The ID of the inventory code to fetch", "title": "Inventory Code Id", "type": "integer" } }, "required": [ "clinic_id", "inventory_code_id" ], "title": "ClinicInventoryCodeDetailPathParamsSchema", "type": "object" }, "ClinicInventoryCodeListPathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to fetch inventory codes for", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ClinicInventoryCodeListPathParamsSchema", "type": "object" }, "ClinicInventoryCodeListQueryParamsSchema": { "properties": { "category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, limits results to inventory codes whose global inventory belongs to this category.", "title": "Category Id" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters inventory codes by the code", "title": "Code" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When provided, filters inventory codes by their enabled status for the clinic. When true, returns only enabled inventory codes. When false, returns only disabled inventory codes.", "title": "Is Enabled" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/InventoryStatus" }, { "type": "null" } ], "description": "When provided, filters inventory codes by their stock status" } }, "title": "ClinicInventoryCodeListQueryParamsSchema", "type": "object" }, "ClinicInventoryPreferenceSchema": { "properties": { "is_enabled": { "description": "Whether this inventory code is enabled for this clinic", "title": "Is Enabled", "type": "boolean" }, "last_unit_price_update": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The last time this inventory's unit price was updated, in UTC", "title": "Last Unit Price Update" }, "min_quantity": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The minimum quantity below which the clinic considers this inventory to be out of stock", "title": "Min Quantity" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name assigned to this type of inventory by the clinic. Can be null if the clinic is inheriting your organization's default or Vetcove's default", "title": "Name" }, "reorder_point": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The quantity of this inventory at which a reorder should be made", "title": "Reorder Point" }, "should_track_lot_number": { "description": "Whether use of this inventory requires lot numbers to be tracked", "title": "Should Track Lot Number", "type": "boolean" }, "status": { "$ref": "#/components/schemas/InventoryStatus", "description": "The current status of this inventory for this clinic" }, "target_quantity": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The quantity this inventory should be replenished to on reorder", "title": "Target Quantity" }, "unit_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The unit price of this inventory, in cents", "title": "Unit Price" } }, "required": [ "status", "is_enabled", "name", "min_quantity", "reorder_point", "target_quantity", "should_track_lot_number", "unit_price", "last_unit_price_update" ], "title": "ClinicInventoryPreferenceSchema", "type": "object" }, "ClinicList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ClinicList", "type": "object" }, "ClinicListQueryParamsSchema": { "description": "Schema for the ClinicListExternalAPIController path parameters", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "group_location_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to clinics for the list of group location codes. Group location codes are a group's internal identifier for their clinics.", "title": "Group Location Codes" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "is_pims": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to PIMS-enabled clinics. When `False`, filters to non-PIMS clinics. When `None`, then both are included.", "title": "Is Pims" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicListQueryParamsSchema", "type": "object" }, "ClinicPatientCreatedWebhookPayload": { "properties": { "data": { "properties": { "allergies": { "description": "The allergies of the clinic patient.", "title": "Allergies", "type": "string" }, "auto_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last automatically recorded rabies tag (driven by treatments).", "title": "Auto Rabies Tag" }, "birth_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of birth of the clinic patient in ISO format (YYYY-MM-DD). Derived from birth_year, birth_month, and birth_day.", "title": "Birth Date" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "calendar_notes": { "description": "Notes set on the clinic patient via the PIMS calendar.", "title": "Calendar Notes", "type": "string" }, "client_id": { "description": "The ID of the primary clinic client associated with this clinic patient.", "title": "Client Id", "type": "integer" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to which this clinic patient belongs.", "title": "Clinic Id" }, "color": { "anyOf": [ { "$ref": "#/components/schemas/PatientColor" }, { "const": "", "type": "string" } ], "description": "The color of the clinic patient.", "title": "Color" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "custom_species": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Custom species declared for this patient if species is set to Other.", "title": "Custom Species" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the clinic patient became inactive (deceased, surrendered, or deleted).", "title": "Deactivated At" }, "deceased_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the clinic patient passed away, if applicable. Format: YYYY-MM-DD.", "title": "Deceased Date" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "first_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's first visit. Format: YYYY-MM-DD.", "title": "First Visit Date" }, "id": { "description": "The ID of the clinic patient.", "title": "Id", "type": "integer" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceSchema" }, { "type": "null" } ], "default": null, "description": "The insurance covering this clinic patient, if any." }, "is_active": { "description": "Whether the clinic patient is currently active (not deceased, surrendered, or deactivated).", "title": "Is Active", "type": "boolean" }, "is_alive": { "description": "Whether this patient is alive.", "title": "Is Alive", "type": "boolean" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "is_bam_deleted": { "description": "Whether this patient was marked as deactivated in the clinic's legacy PIMS.", "title": "Is Bam Deleted", "type": "boolean" }, "is_deactivated": { "description": "Whether this patient has been marked as deactivated.", "title": "Is Deactivated", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_surrendered": { "description": "Whether this patient has been surrendered by all related clients.", "title": "Is Surrendered", "type": "boolean" }, "last_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's last visit. Format: YYYY-MM-DD.", "title": "Last Visit Date" }, "microchip_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The microchip number of the clinic patient.", "title": "Microchip Number" }, "microchip_number_updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the patient's microchip number was last set or changed. This is a last-updated timestamp, not a strict assignment date, and there is no removed-date concept \u2014 the microchip number is overwritten with the latest value.", "title": "Microchip Number Updated At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of the clinic patient.", "title": "Name", "type": "string" }, "patientclientrelationship_set": { "description": "A list of clinic clients associated with this clinic patient.", "items": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipPatientViewSchema" }, "title": "Patientclientrelationship Set", "type": "array" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "reissued_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The manually updated rabies tag, which overrides the automatically set one.", "title": "Reissued Rabies Tag" }, "resuscitate_status": { "anyOf": [ { "$ref": "#/components/schemas/ResuscitateStatus" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The resuscitate status of the clinic patient.", "title": "Resuscitate Status" }, "secondary_breeds": { "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "$ref": "#/components/schemas/SexKind", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "surrendered_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the patient was surrendered, if applicable.", "title": "Surrendered Date" }, "universal_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization patient ID corresponding to this clinic patient", "title": "Universal Patient Id" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds (legacy field).", "title": "Weight" }, "weight_in_units": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient in the unit specified by weight_unit.", "title": "Weight In Units" }, "weight_unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/WeightUnitOfMeasure" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit of measure for weight_in_units.", "title": "Weight Unit Of Measure" } }, "required": [ "created", "modified", "is_deleted", "deleted", "name", "patientclientrelationship_set", "id", "species", "pim_id", "weight", "weight_in_units", "weight_unit_of_measure", "sex", "birth_month", "birth_day", "birth_year", "universal_patient_id", "primary_breed", "secondary_breeds", "custom_breed", "allergies", "is_altered", "is_alive", "is_surrendered", "is_deactivated", "is_bam_deleted", "microchip_number", "microchip_number_updated_at", "external_id", "client_id", "clinic_id", "custom_species", "color", "deceased_date", "surrendered_date", "deactivated_at", "first_visit_date", "last_visit_date", "calendar_notes", "resuscitate_status", "auto_rabies_tag", "reissued_rabies_tag", "is_active", "birth_date" ], "title": "ExternalClinicPatientSchema", "type": "object" }, "type": { "const": "clinic_patient.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "clinic_patient.created payload", "type": "object" }, "ClinicPatientDetailPathParamsSchema": { "properties": { "clinic_patient_id": { "description": "The ID of the clinic patient to fetch", "title": "Clinic Patient Id", "type": "integer" } }, "required": [ "clinic_patient_id" ], "title": "ClinicPatientDetailPathParamsSchema", "type": "object" }, "ClinicPatientForOrganizationPatientListSchema": { "properties": { "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "clinic_id": { "description": "The ID of the clinic this patient belongs to.", "title": "Clinic Id", "type": "integer" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "id": { "description": "The ID of the clinic patient.", "title": "Id", "type": "integer" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceSchema" }, { "type": "null" } ], "description": "The insurance covering this clinic patient, if any." }, "is_alive": { "description": "Whether this patient is alive.", "title": "Is Alive", "type": "boolean" }, "is_deactivated": { "description": "Whether this patient has been marked as deactivated.", "title": "Is Deactivated", "type": "boolean" }, "is_legacy_deactivated": { "description": "Whether this patient was marked as deactivated in the clinic's legacy PIMS.", "title": "Is Legacy Deactivated", "type": "boolean" }, "is_surrendered": { "description": "Whether this patient has been surrendered by all related clients.", "title": "Is Surrendered", "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the clinic patient.", "title": "Name" }, "organization_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization patient ID corresponding to this clinic patient", "title": "Organization Patient Id" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "secondary_breeds": { "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "$ref": "#/components/schemas/SexKind", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds.", "title": "Weight" } }, "required": [ "name", "id", "clinic_id", "species", "pim_id", "weight", "sex", "birth_month", "birth_day", "birth_year", "organization_patient_id", "primary_breed", "secondary_breeds", "custom_breed", "is_alive", "is_surrendered", "is_deactivated", "is_legacy_deactivated" ], "title": "ClinicPatientForOrganizationPatientListSchema", "type": "object" }, "ClinicPatientForOrganizationPatientListSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ClinicPatientForOrganizationPatientListSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ClinicPatientForOrganizationPatientListSchemaList", "type": "object" }, "ClinicPatientPatchPathParamsSchema": { "properties": { "clinic_patient_id": { "description": "The ID of the clinic patient to update", "title": "Clinic Patient Id", "type": "integer" } }, "required": [ "clinic_patient_id" ], "title": "ClinicPatientPatchPathParamsSchema", "type": "object" }, "ClinicPatientUpdatedWebhookPayload": { "properties": { "data": { "properties": { "allergies": { "description": "The allergies of the clinic patient.", "title": "Allergies", "type": "string" }, "auto_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last automatically recorded rabies tag (driven by treatments).", "title": "Auto Rabies Tag" }, "birth_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of birth of the clinic patient in ISO format (YYYY-MM-DD). Derived from birth_year, birth_month, and birth_day.", "title": "Birth Date" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "calendar_notes": { "description": "Notes set on the clinic patient via the PIMS calendar.", "title": "Calendar Notes", "type": "string" }, "client_id": { "description": "The ID of the primary clinic client associated with this clinic patient.", "title": "Client Id", "type": "integer" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to which this clinic patient belongs.", "title": "Clinic Id" }, "color": { "anyOf": [ { "$ref": "#/components/schemas/PatientColor" }, { "const": "", "type": "string" } ], "description": "The color of the clinic patient.", "title": "Color" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "custom_species": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Custom species declared for this patient if species is set to Other.", "title": "Custom Species" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the clinic patient became inactive (deceased, surrendered, or deleted).", "title": "Deactivated At" }, "deceased_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the clinic patient passed away, if applicable. Format: YYYY-MM-DD.", "title": "Deceased Date" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "first_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's first visit. Format: YYYY-MM-DD.", "title": "First Visit Date" }, "id": { "description": "The ID of the clinic patient.", "title": "Id", "type": "integer" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceSchema" }, { "type": "null" } ], "default": null, "description": "The insurance covering this clinic patient, if any." }, "is_active": { "description": "Whether the clinic patient is currently active (not deceased, surrendered, or deactivated).", "title": "Is Active", "type": "boolean" }, "is_alive": { "description": "Whether this patient is alive.", "title": "Is Alive", "type": "boolean" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "is_bam_deleted": { "description": "Whether this patient was marked as deactivated in the clinic's legacy PIMS.", "title": "Is Bam Deleted", "type": "boolean" }, "is_deactivated": { "description": "Whether this patient has been marked as deactivated.", "title": "Is Deactivated", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_surrendered": { "description": "Whether this patient has been surrendered by all related clients.", "title": "Is Surrendered", "type": "boolean" }, "last_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's last visit. Format: YYYY-MM-DD.", "title": "Last Visit Date" }, "microchip_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The microchip number of the clinic patient.", "title": "Microchip Number" }, "microchip_number_updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the patient's microchip number was last set or changed. This is a last-updated timestamp, not a strict assignment date, and there is no removed-date concept \u2014 the microchip number is overwritten with the latest value.", "title": "Microchip Number Updated At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of the clinic patient.", "title": "Name", "type": "string" }, "patientclientrelationship_set": { "description": "A list of clinic clients associated with this clinic patient.", "items": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipPatientViewSchema" }, "title": "Patientclientrelationship Set", "type": "array" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "reissued_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The manually updated rabies tag, which overrides the automatically set one.", "title": "Reissued Rabies Tag" }, "resuscitate_status": { "anyOf": [ { "$ref": "#/components/schemas/ResuscitateStatus" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The resuscitate status of the clinic patient.", "title": "Resuscitate Status" }, "secondary_breeds": { "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "$ref": "#/components/schemas/SexKind", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "surrendered_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the patient was surrendered, if applicable.", "title": "Surrendered Date" }, "universal_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization patient ID corresponding to this clinic patient", "title": "Universal Patient Id" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds (legacy field).", "title": "Weight" }, "weight_in_units": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient in the unit specified by weight_unit.", "title": "Weight In Units" }, "weight_unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/WeightUnitOfMeasure" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit of measure for weight_in_units.", "title": "Weight Unit Of Measure" } }, "required": [ "created", "modified", "is_deleted", "deleted", "name", "patientclientrelationship_set", "id", "species", "pim_id", "weight", "weight_in_units", "weight_unit_of_measure", "sex", "birth_month", "birth_day", "birth_year", "universal_patient_id", "primary_breed", "secondary_breeds", "custom_breed", "allergies", "is_altered", "is_alive", "is_surrendered", "is_deactivated", "is_bam_deleted", "microchip_number", "microchip_number_updated_at", "external_id", "client_id", "clinic_id", "custom_species", "color", "deceased_date", "surrendered_date", "deactivated_at", "first_visit_date", "last_visit_date", "calendar_notes", "resuscitate_status", "auto_rabies_tag", "reissued_rabies_tag", "is_active", "birth_date" ], "title": "ExternalClinicPatientSchema", "type": "object" }, "type": { "const": "clinic_patient.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "clinic_patient.updated payload", "type": "object" }, "ClinicPatientUploadGroupDetailPathParamsSchema": { "properties": { "clinic_patient_upload_group_id": { "description": "The ID of the clinic patient upload group to fetch", "title": "Clinic Patient Upload Group Id", "type": "integer" } }, "required": [ "clinic_patient_upload_group_id" ], "title": "ClinicPatientUploadGroupDetailPathParamsSchema", "type": "object" }, "ClinicPatientUploadGroupListQueryParamsSchema": { "properties": { "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to upload groups for the clinic patient with this ID.", "title": "Clinic Patient Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicPatientUploadGroupListQueryParamsSchema", "type": "object" }, "ClinicPatientsListQueryParamsSchema": { "description": "Schema for the ClinicPatientsListExternalAPIController query parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patients associated with the clinic client with the given ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patients associated with the clinic with the given ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filters to active patients. Active patients are alive, not deleted, not surrendered, and not deactivated.", "title": "Is Active" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "organization_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patients associated with the organization patient ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "title": "Organization Patient Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicPatientsListQueryParamsSchema", "type": "object" }, "ClinicServiceCreatePathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to add clinic-level group service data for.", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ClinicServiceCreatePathParamsSchema", "type": "object" }, "ClinicServiceDeletePathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to delete clinic price overrides for.", "title": "Clinic Id", "type": "integer" }, "group_service_id": { "description": "The ID of the group service to delete clinic price overrides for.", "title": "Group Service Id", "type": "integer" } }, "required": [ "group_service_id", "clinic_id" ], "title": "ClinicServiceDeletePathParamsSchema", "type": "object" }, "ClinicServiceDetailPathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to fetch the clinic-level service data for.", "title": "Clinic Id", "type": "integer" }, "group_service_id": { "description": "The ID of the group service to fetch clinic-level service data for.", "title": "Group Service Id", "type": "integer" } }, "required": [ "group_service_id", "clinic_id" ], "title": "ClinicServiceDetailPathParamsSchema", "type": "object" }, "ClinicServiceUpdatePathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to update the clinic-level service data for.", "title": "Clinic Id", "type": "integer" }, "group_service_id": { "description": "The ID of the group service to update clinic-level data for.", "title": "Group Service Id", "type": "integer" } }, "required": [ "group_service_id", "clinic_id" ], "title": "ClinicServiceUpdatePathParamsSchema", "type": "object" }, "ClinicTagDetailPathParamsSchema": { "description": "Schema for the ClinicTagDetailExternalAPIController path parameters", "properties": { "clinic_location_group_id": { "description": "The ID of the clinic location group to fetch", "title": "Clinic Location Group Id", "type": "integer" } }, "required": [ "clinic_location_group_id" ], "title": "ClinicTagDetailPathParamsSchema", "type": "object" }, "ClinicTagListQueryParamsSchema": { "description": "Schema for the ClinicTagListExternalAPIController path parameters", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicTagListQueryParamsSchema", "type": "object" }, "ClinicTaxCategoryListPathParamsSchema": { "description": "Schema for the ClinicTaxCategoryListExternalAPIController path parameters", "properties": { "clinic_id": { "description": "The clinic ID of the tax statuses to fetch", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ClinicTaxCategoryListPathParamsSchema", "type": "object" }, "ClinicTaxCategoryListQueryParamsSchema": { "description": "Schema for the ClinicTaxCategoryListExternalAPIController query parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ClinicTaxCategoryListQueryParamsSchema", "type": "object" }, "CoOwnerRelationshipKind": { "enum": [ "SPOUSE", "PARTNER", "PARENT", "CHILD", "SIBLING", "OTHER" ], "title": "CoOwnerRelationshipKind", "type": "string" }, "ConnectExternalPrescriptionSchema": { "properties": { "group_service_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the group service, if mapped.", "title": "Group Service Id" }, "group_service_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the group service, if mapped.", "title": "Group Service Name" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the external prescription.", "title": "Name" }, "quantity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The prescribed quantity.", "title": "Quantity" } }, "title": "External Prescription", "type": "object" }, "ConnectHDPrescriptionSchema": { "properties": { "id": { "description": "The ID of the HD prescription fill. References the prescription fill history API.", "title": "Id", "type": "integer" }, "item_id": { "description": "The ID of the catalog item.", "title": "Item Id", "type": "integer" }, "item_name": { "description": "The name of the catalog item.", "title": "Item Name", "type": "string" }, "quantity_prescribed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The prescribed quantity, accounting for default units.", "title": "Quantity Prescribed" } }, "required": [ "id", "item_id", "item_name" ], "title": "Home Delivery Prescription", "type": "object" }, "ConnectInternalPrescriptionSchema": { "properties": { "group_service_id": { "description": "The ID of the group service.", "title": "Group Service Id", "type": "integer" }, "group_service_name": { "description": "The name of the group service.", "title": "Group Service Name", "type": "string" }, "quantity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The prescribed quantity.", "title": "Quantity" } }, "required": [ "group_service_id", "group_service_name" ], "title": "Internal Prescription", "type": "object" }, "ConnectPrescriptionDetailSchema": { "description": "A medication prescribed to a patient by a doctor.", "properties": { "allowed_uses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The number of fills allowed for this prescript, each with the specified `quantity`.", "title": "Allowed Uses" }, "client_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Additional notes for the prescription.", "title": "Client Notes" }, "clinic_id": { "description": "The ID of the clinic where this prescription was created.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient that this prescription is for.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "days_supply": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "How many days one unit of this prescription is itended to last for.", "title": "Days Supply" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "directions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The directions for the prescription.", "title": "Directions" }, "expiration_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this prescription expires, if applicable.", "title": "Expiration Date" }, "id": { "description": "The unique identifier for the prescription.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_prn": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the prescription is PRN.", "title": "Is Prn" }, "item": { "$ref": "#/components/schemas/ConnectPrescriptionItemSchema", "description": "The item this prescription is for." }, "last_filled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the last fill was dispensed.", "title": "Last Filled At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "prescribed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the prescription was prescribed.", "title": "Prescribed At" }, "prescribed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the doctor who prescribed the prescription.", "title": "Prescribed By" }, "prescribed_by_doctor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the doctor who prescribed the prescription. Use with the Doctors endpoint to look up full doctor details.", "title": "Prescribed By Doctor Id" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "How many of the items should be provided for each fill.", "title": "Quantity" }, "remaining_fills": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of fills remaining for this prescription.", "title": "Remaining Fills" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PrescriptionStatus" }, { "type": "null" } ], "description": "The status of the prescription." }, "total_allowed_uses": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The total quantity for which the prescription can be used for the item. None if the prescription is PRN.", "title": "Total Allowed Uses" }, "total_order_item_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The count of order items placed against this prescription. Each order consumes one full fill.", "title": "Total Order Item Count" }, "total_uses": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The total quantity of the item that has been used for this prescription.", "title": "Total Uses" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "clinic_patient_id", "item" ], "title": "Prescription", "type": "object" }, "ConnectPrescriptionFillItemSchema": { "properties": { "id": { "description": "The ID of the catalog item prescribed.", "title": "Id", "type": "integer" }, "name": { "description": "The name of the catalog item prescribed.", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "ConnectPrescriptionFillItemSchema", "type": "object" }, "ConnectPrescriptionHistorySchema": { "properties": { "allowed_uses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The number of fills allowed, each with the specified `quantity`.", "title": "Allowed Uses" }, "client_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Additional notes for the client.", "title": "Client Notes" }, "clinic_id": { "description": "The ID of the clinic where this prescription was created.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient that this prescription is for.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "days_supply": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "How many days one unit of this prescription is intended to last for.", "title": "Days Supply" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "directions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The directions for the prescription.", "title": "Directions" }, "expiration_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this prescription expires, if applicable.", "title": "Expiration Date" }, "id": { "description": "The unique identifier for this prescription history record.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_prn": { "description": "Whether the prescription is PRN (as needed).", "title": "Is Prn", "type": "boolean" }, "item": { "$ref": "#/components/schemas/ConnectPrescriptionFillItemSchema", "description": "The catalog item prescribed." }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "prescribed_at": { "description": "The date and time when the prescription was written.", "format": "date-time", "title": "Prescribed At", "type": "string" }, "prescribed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the doctor who prescribed the prescription.", "title": "Prescribed By" }, "prescribed_by_doctor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the doctor who prescribed the prescription. Use with the Doctors endpoint to look up full doctor details.", "title": "Prescribed By Doctor Id" }, "prescription_id": { "description": "The ID of the prescription record that this prescription history entry belongs to.", "title": "Prescription Id", "type": "integer" }, "quantity": { "description": "How many of the items should be provided for each fill.", "minimum": 0, "title": "Quantity", "type": "integer" }, "rx_notification_sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp of when the prescription created notification was sent. Null if no notification has been sent.", "title": "Rx Notification Sent At" }, "scheduled_rx_notification_sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp of when the scheduled prescription created notification was sent. Null if no scheduled notification has been sent.", "title": "Scheduled Rx Notification Sent At" }, "status": { "$ref": "#/components/schemas/PrescriptionStatus", "description": "The status of this prescription history record." }, "total_allowed_uses": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The total quantity for which the prescription can be used for the item. None if the prescription is PRN.", "title": "Total Allowed Uses" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "status", "prescription_id", "clinic_id", "clinic_patient_id", "item", "is_prn", "prescribed_at", "quantity" ], "title": "ConnectPrescriptionHistorySchema", "type": "object" }, "ConnectPrescriptionHistorySchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ConnectPrescriptionHistorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ConnectPrescriptionHistorySchemaList", "type": "object" }, "ConnectPrescriptionItemSchema": { "properties": { "id": { "description": "The ID of the item.", "title": "Id", "type": "integer" }, "name": { "description": "The name of the item.", "title": "Name", "type": "string" } }, "required": [ "name", "id" ], "title": "ConnectPrescriptionItemSchema", "type": "object" }, "ConnectPrescriptionSchema": { "properties": { "allowed_uses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The number of fills allowed for this prescript, each with the specified `quantity`.", "title": "Allowed Uses" }, "client_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Additional notes for the prescription.", "title": "Client Notes" }, "clinic_id": { "description": "The ID of the clinic where this prescription was created.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient that this prescription is for.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "days_supply": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "How many days one unit of this prescription is itended to last for.", "title": "Days Supply" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "directions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The directions for the prescription.", "title": "Directions" }, "expiration_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this prescription expires, if applicable.", "title": "Expiration Date" }, "id": { "description": "The unique identifier for the prescription.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_prn": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the prescription is PRN.", "title": "Is Prn" }, "item": { "$ref": "#/components/schemas/ConnectPrescriptionItemSchema", "description": "The item this prescription is for." }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "prescribed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the prescription was prescribed.", "title": "Prescribed At" }, "prescribed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the doctor who prescribed the prescription.", "title": "Prescribed By" }, "prescribed_by_doctor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the doctor who prescribed the prescription. Use with the Doctors endpoint to look up full doctor details.", "title": "Prescribed By Doctor Id" }, "quantity": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "How many of the items should be provided for each fill.", "title": "Quantity" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PrescriptionStatus" }, { "type": "null" } ], "description": "The status of the prescription." }, "total_allowed_uses": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The total quantity for which the prescription can be used for the item. None if the prescription is PRN.", "title": "Total Allowed Uses" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "clinic_patient_id", "item" ], "title": "ConnectPrescriptionSchema", "type": "object" }, "ConnectPrescriptionSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ConnectPrescriptionSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ConnectPrescriptionSchemaList", "type": "object" }, "ConnectUniversalPrescriptionHistorySchema": { "description": "A version of a universal prescription. Multiple versions may exist for the same logical prescription when it is renewed or edited.", "properties": { "allowed_uses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The number of fills allowed. None if the prescription is PRN.", "title": "Allowed Uses" }, "authorized_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the clinic user who authorized this prescription.", "title": "Authorized By" }, "client_notes": { "default": "", "description": "Additional notes for the client.", "title": "Client Notes", "type": "string" }, "clinic_id": { "description": "The ID of the clinic where this prescription was created.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient that this prescription is for.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "directions": { "default": "", "description": "The directions for the prescription.", "title": "Directions", "type": "string" }, "expiration_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this prescription expires, if applicable.", "title": "Expiration Date" }, "external_prescription": { "anyOf": [ { "$ref": "#/components/schemas/ConnectExternalPrescriptionSchema" }, { "type": "null" } ], "description": "External (third-party pharmacy) prescription details. Present when this is an external prescription." }, "fills_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of fills still available. None if PRN.", "title": "Fills Remaining" }, "fills_used": { "description": "The number of fills consumed across all fulfillment channels.", "title": "Fills Used", "type": "integer" }, "hd_prescription": { "anyOf": [ { "$ref": "#/components/schemas/ConnectHDPrescriptionSchema" }, { "type": "null" } ], "description": "Home delivery prescription details. Present when this is a home delivery prescription." }, "id": { "description": "The unique identifier for this universal prescription history record.", "title": "Id", "type": "integer" }, "internal_prescription": { "anyOf": [ { "$ref": "#/components/schemas/ConnectInternalPrescriptionSchema" }, { "type": "null" } ], "description": "Internal (in-clinic) prescription details. Present when this is an internal prescription." }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_prn": { "description": "Whether the prescription allows unlimited refills (PRN).", "title": "Is Prn", "type": "boolean" }, "latest_fill_id": { "title": "Latest Fill Id", "type": "null" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "original_created": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the prescription was first created in the system. Null when the source system did not provide an issued date.", "title": "Original Created" }, "prescribed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the prescribing doctor.", "title": "Prescribed By" }, "prescribed_by_doctor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the prescribing doctor. Use with the Doctors endpoint to look up full doctor details.", "title": "Prescribed By Doctor Id" }, "prescription_id": { "description": "The ID of the universal prescription this history record belongs to.", "title": "Prescription Id", "type": "integer" }, "status": { "$ref": "#/components/schemas/VisibleUniversalPrescriptionStatus", "description": "The visible status of the prescription." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "clinic_patient_id", "status", "is_prn", "fills_used", "fills_remaining", "prescription_id" ], "title": "Universal Prescription History", "type": "object" }, "ConnectUniversalPrescriptionSchema": { "description": "A universal prescription represents a medication or service prescribed to a patient by a veterinarian. Universal prescriptions unify three fulfillment types \u2014 home delivery, internal (in-clinic), and external (third-party pharmacy) \u2014 into a single record.", "properties": { "allowed_uses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The number of fills allowed. None if the prescription is PRN.", "title": "Allowed Uses" }, "authorized_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the clinic user who authorized this prescription.", "title": "Authorized By" }, "client_notes": { "default": "", "description": "Additional notes for the client.", "title": "Client Notes", "type": "string" }, "clinic_id": { "description": "The ID of the clinic where this prescription was created.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient that this prescription is for.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "directions": { "default": "", "description": "The directions for the prescription.", "title": "Directions", "type": "string" }, "expiration_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this prescription expires, if applicable.", "title": "Expiration Date" }, "external_prescription": { "anyOf": [ { "$ref": "#/components/schemas/ConnectExternalPrescriptionSchema" }, { "type": "null" } ], "description": "External (third-party pharmacy) prescription details. Present when this is an external prescription." }, "fills_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of fills still available. None if PRN.", "title": "Fills Remaining" }, "fills_used": { "description": "The number of fills consumed across all fulfillment channels.", "title": "Fills Used", "type": "integer" }, "hd_prescription": { "anyOf": [ { "$ref": "#/components/schemas/ConnectHDPrescriptionSchema" }, { "type": "null" } ], "description": "Home delivery prescription details. Present when this is a home delivery prescription." }, "id": { "description": "The unique identifier for this universal prescription.", "title": "Id", "type": "integer" }, "internal_prescription": { "anyOf": [ { "$ref": "#/components/schemas/ConnectInternalPrescriptionSchema" }, { "type": "null" } ], "description": "Internal (in-clinic) prescription details. Present when this is an internal prescription." }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_prn": { "description": "Whether the prescription allows unlimited refills (PRN).", "title": "Is Prn", "type": "boolean" }, "latest_fill_id": { "description": "The ID of the current universal prescription version. Use this to look up the full history via the history endpoint.", "title": "Latest Fill Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "original_created": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the prescription was first created in the system. Null when the source system did not provide an issued date.", "title": "Original Created" }, "prescribed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the prescribing doctor.", "title": "Prescribed By" }, "prescribed_by_doctor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the prescribing doctor. Use with the Doctors endpoint to look up full doctor details.", "title": "Prescribed By Doctor Id" }, "status": { "$ref": "#/components/schemas/VisibleUniversalPrescriptionStatus", "description": "The visible status of the prescription." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "clinic_patient_id", "status", "is_prn", "latest_fill_id", "fills_used", "fills_remaining" ], "title": "Universal Prescription", "type": "object" }, "Countries": { "enum": [ "CA", "US", "AS", "GU", "MP", "PR", "VI" ], "title": "Countries", "type": "string" }, "CreateImportedConversationRequestSchema": { "description": "Schema for creating an imported conversation via the Connect API.", "properties": { "attachment_uploaded_file_ids": { "description": "IDs of files previously uploaded via `POST /file-uploads/` that belong to this conversation.", "items": { "type": "integer" }, "title": "Attachment Uploaded File Ids", "type": "array" }, "clinic_client_id": { "description": "The ID of the clinic client (pet parent) the conversation is about.", "title": "Clinic Client Id", "type": "integer" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient the conversation is about. When omitted, the conversation is attached to every active patient of the clinic client so that it surfaces on every one of the client's patient timelines.", "title": "Clinic Patient Id" }, "text": { "description": "The full conversation transcript, stored and rendered verbatim in the Vetcove patient timeline.", "minLength": 1, "title": "Text", "type": "string" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Short label shown in the patient timeline preview row.", "title": "Title" } }, "required": [ "clinic_client_id", "text" ], "title": "CreateImportedConversationRequestSchema", "type": "object" }, "CreateSmsNotificationRequestSchema": { "description": "Schema for creating an SMS notification via the Connect API.", "properties": { "body": { "description": "The SMS message body.", "maxLength": 1600, "minLength": 1, "title": "Body", "type": "string" }, "clinic_client_id": { "description": "The ID of the clinic client to send the SMS to.", "title": "Clinic Client Id", "type": "integer" } }, "required": [ "clinic_client_id", "body" ], "title": "CreateSmsNotificationRequestSchema", "type": "object" }, "Currency": { "enum": [ "USD", "CAD" ], "title": "Currency", "type": "string" }, "DeletedFilterOption": { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" }, "DisambiguationResolutionField": { "enum": [ "clinic_patient_id", "clinic_client_id" ], "title": "DisambiguationResolutionField", "type": "string" }, "DoctorDetailPathParamsSchema": { "description": "Schema for the DoctorDetailExternalAPIController path parameters", "properties": { "doctor_id": { "description": "The ID of the doctor to fetch", "title": "Doctor Id", "type": "integer" } }, "required": [ "doctor_id" ], "title": "DoctorDetailPathParamsSchema", "type": "object" }, "DoctorListQueryParamsSchema": { "description": "Schema for the DoctorListExternalAPIController query parameters", "properties": { "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to doctors associated with the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to active doctors. When `False`, filters to inactive doctors. When omitted, both are included.", "title": "Is Active" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "DoctorListQueryParamsSchema", "type": "object" }, "EffectiveInventoryPreference": { "properties": { "clinic_location_group_ids": { "description": "Which clinic location groups this inventory code is relevant to within your organization", "items": { "type": "integer" }, "title": "Clinic Location Group Ids", "type": "array" }, "grade": { "anyOf": [ { "$ref": "#/components/schemas/InventoryGrade" }, { "const": "", "type": "string" } ], "description": "The grade (importance) assigned to this type of inventory by your organization", "title": "Grade" }, "is_enabled": { "description": "Whether this inventory code is enabled for your organization", "title": "Is Enabled", "type": "boolean" }, "name": { "description": "The name assigned to this type of inventory for your organization", "title": "Name", "type": "string" }, "unit_of_measure": { "$ref": "#/components/schemas/InventoryUnitOfMeasure", "description": "The settings for how units of this inventory are measured for your organization" } }, "required": [ "is_enabled", "name", "unit_of_measure", "grade", "clinic_location_group_ids" ], "title": "EffectiveInventoryPreference", "type": "object" }, "EmailOperator": { "enum": [ "EXACT", "CONTAINS" ], "title": "EmailOperator", "type": "string" }, "ExternalAPIDetailViewPkPathParamsSchema": { "properties": { "pk": { "title": "Pk", "type": "integer" } }, "required": [ "pk" ], "title": "ExternalAPIDetailViewPkPathParamsSchema", "type": "object" }, "ExternalAPIListViewQueryParamsSchema": { "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ExternalAPIListViewQueryParamsSchema", "type": "object" }, "ExternalAPITimestampedListViewQueryParamsSchema": { "description": "Query parameters for list endpoints with timestamp filtering and cursor-based pagination.\n\nExtends the base list schema with:\n- cursor: for stable pagination using modified timestamp + ID\n- modified__gte/modified__lte: for timestamp filtering\n\nSupports both id_pagination and modified_pagination strategies dynamically.", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ExternalAPITimestampedListViewQueryParamsSchema", "type": "object" }, "ExternalAddressSchema": { "properties": { "address_one": { "description": "The first line of the address.", "maxLength": 100, "title": "Address One", "type": "string" }, "address_two": { "default": "", "description": "The second line of the address.", "maxLength": 100, "title": "Address Two", "type": "string" }, "city": { "description": "The city of the address.", "maxLength": 100, "title": "City", "type": "string" }, "country": { "allOf": [ { "$ref": "#/components/schemas/Countries" } ], "default": "US", "description": "The 2-letter code of the country of the address." }, "county": { "default": "", "description": "The county of the address.", "maxLength": 100, "title": "County", "type": "string" }, "id": { "description": "The ID of the address.", "title": "Id", "type": "integer" }, "name": { "default": "", "description": "The name of the address.", "maxLength": 100, "title": "Name", "type": "string" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The phone number of the address.", "title": "Phone Number" }, "state": { "description": "The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention.", "title": "State", "type": "string" }, "zipcode": { "description": "The zip code/postal code of the address.", "maxLength": 10, "title": "Zipcode", "type": "string" } }, "required": [ "address_one", "city", "state", "zipcode", "id" ], "title": "ExternalAddressSchema", "type": "object" }, "ExternalAppointmentCreatedWebhookFormRequestSchema": { "description": "Form request payload for the appointment.created webhook event.", "properties": { "appointment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the linked appointment, if any.", "title": "Appointment Id" }, "client_id": { "description": "The ID of the clinic client this form request belongs to.", "title": "Client Id", "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the client submitted the completed form.", "title": "Completed At" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "dashboard_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client-facing dashboard URL for all pending forms for this client. Null until the form request has been sent.", "title": "Dashboard Url" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the form request expires and is no longer available.", "title": "Expires At" }, "form_type": { "$ref": "#/components/schemas/ExternalFormTypeSchema", "description": "Metadata about the form definition for this request." }, "id": { "description": "The unique identifier for the form request.", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_id": { "description": "The ID of the clinic patient this form request belongs to.", "title": "Patient Id", "type": "integer" }, "sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the form request was sent to the client.", "title": "Sent At" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the client first opened or began filling out the form.", "title": "Started At" }, "status": { "$ref": "#/components/schemas/ExternalFormRequestStatus", "description": "The current status of the form request." }, "url": { "description": "The client-facing URL for this individual form request.", "title": "Url", "type": "string" } }, "required": [ "created", "modified", "id", "client_id", "patient_id", "appointment_id", "form_type", "status", "sent_at", "started_at", "completed_at", "expires_at", "url", "dashboard_url" ], "title": "ExternalAppointmentCreatedWebhookFormRequestSchema", "type": "object" }, "ExternalAppointmentHistorySchema": { "description": "Appointment history represents a snapshot of what an appointment's data looked like in the past.", "properties": { "acting_user_id": { "description": "The ID of the profile of the user who took this action.", "title": "Acting User Id", "type": "integer" }, "action_kind": { "anyOf": [ { "$ref": "#/components/schemas/HistoryActionKind" }, { "const": "", "type": "string" } ], "description": "The kind of action captured by this event.", "title": "Action Kind" }, "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "appointment_id": { "description": "The unique identifier for the appointment that this history is tracking.", "title": "Appointment Id", "type": "integer" }, "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Clinic Client Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Clinic Patient Id" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "event_datetime": { "description": "The date and time the event occurred.", "format": "date-time", "title": "Event Datetime", "type": "string" }, "id": { "description": "The unique identifier for this appointment history object. The value of this ID may exceed JavaScript's `Number.MAX_SAFE_INTEGER` (2^53 - 1). JavaScript consumers should handle this value appropriately to avoid precision loss.", "format": "int64", "title": "Id", "type": "integer" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "event_datetime", "action_kind", "acting_user_id", "id", "appointment_id", "resource_id", "room_id", "clinic_patient_id", "clinic_client_id", "start_datetime", "end_datetime", "status", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags" ], "title": "AppointmentHistory", "type": "object" }, "ExternalAppointmentKindDetailSchema": { "description": "Detailed information about an appointment kind.", "properties": { "color": { "anyOf": [ { "$ref": "#/components/schemas/PastelColor" }, { "const": "", "type": "string" } ], "description": "Color for the AppointmentKind.", "title": "Color" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the appointment kind.", "title": "Description" }, "id": { "description": "The unique identifier for the appointment kind.", "title": "Id", "type": "integer" }, "includes_pickup_and_dropoff": { "description": "Whether appointments of this kind require a dropoff and pickup.", "title": "Includes Pickup And Dropoff", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Display name for the appointment kind.", "title": "Name", "type": "string" } }, "required": [ "created", "modified", "id", "name", "color", "includes_pickup_and_dropoff", "description" ], "title": "AppointmentKindDetail", "type": "object" }, "ExternalAppointmentKindSchema": { "description": "A configurable 'kind' that an Appointment can be made for.", "properties": { "color": { "anyOf": [ { "$ref": "#/components/schemas/PastelColor" }, { "const": "", "type": "string" } ], "description": "Color for the AppointmentKind.", "title": "Color" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the appointment kind.", "title": "Description" }, "id": { "description": "The unique identifier for the appointment kind.", "title": "Id", "type": "integer" }, "includes_pickup_and_dropoff": { "description": "Whether appointments of this kind require a dropoff and pickup.", "title": "Includes Pickup And Dropoff", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Display name for the appointment kind.", "title": "Name", "type": "string" } }, "required": [ "created", "modified", "id", "name", "color", "includes_pickup_and_dropoff", "description" ], "title": "AppointmentKind", "type": "object" }, "ExternalAppointmentSchema": { "description": "Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.\n\nUnlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.", "properties": { "alert_tags": { "description": "Array of alert tags associated with this appointment.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentAlertTag" }, { "const": "", "type": "string" } ] }, "title": "Alert Tags", "type": "array" }, "calendar_id": { "description": "The ID of the calendar this appointment belongs to.", "title": "Calendar Id", "type": "integer" }, "cancelation_reason": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentCancelationReason" }, { "const": "", "type": "string" } ], "description": "The reason for cancelation or no-show, if applicable.", "title": "Cancelation Reason" }, "cancelation_reason_other": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text explanation of the cancelation, if one was provided.", "title": "Cancelation Reason Other" }, "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client responsible for the appointment.", "title": "Clinic Client Id" }, "clinic_id": { "description": "The ID of the clinic this appointment belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_notes": { "anyOf": [ {}, { "type": "null" } ], "description": "JSON structured notes for clinic use.", "title": "Clinic Notes" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic patient this appointment is for.", "title": "Clinic Patient Id" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "dropoff_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be dropped off.", "title": "Dropoff Start Datetime" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment ends.", "title": "End Datetime" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this appointment.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "id": { "description": "The unique identifier for the appointment.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The appointment kind (type of appointment).", "title": "Kind" }, "kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the appointment kind (type of appointment).", "title": "Kind Id" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the medical record associated with this appointment, if any.", "title": "Medical Record Id" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "pickup_start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the patient should be picked up.", "title": "Pickup Start Datetime" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason for this appointment.", "title": "Reason" }, "resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Id" }, "resource_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the calendar resource (provider/room) assigned to handle this appointment.", "title": "Resource Name" }, "room_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the room assigned to this appointment, if any.", "title": "Room Id" }, "room_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the room assigned to this appointment, if any.", "title": "Room Name" }, "start_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the appointment starts.", "title": "Start Datetime" }, "status": { "$ref": "#/components/schemas/AppointmentStatus", "description": "The current status of the appointment." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "calendar_id", "resource_id", "room_id", "clinic_patient_id", "clinic_client_id", "start_datetime", "end_datetime", "status", "clinic_notes", "reason", "dropoff_start_datetime", "pickup_start_datetime", "alert_tags", "cancelation_reason", "cancelation_reason_other" ], "title": "Appointment", "type": "object" }, "ExternalAssessmentSchema": { "description": "An assessment represents a diagnosis or differential diagnosis associated with a medical record. It contains information about the diagnosis, notes, and resolution status.", "properties": { "created_by_name": { "description": "The name of the user who created this assessment.", "title": "Created By Name", "type": "string" }, "created_datetime": { "description": "When this assessment was created.", "format": "date-time", "title": "Created Datetime", "type": "string" }, "diagnosis_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the diagnosis.", "title": "Diagnosis Description" }, "diagnosis_name": { "description": "The name of the diagnosis for this assessment.", "title": "Diagnosis Name", "type": "string" }, "differential_confirmed_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the differential assessment was confirmed, if applicable.", "title": "Differential Confirmed Datetime" }, "id": { "description": "The ID for the assessment.", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether this assessment is currently active (not resolved).", "title": "Is Active", "type": "boolean" }, "is_chronic": { "description": "Whether this is a chronic diagnosis.", "title": "Is Chronic", "type": "boolean" }, "is_external": { "description": "Whether this is an external diagnosis.", "title": "Is External", "type": "boolean" }, "kind": { "description": "The kind of assessment (Assessment or Differential).", "title": "Kind", "type": "string" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the medical record this assessment belongs to.", "title": "Medical Record Id" }, "note": { "description": "Notes for this assessment.", "title": "Note", "type": "string" }, "patient_id": { "description": "The ID of the patient this assessment belongs to.", "title": "Patient Id", "type": "integer" }, "resolved_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this assessment was resolved, if applicable.", "title": "Resolved Datetime" } }, "required": [ "id", "patient_id", "medical_record_id", "diagnosis_name", "is_external", "created_by_name", "is_chronic", "note", "kind", "created_datetime", "resolved_datetime", "differential_confirmed_datetime", "is_active" ], "title": "Assessment", "type": "object" }, "ExternalAutoAuthRequestSchema": { "properties": { "client_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client's email address. At least one of client_email, client_phone_number, or clinic_client_user_id must be provided.", "title": "Client Email" }, "client_phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The client's phone number. At least one of client_email, client_phone_number, or clinic_client_user_id must be provided.", "title": "Client Phone Number" }, "clinic_client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client user to authenticate. When provided, client_email and client_phone_number are ignored. At least one of client_email, client_phone_number, or clinic_client_user_id must be provided.", "title": "Clinic Client User Id" }, "clinic_id": { "description": "The ID of the clinic the client belongs to", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ExternalAutoAuthRequestSchema", "type": "object" }, "ExternalAvailabilitySlotSchema": { "properties": { "end_datetime": { "description": "The end of this available slot, in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "start_datetime": { "description": "The start of this available slot, in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "start_datetime", "end_datetime" ], "title": "ExternalAvailabilitySlotSchema", "type": "object" }, "ExternalBillingFrequency": { "enum": [ "MONTHLY", "ANNUAL" ], "title": "ExternalBillingFrequency", "type": "string" }, "ExternalCalendarAvailabilitySchema": { "properties": { "appointment_kind_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the appointment kind these slots apply to, or null when no appointment kind was requested. When null, slots are sized by the calendar's configured default appointment duration.", "title": "Appointment Kind Id" }, "calendar_resource_id": { "description": "The ID of the calendar resource.", "title": "Calendar Resource Id", "type": "integer" }, "calendar_resource_name": { "description": "The name of the calendar resource.", "title": "Calendar Resource Name", "type": "string" }, "slots": { "description": "The available appointment slots for this resource within the requested date range.", "items": { "$ref": "#/components/schemas/ExternalAvailabilitySlotSchema" }, "title": "Slots", "type": "array" } }, "required": [ "calendar_resource_id", "calendar_resource_name", "appointment_kind_id", "slots" ], "title": "ExternalCalendarAvailabilitySchema", "type": "object" }, "ExternalCalendarAvailabilitySchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarAvailabilitySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCalendarAvailabilitySchemaList", "type": "object" }, "ExternalCalendarDesignationBlockSchema": { "properties": { "appointment_kind_ids": { "default": [], "description": "The ID's of the appointment kinds allowed for this designation block", "items": { "type": "integer" }, "title": "Appointment Kind Ids", "type": "array" }, "calendar_resource_id": { "description": "The ID of the calendar resource this designation belongs to.", "title": "Calendar Resource Id", "type": "integer" }, "end_datetime": { "description": "The ending datetime of this instance of the designation, in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of this designation.", "title": "Name" }, "start_datetime": { "description": "The starting datetime of this instance of the designation, in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "calendar_resource_id", "name", "start_datetime", "end_datetime" ], "title": "ExternalCalendarDesignationBlockSchema", "type": "object" }, "ExternalCalendarDesignationBlockSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarDesignationBlockSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCalendarDesignationBlockSchemaList", "type": "object" }, "ExternalCalendarDesignationSchema": { "properties": { "appointment_kind_ids": { "description": "The IDs of the appointment kinds this designation is reserved for.", "items": { "type": "integer" }, "title": "Appointment Kind Ids", "type": "array" }, "calendar_resource_id": { "description": "The ID of the calendar resource this designation is assigned to.", "title": "Calendar Resource Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this designation belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "duration_minutes": { "description": "Duration of the designation in minutes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the designation in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar designation.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Display name for this designation.", "title": "Name", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_designation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "If this is an exception to a recurring designation, the ID of the parent.", "title": "Recurring Designation Id" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the designation in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "clinic_id", "calendar_resource_id", "name", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarDesignationSchema", "type": "object" }, "ExternalCalendarDesignationSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarDesignationSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCalendarDesignationSchemaList", "type": "object" }, "ExternalCalendarDetailSchema": { "description": "Detailed information about a calendar", "properties": { "allowed_appointment_kinds": { "description": "List of appointment kind IDs that can be booked on this calendar.", "items": { "type": "integer" }, "title": "Allowed Appointment Kinds", "type": "array" }, "block_increment_minutes": { "$ref": "#/components/schemas/MinuteIncrements", "description": "The granularity at which blocks should be scheduled in this calendar." }, "clinic_id": { "description": "The ID of the clinic this calendar belongs to.", "title": "Clinic Id", "type": "integer" }, "default_duration_minutes": { "$ref": "#/components/schemas/MinuteIncrements", "description": "The default time a generic appointment on this calendar should be booked for." }, "id": { "description": "The unique identifier for the calendar.", "title": "Id", "type": "integer" }, "is_client_booking_enabled": { "description": "Whether client booking is enabled for this calendar.", "title": "Is Client Booking Enabled", "type": "boolean" }, "name": { "description": "Display name for the calendar.", "title": "Name", "type": "string" }, "non_exotic_species": { "description": "List of species that the clinic defines as not exotic.", "items": { "type": "string" }, "title": "Non Exotic Species", "type": "array" } }, "required": [ "id", "clinic_id", "name", "block_increment_minutes", "default_duration_minutes", "is_client_booking_enabled", "non_exotic_species", "allowed_appointment_kinds" ], "title": "CalendarDetail", "type": "object" }, "ExternalCalendarEventBlockSchema": { "properties": { "calendar_resource_ids": { "description": "The ID's of the calendar resources for this event block. `is_applicable_to_all_resources` takes precedence over this field.", "items": { "type": "integer" }, "title": "Calendar Resource Ids", "type": "array" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of this event block.", "title": "Description" }, "end_datetime": { "description": "The end datetime for this event block, in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "is_applicable_to_all_resources": { "description": "Whether this event block is applicable to all calendar resources.", "title": "Is Applicable To All Resources", "type": "boolean" }, "kind_id": { "description": "The ID of the calendar event kind for this event block.", "title": "Kind Id", "type": "integer" }, "should_block_appointments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether appointments can be scheduled over this event block.", "title": "Should Block Appointments" }, "start_datetime": { "description": "The start datetime for this event block, in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "calendar_resource_ids", "is_applicable_to_all_resources", "kind_id", "description", "should_block_appointments", "start_datetime", "end_datetime" ], "title": "ExternalCalendarEventBlockSchema", "type": "object" }, "ExternalCalendarEventBlockSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarEventBlockSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCalendarEventBlockSchemaList", "type": "object" }, "ExternalCalendarEventKindSchema": { "properties": { "counts_towards_working_hours": { "description": "Whether events of this kind count towards a resource's working hours", "title": "Counts Towards Working Hours", "type": "boolean" }, "id": { "description": "The unique identifier for this calendar event kind object.", "title": "Id", "type": "integer" }, "name": { "description": "The name of this calendar event kind.", "title": "Name", "type": "string" }, "requires_event_description": { "description": "Whether events of this kind require an event description.", "title": "Requires Event Description", "type": "boolean" } }, "required": [ "id", "name", "requires_event_description", "counts_towards_working_hours" ], "title": "ExternalCalendarEventKindSchema", "type": "object" }, "ExternalCalendarEventKindSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarEventKindSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCalendarEventKindSchemaList", "type": "object" }, "ExternalCalendarEventSchema": { "properties": { "calendar_resource_ids": { "description": "The IDs of the calendar resources this event is assigned to.", "items": { "type": "integer" }, "title": "Calendar Resource Ids", "type": "array" }, "clinic_id": { "description": "The ID of the clinic this calendar event belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Plain-text description of the event.", "title": "Description" }, "duration_minutes": { "description": "Duration of the event in minutes, computed from start and end datetimes.", "title": "Duration Minutes", "type": "integer" }, "end_datetime": { "description": "ISO 8601 formatted end datetime of the event in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "id": { "description": "The unique identifier for this calendar event.", "title": "Id", "type": "integer" }, "is_applicable_to_all_resources": { "description": "Whether this event applies to all resources on the calendar.", "title": "Is Applicable To All Resources", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "kind_id": { "description": "The ID of the calendar event kind.", "title": "Kind Id", "type": "integer" }, "kind_slug": { "description": "The slug identifier of the calendar event kind.", "title": "Kind Slug", "type": "string" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "description": "Structured recurrence pattern, if recurring." }, "recurrence_excluded_datetimes": { "description": "Specific datetimes excluded from the recurrence pattern.", "items": { "format": "date-time", "type": "string" }, "title": "Recurrence Excluded Datetimes", "type": "array" }, "recurring_event_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "If this event is an exception to a recurring series, the ID of the parent recurring event.", "title": "Recurring Event Id" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "should_block_appointments": { "description": "Whether this event prevents appointments from being scheduled during its time window.", "title": "Should Block Appointments", "type": "boolean" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the event in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "clinic_id", "is_applicable_to_all_resources", "kind_id", "kind_slug", "description", "should_block_appointments", "start_datetime", "end_datetime", "duration_minutes" ], "title": "ExternalCalendarEventSchema", "type": "object" }, "ExternalCalendarEventSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarEventSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCalendarEventSchemaList", "type": "object" }, "ExternalCalendarKindPreferenceSchema": { "description": "Calendar Kind Preferences represent configurations of an AppointmentKind for a specific Calendar", "properties": { "appointment_kind_id": { "description": "The ID of the appointment kind this preference is for.", "title": "Appointment Kind Id", "type": "integer" }, "calendar_id": { "description": "The ID of the calendar this preference is for.", "title": "Calendar Id", "type": "integer" }, "calendar_resource_ids": { "default": [], "description": "Calendar resources this appointment kind is limited to.", "items": { "type": "integer" }, "title": "Calendar Resource Ids", "type": "array" }, "clinic_id": { "description": "The ID of the clinic this preference belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "default_duration_minutes": { "$ref": "#/components/schemas/MinuteIncrements", "description": "The default duration in minutes for appointments of this kind on this calendar." }, "id": { "description": "The unique identifier for this calendar kind preference object.", "title": "Id", "type": "integer" }, "is_client_bookable": { "description": "Whether clients can book this appointment kind.", "title": "Is Client Bookable", "type": "boolean" }, "min_hours_before_booking": { "description": "The minimum number of hours in advance appointments can be booked, for this appointment kind and calendar.", "title": "Min Hours Before Booking", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" } }, "required": [ "created", "modified", "id", "appointment_kind_id", "calendar_id", "clinic_id", "default_duration_minutes", "is_client_bookable", "min_hours_before_booking" ], "title": "CalendarKindPreference", "type": "object" }, "ExternalCalendarResourceClinicUserSchema": { "description": "Nested schema for the clinic user on a calendar resource.", "properties": { "id": { "description": "The unique identifier for the clinic user.", "title": "Id", "type": "integer" }, "name": { "description": "The display name of the clinic user.", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "ExternalCalendarResourceClinicUserSchema", "type": "object" }, "ExternalCalendarResourceSchema": { "description": "Calendar resource represents a provider, room, or similar for a calendar.", "properties": { "calendar_id": { "description": "The ID of the calendar this resource belongs to.", "title": "Calendar Id", "type": "integer" }, "can_client_double_book": { "description": "Whether this resource can be double booked from the client side.", "title": "Can Client Double Book", "type": "boolean" }, "can_clinic_double_book": { "description": "Whether this resource can be double booked from the clinic side.", "title": "Can Clinic Double Book", "type": "boolean" }, "clinic_id": { "description": "The ID of the clinic this resource belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_user": { "anyOf": [ { "$ref": "#/components/schemas/ExternalCalendarResourceClinicUserSchema" }, { "type": "null" } ], "description": "The clinic user associated with this resource, if any." }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "description": "The unique identifier for this calendar resource object.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_imported": { "description": "Whether this resource was created via import from the legacy PIMS.", "title": "Is Imported", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of this resource.", "title": "Name" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "calendar_id", "clinic_id", "clinic_user", "name", "can_clinic_double_book", "can_client_double_book", "is_imported" ], "title": "Calendar Resource", "type": "object" }, "ExternalCalendarRoomSchema": { "properties": { "calendar_id": { "description": "The ID of the calendar this room belongs to.", "title": "Calendar Id", "type": "integer" }, "id": { "description": "The unique identifier for this calendar room object.", "title": "Id", "type": "integer" }, "name": { "description": "The name of the calendar's room.", "title": "Name", "type": "string" } }, "required": [ "id", "calendar_id", "name" ], "title": "ExternalCalendarRoomSchema", "type": "object" }, "ExternalCalendarRoomSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCalendarRoomSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCalendarRoomSchemaList", "type": "object" }, "ExternalCalendarSchema": { "description": "Calendar showing appointments and other event types with distinct configurations, can have multiple for each Clinic (eg. a 'medical' calendar and a 'boarding' calendar)", "properties": { "allowed_appointment_kinds": { "description": "List of appointment kind IDs that can be booked on this calendar.", "items": { "type": "integer" }, "title": "Allowed Appointment Kinds", "type": "array" }, "block_increment_minutes": { "$ref": "#/components/schemas/MinuteIncrements", "description": "The granularity at which blocks should be scheduled in this calendar." }, "clinic_id": { "description": "The ID of the clinic this calendar belongs to.", "title": "Clinic Id", "type": "integer" }, "default_duration_minutes": { "$ref": "#/components/schemas/MinuteIncrements", "description": "The default time a generic appointment on this calendar should be booked for." }, "id": { "description": "The unique identifier for the calendar.", "title": "Id", "type": "integer" }, "is_client_booking_enabled": { "description": "Whether client booking is enabled for this calendar.", "title": "Is Client Booking Enabled", "type": "boolean" }, "name": { "description": "Display name for the calendar.", "title": "Name", "type": "string" }, "non_exotic_species": { "description": "List of species that the clinic defines as not exotic.", "items": { "type": "string" }, "title": "Non Exotic Species", "type": "array" } }, "required": [ "id", "clinic_id", "name", "block_increment_minutes", "default_duration_minutes", "is_client_booking_enabled", "non_exotic_species", "allowed_appointment_kinds" ], "title": "Calendar", "type": "object" }, "ExternalCareBenefitSchema": { "properties": { "care_benefit_services": { "description": "The services that are part of this care benefit", "items": { "$ref": "#/components/schemas/ExternalCareBenefitServicesSchema" }, "title": "Care Benefit Services", "type": "array" }, "category": { "$ref": "#/components/schemas/CareBenefitCategory", "description": "The category of the care benefit" }, "excluded_services": { "description": "The group service IDs that are excluded from this care benefit", "items": { "type": "integer" }, "title": "Excluded Services", "type": "array" }, "id": { "description": "The ID of the care benefit", "title": "Id", "type": "integer" }, "kind": { "$ref": "#/components/schemas/CareBenefitKind", "description": "The kind of the care benefit" }, "name": { "description": "The name of the care benefit", "title": "Name", "type": "string" }, "service_categories": { "description": "The service category IDs that are part of this care benefit", "items": { "type": "integer" }, "title": "Service Categories", "type": "array" }, "status": { "$ref": "#/components/schemas/CareBenefitStatus", "description": "The status of the care benefit" } }, "required": [ "id", "name", "status", "service_categories", "excluded_services", "category", "kind", "care_benefit_services" ], "title": "ExternalCareBenefitSchema", "type": "object" }, "ExternalCareBenefitSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCareBenefitSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCareBenefitSchemaList", "type": "object" }, "ExternalCareBenefitServicesSchema": { "properties": { "group_bundle_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the group bundle this service belongs to", "title": "Group Bundle Id" }, "group_bundle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the group bundle this service belongs to", "title": "Group Bundle Name" }, "group_service_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the group service", "title": "Group Service Id" }, "group_service_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the group service", "title": "Group Service Name" }, "id": { "description": "The ID of the care benefit service", "title": "Id", "type": "integer" }, "points": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of points this service is worth in this benefit", "title": "Points" } }, "required": [ "id", "group_service_id", "group_bundle_id", "points" ], "title": "ExternalCareBenefitServicesSchema", "type": "object" }, "ExternalCarePlanDetailSchema": { "description": "Care plans are the core resource for recurring care on Vetcove. A care plan can be one of the following types:\n\n- **Core Plans**: A plan for some defined period of time that typically include a physical exam, vaccinations, and other routine care.\n- **Add-ons**: Optional plans purchased in addition to a core plan (e.g., 12 months of flea and tick prevention).\n\n", "properties": { "code": { "description": "The unique identifier (within a group) for this care plan.", "title": "Code", "type": "string" }, "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the default duration", "title": "Default Duration Unit" }, "default_duration_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The value for the default duration of the care plan. Typically, this will be 12 months.", "title": "Default Duration Value" }, "id": { "description": "The unique identifier for the care plan", "title": "Id", "type": "integer" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/CarePlanKind" }, { "const": "", "type": "string" } ], "description": "The type of the care plan", "title": "Kind" }, "max_age_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the maximum age", "title": "Max Age Unit" }, "max_age_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans", "title": "Max Age Value" }, "min_age_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the minimum age", "title": "Min Age Unit" }, "min_age_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans", "title": "Min Age Value" }, "name": { "description": "The name of the care plan", "title": "Name", "type": "string" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next Care Plan this plan transitions to. Only applicable to Core plans. When a patient meets the age and eligibility requirements of the next plan, they will be automatically transitioned to that plan upon renewal.", "title": "Next Plan Id" }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species this care plan is for", "title": "Species" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/CarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the care plan", "title": "Status" } }, "required": [ "id", "name", "status", "kind", "species", "min_age_value", "min_age_unit", "max_age_value", "max_age_unit", "default_duration_value", "default_duration_unit", "next_plan_id", "code" ], "title": "ExternalCarePlanDetailSchema", "type": "object" }, "ExternalCarePlanSchema": { "properties": { "code": { "description": "The unique identifier (within a group) for this care plan.", "title": "Code", "type": "string" }, "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the default duration", "title": "Default Duration Unit" }, "default_duration_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The value for the default duration of the care plan. Typically, this will be 12 months.", "title": "Default Duration Value" }, "id": { "description": "The unique identifier for the care plan", "title": "Id", "type": "integer" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/CarePlanKind" }, { "const": "", "type": "string" } ], "description": "The type of the care plan", "title": "Kind" }, "max_age_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the maximum age", "title": "Max Age Unit" }, "max_age_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans", "title": "Max Age Value" }, "min_age_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the minimum age", "title": "Min Age Unit" }, "min_age_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans", "title": "Min Age Value" }, "name": { "description": "The name of the care plan", "title": "Name", "type": "string" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next Care Plan this plan transitions to. Only applicable to Core plans. When a patient meets the age and eligibility requirements of the next plan, they will be automatically transitioned to that plan upon renewal.", "title": "Next Plan Id" }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species this care plan is for", "title": "Species" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/CarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the care plan", "title": "Status" } }, "required": [ "id", "name", "status", "kind", "species", "min_age_value", "min_age_unit", "max_age_value", "max_age_unit", "default_duration_value", "default_duration_unit", "next_plan_id", "code" ], "title": "ExternalCarePlanSchema", "type": "object" }, "ExternalCarePlanSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCarePlanSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCarePlanSchemaList", "type": "object" }, "ExternalCheckoutLinkSchema": { "properties": { "acting_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the person who sent this checkout link. If null, then the link was system generated.", "title": "Acting User" }, "cart_id": { "description": "The ID of the cart associated with this checkout link.", "title": "Cart Id", "type": "integer" }, "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic client this checkout link was sent to.", "title": "Clinic Client Id" }, "clinic_id": { "description": "The ID of the clinic for this checkout link.", "title": "Clinic Id", "type": "integer" }, "communication_methods": { "default": [], "description": "The methods through which this checkout link was sent.", "items": { "type": "string" }, "title": "Communication Methods", "type": "array" }, "id": { "description": "The unique identifier for the checkout link.", "title": "Id", "type": "integer" }, "order_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the order that was placed as a result of this checkout", "title": "Order Id" }, "sent_at": { "description": "When this checkout link was sent.", "format": "date-time", "title": "Sent At", "type": "string" }, "sms_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The body of the SMS message sent for this checkout link, if sent via text.", "title": "Sms Body" } }, "required": [ "id", "clinic_id", "sent_at", "cart_id", "clinic_client_id", "order_id" ], "title": "ExternalCheckoutLinkSchema", "type": "object" }, "ExternalCheckoutLinkSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalCheckoutLinkSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalCheckoutLinkSchemaList", "type": "object" }, "ExternalClientAddressCreateSchema": { "properties": { "address_one": { "description": "The first line of the address.", "maxLength": 100, "title": "Address One", "type": "string" }, "address_two": { "default": "", "description": "The second line of the address.", "maxLength": 100, "title": "Address Two", "type": "string" }, "city": { "description": "The city of the address.", "maxLength": 100, "title": "City", "type": "string" }, "client_id": { "description": "The ID of the client that this address belongs to.", "title": "Client Id", "type": "integer" }, "country": { "allOf": [ { "$ref": "#/components/schemas/Countries" } ], "default": "US", "description": "The 2-letter code of the country of the address." }, "county": { "default": "", "description": "The county of the address.", "maxLength": 100, "title": "County", "type": "string" }, "is_primary": { "default": true, "description": "Whether this address is the primary address of the client.", "title": "Is Primary", "type": "boolean" }, "name": { "default": "", "description": "The name of the address.", "maxLength": 100, "title": "Name", "type": "string" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The phone number of the address.", "title": "Phone Number" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/States" }, { "const": "", "type": "string" } ], "description": "The 2-letter code of the state/province/region of the address.", "title": "State" }, "zipcode": { "description": "The zip code/postal code of the address.", "maxLength": 10, "minLength": 5, "title": "Zipcode", "type": "string" } }, "required": [ "address_one", "city", "state", "zipcode", "client_id" ], "title": "ExternalClientAddressCreateSchema", "type": "object" }, "ExternalClientAddressSchema": { "properties": { "address_one": { "description": "The first line of the address.", "maxLength": 100, "title": "Address One", "type": "string" }, "address_two": { "default": "", "description": "The second line of the address.", "maxLength": 100, "title": "Address Two", "type": "string" }, "city": { "description": "The city of the address.", "maxLength": 100, "title": "City", "type": "string" }, "client_id": { "description": "The ID of the client that this address belongs to.", "title": "Client Id", "type": "integer" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic this address belongs to.", "title": "Clinic Id" }, "country": { "allOf": [ { "$ref": "#/components/schemas/Countries" } ], "default": "US", "description": "The 2-letter code of the country of the address." }, "county": { "default": "", "description": "The county of the address.", "maxLength": 100, "title": "County", "type": "string" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "description": "The ID of the address.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_primary": { "description": "Whether this address is the primary address of the client.", "title": "Is Primary", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "default": "", "description": "The name of the address.", "maxLength": 100, "title": "Name", "type": "string" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The phone number of the address.", "title": "Phone Number" }, "state": { "description": "The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention.", "title": "State", "type": "string" }, "zipcode": { "description": "The zip code/postal code of the address.", "maxLength": 10, "title": "Zipcode", "type": "string" } }, "required": [ "address_one", "city", "state", "zipcode", "id", "created", "modified", "is_deleted", "deleted", "client_id", "clinic_id", "is_primary" ], "title": "ExternalClientAddressSchema", "type": "object" }, "ExternalClientAddressSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClientAddressSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClientAddressSchemaList", "type": "object" }, "ExternalClientCommunicationNumberSchema": { "properties": { "client_id": { "description": "The ID of the clinic client this phone number belongs to.", "title": "Client Id", "type": "integer" }, "client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the client user this phone number is tied to.", "title": "Client User Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic this phone number belongs to.", "title": "Clinic Id" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "custom_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Custom label for the phone number kind.", "title": "Custom Kind" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "external_contact_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the external contact this phone number is tied to.", "title": "External Contact Id" }, "id": { "description": "The ID of the client communication number record.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of phone number (e.g. Mobile, Home, Work, Other).", "title": "Kind" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "phone_number": { "description": "The phone number as an integer.", "title": "Phone Number", "type": "integer" }, "sms_enabled": { "description": "Whether this phone number can receive SMS messages.", "title": "Sms Enabled", "type": "boolean" }, "sms_preference": { "$ref": "#/components/schemas/SMSPreference", "description": "Client's SMS preference:\n- `NA`: Not applicable or unknown.\n- `ALL`: Receive all SMS notifications.\n- `TRANSACTIONAL`: Only critical transactional notifications (e.g. password reset, onboarding, checkout).\n- `UNSUBSCRIBED`: Do not send any SMS messages." }, "verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the client verified access to this phone number, if at all.", "title": "Verified At" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "client_id", "client_user_id", "external_contact_id", "clinic_id", "phone_number", "kind", "custom_kind", "sms_enabled", "verified_at", "sms_preference" ], "title": "ExternalClientCommunicationNumberSchema", "type": "object" }, "ExternalClientCommunicationNumberSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClientCommunicationNumberSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClientCommunicationNumberSchemaList", "type": "object" }, "ExternalClientEmailAddressSchema": { "properties": { "client_id": { "description": "The ID of the clinic client this email address belongs to.", "title": "Client Id", "type": "integer" }, "client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the client user this email address is tied to.", "title": "Client User Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic this email address belongs to.", "title": "Clinic Id" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "email": { "description": "The email address string.", "title": "Email", "type": "string" }, "external_contact_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the external contact this email address is tied to.", "title": "External Contact Id" }, "id": { "description": "The ID of the client email address record.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_email_unsubscribed": { "description": "Whether the client has unsubscribed from marketing emails for this email address.", "title": "Is Email Unsubscribed", "type": "boolean" }, "last_verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp of the last deliverability verification attempt.", "title": "Last Verified At" }, "marked_undeliverable_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this email address was marked as undeliverable, if at all.", "title": "Marked Undeliverable At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "client_id", "client_user_id", "external_contact_id", "clinic_id", "email", "marked_undeliverable_at", "last_verified_at", "is_email_unsubscribed" ], "title": "ExternalClientEmailAddressSchema", "type": "object" }, "ExternalClientEmailAddressSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClientEmailAddressSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClientEmailAddressSchemaList", "type": "object" }, "ExternalClientOnboardingSchema": { "properties": { "client_id": { "description": "ID of the client being onboarded", "title": "Client Id", "type": "integer" }, "clinic_id": { "description": "ID of the clinic handling the onboarding", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "has_payment_method": { "description": "Indicates whether the client has a saved payment method in Vetcove Home Delivery", "title": "Has Payment Method", "type": "boolean" }, "id": { "description": "Unique identifier for the onboarding", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "onboarding_events": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExternalOnboardingEventSchema" }, "type": "array" }, { "type": "null" } ], "description": "List of events in the onboarding process", "title": "Onboarding Events" }, "onboarding_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The status of the onboarding event", "title": "Onboarding Status" }, "subscription_message_sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Timestamp when subscription message was sent", "title": "Subscription Message Sent At" }, "subscriptions": { "description": "List of subscriptions associated with the onboarding", "items": { "$ref": "#/components/schemas/ExternalClientOnboardingSubscriptionSchema" }, "title": "Subscriptions", "type": "array" } }, "required": [ "created", "modified", "id", "client_id", "clinic_id", "subscriptions", "has_payment_method" ], "title": "ExternalClientOnboardingSchema", "type": "object" }, "ExternalClientOnboardingSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClientOnboardingSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClientOnboardingSchemaList", "type": "object" }, "ExternalClientOnboardingSubscriptionSchema": { "properties": { "estimated_value_annual": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The estimated annualized value associated with the onboarding", "title": "Estimated Value Annual" }, "frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display name of the frequency", "title": "Frequency" }, "id": { "description": "Unique identifier for the subscription", "title": "Id", "type": "integer" }, "item": { "description": "Name of the item being subscribed to", "title": "Item", "type": "string" }, "next_order_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Date of the next order", "title": "Next Order Date" }, "original_rx_status": { "description": "The original status of the prescription upon import", "title": "Original Rx Status", "type": "string" }, "patient_id": { "description": "ID of the patient being subscribed to", "title": "Patient Id", "type": "integer" }, "rx_status": { "description": "The status of the prescription", "title": "Rx Status", "type": "string" }, "status": { "$ref": "#/components/schemas/SubscriptionStatus", "description": "The status of the subscription." } }, "required": [ "id", "item", "patient_id", "rx_status", "original_rx_status", "status" ], "title": "ExternalClientOnboardingSubscriptionSchema", "type": "object" }, "ExternalClinicAssignedPricingGroupsSchema": { "properties": { "assigned_service_pricing_group_ids": { "description": "The IDs of the service pricing groups assigned to this clinic.", "items": { "type": "integer" }, "title": "Assigned Service Pricing Group Ids", "type": "array" } }, "required": [ "assigned_service_pricing_group_ids" ], "title": "ExternalClinicAssignedPricingGroupsSchema", "type": "object" }, "ExternalClinicBundlePriceSchema": { "properties": { "fixed_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Fixed price in cents when not using pass-through pricing.", "title": "Fixed Price" }, "group_bundle_id": { "description": "The organization bundle (group bundle) this clinic override applies to.", "title": "Group Bundle Id", "type": "integer" }, "id": { "description": "The unique identifier for the bundle price.", "title": "Id", "type": "integer" }, "is_enabled": { "description": "Whether the clinic bundle enrollment is enabled.", "title": "Is Enabled", "type": "boolean" }, "is_pass_through_pricing": { "description": "Whether this bundle price uses pass-through pricing.", "title": "Is Pass Through Pricing", "type": "boolean" }, "name": { "description": "Display name for this bundle price.", "title": "Name", "type": "string" } }, "required": [ "id", "name", "is_pass_through_pricing", "is_enabled", "group_bundle_id" ], "title": "ExternalClinicBundlePriceSchema", "type": "object" }, "ExternalClinicCarePlanPriceSchema": { "properties": { "care_plan_id": { "description": "The ID of the care plan this care plan price is associated with.", "title": "Care Plan Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this care plan price is associated with.", "title": "Clinic Id", "type": "integer" }, "enrollment_fee": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The fee the clinic charges for enrolling in the care plan, in cents. Null if no pricing is configured.", "title": "Enrollment Fee" }, "price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price at which the clinic offers the care plan, in cents. Null if no pricing is configured.", "title": "Price" } }, "required": [ "clinic_id", "care_plan_id", "price", "enrollment_fee" ], "title": "ExternalClinicCarePlanPriceSchema", "type": "object" }, "ExternalClinicCarePlanPriceSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicCarePlanPriceSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicCarePlanPriceSchemaList", "type": "object" }, "ExternalClinicCarePlanSchema": { "properties": { "annual_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The annual price of the care plan, in cents. For annual-duration plans this equals the plan `price`. For monthly-duration plans this is the plan price multiplied by 12. Null if no pricing is configured for the clinic.", "title": "Annual Price" }, "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the default duration", "title": "Default Duration Unit" }, "default_duration_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The value for the default duration of the care plan. Typically, this will be 12 months.", "title": "Default Duration Value" }, "enrollment_fee": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The fee the clinic charges for enrolling in the care plan, in cents. Null if no pricing is configured for the clinic.", "title": "Enrollment Fee" }, "id": { "description": "The unique identifier for the care plan", "title": "Id", "type": "integer" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/CarePlanKind" }, { "const": "", "type": "string" } ], "description": "The type of the care plan", "title": "Kind" }, "max_age_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the maximum age", "title": "Max Age Unit" }, "max_age_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans", "title": "Max Age Value" }, "min_age_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of the minimum age", "title": "Min Age Unit" }, "min_age_value": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans", "title": "Min Age Value" }, "monthly_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The monthly price of the care plan, in cents. For monthly-duration plans this equals the plan `price`. For annual-duration plans this is the plan price divided by 12. Null if no pricing is configured for the clinic.", "title": "Monthly Price" }, "name": { "description": "The name of the care plan", "title": "Name", "type": "string" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next Care Plan this plan transitions to. Only applicable to Core plans. When a patient meets the age and eligibility requirements of the next plan, they will be automatically transitioned to that plan upon renewal.", "title": "Next Plan Id" }, "price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price at which the clinic offers the care plan, in cents. Null if no pricing is configured for the clinic.", "title": "Price" }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species this care plan is for", "title": "Species" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/CarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the care plan", "title": "Status" } }, "required": [ "id", "name", "status", "kind", "species", "min_age_value", "min_age_unit", "max_age_value", "max_age_unit", "default_duration_value", "default_duration_unit", "next_plan_id", "price", "enrollment_fee", "monthly_price", "annual_price" ], "title": "ExternalClinicCarePlanSchema", "type": "object" }, "ExternalClinicCarePlanSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicCarePlanSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicCarePlanSchemaList", "type": "object" }, "ExternalClinicClientAddressCreateSchema": { "properties": { "address_one": { "description": "The first line of the address.", "maxLength": 100, "title": "Address One", "type": "string" }, "address_two": { "default": "", "description": "The second line of the address.", "maxLength": 100, "title": "Address Two", "type": "string" }, "city": { "description": "The city of the address.", "maxLength": 100, "title": "City", "type": "string" }, "country": { "allOf": [ { "$ref": "#/components/schemas/Countries" } ], "default": "US", "description": "The 2-letter code of the country of the address." }, "county": { "default": "", "description": "The county of the address.", "maxLength": 100, "title": "County", "type": "string" }, "name": { "default": "", "description": "The name of the address.", "maxLength": 100, "title": "Name", "type": "string" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The phone number of the address.", "title": "Phone Number" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/States" }, { "const": "", "type": "string" } ], "description": "The 2-letter code of the state/province/region of the address.", "title": "State" }, "zipcode": { "description": "The zip code/postal code of the address.", "maxLength": 10, "minLength": 5, "title": "Zipcode", "type": "string" } }, "required": [ "address_one", "city", "state", "zipcode" ], "title": "ExternalClinicClientAddressCreateSchema", "type": "object" }, "ExternalClinicClientCreatePatientSchema": { "properties": { "allergies": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "", "description": "The allergies of the clinic patient.", "title": "Allergies" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceCreateSchema" }, { "type": "null" } ], "description": "The insurance covering this clinic patient, if any." }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "User-set metadata related to this client.", "title": "Metadata" }, "microchip_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The microchip number of the clinic patient.", "title": "Microchip Number" }, "name": { "description": "The name of the clinic patient.", "title": "Name", "type": "string" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "default": "", "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "secondary_breeds": { "default": [], "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "allOf": [ { "$ref": "#/components/schemas/SexKind" } ], "default": "UNKNOWN", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds.", "title": "Weight" } }, "required": [ "name", "species" ], "title": "ExternalClinicClientCreatePatientSchema", "type": "object" }, "ExternalClinicClientCreateSchema": { "properties": { "client_notes": { "default": "", "description": "The notes on the client.", "title": "Client Notes", "type": "string" }, "clinic_id": { "description": "The ID of the clinic which this clinic client belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patients": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExternalClinicClientCreatePatientSchema" }, "type": "array" }, { "type": "null" } ], "description": "A list of clinic patients associated with this clinic client.", "title": "Clinic Patients" }, "email": { "default": "", "description": "The email address of the clinic client.", "format": "email", "title": "Email", "type": "string" }, "first_name": { "description": "The first name of the clinic client.", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the clinic client.", "title": "Last Name", "type": "string" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "User-set metadata related to this client.", "title": "Metadata" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "description": "The phone number of the clinic client.", "title": "Phone Number" }, "pim_id": { "default": "", "description": "The ID of the clinic client in the clinic's PIMS.", "title": "Pim Id", "type": "string" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicClientAddressCreateSchema" }, { "type": "null" } ], "description": "The primary address of the clinic client." } }, "required": [ "clinic_id", "first_name", "last_name", "phone_number" ], "title": "ExternalClinicClientCreateSchema", "type": "object" }, "ExternalClinicClientDetailPatientSchema": { "properties": { "allergies": { "description": "The allergies of the clinic patient.", "title": "Allergies", "type": "string" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "clinic_client_id": { "description": "The ID of the clinic client which this clinic patient is associated with.", "title": "Clinic Client Id", "type": "integer" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "id": { "description": "The ID of the clinic patient.", "title": "Id", "type": "integer" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A pre-signed S3 URL good for 24 hours after request to the patient's profile picture, if any.", "title": "Image Url" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceSchema" }, { "type": "null" } ], "description": "The insurance covering this clinic patient, if any." }, "is_active": { "description": "Whether the clinic patient is actively associated with this clinic client or not.", "title": "Is Active", "type": "boolean" }, "is_alive": { "description": "Whether this patient is alive.", "title": "Is Alive", "type": "boolean" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "is_deactivated": { "description": "Whether this patient has been marked as deactivated.", "title": "Is Deactivated", "type": "boolean" }, "is_legacy_deactivated": { "description": "Whether this patient was marked as deactivated in the clinic's legacy PIMS.", "title": "Is Legacy Deactivated", "type": "boolean" }, "is_surrendered": { "description": "Whether this patient has been surrendered by all related clients.", "title": "Is Surrendered", "type": "boolean" }, "name": { "description": "The name of the clinic patient.", "title": "Name", "type": "string" }, "organization_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization patient ID corresponding to this clinic patient.", "title": "Organization Patient Id" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "secondary_breeds": { "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "$ref": "#/components/schemas/SexKind", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds.", "title": "Weight" } }, "required": [ "id", "name", "species", "pim_id", "weight", "sex", "birth_month", "birth_day", "birth_year", "clinic_client_id", "is_active", "organization_patient_id", "primary_breed", "secondary_breeds", "custom_breed", "allergies", "is_altered", "image_url", "is_alive", "is_surrendered", "is_deactivated", "is_legacy_deactivated" ], "title": "ExternalClinicClientDetailPatientSchema", "type": "object" }, "ExternalClinicClientDetailPatientSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicClientDetailPatientSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicClientDetailPatientSchemaList", "type": "object" }, "ExternalClinicClientDetailSchema": { "properties": { "can_be_called": { "description": "Whether the clinic can call the client.", "title": "Can Be Called", "type": "boolean" }, "client_notes": { "description": "The notes on the client.", "title": "Client Notes", "type": "string" }, "clinic_id": { "description": "The ID of the clinic this client belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patients": { "$ref": "#/components/schemas/ExternalClinicClientDetailPatientSchemaList", "description": "A list of all clinic patients associated with this clinic client." }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Email" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "First Name" }, "has_multiple_users": { "description": "Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client.", "title": "Has Multiple Users", "type": "boolean" }, "has_unread_messages_for_clinic": { "description": "Whether there are unread inbound messages from the client (for clinic's perspective)", "title": "Has Unread Messages For Clinic", "type": "boolean" }, "id": { "description": "The ID of the clinic client", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the client is active.", "title": "Is Active", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_email_unsubscribed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file.", "title": "Is Email Unsubscribed" }, "is_subscribed": { "description": "Whether the client is subscribed to receive info from the clinic.", "title": "Is Subscribed", "type": "boolean" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "Last Name" }, "last_visit_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date of the client's most recent appointment or invoice.", "title": "Last Visit Date" }, "metadata": { "description": "User-set metadata related to this client.", "title": "Metadata", "type": "object" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "organization_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization client ID corresponding to this clinic client.", "title": "Organization Client Id" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Phone Number" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic client in the clinic's PIMS.", "title": "Pim Id" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "description": "The primary address of the clinic client." }, "primary_client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields.", "title": "Primary Client User Id" }, "primary_payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary payment method of the clinic client", "title": "Primary Payment Method Id" }, "sms_preference": { "$ref": "#/components/schemas/SMSPreference", "description": "Client's SMS preference:\n- `NA`: Not applicable or unknown.\n- `ALL`: Receive all SMS notifications.\n- `TRANSACTIONAL`: Only critical transactional notifications (e.g. password reset, onboarding, checkout).\n- `UNSUBSCRIBED`: Do not send any SMS messages." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "pim_id", "organization_client_id", "is_email_unsubscribed", "is_active", "external_id", "can_be_called", "is_subscribed", "has_unread_messages_for_clinic", "last_visit_date", "client_notes", "has_multiple_users", "primary_client_user_id", "clinic_patients", "metadata", "sms_preference" ], "title": "ExternalClinicClientDetailSchema", "type": "object" }, "ExternalClinicClientPatchSchema": { "properties": { "client_notes": { "default": "", "description": "The notes on the client.", "title": "Client Notes", "type": "string" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "description": "The primary email address for this clinic client account. This is selected from the available contact methods across all ClientUsers. When updating, these communication methods are assumed to belong to the primary clinic client user.", "title": "Email" }, "first_name": { "description": "The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this updates only the primary clinic client user's name.", "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this updates only the primary clinic client user's name.", "title": "Last Name", "type": "string" }, "metadata": { "description": "User-set metadata related to this client.", "title": "Metadata", "type": "object" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "description": "The primary phone number for this clinic client account. This is selected from the available contact methods across all ClientUsers. When updating, these communication methods are assumed to belong to the primary clinic client user.", "title": "Phone Number" }, "primary_address_id": { "description": "The primary address ID of the clinic client.", "title": "Primary Address Id", "type": "integer" }, "primary_client_user_id": { "description": "The ID of the ClientUser to set as the primary user (account owner) for this client. When changed, the Client's first_name and last_name fields will reflect the new primary user's name. The ClientUser must belong to this Client. Note: Changing the primary ClientUser will clear the relationship_kind and custom_relationship fields on all ClientUsers for this Client.", "title": "Primary Client User Id", "type": "integer" }, "sms_preference": { "anyOf": [ { "$ref": "#/components/schemas/SMSPreference" }, { "type": "null" } ], "description": "The SMS preference of the clinic client." } }, "title": "ExternalClinicClientPatchSchema", "type": "object" }, "ExternalClinicClientSchema": { "properties": { "can_be_called": { "description": "Whether the clinic can call the client.", "title": "Can Be Called", "type": "boolean" }, "client_notes": { "description": "The notes on the client.", "title": "Client Notes", "type": "string" }, "clinic_id": { "description": "The ID of the clinic this client belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Email" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "First Name" }, "has_multiple_users": { "description": "Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client.", "title": "Has Multiple Users", "type": "boolean" }, "has_unread_messages_for_clinic": { "description": "Whether there are unread inbound messages from the client (for clinic's perspective)", "title": "Has Unread Messages For Clinic", "type": "boolean" }, "id": { "description": "The ID of the clinic client", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the client is active.", "title": "Is Active", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_email_unsubscribed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file.", "title": "Is Email Unsubscribed" }, "is_subscribed": { "description": "Whether the client is subscribed to receive info from the clinic.", "title": "Is Subscribed", "type": "boolean" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "Last Name" }, "last_visit_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date of the client's most recent appointment or invoice.", "title": "Last Visit Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "organization_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization client ID corresponding to this clinic client.", "title": "Organization Client Id" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Phone Number" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic client in the clinic's PIMS.", "title": "Pim Id" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "description": "The primary address of the clinic client." }, "primary_client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields.", "title": "Primary Client User Id" }, "primary_payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary payment method of the clinic client", "title": "Primary Payment Method Id" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "pim_id", "organization_client_id", "is_email_unsubscribed", "is_active", "external_id", "can_be_called", "is_subscribed", "has_unread_messages_for_clinic", "last_visit_date", "client_notes", "has_multiple_users", "primary_client_user_id" ], "title": "ExternalClinicClientSchema", "type": "object" }, "ExternalClinicClientSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicClientSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicClientSchemaList", "type": "object" }, "ExternalClinicClientSearchSchema": { "properties": { "can_be_called": { "description": "Whether the clinic can call the client.", "title": "Can Be Called", "type": "boolean" }, "client_notes": { "description": "The notes on the client.", "title": "Client Notes", "type": "string" }, "clinic_id": { "description": "The ID of the clinic this client belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Email" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "First Name" }, "has_multiple_users": { "description": "Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client.", "title": "Has Multiple Users", "type": "boolean" }, "has_unread_messages_for_clinic": { "description": "Whether there are unread inbound messages from the client (for clinic's perspective)", "title": "Has Unread Messages For Clinic", "type": "boolean" }, "id": { "description": "The ID of the clinic client", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the client is active.", "title": "Is Active", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_email_unsubscribed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file.", "title": "Is Email Unsubscribed" }, "is_subscribed": { "description": "Whether the client is subscribed to receive info from the clinic.", "title": "Is Subscribed", "type": "boolean" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.", "title": "Last Name" }, "last_visit_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date of the client's most recent appointment or invoice.", "title": "Last Visit Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "organization_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization client ID corresponding to this clinic client.", "title": "Organization Client Id" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.", "title": "Phone Number" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic client in the clinic's PIMS.", "title": "Pim Id" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "description": "The primary address of the clinic client." }, "primary_client_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields.", "title": "Primary Client User Id" }, "primary_payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the primary payment method of the clinic client", "title": "Primary Payment Method Id" }, "secondary_emails": { "description": "Additional email addresses on this clinic client besides the primary email. Only addresses that can match an email search are included.", "items": { "type": "string" }, "title": "Secondary Emails", "type": "array" }, "secondary_phone_numbers": { "description": "Additional phone numbers on this clinic client besides the primary phone number. Only numbers that can match a phone search are included.", "items": { "type": "integer" }, "title": "Secondary Phone Numbers", "type": "array" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "pim_id", "organization_client_id", "is_email_unsubscribed", "is_active", "external_id", "can_be_called", "is_subscribed", "has_unread_messages_for_clinic", "last_visit_date", "client_notes", "has_multiple_users", "primary_client_user_id", "secondary_emails", "secondary_phone_numbers" ], "title": "ExternalClinicClientSearchSchema", "type": "object" }, "ExternalClinicClientSearchSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicClientSearchSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicClientSearchSchemaList", "type": "object" }, "ExternalClinicClientUserCreateSchema": { "description": "Schema for creating a new ClientUser", "properties": { "client_id": { "description": "The ID of the clinic client to add this clinic client user to.", "title": "Client Id", "type": "integer" }, "custom_relationship": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "description": "A custom relationship description (optional). Should be used when relationship_kind is 'Other'.", "title": "Custom Relationship" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "description": "The email address of the clinic client user (optional).", "title": "Email" }, "first_name": { "description": "The first name of the clinic client user.", "maxLength": 30, "minLength": 1, "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the clinic client user.", "maxLength": 30, "minLength": 1, "title": "Last Name", "type": "string" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "description": "The phone number of the clinic client user. Must be exactly 10 digits.", "title": "Phone Number" }, "relationship_kind": { "anyOf": [ { "$ref": "#/components/schemas/CoOwnerRelationshipKind" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The type of relationship this clinic client user has to the clinic client account (optional).", "title": "Relationship Kind" } }, "required": [ "client_id", "first_name", "last_name", "phone_number" ], "title": "ExternalClinicClientUserCreateSchema", "type": "object" }, "ExternalClinicClientUserPatchSchema": { "description": "Schema for updating a ClientUser", "properties": { "custom_relationship": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "description": "A custom relationship description. Should be used when relationship_kind is 'Other'.", "title": "Custom Relationship" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "description": "The email address of the clinic client user.", "title": "Email" }, "first_name": { "anyOf": [ { "maxLength": 30, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The first name of the clinic client user.", "title": "First Name" }, "last_name": { "anyOf": [ { "maxLength": 30, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The last name of the clinic client user.", "title": "Last Name" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "description": "The phone number of the clinic client user. Must be exactly 10 digits.", "title": "Phone Number" }, "relationship_kind": { "anyOf": [ { "$ref": "#/components/schemas/CoOwnerRelationshipKind" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The type of relationship this clinic client user has to the client account.", "title": "Relationship Kind" } }, "title": "ExternalClinicClientUserPatchSchema", "type": "object" }, "ExternalClinicClientUserSchema": { "properties": { "clinic_client_id": { "description": "The ID of the clinic client this clinic client user belongs to", "title": "Clinic Client Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "custom_relationship": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom relationship description if relationship_kind is set to 'Other'.", "title": "Custom Relationship" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The primary email address of the clinic client user.", "title": "Email" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The first name of the clinic client user.", "title": "First Name" }, "id": { "description": "The ID of the clinic client user", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last name of the clinic client user.", "title": "Last Name" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The primary phone number of the clinic client user.", "title": "Phone Number" }, "relationship_kind": { "anyOf": [ { "$ref": "#/components/schemas/CoOwnerRelationshipKind" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The type of relationship this clinic client user has to the clinic client account.", "title": "Relationship Kind" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_client_id" ], "title": "ExternalClinicClientUserSchema", "type": "object" }, "ExternalClinicClientUserSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicClientUserSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicClientUserSchemaList", "type": "object" }, "ExternalClinicInventoryCodeDetailSchema": { "properties": { "category_id": { "description": "The ID of the inventory category for this inventory code", "title": "Category Id", "type": "integer" }, "clinic_preferences": { "anyOf": [ { "$ref": "#/components/schemas/ClinicInventoryPreferenceSchema" }, { "type": "null" } ], "description": "The settings for this type of inventory set by the clinic. Will be null if the clinic does not have its own settings for this type of inventory" }, "code": { "description": "The global code assigned to this type of inventory at Vetcove", "title": "Code", "type": "string" }, "effective_preferences": { "$ref": "#/components/schemas/ClinicEffectiveInventoryPreference", "description": "The effective settings for this type of inventory, favoring the clinic's settings first, followed by your organization's settings, then falling back to Vetcove's defaults when there is no override set" }, "global_preferences": { "$ref": "#/components/schemas/GlobalInventoryPreference", "description": "Vetcove's default settings for this type of inventory" }, "id": { "description": "The unique identifier for the inventory code", "title": "Id", "type": "integer" }, "in_transit_quantity": { "description": "The number of inventory units currently in transit for this clinic", "title": "In Transit Quantity", "type": "string" }, "is_controlled": { "description": "Whether this inventory code is controlled or not", "title": "Is Controlled", "type": "boolean" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/GlobalInventoryKind" }, { "const": "", "type": "string" } ], "description": "The kind of the inventory code", "title": "Kind" }, "on_hold_quantity": { "description": "The number of inventory units currently on hold for this clinic", "title": "On Hold Quantity", "type": "string" }, "organization_preferences": { "$ref": "#/components/schemas/OrganizationInventoryPreference", "description": "The settings for this type of inventory set by your organization. This cannot be null when viewing inventory codes at the clinic level - no inventory code is accessible at the clinic level if there are no organization level preferences" }, "stock_quantity": { "description": "The number of stock items available for this inventory code", "title": "Stock Quantity", "type": "string" } }, "required": [ "id", "code", "kind", "category_id", "global_preferences", "organization_preferences", "clinic_preferences", "effective_preferences", "stock_quantity", "in_transit_quantity", "on_hold_quantity", "is_controlled" ], "title": "ExternalClinicInventoryCodeDetailSchema", "type": "object" }, "ExternalClinicInventoryCodeSchema": { "properties": { "category_id": { "description": "The ID of the inventory category for this inventory code", "title": "Category Id", "type": "integer" }, "clinic_preferences": { "anyOf": [ { "$ref": "#/components/schemas/ClinicInventoryPreferenceSchema" }, { "type": "null" } ], "description": "The settings for this type of inventory set by the clinic. Will be null if the clinic does not have its own settings for this type of inventory" }, "code": { "description": "The global code assigned to this type of inventory at Vetcove", "title": "Code", "type": "string" }, "effective_preferences": { "$ref": "#/components/schemas/ClinicEffectiveInventoryPreference", "description": "The effective settings for this type of inventory, favoring the clinic's settings first, followed by your organization's settings, then falling back to Vetcove's defaults when there is no override set" }, "global_preferences": { "$ref": "#/components/schemas/GlobalInventoryPreference", "description": "Vetcove's default settings for this type of inventory" }, "id": { "description": "The unique identifier for the inventory code", "title": "Id", "type": "integer" }, "in_transit_quantity": { "description": "The number of inventory units currently in transit for this clinic", "title": "In Transit Quantity", "type": "string" }, "is_controlled": { "description": "Whether this inventory code is controlled or not", "title": "Is Controlled", "type": "boolean" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/GlobalInventoryKind" }, { "const": "", "type": "string" } ], "description": "The kind of the inventory code", "title": "Kind" }, "on_hold_quantity": { "description": "The number of inventory units currently on hold for this clinic", "title": "On Hold Quantity", "type": "string" }, "organization_preferences": { "$ref": "#/components/schemas/OrganizationInventoryPreference", "description": "The settings for this type of inventory set by your organization. This cannot be null when viewing inventory codes at the clinic level - no inventory code is accessible at the clinic level if there are no organization level preferences" }, "stock_quantity": { "description": "The number of stock items available for this inventory code", "title": "Stock Quantity", "type": "string" } }, "required": [ "id", "code", "kind", "category_id", "global_preferences", "organization_preferences", "clinic_preferences", "effective_preferences", "stock_quantity", "in_transit_quantity", "on_hold_quantity", "is_controlled" ], "title": "ExternalClinicInventoryCodeSchema", "type": "object" }, "ExternalClinicInventoryCodeSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicInventoryCodeSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicInventoryCodeSchemaList", "type": "object" }, "ExternalClinicPatientCreateSchema": { "properties": { "allergies": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "", "description": "The allergies of the clinic patient.", "title": "Allergies" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "clinic_client_id": { "description": "The ID of the clinic client associated with this clinic patient.", "title": "Clinic Client Id", "type": "integer" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceCreateSchema" }, { "type": "null" } ], "description": "The insurance covering this clinic patient, if any." }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "User-set metadata related to this client.", "title": "Metadata" }, "microchip_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The microchip number of the clinic patient.", "title": "Microchip Number" }, "name": { "description": "The name of the clinic patient.", "title": "Name", "type": "string" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "default": "", "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "secondary_breeds": { "default": [], "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "allOf": [ { "$ref": "#/components/schemas/SexKind" } ], "default": "UNKNOWN", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds.", "title": "Weight" } }, "required": [ "name", "species", "clinic_client_id" ], "title": "ExternalClinicPatientCreateSchema", "type": "object" }, "ExternalClinicPatientDetailSchema": { "properties": { "allergies": { "description": "The allergies of the clinic patient.", "title": "Allergies", "type": "string" }, "auto_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last automatically recorded rabies tag (driven by treatments).", "title": "Auto Rabies Tag" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "clinic_clients": { "description": "A list of clinic clients associated with this clinic patient.", "items": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipPatientViewSchema" }, "title": "Clinic Clients", "type": "array" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to which this clinic patient belongs.", "title": "Clinic Id" }, "color": { "anyOf": [ { "$ref": "#/components/schemas/PatientColor" }, { "const": "", "type": "string" } ], "description": "The color of the clinic patient.", "title": "Color" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "custom_species": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Custom species declared for this patient if species is set to Other.", "title": "Custom Species" }, "date_of_birth": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of birth of the clinic patient in ISO format (YYYY-MM-DD). Derived from birth_year, birth_month, and birth_day.", "title": "Date Of Birth" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the clinic patient became inactive (deceased, surrendered, or deleted).", "title": "Deactivated At" }, "deceased_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the clinic patient passed away, if applicable. Format: YYYY-MM-DD.", "title": "Deceased Date" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "first_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's first visit. Format: YYYY-MM-DD.", "title": "First Visit Date" }, "id": { "description": "The ID of the clinic patient.", "title": "Id", "type": "integer" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A pre-signed S3 URL good for 24 hours after request to the patient's profile picture, if any.", "title": "Image Url" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceSchema" }, { "type": "null" } ], "description": "The insurance covering this clinic patient, if any." }, "is_active": { "description": "Whether the clinic patient is currently active (not deceased, surrendered, or deactivated).", "title": "Is Active", "type": "boolean" }, "is_alive": { "description": "Whether this patient is alive.", "title": "Is Alive", "type": "boolean" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "is_deactivated": { "description": "Whether this patient has been marked as deactivated.", "title": "Is Deactivated", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_legacy_deactivated": { "description": "Whether this patient was marked as deactivated in the clinic's legacy PIMS.", "title": "Is Legacy Deactivated", "type": "boolean" }, "is_surrendered": { "description": "Whether this patient has been surrendered by all related clients.", "title": "Is Surrendered", "type": "boolean" }, "last_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's last visit. Format: YYYY-MM-DD.", "title": "Last Visit Date" }, "metadata": { "description": "User-set metadata related to this patient.", "title": "Metadata", "type": "object" }, "microchip_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The microchip number of the clinic patient.", "title": "Microchip Number" }, "microchip_number_updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the patient's microchip number was last set or changed. This is a last-updated timestamp, not a strict assignment date, and there is no removed-date concept \u2014 the microchip number is overwritten with the latest value.", "title": "Microchip Number Updated At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of the clinic patient.", "title": "Name", "type": "string" }, "organization_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization patient ID corresponding to this clinic patient", "title": "Organization Patient Id" }, "patient_notes": { "description": "Notes set on the clinic patient via the PIMS calendar.", "title": "Patient Notes", "type": "string" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "primary_clinic_client_id": { "description": "The ID of the primary clinic client associated with this clinic patient.", "title": "Primary Clinic Client Id", "type": "integer" }, "reissued_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The manually updated rabies tag, which overrides the automatically set one.", "title": "Reissued Rabies Tag" }, "resuscitate_status": { "anyOf": [ { "$ref": "#/components/schemas/ResuscitateStatus" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The resuscitate status of the clinic patient.", "title": "Resuscitate Status" }, "secondary_breeds": { "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "$ref": "#/components/schemas/SexKind", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "surrendered_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the patient was surrendered, if applicable.", "title": "Surrendered Date" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds (legacy field).", "title": "Weight" }, "weight_in_units": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient in the unit specified by weight_unit.", "title": "Weight In Units" }, "weight_unit": { "anyOf": [ { "$ref": "#/components/schemas/WeightUnitOfMeasure" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit of measure for weight_in_units.", "title": "Weight Unit" } }, "required": [ "created", "modified", "is_deleted", "deleted", "name", "clinic_clients", "id", "species", "pim_id", "weight", "weight_in_units", "weight_unit", "sex", "birth_month", "birth_day", "birth_year", "organization_patient_id", "primary_breed", "secondary_breeds", "custom_breed", "allergies", "is_altered", "is_alive", "is_surrendered", "is_deactivated", "is_legacy_deactivated", "microchip_number", "microchip_number_updated_at", "external_id", "primary_clinic_client_id", "clinic_id", "custom_species", "color", "deceased_date", "surrendered_date", "deactivated_at", "first_visit_date", "last_visit_date", "patient_notes", "resuscitate_status", "auto_rabies_tag", "reissued_rabies_tag", "is_active", "date_of_birth", "metadata", "image_url" ], "title": "ExternalClinicPatientDetailSchema", "type": "object" }, "ExternalClinicPatientInsuranceCreateSchema": { "properties": { "custom_provider_name": { "default": "", "description": "A custom name of the insurance provider. This field should be populated when `provider_id` is not. This field represents an insurance provider that is not yet in our standard listing.", "title": "Custom Provider Name", "type": "string" }, "policy_number": { "description": "The policy number of this clinic patient's insurance.", "title": "Policy Number", "type": "string" }, "provider_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the insurance provider backing this insurance, if it is one of the providers in our standard listing.", "title": "Provider Id" } }, "required": [ "policy_number" ], "title": "ExternalClinicPatientInsuranceCreateSchema", "type": "object" }, "ExternalClinicPatientInsuranceSchema": { "properties": { "custom_provider_name": { "description": "A custom name of the insurance provider. This field should be populated when `provider_id` is not. This field represents an insurance provider that is not yet in our standard listing.", "title": "Custom Provider Name", "type": "string" }, "policy_number": { "description": "The policy number of this clinic patient's insurance.", "title": "Policy Number", "type": "string" }, "provider_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the insurance provider backing this insurance, if it is one of the providers in our standard listing.", "title": "Provider Id" } }, "required": [ "provider_id", "custom_provider_name", "policy_number" ], "title": "ExternalClinicPatientInsuranceSchema", "type": "object" }, "ExternalClinicPatientPatchSchema": { "properties": { "allergies": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The allergies of the clinic patient.", "title": "Allergies" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An accessible URL containing the image we wish to set as this user's profile picture. Must have one of the following file extensions: .jpg, .jpeg, .png, .gif.", "title": "Image Url" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceCreateSchema" }, { "type": "null" } ], "description": "The insurance covering this clinic patient, if any." }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "User-set metadata related to this client.", "title": "Metadata" }, "microchip_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The microchip number of the clinic patient.", "title": "Microchip Number" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "sex": { "allOf": [ { "$ref": "#/components/schemas/SexKind" } ], "default": "UNKNOWN", "description": "The sex of the clinic patient." } }, "title": "ExternalClinicPatientPatchSchema", "type": "object" }, "ExternalClinicPatientSchema": { "properties": { "allergies": { "description": "The allergies of the clinic patient.", "title": "Allergies", "type": "string" }, "auto_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The last automatically recorded rabies tag (driven by treatments).", "title": "Auto Rabies Tag" }, "birth_day": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth day of the clinic patient.", "title": "Birth Day" }, "birth_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The birth month of the clinic patient.", "title": "Birth Month" }, "birth_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The birth year of the clinic patient.", "title": "Birth Year" }, "clinic_clients": { "description": "A list of clinic clients associated with this clinic patient.", "items": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipPatientViewSchema" }, "title": "Clinic Clients", "type": "array" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to which this clinic patient belongs.", "title": "Clinic Id" }, "color": { "anyOf": [ { "$ref": "#/components/schemas/PatientColor" }, { "const": "", "type": "string" } ], "description": "The color of the clinic patient.", "title": "Color" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "custom_breed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.", "title": "Custom Breed" }, "custom_species": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Custom species declared for this patient if species is set to Other.", "title": "Custom Species" }, "date_of_birth": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of birth of the clinic patient in ISO format (YYYY-MM-DD). Derived from birth_year, birth_month, and birth_day.", "title": "Date Of Birth" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the clinic patient became inactive (deceased, surrendered, or deleted).", "title": "Deactivated At" }, "deceased_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the clinic patient passed away, if applicable. Format: YYYY-MM-DD.", "title": "Deceased Date" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID from a clinic's legacy PIMS system, if the data was imported from there.", "title": "External Id" }, "first_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's first visit. Format: YYYY-MM-DD.", "title": "First Visit Date" }, "id": { "description": "The ID of the clinic patient.", "title": "Id", "type": "integer" }, "insurance": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicPatientInsuranceSchema" }, { "type": "null" } ], "description": "The insurance covering this clinic patient, if any." }, "is_active": { "description": "Whether the clinic patient is currently active (not deceased, surrendered, or deactivated).", "title": "Is Active", "type": "boolean" }, "is_alive": { "description": "Whether this patient is alive.", "title": "Is Alive", "type": "boolean" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.", "title": "Is Altered" }, "is_deactivated": { "description": "Whether this patient has been marked as deactivated.", "title": "Is Deactivated", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_legacy_deactivated": { "description": "Whether this patient was marked as deactivated in the clinic's legacy PIMS.", "title": "Is Legacy Deactivated", "type": "boolean" }, "is_surrendered": { "description": "Whether this patient has been surrendered by all related clients.", "title": "Is Surrendered", "type": "boolean" }, "last_visit_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the clinic patient's last visit. Format: YYYY-MM-DD.", "title": "Last Visit Date" }, "microchip_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The microchip number of the clinic patient.", "title": "Microchip Number" }, "microchip_number_updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The timestamp when the patient's microchip number was last set or changed. This is a last-updated timestamp, not a strict assignment date, and there is no removed-date concept \u2014 the microchip number is overwritten with the latest value.", "title": "Microchip Number Updated At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of the clinic patient.", "title": "Name", "type": "string" }, "organization_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The organization patient ID corresponding to this clinic patient", "title": "Organization Patient Id" }, "patient_notes": { "description": "Notes set on the clinic patient via the PIMS calendar.", "title": "Patient Notes", "type": "string" }, "pim_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the clinic patient in the clinic's PIMS.", "title": "Pim Id" }, "primary_breed": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ], "description": "The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "title": "Primary Breed" }, "primary_clinic_client_id": { "description": "The ID of the primary clinic client associated with this clinic patient.", "title": "Primary Clinic Client Id", "type": "integer" }, "reissued_rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The manually updated rabies tag, which overrides the automatically set one.", "title": "Reissued Rabies Tag" }, "resuscitate_status": { "anyOf": [ { "$ref": "#/components/schemas/ResuscitateStatus" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The resuscitate status of the clinic patient.", "title": "Resuscitate Status" }, "secondary_breeds": { "description": "The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint.", "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientBreed" }, { "const": "", "type": "string" } ] }, "title": "Secondary Breeds", "type": "array" }, "sex": { "$ref": "#/components/schemas/SexKind", "description": "The sex of the clinic patient." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ], "description": "The species of the clinic patient.", "title": "Species" }, "surrendered_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date when the patient was surrendered, if applicable.", "title": "Surrendered Date" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient, in pounds (legacy field).", "title": "Weight" }, "weight_in_units": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the clinic patient in the unit specified by weight_unit.", "title": "Weight In Units" }, "weight_unit": { "anyOf": [ { "$ref": "#/components/schemas/WeightUnitOfMeasure" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit of measure for weight_in_units.", "title": "Weight Unit" } }, "required": [ "created", "modified", "is_deleted", "deleted", "name", "clinic_clients", "id", "species", "pim_id", "weight", "weight_in_units", "weight_unit", "sex", "birth_month", "birth_day", "birth_year", "organization_patient_id", "primary_breed", "secondary_breeds", "custom_breed", "allergies", "is_altered", "is_alive", "is_surrendered", "is_deactivated", "is_legacy_deactivated", "microchip_number", "microchip_number_updated_at", "external_id", "primary_clinic_client_id", "clinic_id", "custom_species", "color", "deceased_date", "surrendered_date", "deactivated_at", "first_visit_date", "last_visit_date", "patient_notes", "resuscitate_status", "auto_rabies_tag", "reissued_rabies_tag", "is_active", "date_of_birth" ], "title": "ExternalClinicPatientSchema", "type": "object" }, "ExternalClinicPatientSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicPatientSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicPatientSchemaList", "type": "object" }, "ExternalClinicPatientUploadGroupCreateSchema": { "properties": { "clinic_patient_id": { "description": "The ID of the clinic patient that this upload group is for.", "title": "Clinic Patient Id", "type": "integer" }, "description": { "description": "The description of this group of uploads.", "title": "Description", "type": "string" }, "uploaded_file_ids": { "description": "The IDs of uploaded files to include in this upload group.", "items": { "type": "integer" }, "minItems": 1, "title": "Uploaded File Ids", "type": "array" } }, "required": [ "description", "clinic_patient_id", "uploaded_file_ids" ], "title": "ExternalClinicPatientUploadGroupCreateSchema", "type": "object" }, "ExternalClinicPatientUploadGroupSchema": { "properties": { "clinic_patient_id": { "description": "The ID of the clinic patient that this upload group is for.", "title": "Clinic Patient Id", "type": "integer" }, "description": { "description": "The description of this group of uploads.", "title": "Description", "type": "string" }, "id": { "description": "The unique identifier for the clinic patient upload group.", "title": "Id", "type": "integer" }, "uploaded_file_ids": { "description": "The IDs of uploaded files that are shown as part of this upload group.", "items": { "type": "integer" }, "title": "Uploaded File Ids", "type": "array" } }, "required": [ "id", "description", "clinic_patient_id", "uploaded_file_ids" ], "title": "ExternalClinicPatientUploadGroupSchema", "type": "object" }, "ExternalClinicPatientUploadGroupSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicPatientUploadGroupSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicPatientUploadGroupSchemaList", "type": "object" }, "ExternalClinicSchema": { "description": "Clinics represent a physical site where clients (pet owners) can go seek care for patients (their pets).", "properties": { "base_url": { "description": "The base URL for the Vetcove client shopping portal. Respects custom/vanity shop domains when configured. This is the same `base_url` returned by auto-auth, without an auto-auth token.", "title": "Base Url", "type": "string" }, "billing_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "description": "The billing address of the clinic." }, "booking_url": { "description": "The URL of this clinic's current client-facing appointment booking page. Respects custom/vanity shop domains when configured.", "title": "Booking Url", "type": "string" }, "client_display_name": { "description": "The display name of this clinic shown to clients.", "title": "Client Display Name", "type": "string" }, "clinic_timezone": { "description": "The IANA timezone identifier where this clinic is located.", "title": "Clinic Timezone", "type": "string" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email address of the clinic.", "title": "Email" }, "group_location_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The group location code of the clinic location group. Group location codes are a group's internal identifier for their clinics.", "title": "Group Location Code" }, "id": { "description": "The unique identifier for the clinic.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_pims": { "description": "Whether this clinic is PIMS-enabled or not.", "title": "Is Pims", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of this clinic.", "title": "Name", "type": "string" }, "phone_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The phone number of the clinic.", "title": "Phone Number" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "description": "The primary address of the clinic." }, "website_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The website url of the clinic.", "title": "Website Url" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "name", "client_display_name", "primary_address", "billing_address", "phone_number", "website_url", "base_url", "booking_url", "group_location_code", "is_pims", "clinic_timezone" ], "title": "Clinic", "type": "object" }, "ExternalClinicServiceConfigData": { "properties": { "breeds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of breed names associated with this service. If the given value is an empty list (`[]`), that indicates that breed is not a relevant criteria for this service and should be ignored. If the given value is null, that indicates we should fall back to the group service's configuration for this.", "title": "Breeds" }, "default_duration_scales_with_quantity": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service's default duration scales with quantity.", "title": "Default Duration Scales With Quantity" }, "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit of default duration used for this service." }, "default_duration_value": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The value of the default duration used for this service.", "title": "Default Duration Value" }, "default_location": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductLocation" }, { "type": "null" } ], "description": "The default location that this vaccine/medication will be administered at. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The default price for this service if not overridden elsewhere.", "title": "Default Price" }, "default_route": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductRoute" }, { "type": "null" } ], "description": "The default route that this vaccine/medication will be administered through. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_sig": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The default signature for this service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Default Sig" }, "default_treatment_kind": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentKind" }, { "type": "null" } ], "description": "The default kind of treatment this service represents. Only applicable when the `kind` of the associated group service is `PRODUCT` or `MEDICATION`." }, "din": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Drug Identification Number (DIN) for this service. Only applicable when the `kind` of the associated group service is `MEDICATION` or `PRODUCT` and the clinic is in Canada.", "title": "Din" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the service. Defaults to the service's name if not defined.", "title": "Display Name" }, "exclude_from_discounts": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is excluded from discounts.", "title": "Exclude From Discounts" }, "has_in_clinic_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when administered in-clinic.", "title": "Has In Clinic Dispense Fee" }, "has_lot_number_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the lot number field is shown in the treatment form. Only applicable when the `kind` of the associated group service is `PRODUCT`, `MEDICATION`, or `SERVICE`.", "title": "Has Lot Number For Treatments" }, "has_route_and_location_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the route/location fields are shown in treatment forms for the service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Has Route And Location For Treatments" }, "has_sig_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this product should have a signature input in treatments. Only applicable when the `kind` of the associated group service is `PRODUCT`.", "title": "Has Sig For Treatments" }, "has_take_home_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when taken home by the pet parent.", "title": "Has Take Home Dispense Fee" }, "invoiced_as_non_integer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is invoiced in integer increments or not.", "title": "Invoiced As Non Integer" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a patient eligible for this service has been spayed/neutered.", "title": "Is Altered" }, "is_invoice_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is only invoiced, not charged for hospitalizations.", "title": "Is Invoice Only" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of keywords associated with this service.", "title": "Keywords" }, "max_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of a patient eligible for this service, in the unit specified by `max_age_units`.", "title": "Max Age" }, "max_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit in which the `max_age` is defined.", "title": "Max Age Units" }, "max_quantity": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The maximum quantity that can be invoiced for this service.", "title": "Max Quantity" }, "max_uses_per_charge": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum number of uses per charge for this service.", "title": "Max Uses Per Charge" }, "max_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The maximum weight of a patient eligible for this service, in pounds.", "title": "Max Weight" }, "min_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of a patient eligible for this service, in the unit specified by `min_age_units`.", "title": "Min Age" }, "min_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit in which the `min_age` is defined.", "title": "Min Age Units" }, "min_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The minimum weight of a patient eligible for this service, in pounds.", "title": "Min Weight" }, "minimum_subtotal": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum subtotal in cents for this service.", "title": "Minimum Subtotal" }, "procedure_kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProcedureKind" }, { "type": "null" } ], "description": "The kind of procedure this service represents. Only applicable when the `kind` of the associated group service is `PROCEDURE`." }, "sex": { "anyOf": [ { "$ref": "#/components/schemas/SexKind" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The sex of a patient eligible for this service.", "title": "Sex" }, "species": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ] }, "type": "array" }, { "type": "null" } ], "description": "The species of patient associated with this service. If the given value is an empty list (`[]`), that indicates that species is not a relevant criteria for this service and should be ignored. If the species is null, that indicates we should fall back to the group service's configuration for this.", "title": "Species" }, "treatment_sheet_billing_type": { "anyOf": [ { "$ref": "#/components/schemas/HospitalizationServiceBillingType" }, { "type": "null" } ], "description": "The treatment sheet billing type for this service." }, "treatment_sheet_category": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentSheetSeriesCategory" }, { "type": "null" } ], "description": "The treatment sheet category for this service, used for grouping in treatment sheet workflows." }, "vaccine_kind": { "anyOf": [ { "$ref": "#/components/schemas/VaccineKind" }, { "type": "null" } ], "description": "The kind of vaccine this service represents. Only applicable when the `kind` of the associated group service is `VACCINE`." } }, "title": "ExternalClinicServiceConfigData", "type": "object" }, "ExternalClinicServiceCreateSchema": { "properties": { "breeds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of breed names associated with this service. If the given value is an empty list (`[]`), that indicates that breed is not a relevant criteria for this service and should be ignored. If the given value is null, that indicates we should fall back to the group service's configuration for this.", "title": "Breeds" }, "config.default_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The default price for this service if not overridden elsewhere.", "title": "Config.Default Price" }, "config.display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the service. Defaults to the service's name if not defined.", "title": "Config.Display Name" }, "config.exclude_from_discounts": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is excluded from discounts.", "title": "Config.Exclude From Discounts" }, "config.invoiced_as_non_integer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is invoiced in integer increments or not.", "title": "Config.Invoiced As Non Integer" }, "config.keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of keywords associated with this service.", "title": "Config.Keywords" }, "config.max_quantity": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The maximum quantity that can be invoiced for this service.", "title": "Config.Max Quantity" }, "config.minimum_subtotal": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum subtotal in cents for this service.", "title": "Config.Minimum Subtotal" }, "default_location": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductLocation" }, { "type": "null" } ], "description": "The default location that this vaccine/medication will be administered at. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_route": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductRoute" }, { "type": "null" } ], "description": "The default route that this vaccine/medication will be administered through. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_sig": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The default signature for this service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Default Sig" }, "default_treatment_kind": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentKind" }, { "type": "null" } ], "description": "The default kind of treatment this service represents. Only applicable when the `kind` of the associated group service is `PRODUCT` or `MEDICATION`." }, "din": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Drug Identification Number (DIN) for this service. Only applicable when the `kind` of the associated group service is `MEDICATION` or `PRODUCT` and the clinic is in Canada.", "title": "Din" }, "group_service_id": { "description": "The ID of the corresponding Group Service to add clinic-level data for.", "title": "Group Service Id", "type": "integer" }, "has_in_clinic_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when administered in-clinic.", "title": "Has In Clinic Dispense Fee" }, "has_lot_number_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the lot number field is shown in the treatment form. Only applicable when the `kind` of the associated group service is `PRODUCT`, `MEDICATION`, or `SERVICE`.", "title": "Has Lot Number For Treatments" }, "has_route_and_location_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the route/location fields are shown in treatment forms for the service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Has Route And Location For Treatments" }, "has_sig_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this product should have a signature input in treatments. Only applicable when the `kind` of the associated group service is `PRODUCT`.", "title": "Has Sig For Treatments" }, "has_take_home_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when taken home by the pet parent.", "title": "Has Take Home Dispense Fee" }, "historical_code": { "description": "The unique service code that this service existed under at this Clinic before being merged into a Group-level service.", "title": "Historical Code", "type": "string" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a patient eligible for this service has been spayed/neutered.", "title": "Is Altered" }, "is_enabled": { "description": "Whether the service is enabled.", "title": "Is Enabled", "type": "boolean" }, "max_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of a patient eligible for this service, in the unit specified by `max_age_units`.", "title": "Max Age" }, "max_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit in which the `max_age` is defined." }, "max_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The maximum weight of a patient eligible for this service, in pounds.", "title": "Max Weight" }, "min_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of a patient eligible for this service, in the unit specified by `min_age_units`.", "title": "Min Age" }, "min_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit in which the `min_age` is defined." }, "min_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The minimum weight of a patient eligible for this service, in pounds.", "title": "Min Weight" }, "procedure_kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProcedureKind" }, { "type": "null" } ], "description": "The kind of procedure this service represents. Only applicable when the `kind` of the associated group service is `PROCEDURE`." }, "sex": { "anyOf": [ { "$ref": "#/components/schemas/SexKind" }, { "type": "null" } ], "description": "The sex of a patient eligible for this service." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The species of patient associated with this service. If the given value is an empty string (``), that indicates that species is not a relevant criteria for this service and should be ignored. If the species is null, that indicates we should fall back to the group service's configuration for this.", "title": "Species" }, "vaccine_kind": { "anyOf": [ { "$ref": "#/components/schemas/VaccineKind" }, { "type": "null" } ], "description": "The kind of vaccine this service represents. Only applicable when the `kind` of the associated group service is `VACCINE`." } }, "required": [ "historical_code", "is_enabled", "group_service_id" ], "title": "ExternalClinicServiceCreateSchema", "type": "object" }, "ExternalClinicServiceDetailSchema": { "properties": { "clinic_config": { "anyOf": [ { "$ref": "#/components/schemas/ExternalClinicServiceConfigData" }, { "type": "null" } ] }, "clinic_service_price": { "anyOf": [ { "$ref": "#/components/schemas/ExternalServicePrice" }, { "type": "null" } ], "description": "The clinic's set override service price for this service, if one exists." }, "code": { "description": "The unique service code for this service.", "title": "Code", "type": "string" }, "config": { "$ref": "#/components/schemas/ExternalClinicServiceConfigData" }, "created_at": { "description": "The date and time the service was created.", "format": "date-time", "title": "Created At", "type": "string" }, "group_config": { "$ref": "#/components/schemas/ExternalClinicServiceConfigData" }, "group_service_id": { "description": "The ID of the Group-level service that this service corresponds to.", "title": "Group Service Id", "type": "integer" }, "group_service_price": { "anyOf": [ { "$ref": "#/components/schemas/ExternalServicePrice" }, { "type": "null" } ], "description": "The service price for this service set at the group-level, from the group-level service pricing group. Null when the clinic has no pricing group assigned for this service's category." }, "has_fixed_subtotal": { "description": "Whether this service should be priced as a fixed subtotal.", "title": "Has Fixed Subtotal", "type": "boolean" }, "has_in_clinic_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when administered in-clinic.", "title": "Has In Clinic Dispense Fee" }, "has_take_home_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when taken home by the pet parent.", "title": "Has Take Home Dispense Fee" }, "historical_code": { "description": "The unique service code that this service existed under at this Clinic before being merged into a Group-level service.", "title": "Historical Code", "type": "string" }, "is_clinic_editable": { "description": "Whether this service is editable at the clinic level.", "title": "Is Clinic Editable", "type": "boolean" }, "is_enabled_for_clinic": { "description": "Whether the service is enabled at the clinic level.", "title": "Is Enabled For Clinic", "type": "boolean" }, "is_enabled_for_group": { "description": "Whether the service is enabled at the group level.", "title": "Is Enabled For Group", "type": "boolean" }, "is_removable": { "description": "Whether this service is removable once added to the medical record. Only relevant for linked services.", "title": "Is Removable", "type": "boolean" }, "is_searchable_for_line_items": { "description": "Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item.", "title": "Is Searchable For Line Items", "type": "boolean" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceKind" }, { "const": "", "type": "string" } ], "description": "The type of the service.", "title": "Kind" }, "min_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum price for this service, below which it cannot be discounted.", "title": "Min Price" }, "name": { "description": "The name of this service.", "title": "Name", "type": "string" }, "pricing_category": { "$ref": "#/components/schemas/ExternalServicePricingCategorySchema", "description": "The service pricing category this group service belongs to." }, "pricing_source": { "anyOf": [ { "$ref": "#/components/schemas/ExternalGroupServicePricingSource" }, { "type": "null" } ], "description": "Whether pricing for this service at this clinic is controlled by the group service pricing group or overridden at the clinic level. Null when the clinic has no pricing group assigned for this service's category." }, "service_price": { "anyOf": [ { "$ref": "#/components/schemas/ExternalServicePrice" }, { "type": "null" } ], "description": "The effective service price for this service, which may be sourced from the group-level service pricing group or from clinic overrides. Null when the clinic has no pricing group assigned for this service's category." }, "unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/InventoryUnitOfMeasure" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit of measurement. This service is sold in increments of this unit.", "title": "Unit Of Measure" } }, "required": [ "group_service_id", "code", "kind", "service_price", "group_service_price", "clinic_service_price", "name", "is_enabled_for_group", "is_enabled_for_clinic", "historical_code", "pricing_source", "pricing_category", "is_removable", "created_at", "unit_of_measure", "has_fixed_subtotal", "min_price", "is_searchable_for_line_items", "is_clinic_editable", "config", "clinic_config", "group_config" ], "title": "ExternalClinicServiceDetailSchema", "type": "object" }, "ExternalClinicServiceDetailSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicServiceDetailSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicServiceDetailSchemaList", "type": "object" }, "ExternalClinicServiceUpdateSchema": { "properties": { "breeds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of breed names associated with this service. If the given value is an empty list (`[]`), that indicates that breed is not a relevant criteria for this service and should be ignored. If the given value is null, that indicates we should fall back to the group service's configuration for this.", "title": "Breeds" }, "config.default_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The default price for this service if not overridden elsewhere.", "title": "Config.Default Price" }, "config.display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the service. Defaults to the service's name if not defined.", "title": "Config.Display Name" }, "config.exclude_from_discounts": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is excluded from discounts.", "title": "Config.Exclude From Discounts" }, "config.invoiced_as_non_integer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is invoiced in integer increments or not.", "title": "Config.Invoiced As Non Integer" }, "config.keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of keywords associated with this service.", "title": "Config.Keywords" }, "config.max_quantity": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The maximum quantity that can be invoiced for this service.", "title": "Config.Max Quantity" }, "config.minimum_subtotal": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum subtotal in cents for this service.", "title": "Config.Minimum Subtotal" }, "default_location": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductLocation" }, { "type": "null" } ], "description": "The default location that this vaccine/medication will be administered at. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_route": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductRoute" }, { "type": "null" } ], "description": "The default route that this vaccine/medication will be administered through. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_sig": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The default signature for this service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Default Sig" }, "default_treatment_kind": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentKind" }, { "type": "null" } ], "description": "The default kind of treatment this service represents. Only applicable when the `kind` of the associated group service is `PRODUCT` or `MEDICATION`." }, "din": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Drug Identification Number (DIN) for this service. Only applicable when the `kind` of the associated group service is `MEDICATION` or `PRODUCT` and the clinic is in Canada.", "title": "Din" }, "has_in_clinic_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when administered in-clinic.", "title": "Has In Clinic Dispense Fee" }, "has_lot_number_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the lot number field is shown in the treatment form. Only applicable when the `kind` of the associated group service is `PRODUCT`, `MEDICATION`, or `SERVICE`.", "title": "Has Lot Number For Treatments" }, "has_route_and_location_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the route/location fields are shown in treatment forms for the service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Has Route And Location For Treatments" }, "has_sig_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this product should have a signature input in treatments. Only applicable when the `kind` of the associated group service is `PRODUCT`.", "title": "Has Sig For Treatments" }, "has_take_home_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service has a dispense fee when taken home by the pet parent.", "title": "Has Take Home Dispense Fee" }, "historical_code": { "description": "The unique service code that this service existed under at this Clinic before being merged into a Group-level service.", "title": "Historical Code", "type": "string" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a patient eligible for this service has been spayed/neutered.", "title": "Is Altered" }, "is_enabled": { "description": "Whether the service is enabled.", "title": "Is Enabled", "type": "boolean" }, "max_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of a patient eligible for this service, in the unit specified by `max_age_units`.", "title": "Max Age" }, "max_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit in which the `max_age` is defined." }, "max_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The maximum weight of a patient eligible for this service, in pounds.", "title": "Max Weight" }, "min_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of a patient eligible for this service, in the unit specified by `min_age_units`.", "title": "Min Age" }, "min_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit in which the `min_age` is defined." }, "min_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The minimum weight of a patient eligible for this service, in pounds.", "title": "Min Weight" }, "procedure_kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProcedureKind" }, { "type": "null" } ], "description": "The kind of procedure this service represents. Only applicable when the `kind` of the associated group service is `PROCEDURE`." }, "sex": { "anyOf": [ { "$ref": "#/components/schemas/SexKind" }, { "type": "null" } ], "description": "The sex of a patient eligible for this service." }, "species": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The species of patient associated with this service. If the given value is an empty string (``), that indicates that species is not a relevant criteria for this service and should be ignored. If the species is null, that indicates we should fall back to the group service's configuration for this.", "title": "Species" }, "vaccine_kind": { "anyOf": [ { "$ref": "#/components/schemas/VaccineKind" }, { "type": "null" } ], "description": "The kind of vaccine this service represents. Only applicable when the `kind` of the associated group service is `VACCINE`." } }, "required": [ "historical_code", "is_enabled" ], "title": "ExternalClinicServiceUpdateSchema", "type": "object" }, "ExternalClinicTagDetailSchema": { "description": "Clinic location groups are identifiers attached to Clinics that can be used to bucket them based on shared characteristics such as region, pricing model, etc.", "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "group_location_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The group location code of the clinic location group.", "title": "Group Location Code" }, "id": { "description": "The unique identifier for the clinic location group.", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of this clinic location group.", "title": "Name", "type": "string" } }, "required": [ "created", "modified", "id", "name", "group_location_code" ], "title": "Clinic Location Group", "type": "object" }, "ExternalClinicTagSchema": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "group_location_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The group location code of the clinic location group.", "title": "Group Location Code" }, "id": { "description": "The unique identifier for the clinic location group.", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of this clinic location group.", "title": "Name", "type": "string" } }, "required": [ "created", "modified", "id", "name", "group_location_code" ], "title": "ExternalClinicTagSchema", "type": "object" }, "ExternalClinicTagSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicTagSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicTagSchemaList", "type": "object" }, "ExternalClinicTaxCategorySchema": { "properties": { "city_status": { "$ref": "#/components/schemas/TaxStatus", "description": "The city tax status." }, "code": { "description": "The code representing this tax category.", "title": "Code", "type": "string" }, "county_status": { "$ref": "#/components/schemas/TaxStatus", "description": "The county tax status." }, "id": { "description": "The unique identifier for the tax category.", "title": "Id", "type": "integer" }, "name": { "description": "The display name of this tax category.", "title": "Name", "type": "string" }, "state_status": { "$ref": "#/components/schemas/TaxStatus", "description": "The state tax status." } }, "required": [ "id", "name", "code", "state_status", "county_status", "city_status" ], "title": "ExternalClinicTaxCategorySchema", "type": "object" }, "ExternalClinicTaxCategorySchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalClinicTaxCategorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalClinicTaxCategorySchemaList", "type": "object" }, "ExternalDetailAutoAuthSchema": { "description": "Schema for auto-auth response data.", "properties": { "auto_auth_token": { "description": "The generated auto-authentication token.", "title": "Auto Auth Token", "type": "string" }, "base_url": { "description": "The base URL for the Vetcove client shopping portal with the auto-auth token applied.", "title": "Base Url", "type": "string" }, "embed_url": { "description": "A URL for the Vetcove client shopping portal designed to be embedded in an iframe.", "title": "Embed Url", "type": "string" }, "expiry": { "description": "The expiry time of the token, as a Unix timestamp in seconds.", "title": "Expiry", "type": "integer" }, "fullscreen_url": { "description": "A URL for the Vetcove client shopping portal designed for fullscreen browser use.", "title": "Fullscreen Url", "type": "string" } }, "required": [ "auto_auth_token", "expiry", "base_url", "fullscreen_url", "embed_url" ], "title": "ExternalDetailAutoAuthSchema", "type": "object" }, "ExternalDisambiguationCandidateSchema": { "description": "A candidate record returned when PIM ID resolution is ambiguous.", "properties": { "id": { "description": "The Vetcove ID of the candidate. Use this value for 'clinic_patient_id' or 'clinic_client_id' to disambiguate.", "title": "Id", "type": "integer" }, "name": { "description": "The name of the patient or client.", "title": "Name", "type": "string" }, "was_imported_from_legacy_source": { "description": "Whether this record was imported from the clinic's legacy PIMS.", "title": "Was Imported From Legacy Source", "type": "boolean" } }, "required": [ "id", "name", "was_imported_from_legacy_source" ], "title": "ExternalDisambiguationCandidateSchema", "type": "object" }, "ExternalDisambiguationDetailsSchema": { "properties": { "candidates": { "description": "The candidate records that matched the given PIM ID. Re-submit the request with the resolution field set to the chosen candidate's 'id'.", "items": { "$ref": "#/components/schemas/ExternalDisambiguationCandidateSchema" }, "title": "Candidates", "type": "array" }, "resolution_field": { "$ref": "#/components/schemas/DisambiguationResolutionField", "description": "The request field to populate with a candidate ID to resolve the ambiguity." } }, "required": [ "resolution_field", "candidates" ], "title": "ExternalDisambiguationDetailsSchema", "type": "object" }, "ExternalDisambiguationErrorBodySchema": { "properties": { "details": { "$ref": "#/components/schemas/ExternalDisambiguationDetailsSchema", "description": "Contains the resolution field and candidate records for disambiguation." }, "message": { "description": "A human-readable description of the error.", "title": "Message", "type": "string" }, "type": { "const": "disambiguation_required", "description": "The error type.", "title": "Type", "type": "string" } }, "required": [ "type", "message", "details" ], "title": "ExternalDisambiguationErrorBodySchema", "type": "object" }, "ExternalDoctorDetailSchema": { "description": "A doctor (veterinarian) within an organization.", "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "credentials": { "description": "The doctor's credentials (e.g. `DVM`, `VMD`).", "items": { "type": "string" }, "title": "Credentials", "type": "array" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The doctor's email address, if they have an associated clinic user account.", "title": "Email" }, "first_name": { "description": "The first name of the doctor.", "title": "First Name", "type": "string" }, "full_name": { "description": "The doctor's full name. Matches the `authorizing_vet` field on order items.", "title": "Full Name", "type": "string" }, "id": { "description": "The unique identifier for the doctor.", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the doctor is active. Archived doctors and doctors whose clinic user is deactivated are inactive.", "title": "Is Active", "type": "boolean" }, "last_name": { "description": "The last name of the doctor.", "title": "Last Name", "type": "string" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" } }, "required": [ "created", "modified", "id", "first_name", "last_name", "full_name", "is_active", "credentials" ], "title": "Doctor", "type": "object" }, "ExternalDoctorSchema": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "credentials": { "description": "The doctor's credentials (e.g. `DVM`, `VMD`).", "items": { "type": "string" }, "title": "Credentials", "type": "array" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The doctor's email address, if they have an associated clinic user account.", "title": "Email" }, "first_name": { "description": "The first name of the doctor.", "title": "First Name", "type": "string" }, "full_name": { "description": "The doctor's full name. Matches the `authorizing_vet` field on order items.", "title": "Full Name", "type": "string" }, "id": { "description": "The unique identifier for the doctor.", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the doctor is active. Archived doctors and doctors whose clinic user is deactivated are inactive.", "title": "Is Active", "type": "boolean" }, "last_name": { "description": "The last name of the doctor.", "title": "Last Name", "type": "string" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" } }, "required": [ "created", "modified", "id", "first_name", "last_name", "full_name", "is_active", "credentials" ], "title": "ExternalDoctorSchema", "type": "object" }, "ExternalDoctorSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalDoctorSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalDoctorSchemaList", "type": "object" }, "ExternalFormRequestSchema": { "description": "A form request sent or available to a clinic client.", "properties": { "appointment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the linked appointment, if any.", "title": "Appointment Id" }, "clinic_client_id": { "description": "The ID of the clinic client this form request belongs to.", "title": "Clinic Client Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this form request belongs to.", "title": "Clinic Patient Id", "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the client submitted the completed form.", "title": "Completed At" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "dashboard_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client-facing dashboard URL for all pending forms for this client. Null until the form request has been sent.", "title": "Dashboard Url" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the form request expires and is no longer available.", "title": "Expires At" }, "form_type": { "$ref": "#/components/schemas/ExternalFormTypeSchema", "description": "Metadata about the form definition for this request." }, "id": { "description": "The unique identifier for the form request.", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "sent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the form request was sent to the client.", "title": "Sent At" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the client first opened or began filling out the form.", "title": "Started At" }, "status": { "$ref": "#/components/schemas/ExternalFormRequestStatus", "description": "The current status of the form request." }, "url": { "description": "The client-facing URL for this individual form request.", "title": "Url", "type": "string" } }, "required": [ "created", "modified", "id", "clinic_client_id", "clinic_patient_id", "appointment_id", "form_type", "status", "sent_at", "started_at", "completed_at", "expires_at", "url", "dashboard_url" ], "title": "ExternalFormRequestSchema", "type": "object" }, "ExternalFormRequestSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalFormRequestSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalFormRequestSchemaList", "type": "object" }, "ExternalFormRequestStatus": { "description": "Status of a form request exposed on the Connect API.", "enum": [ "CREATED", "SENT", "STARTED", "COMPLETED", "EXPIRED" ], "title": "ExternalFormRequestStatus", "type": "string" }, "ExternalFormTypeSchema": { "description": "Form definition metadata for a form request.", "properties": { "client_facing_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The client-facing title of the form.", "title": "Client Facing Title" }, "id": { "description": "The ID of the form definition.", "title": "Id", "type": "integer" }, "internal_name": { "description": "The internal name of the form used by clinic staff.", "title": "Internal Name", "type": "string" } }, "required": [ "id", "internal_name", "client_facing_title" ], "title": "ExternalFormTypeSchema", "type": "object" }, "ExternalGroupServiceCreateOrUpdateSchema": { "properties": { "breeds": { "default": [], "description": "A list of breed names associated with this service. If the given value is an empty list (`[]`), that indicates that breed is not a relevant criteria for this service and should be ignored.", "items": { "type": "string" }, "title": "Breeds", "type": "array" }, "clinic_location_group_ids": { "description": "If defined, the subset of clinic location groups that this service is for.Otherwise, the service is for all clinics in the group regardless of their location group.", "items": { "type": "integer" }, "title": "Clinic Location Group Ids", "type": "array" }, "code": { "description": "The unique service code for this service.", "title": "Code", "type": "string" }, "default_duration_scales_with_quantity": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service's default duration scales with quantity.", "title": "Default Duration Scales With Quantity" }, "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit of default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`." }, "default_duration_value": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The value of the default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`.", "title": "Default Duration Value" }, "default_durations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExternalServiceVaccineDefaultDurationCreateOrUpdateSchema" }, "type": "array" }, { "type": "null" } ], "description": "Per-reminder default durations for active standard care reminders linked to this vaccine service. Only applicable when the `kind` is `VACCINE`.", "title": "Default Durations" }, "default_location": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductLocation" }, { "type": "null" } ], "description": "The default location that this vaccine/medication will be administered at. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The default price for this service if not overridden elsewhere.", "title": "Default Price" }, "default_route": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductRoute" }, { "type": "null" } ], "description": "The default route that this vaccine/medication will be administered through. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_sig": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The default signature for this service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Default Sig" }, "default_treatment_kind": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentKind" }, { "type": "null" } ], "description": "The default kind of treatment this service represents. Only applicable when the `kind` of the associated group service is `PRODUCT` or `MEDICATION`." }, "din": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Drug Identification Number (DIN) for this service. Only applicable when the `kind` of the associated group service is `MEDICATION` or `PRODUCT` and the clinic is in Canada.", "title": "Din" }, "display_name": { "description": "The display name of the service. Defaults to the service's name if not defined.", "title": "Display Name", "type": "string" }, "exclude_from_discounts": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is excluded from discounts.", "title": "Exclude From Discounts" }, "has_fixed_subtotal": { "description": "Whether this service should be priced as a fixed subtotal.", "title": "Has Fixed Subtotal", "type": "boolean" }, "has_in_clinic_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Whether this service has a dispense fee when administered in-clinic.", "title": "Has In Clinic Dispense Fee" }, "has_lot_number_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the lot number field is shown in the treatment form. Only applicable when the `kind` of the associated group service is `PRODUCT`, `MEDICATION`, or `SERVICE`.", "title": "Has Lot Number For Treatments" }, "has_route_and_location_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the route/location fields are shown in treatment forms for the service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Has Route And Location For Treatments" }, "has_sig_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this product should have a signature input in treatments. Only applicable when the `kind` of the associated group service is `PRODUCT`.", "title": "Has Sig For Treatments" }, "has_take_home_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Whether this service has a dispense fee when taken home by the pet parent.", "title": "Has Take Home Dispense Fee" }, "invoiced_as_non_integer": { "description": "Whether this service is invoiced in integer increments or not.", "title": "Invoiced As Non Integer", "type": "boolean" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a patient eligible for this service has been spayed/neutered.", "title": "Is Altered" }, "is_enabled": { "description": "Whether the service is enabled.", "title": "Is Enabled", "type": "boolean" }, "is_invoice_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is only invoiced, not charged for hospitalizations.", "title": "Is Invoice Only" }, "is_removable": { "default": false, "description": "Whether this service is removable once added to the medical record. Only relevant for linked services.", "title": "Is Removable", "type": "boolean" }, "is_searchable_for_line_items": { "default": true, "description": "Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item.", "title": "Is Searchable For Line Items", "type": "boolean" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of keywords associated with this service.", "title": "Keywords" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceKind" }, { "const": "", "type": "string" } ], "description": "The type of the service.", "title": "Kind" }, "max_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of a patient eligible for this service, in the unit specified by `max_age_units`.", "title": "Max Age" }, "max_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "default": "", "description": "The unit in which the `max_age` is defined.", "title": "Max Age Units" }, "max_quantity": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The maximum quantity that can be invoiced for this service.", "title": "Max Quantity" }, "max_uses_per_charge": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum number of uses per charge for this service.", "title": "Max Uses Per Charge" }, "max_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The maximum weight of a patient eligible for this service, in pounds.", "title": "Max Weight" }, "min_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of a patient eligible for this service, in the unit specified by `min_age_units`.", "title": "Min Age" }, "min_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "default": "", "description": "The unit in which the `min_age` is defined.", "title": "Min Age Units" }, "min_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum price for this service, below which it cannot be discounted.", "title": "Min Price" }, "min_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The minimum weight of a patient eligible for this service, in pounds.", "title": "Min Weight" }, "minimum_subtotal": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum subtotal in cents for this service.", "title": "Minimum Subtotal" }, "name": { "description": "The name of this service.", "title": "Name", "type": "string" }, "procedure_kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProcedureKind" }, { "type": "null" } ], "description": "The kind of procedure this service represents. Only applicable when the `kind` of the associated group service is `PROCEDURE`." }, "revenue_category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the revenue category for this service.", "title": "Revenue Category Id" }, "service_pricing_category_id": { "description": "The ID of the pricing category for this service.", "title": "Service Pricing Category Id", "type": "integer" }, "sex": { "anyOf": [ { "$ref": "#/components/schemas/SexKind" }, { "const": "", "type": "string" } ], "default": "", "description": "The sex of a patient eligible for this service.", "title": "Sex" }, "species": { "default": [], "description": "The species of patient associated with this service. If the given value is an empty list (`[]`), that indicates that species is not a relevant criteria for this service and should be ignored.", "items": { "$ref": "#/components/schemas/PatientKind" }, "title": "Species", "type": "array" }, "tax_category_id": { "description": "The ID of the tax category for this service.", "title": "Tax Category Id", "type": "integer" }, "treatment_sheet_billing_type": { "anyOf": [ { "$ref": "#/components/schemas/HospitalizationServiceBillingType" }, { "type": "null" } ], "description": "The treatment sheet billing type for this service." }, "treatment_sheet_category": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentSheetSeriesCategory" }, { "type": "null" } ], "description": "The treatment sheet category of this service." }, "unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/InventoryUnitOfMeasure" }, { "const": "", "type": "string" } ], "description": "The unit of measurement. This service is sold in increments of this unit.", "title": "Unit Of Measure" }, "vaccine_kind": { "anyOf": [ { "$ref": "#/components/schemas/VaccineKind" }, { "type": "null" } ], "description": "The kind of vaccine this service represents. Only applicable when the `kind` of the associated group service is `VACCINE`." } }, "required": [ "code", "name", "kind", "service_pricing_category_id", "is_enabled", "min_price", "unit_of_measure", "has_fixed_subtotal", "clinic_location_group_ids", "tax_category_id", "display_name", "invoiced_as_non_integer" ], "title": "ExternalGroupServiceCreateOrUpdateSchema", "type": "object" }, "ExternalGroupServiceDetailSchema": { "properties": { "breeds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of breed names associated with this service. If the given value is an empty list (`[]`), that indicates that breed is not a relevant criteria for this service and should be ignored.", "title": "Breeds" }, "clinic_location_group_ids": { "default": [], "description": "If defined, the subset of clinic location groups that this service is for.Otherwise, the service is for all clinics in the group regardless of their location group.", "items": { "type": "integer" }, "title": "Clinic Location Group Ids", "type": "array" }, "code": { "description": "The unique service code for this service.", "title": "Code", "type": "string" }, "created_at": { "description": "The date and time the service was created.", "format": "date-time", "title": "Created At", "type": "string" }, "default_duration_scales_with_quantity": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service's default duration scales with quantity.", "title": "Default Duration Scales With Quantity" }, "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit of default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`." }, "default_duration_value": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The value of the default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`.", "title": "Default Duration Value" }, "default_durations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExternalServiceVaccineDefaultDurationSchema" }, "type": "array" }, { "type": "null" } ], "description": "Per-reminder default durations for active standard care reminders linked to this vaccine service. Only applicable when the `kind` is `VACCINE`.", "title": "Default Durations" }, "default_location": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductLocation" }, { "type": "null" } ], "description": "The default location that this vaccine/medication will be administered at. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The default price for this service if not overridden elsewhere.", "title": "Default Price" }, "default_route": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProductRoute" }, { "type": "null" } ], "description": "The default route that this vaccine/medication will be administered through. Only applicable when the `kind` of the associated group service is `VACCINE` or `MEDICATION`." }, "default_sig": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The default signature for this service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Default Sig" }, "default_treatment_kind": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentKind" }, { "type": "null" } ], "description": "The default kind of treatment this service represents. Only applicable when the `kind` of the associated group service is `PRODUCT` or `MEDICATION`." }, "din": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Drug Identification Number (DIN) for this service. Only applicable when the `kind` of the associated group service is `MEDICATION` or `PRODUCT` and the clinic is in Canada.", "title": "Din" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the service. Defaults to the service's name if not defined.", "title": "Display Name" }, "exclude_from_discounts": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is excluded from discounts.", "title": "Exclude From Discounts" }, "has_fixed_subtotal": { "description": "Whether this service should be priced as a fixed subtotal.", "title": "Has Fixed Subtotal", "type": "boolean" }, "has_in_clinic_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Whether this service has a dispense fee when administered in-clinic.", "title": "Has In Clinic Dispense Fee" }, "has_lot_number_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the lot number field is shown in the treatment form. Only applicable when the `kind` of the associated group service is `PRODUCT`, `MEDICATION`, or `SERVICE`.", "title": "Has Lot Number For Treatments" }, "has_route_and_location_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the route/location fields are shown in treatment forms for the service. Only applicable when the `kind` of the associated group service is `MEDICATION`.", "title": "Has Route And Location For Treatments" }, "has_sig_for_treatments": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this product should have a signature input in treatments. Only applicable when the `kind` of the associated group service is `PRODUCT`.", "title": "Has Sig For Treatments" }, "has_take_home_dispense_fee": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Whether this service has a dispense fee when taken home by the pet parent.", "title": "Has Take Home Dispense Fee" }, "id": { "description": "The unique identifier for the service.", "title": "Id", "type": "integer" }, "invoiced_as_non_integer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is invoiced in integer increments or not.", "title": "Invoiced As Non Integer" }, "is_altered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether a patient eligible for this service has been spayed/neutered.", "title": "Is Altered" }, "is_enabled": { "description": "Whether the service is enabled.", "title": "Is Enabled", "type": "boolean" }, "is_invoice_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this service is only invoiced, not charged for hospitalizations.", "title": "Is Invoice Only" }, "is_removable": { "description": "Whether this service is removable once added to the medical record. Only relevant for linked services.", "title": "Is Removable", "type": "boolean" }, "is_searchable_for_line_items": { "description": "Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item.", "title": "Is Searchable For Line Items", "type": "boolean" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "A list of keywords associated with this service.", "title": "Keywords" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceKind" }, { "const": "", "type": "string" } ], "description": "The type of the service.", "title": "Kind" }, "max_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The maximum age of a patient eligible for this service, in the unit specified by `max_age_units`.", "title": "Max Age" }, "max_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit in which the `max_age` is defined.", "title": "Max Age Units" }, "max_quantity": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "The maximum quantity that can be invoiced for this service.", "title": "Max Quantity" }, "max_uses_per_charge": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum number of uses per charge for this service.", "title": "Max Uses Per Charge" }, "max_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The maximum weight of a patient eligible for this service, in pounds.", "title": "Max Weight" }, "min_age": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum age of a patient eligible for this service, in the unit specified by `min_age_units`.", "title": "Min Age" }, "min_age_units": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The unit in which the `min_age` is defined.", "title": "Min Age Units" }, "min_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum price for this service, below which it cannot be discounted.", "title": "Min Price" }, "min_weight": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "The minimum weight of a patient eligible for this service, in pounds.", "title": "Min Weight" }, "minimum_subtotal": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum subtotal in cents for this service.", "title": "Minimum Subtotal" }, "name": { "description": "The name of this service.", "title": "Name", "type": "string" }, "procedure_kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProcedureKind" }, { "type": "null" } ], "description": "The kind of procedure this service represents. Only applicable when the `kind` of the associated group service is `PROCEDURE`." }, "revenue_category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the revenue category for this service.", "title": "Revenue Category Id" }, "service_pricing_category_id": { "description": "The ID of the pricing category for this service.", "title": "Service Pricing Category Id", "type": "integer" }, "sex": { "anyOf": [ { "$ref": "#/components/schemas/SexKind" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "The sex of a patient eligible for this service.", "title": "Sex" }, "species": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "const": "", "type": "string" } ] }, "type": "array" }, { "type": "null" } ], "description": "The species of patient associated with this service. If the given value is an empty list (`[]`), that indicates that species is not a relevant criteria for this service and should be ignored.", "title": "Species" }, "tax_category_id": { "description": "The ID of the tax category for this service.", "title": "Tax Category Id", "type": "integer" }, "treatment_sheet_billing_type": { "anyOf": [ { "$ref": "#/components/schemas/HospitalizationServiceBillingType" }, { "type": "null" } ], "description": "The treatment sheet billing type for this service." }, "treatment_sheet_category": { "anyOf": [ { "$ref": "#/components/schemas/TreatmentSheetSeriesCategory" }, { "type": "null" } ], "description": "The treatment sheet category for this service, used for grouping in treatment sheet workflows." }, "unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/InventoryUnitOfMeasure" }, { "const": "", "type": "string" } ], "description": "The unit of measurement. This service is sold in increments of this unit.", "title": "Unit Of Measure" }, "vaccine_kind": { "anyOf": [ { "$ref": "#/components/schemas/VaccineKind" }, { "type": "null" } ], "description": "The kind of vaccine this service represents. Only applicable when the `kind` of the associated group service is `VACCINE`." } }, "required": [ "id", "code", "name", "kind", "service_pricing_category_id", "is_enabled", "created_at", "min_price", "is_removable", "unit_of_measure", "tax_category_id", "revenue_category_id", "is_searchable_for_line_items", "has_fixed_subtotal" ], "title": "ExternalGroupServiceDetailSchema", "type": "object" }, "ExternalGroupServicePricingSource": { "enum": [ "SERVICE_PRICING_GROUP", "CLINIC_OVERRIDE" ], "title": "ExternalGroupServicePricingSource", "type": "string" }, "ExternalGroupServiceSchema": { "properties": { "code": { "description": "The unique service code for this service.", "title": "Code", "type": "string" }, "created_at": { "description": "The date and time the service was created.", "format": "date-time", "title": "Created At", "type": "string" }, "id": { "description": "The unique identifier for the service.", "title": "Id", "type": "integer" }, "is_enabled": { "description": "Whether the service is enabled.", "title": "Is Enabled", "type": "boolean" }, "is_removable": { "description": "Whether this service is removable once added to the medical record. Only relevant for linked services.", "title": "Is Removable", "type": "boolean" }, "is_searchable_for_line_items": { "description": "Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item.", "title": "Is Searchable For Line Items", "type": "boolean" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceKind" }, { "const": "", "type": "string" } ], "description": "The type of the service.", "title": "Kind" }, "min_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum price for this service, below which it cannot be discounted.", "title": "Min Price" }, "name": { "description": "The name of this service.", "title": "Name", "type": "string" }, "revenue_category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the revenue category for this service.", "title": "Revenue Category Id" }, "service_pricing_category_id": { "description": "The ID of the pricing category for this service.", "title": "Service Pricing Category Id", "type": "integer" }, "tax_category_id": { "description": "The ID of the tax category for this service.", "title": "Tax Category Id", "type": "integer" }, "unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/InventoryUnitOfMeasure" }, { "const": "", "type": "string" } ], "description": "The unit of measurement. This service is sold in increments of this unit.", "title": "Unit Of Measure" } }, "required": [ "id", "code", "name", "kind", "service_pricing_category_id", "is_enabled", "created_at", "min_price", "is_removable", "unit_of_measure", "tax_category_id", "revenue_category_id", "is_searchable_for_line_items" ], "title": "ExternalGroupServiceSchema", "type": "object" }, "ExternalGroupServiceSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalGroupServiceSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalGroupServiceSchemaList", "type": "object" }, "ExternalGroupServiceWithPricingSchema": { "properties": { "code": { "description": "The unique service code for this service.", "title": "Code", "type": "string" }, "created_at": { "description": "The date and time the service was created.", "format": "date-time", "title": "Created At", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the service. Defaults to the service's name if not defined.", "title": "Display Name" }, "id": { "description": "The unique identifier for the service.", "title": "Id", "type": "integer" }, "is_enabled": { "description": "Whether the service is enabled.", "title": "Is Enabled", "type": "boolean" }, "is_removable": { "description": "Whether this service is removable once added to the medical record. Only relevant for linked services.", "title": "Is Removable", "type": "boolean" }, "is_searchable_for_line_items": { "description": "Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item.", "title": "Is Searchable For Line Items", "type": "boolean" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/ServiceKind" }, { "const": "", "type": "string" } ], "description": "The type of the service.", "title": "Kind" }, "min_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The minimum price for this service, below which it cannot be discounted.", "title": "Min Price" }, "name": { "description": "The name of this service.", "title": "Name", "type": "string" }, "revenue_category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the revenue category for this service.", "title": "Revenue Category Id" }, "service_price": { "$ref": "#/components/schemas/ExternalServicePrice", "description": "The service price for this service." }, "service_pricing_category_id": { "description": "The ID of the pricing category for this service.", "title": "Service Pricing Category Id", "type": "integer" }, "tax_category_id": { "description": "The ID of the tax category for this service.", "title": "Tax Category Id", "type": "integer" }, "unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/InventoryUnitOfMeasure" }, { "const": "", "type": "string" } ], "description": "The unit of measurement. This service is sold in increments of this unit.", "title": "Unit Of Measure" } }, "required": [ "id", "code", "name", "kind", "service_pricing_category_id", "is_enabled", "created_at", "min_price", "is_removable", "unit_of_measure", "tax_category_id", "revenue_category_id", "is_searchable_for_line_items", "service_price" ], "title": "ExternalGroupServiceWithPricingSchema", "type": "object" }, "ExternalImportDisambiguationErrorSchema": { "description": "Returned when a PIM ID matches multiple patients or clients and the system cannot auto-resolve to a single record. The 'details.candidates' array lists the matching records, and 'details.resolution_field' indicates which request field to populate with the chosen candidate's ID.", "properties": { "error": { "$ref": "#/components/schemas/ExternalDisambiguationErrorBodySchema", "description": "The disambiguation error. Contains candidate records and the field to use for resolution." } }, "required": [ "error" ], "title": "ExternalImportDisambiguationErrorSchema", "type": "object" }, "ExternalImportedConversationSchema": { "properties": { "attachment_uploaded_file_ids": { "description": "IDs of uploaded files attached to this conversation. Clients fetch the underlying file bytes via the `/file-uploads/` endpoints.", "items": { "type": "integer" }, "title": "Attachment Uploaded File Ids", "type": "array" }, "clinic_client_id": { "description": "The ID of the clinic client (pet parent) the conversation is about.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic the conversation belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_ids": { "description": "The IDs of the clinic patients the conversation is attached to. Conversations submitted without a patient are fanned out to every active patient of the client at ingest time.", "items": { "type": "integer" }, "title": "Clinic Patient Ids", "type": "array" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "id": { "description": "The ID of the imported conversation record.", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "text": { "description": "The full conversation transcript, stored and rendered verbatim in the Vetcove patient timeline.", "title": "Text", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short label shown in the patient timeline preview row.", "title": "Title" } }, "required": [ "created", "modified", "id", "clinic_id", "clinic_client_id", "clinic_patient_ids", "title", "text", "attachment_uploaded_file_ids" ], "title": "ExternalImportedConversationSchema", "type": "object" }, "ExternalImportedConversationSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalImportedConversationSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalImportedConversationSchemaList", "type": "object" }, "ExternalInsuranceProviderDetailSchema": { "description": "A provider of insurance for patients.", "properties": { "id": { "description": "The ID of the insurance provider.", "title": "Id", "type": "integer" }, "name": { "description": "The name of the insurance provider.", "title": "Name", "type": "string" } }, "required": [ "name", "id" ], "title": "InsuranceProvider", "type": "object" }, "ExternalInsuranceProviderSchema": { "properties": { "id": { "description": "The ID of the insurance provider.", "title": "Id", "type": "integer" }, "name": { "description": "The name of the insurance provider.", "title": "Name", "type": "string" } }, "required": [ "name", "id" ], "title": "ExternalInsuranceProviderSchema", "type": "object" }, "ExternalInsuranceProviderSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInsuranceProviderSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalInsuranceProviderSchemaList", "type": "object" }, "ExternalInventoryCategoryDetailSchema": { "properties": { "id": { "description": "The unique identifier for the inventory category", "title": "Id", "type": "integer" }, "name": { "description": "The name of the category", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "ExternalInventoryCategoryDetailSchema", "type": "object" }, "ExternalInventoryCategorySchema": { "properties": { "id": { "description": "The unique identifier for the inventory category", "title": "Id", "type": "integer" }, "name": { "description": "The name of the category", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "ExternalInventoryCategorySchema", "type": "object" }, "ExternalInventoryCategorySchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInventoryCategorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalInventoryCategorySchemaList", "type": "object" }, "ExternalInventoryCodeDetailSchema": { "properties": { "category_id": { "description": "The ID of the inventory category for this inventory code", "title": "Category Id", "type": "integer" }, "code": { "description": "The global code assigned to this type of inventory at Vetcove", "title": "Code", "type": "string" }, "effective_preferences": { "$ref": "#/components/schemas/EffectiveInventoryPreference", "description": "The effective settings for this type of inventory, favoring your organization's settings but falling back to Vetcove's defaults when you do not have an override set" }, "global_preferences": { "$ref": "#/components/schemas/GlobalInventoryPreference", "description": "Vetcove's default settings for this type of inventory" }, "id": { "description": "The unique identifier for the inventory code", "title": "Id", "type": "integer" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/GlobalInventoryKind" }, { "const": "", "type": "string" } ], "description": "The kind of the inventory code", "title": "Kind" }, "organization_preferences": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationInventoryPreference" }, { "type": "null" } ], "description": "The settings for this type of inventory set by your organization. Will be null if your organization does not have its own settings for this type of inventory" } }, "required": [ "id", "code", "kind", "category_id", "global_preferences", "organization_preferences", "effective_preferences" ], "title": "ExternalInventoryCodeDetailSchema", "type": "object" }, "ExternalInventoryCodeSchema": { "properties": { "category_id": { "description": "The ID of the inventory category for this inventory code", "title": "Category Id", "type": "integer" }, "code": { "description": "The global code assigned to this type of inventory at Vetcove", "title": "Code", "type": "string" }, "effective_preferences": { "$ref": "#/components/schemas/EffectiveInventoryPreference", "description": "The effective settings for this type of inventory, favoring your organization's settings but falling back to Vetcove's defaults when you do not have an override set" }, "global_preferences": { "$ref": "#/components/schemas/GlobalInventoryPreference", "description": "Vetcove's default settings for this type of inventory" }, "id": { "description": "The unique identifier for the inventory code", "title": "Id", "type": "integer" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/GlobalInventoryKind" }, { "const": "", "type": "string" } ], "description": "The kind of the inventory code", "title": "Kind" }, "organization_preferences": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationInventoryPreference" }, { "type": "null" } ], "description": "The settings for this type of inventory set by your organization. Will be null if your organization does not have its own settings for this type of inventory" } }, "required": [ "id", "code", "kind", "category_id", "global_preferences", "organization_preferences", "effective_preferences" ], "title": "ExternalInventoryCodeSchema", "type": "object" }, "ExternalInventoryCodeSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInventoryCodeSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalInventoryCodeSchemaList", "type": "object" }, "ExternalInvoiceDetailSchema": { "description": "An invoice represents a bill issued by a clinic to a client (pet parent) for services rendered, products sold, or other charges. Invoices track the total amount, payments made, discounts applied, and remaining balance.", "properties": { "amount_paid": { "description": "The amount paid so far for this invoice", "minimum": 0, "title": "Amount Paid", "type": "integer" }, "clinic_client_id": { "description": "The ID of the client this invoice is for", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic which issued this invoice", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "date_posted": { "description": "The datetime this invoice was posted", "format": "date-time", "title": "Date Posted", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "discount": { "description": "The discount given to the client for this invoice, if any", "minimum": 0, "title": "Discount", "type": "integer" }, "finalized_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as finalized and became due", "title": "Finalized At" }, "id": { "description": "The unique identifier for the invoice", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "locked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as locked", "title": "Locked At" }, "marked_as_collections_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as collections (a.k.a. written off)", "title": "Marked As Collections At" }, "marked_not_rendered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as not-rendered", "title": "Marked Not Rendered At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "remaining_balance": { "description": "The remaining balance for this invoice", "title": "Remaining Balance", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ClientInvoiceStatus" }, { "const": "", "type": "string" } ], "description": "The status of the invoice", "title": "Status" }, "subtotal": { "description": "The subtotal due for this invoice", "minimum": 0, "title": "Subtotal", "type": "integer" }, "tax": { "description": "The amount of tax charged to the client for this invoice", "minimum": 0, "title": "Tax", "type": "integer" }, "total": { "description": "The total amount billed to the client for this invoice", "title": "Total", "type": "integer" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "status", "clinic_client_id", "clinic_id", "marked_as_collections_at", "marked_not_rendered_at", "finalized_at", "locked_at", "date_posted", "total", "subtotal", "discount", "tax", "amount_paid", "remaining_balance" ], "title": "ExternalInvoiceDetailSchema", "type": "object" }, "ExternalInvoiceItemDetailSchema": { "properties": { "clinic_client_id": { "description": "The ID of the client (pet parent) on the invoice.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic that issued the invoice.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the patient this item is for.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "date_posted": { "description": "The date and time when this item was posted.", "format": "date-time", "title": "Date Posted", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "description": { "description": "The display description of the line item.", "title": "Description", "type": "string" }, "discount": { "description": "The discount applied to this item, in cents.", "title": "Discount", "type": "integer" }, "group_bundle_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The human-visible bundle code for this line item, if it is a bundle.", "title": "Group Bundle Code" }, "group_bundle_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the group bundle for this line item, if it is a bundle.", "title": "Group Bundle Id" }, "group_service_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The human-visible service code for this line item, if it is a service.", "title": "Group Service Code" }, "group_service_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the group service (catalog item) for this line item, if it is a service.", "title": "Group Service Id" }, "id": { "description": "The unique identifier for the invoice item.", "title": "Id", "type": "integer" }, "invoice_id": { "description": "The ID of the invoice this item belongs to.", "title": "Invoice Id", "type": "integer" }, "is_declined": { "description": "Whether the client declined this item.", "title": "Is Declined", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind": { "$ref": "#/components/schemas/ClientInvoiceItemKind", "description": "Whether the item is an in-clinic service or a take-home product." }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "provider_clinic_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic user assigned to this item. May be null even when provider_clinic_user_name is present, for items imported from an external PIMS whose provider has not been matched to a clinic user.", "title": "Provider Clinic User Id" }, "provider_clinic_user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the clinic user assigned to this item. Derived from the clinic user when provider_clinic_user_id is present, or from the imported PIMS provider name otherwise.", "title": "Provider Clinic User Name" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The quantity of the item.", "title": "Quantity" }, "subtotal": { "description": "The subtotal for the item before discounts and taxes, in cents.", "title": "Subtotal", "type": "integer" }, "tax": { "description": "The tax applied to this item, in cents.", "title": "Tax", "type": "integer" }, "total": { "description": "The total for the item after discounts and taxes, in cents.", "title": "Total", "type": "integer" }, "unit_price": { "description": "The unit price of the item, in cents.", "title": "Unit Price", "type": "integer" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "invoice_id", "clinic_id", "clinic_client_id", "clinic_patient_id", "description", "kind", "quantity", "unit_price", "subtotal", "discount", "tax", "total", "date_posted", "is_declined" ], "title": "ExternalInvoiceItemDetailSchema", "type": "object" }, "ExternalInvoiceItemNotRenderedSchema": { "description": "Invoice item not rendered represents a quantity of an invoice item that was not rendered.", "properties": { "created": { "description": "The time at which this invoice item was marked as not rendered", "format": "date-time", "title": "Created", "type": "string" }, "id": { "description": "The unique identifier for the invoice item not fully rendered", "title": "Id", "type": "integer" }, "invoice_item_id": { "description": "The ID of the invoice item not fully rendered", "title": "Invoice Item Id", "type": "integer" }, "quantity": { "description": "The quantity of the invoice item that was not fully rendered", "title": "Quantity", "type": "number" }, "reason": { "$ref": "#/components/schemas/InvoiceRefundReason", "description": "The reason this invoice item was not fully rendered" } }, "required": [ "id", "created", "invoice_item_id", "quantity", "reason" ], "title": "InvoiceItemNotRendered", "type": "object" }, "ExternalInvoiceItemRefundSchema": { "description": "Invoice item refunds represents all refunds comprising an invoice refund.", "properties": { "amount": { "description": "The amount of the refund", "title": "Amount", "type": "integer" }, "created": { "description": "The time at which this item refund was created", "format": "date-time", "title": "Created", "type": "string" }, "id": { "description": "The unique identifier for the item refund", "title": "Id", "type": "integer" }, "invoice_item_id": { "description": "The ID of the invoice item this refund is for", "title": "Invoice Item Id", "type": "integer" }, "invoice_refund_id": { "description": "The ID of the invoice refund this item refund belongs to", "title": "Invoice Refund Id", "type": "integer" }, "reason": { "anyOf": [ { "$ref": "#/components/schemas/InvoiceRefundReason" }, { "const": "", "type": "string" } ], "description": "The reason for this refund", "title": "Reason" } }, "required": [ "id", "created", "invoice_refund_id", "invoice_item_id", "amount", "reason" ], "title": "InvoiceItemRefund", "type": "object" }, "ExternalInvoiceItemSchema": { "properties": { "clinic_client_id": { "description": "The ID of the client (pet parent) on the invoice.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic that issued the invoice.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the patient this item is for.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "date_posted": { "description": "The date and time when this item was posted.", "format": "date-time", "title": "Date Posted", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "description": { "description": "The display description of the line item.", "title": "Description", "type": "string" }, "discount": { "description": "The discount applied to this item, in cents.", "title": "Discount", "type": "integer" }, "group_bundle_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The human-visible bundle code for this line item, if it is a bundle.", "title": "Group Bundle Code" }, "group_bundle_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the group bundle for this line item, if it is a bundle.", "title": "Group Bundle Id" }, "group_service_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The human-visible service code for this line item, if it is a service.", "title": "Group Service Code" }, "group_service_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the group service (catalog item) for this line item, if it is a service.", "title": "Group Service Id" }, "id": { "description": "The unique identifier for the invoice item.", "title": "Id", "type": "integer" }, "invoice_id": { "description": "The ID of the invoice this item belongs to.", "title": "Invoice Id", "type": "integer" }, "is_declined": { "description": "Whether the client declined this item.", "title": "Is Declined", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "kind": { "$ref": "#/components/schemas/ClientInvoiceItemKind", "description": "Whether the item is an in-clinic service or a take-home product." }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "provider_clinic_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic user assigned to this item. May be null even when provider_clinic_user_name is present, for items imported from an external PIMS whose provider has not been matched to a clinic user.", "title": "Provider Clinic User Id" }, "provider_clinic_user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the clinic user assigned to this item. Derived from the clinic user when provider_clinic_user_id is present, or from the imported PIMS provider name otherwise.", "title": "Provider Clinic User Name" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The quantity of the item.", "title": "Quantity" }, "subtotal": { "description": "The subtotal for the item before discounts and taxes, in cents.", "title": "Subtotal", "type": "integer" }, "tax": { "description": "The tax applied to this item, in cents.", "title": "Tax", "type": "integer" }, "total": { "description": "The total for the item after discounts and taxes, in cents.", "title": "Total", "type": "integer" }, "unit_price": { "description": "The unit price of the item, in cents.", "title": "Unit Price", "type": "integer" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "invoice_id", "clinic_id", "clinic_client_id", "clinic_patient_id", "description", "kind", "quantity", "unit_price", "subtotal", "discount", "tax", "total", "date_posted", "is_declined" ], "title": "ExternalInvoiceItemSchema", "type": "object" }, "ExternalInvoiceItemSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoiceItemSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalInvoiceItemSchemaList", "type": "object" }, "ExternalInvoiceManualDiscountHistorySchema": { "description": "Invoice manual discount history represents all actions taken on a manual discount prior to invoice finalization.", "properties": { "acting_user_id": { "description": "The ID of the profile of the user who took this action.", "title": "Acting User Id", "type": "integer" }, "action_kind": { "anyOf": [ { "$ref": "#/components/schemas/HistoryActionKind" }, { "const": "", "type": "string" } ], "description": "The kind of action captured by this event.", "title": "Action Kind" }, "cents_value": { "description": "If set, the $ off discount this promotion will provide, in cents.", "title": "Cents Value", "type": "integer" }, "event_datetime": { "description": "The date and time the event occurred.", "format": "date-time", "title": "Event Datetime", "type": "string" }, "invoice_id": { "description": "The ID of the invoice for this discount.", "title": "Invoice Id", "type": "integer" }, "invoice_item_id": { "description": "The ID of the invoice item for this discount.", "title": "Invoice Item Id", "type": "integer" }, "manual_discount_id": { "description": "The ID of the manual discount this history is tracking.", "title": "Manual Discount Id", "type": "integer" }, "percent_value": { "description": "If set, the % discount this promotion will provide.", "title": "Percent Value", "type": "number" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The reason this discount is being applied.", "title": "Reason" } }, "required": [ "event_datetime", "action_kind", "acting_user_id", "manual_discount_id", "invoice_id", "invoice_item_id", "percent_value", "cents_value", "reason" ], "title": "InvoiceManualDiscountHistory", "type": "object" }, "ExternalInvoicePaymentDetailSchema": { "description": "An invoice payment represents a payment applied toward a specific invoice. Each invoice payment records the amount applied to that invoice.", "properties": { "amount": { "description": "The payment amount applied to the invoice, in cents.", "title": "Amount", "type": "integer" }, "clinic_client_id": { "description": "The ID of the client (pet parent) on the invoice.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic that issued the invoice.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "id": { "description": "The unique identifier for the invoice payment.", "title": "Id", "type": "integer" }, "invoice_id": { "description": "The ID of the invoice this payment is applied to.", "title": "Invoice Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "payment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment this invoice payment is linked to, if any.", "title": "Payment Id" } }, "required": [ "created", "modified", "id", "invoice_id", "clinic_id", "clinic_client_id", "payment_id", "amount" ], "title": "InvoicePaymentDetail", "type": "object" }, "ExternalInvoicePaymentDisputeSchema": { "description": "Invoice payment disputes represents all disputes on an invoice payment.", "properties": { "created": { "description": "The time at which this dispute was created", "format": "date-time", "title": "Created", "type": "string" }, "created_by_id": { "description": "The ID of the user who created this dispute", "title": "Created By Id", "type": "integer" }, "id": { "description": "The unique identifier for the payment dispute", "title": "Id", "type": "integer" }, "payment_id": { "description": "The payment ID associated with this dispute", "title": "Payment Id", "type": "integer" }, "resolved_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The time at which this dispute was resolved, if resolved", "title": "Resolved At" }, "resolved_by_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the user who marked this dispute as resolved, if resolved", "title": "Resolved By Id" }, "status": { "$ref": "#/components/schemas/PaymentDisputeStatus", "description": "The status of this dispute" } }, "required": [ "id", "created", "payment_id", "status", "created_by_id", "resolved_at", "resolved_by_id" ], "title": "InvoicePaymentDisputes", "type": "object" }, "ExternalInvoicePaymentHistorySchema": { "description": "Invoice payment history represents all actions taken on an invoice payment.", "properties": { "acting_user_id": { "description": "The ID of the profile of the user who took this action.", "title": "Acting User Id", "type": "integer" }, "action_kind": { "anyOf": [ { "$ref": "#/components/schemas/HistoryActionKind" }, { "const": "", "type": "string" } ], "description": "The kind of action captured by this event.", "title": "Action Kind" }, "amount": { "description": "The amount of the payment, in cents.", "title": "Amount", "type": "integer" }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/Currency" }, { "const": "", "type": "string" } ], "description": "The currency of the payment", "title": "Currency" }, "event_datetime": { "description": "The date and time the event occurred.", "format": "date-time", "title": "Event Datetime", "type": "string" }, "id": { "description": "The unique identifier for this payment history object. The value of this ID may exceed JavaScript's `Number.MAX_SAFE_INTEGER` (2^53 - 1). JavaScript consumers should handle this value appropriately to avoid precision loss.", "format": "int64", "title": "Id", "type": "integer" }, "payment_id": { "description": "The ID of the payment this history is tracking.", "title": "Payment Id", "type": "integer" }, "recorded_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the payment was recorded.", "title": "Recorded At" }, "status": { "$ref": "#/components/schemas/ClientPaymentStatus", "description": "The status of the payment." }, "voided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted datetime for when the payment was voided.", "title": "Voided At" } }, "required": [ "event_datetime", "action_kind", "acting_user_id", "id", "payment_id", "recorded_at", "voided_at", "amount", "currency", "status" ], "title": "InvoicePaymentHistory", "type": "object" }, "ExternalInvoicePaymentSchema": { "properties": { "amount": { "description": "The payment amount applied to the invoice, in cents.", "title": "Amount", "type": "integer" }, "clinic_client_id": { "description": "The ID of the client (pet parent) on the invoice.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic that issued the invoice.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "id": { "description": "The unique identifier for the invoice payment.", "title": "Id", "type": "integer" }, "invoice_id": { "description": "The ID of the invoice this payment is applied to.", "title": "Invoice Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "payment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment this invoice payment is linked to, if any.", "title": "Payment Id" } }, "required": [ "created", "modified", "id", "invoice_id", "clinic_id", "clinic_client_id", "payment_id", "amount" ], "title": "ExternalInvoicePaymentSchema", "type": "object" }, "ExternalInvoicePaymentSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoicePaymentSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalInvoicePaymentSchemaList", "type": "object" }, "ExternalInvoiceRefundSchema": { "description": "Invoice refunds represents all refunds for a given invoice.", "properties": { "amount": { "description": "The amount refunded, in cents", "title": "Amount", "type": "integer" }, "created": { "description": "The time at which this refund was created", "format": "date-time", "title": "Created", "type": "string" }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/Currency" }, { "const": "", "type": "string" } ], "description": "The currency of the refund", "title": "Currency" }, "id": { "description": "The unique identifier for the refund", "title": "Id", "type": "integer" } }, "required": [ "id", "created", "amount", "currency" ], "title": "InvoiceRefund", "type": "object" }, "ExternalInvoiceRefundTopLevelDetailSchema": { "properties": { "amount": { "description": "The amount refunded, in cents.", "title": "Amount", "type": "integer" }, "clinic_client_id": { "description": "The ID of the client (pet parent) on the invoice.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic that issued the invoice.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "currency": { "$ref": "#/components/schemas/Currency", "description": "The currency of the refund." }, "id": { "description": "The unique identifier for the invoice refund.", "title": "Id", "type": "integer" }, "invoice_id": { "description": "The ID of the invoice this refund is associated with.", "title": "Invoice Id", "type": "integer" }, "invoice_payment_id": { "description": "The ID of the invoice payment this refund is against.", "title": "Invoice Payment Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "refund_type": { "$ref": "#/components/schemas/RefundType", "description": "The type of refund (e.g. credit card, store credit, external)." } }, "required": [ "created", "modified", "id", "invoice_payment_id", "invoice_id", "clinic_id", "clinic_client_id", "amount", "refund_type", "currency" ], "title": "ExternalInvoiceRefundTopLevelDetailSchema", "type": "object" }, "ExternalInvoiceRefundTopLevelSchema": { "properties": { "amount": { "description": "The amount refunded, in cents.", "title": "Amount", "type": "integer" }, "clinic_client_id": { "description": "The ID of the client (pet parent) on the invoice.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic that issued the invoice.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "currency": { "$ref": "#/components/schemas/Currency", "description": "The currency of the refund." }, "id": { "description": "The unique identifier for the invoice refund.", "title": "Id", "type": "integer" }, "invoice_id": { "description": "The ID of the invoice this refund is associated with.", "title": "Invoice Id", "type": "integer" }, "invoice_payment_id": { "description": "The ID of the invoice payment this refund is against.", "title": "Invoice Payment Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "refund_type": { "$ref": "#/components/schemas/RefundType", "description": "The type of refund (e.g. credit card, store credit, external)." } }, "required": [ "created", "modified", "id", "invoice_payment_id", "invoice_id", "clinic_id", "clinic_client_id", "amount", "refund_type", "currency" ], "title": "ExternalInvoiceRefundTopLevelSchema", "type": "object" }, "ExternalInvoiceRefundTopLevelSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoiceRefundTopLevelSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalInvoiceRefundTopLevelSchemaList", "type": "object" }, "ExternalInvoiceSchema": { "properties": { "amount_paid": { "description": "The amount paid so far for this invoice", "minimum": 0, "title": "Amount Paid", "type": "integer" }, "clinic_client_id": { "description": "The ID of the client this invoice is for", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic which issued this invoice", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "date_posted": { "description": "The datetime this invoice was posted", "format": "date-time", "title": "Date Posted", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "discount": { "description": "The discount given to the client for this invoice, if any", "minimum": 0, "title": "Discount", "type": "integer" }, "finalized_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as finalized and became due", "title": "Finalized At" }, "id": { "description": "The unique identifier for the invoice", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "locked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as locked", "title": "Locked At" }, "marked_as_collections_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as collections (a.k.a. written off)", "title": "Marked As Collections At" }, "marked_not_rendered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime at which this invoice was marked as not-rendered", "title": "Marked Not Rendered At" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "remaining_balance": { "description": "The remaining balance for this invoice", "title": "Remaining Balance", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ClientInvoiceStatus" }, { "const": "", "type": "string" } ], "description": "The status of the invoice", "title": "Status" }, "subtotal": { "description": "The subtotal due for this invoice", "minimum": 0, "title": "Subtotal", "type": "integer" }, "tax": { "description": "The amount of tax charged to the client for this invoice", "minimum": 0, "title": "Tax", "type": "integer" }, "total": { "description": "The total amount billed to the client for this invoice", "title": "Total", "type": "integer" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "status", "clinic_client_id", "clinic_id", "marked_as_collections_at", "marked_not_rendered_at", "finalized_at", "locked_at", "date_posted", "total", "subtotal", "discount", "tax", "amount_paid", "remaining_balance" ], "title": "ExternalInvoiceSchema", "type": "object" }, "ExternalInvoiceSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoiceSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalInvoiceSchemaList", "type": "object" }, "ExternalItemSchema": { "description": "Schema for catalog item details.", "properties": { "alt_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alternative URL to the item's image", "title": "Alt Image Url" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "duration_unit": { "description": "Unit of time used to measure the duration value field (days, weeks, months, or years)", "title": "Duration Unit", "type": "string" }, "duration_value": { "description": "Duration the item is expected to last ", "title": "Duration Value", "type": "integer" }, "etailer_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price of this item at major online retailers, in cents. Used for price comparison.", "title": "Etailer Price" }, "full_name": { "description": "Complete name of the item", "title": "Full Name", "type": "string" }, "id": { "description": "Unique identifier for the catalog item", "title": "Id", "type": "integer" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to the item's image", "title": "Image Url" }, "is_active": { "description": "Whether the item is active", "title": "Is Active", "type": "boolean" }, "manufacturer_no": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Manufacturer number of the item", "title": "Manufacturer No" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "msrp": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Manufacturer's suggested retail price (MSRP) of the item, in cents.", "title": "Msrp" }, "name": { "description": "Name of the Item itself. For the complete name of the Item, see the full_name field.", "title": "Name", "type": "string" }, "product_id": { "description": "ID of the associated product", "title": "Product Id", "type": "integer" }, "shopping_path": { "description": "URL path to the item's page in the Vetcove client shopping portal", "title": "Shopping Path", "type": "string" }, "sku": { "description": "Stock keeping unit (SKU) identifier for the item", "title": "Sku", "type": "string" }, "vendor_stock_availability": { "anyOf": [ { "$ref": "#/components/schemas/VendorSupplyAvailability" }, { "type": "null" } ], "description": "The current stock availability status from the vendor supplying this item." }, "weight": { "description": "The weight of the Item in ounces", "title": "Weight", "type": "number" } }, "required": [ "created", "modified", "id", "full_name", "name", "sku", "product_id", "shopping_path", "is_active", "msrp", "weight", "duration_unit", "duration_value" ], "title": "ExternalItemSchema", "type": "object" }, "ExternalItemSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalItemSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalItemSchemaList", "type": "object" }, "ExternalLabResultSchema": { "properties": { "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The category of the test result.", "title": "Category" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The test code.", "title": "Code" }, "critical_range_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The high end of the critical range.", "title": "Critical Range High" }, "critical_range_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The low end of the critical range.", "title": "Critical Range Low" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Stable identifier for this individual lab result. Null for manual lab results. Present for integrated labs (VCP, Antech, PACS) and imported labs.", "title": "Id" }, "is_abnormal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this result is abnormal.", "title": "Is Abnormal" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the test or analyte.", "title": "Name" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any notes associated with this result.", "title": "Notes" }, "reference_range_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The high end of the normal reference range.", "title": "Reference Range High" }, "reference_range_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The low end of the normal reference range.", "title": "Reference Range Low" }, "result_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The date/time the result was recorded (ISO 8601).", "title": "Result Date" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The status of this individual result.", "title": "Status" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The result type: NUMERIC, TEXT, or IMAGE.", "title": "Type" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The unit of measurement for the result value.", "title": "Units" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The result value. For IMAGE type results, this is a presigned S3 URL (1-hour expiry).", "title": "Value" } }, "required": [ "name", "code", "value", "type", "units", "reference_range_low", "reference_range_high", "critical_range_low", "critical_range_high", "is_abnormal", "status", "result_date", "category", "notes" ], "title": "ExternalLabResultSchema", "type": "object" }, "ExternalLegacyPatientCareBenefitImportSchema": { "description": "Schema for uploading legacy patient care benefit data.", "properties": { "care_benefit_id": { "description": "The ID of the care benefit to upload", "title": "Care Benefit Id", "type": "integer" }, "points_used": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The number of points used for the care benefit if applicable", "title": "Points Used" }, "redemptions": { "description": "The redemptions for the care benefit", "items": { "$ref": "#/components/schemas/ExternalLegacyPatientCareBenefitRedemptionImportSchema" }, "title": "Redemptions", "type": "array" } }, "required": [ "care_benefit_id", "redemptions" ], "title": "ExternalLegacyPatientCareBenefitImportSchema", "type": "object" }, "ExternalLegacyPatientCareBenefitRedemptionImportSchema": { "description": "Schema for uploading legacy patient care benefit redemption data.", "properties": { "amount_discounted": { "description": "The amount discounted for the care benefit", "minimum": 0, "title": "Amount Discounted", "type": "integer" }, "points_redeemed": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The number of points redeemed for the care benefit if applicable", "title": "Points Redeemed" } }, "required": [ "amount_discounted" ], "title": "ExternalLegacyPatientCareBenefitRedemptionImportSchema", "type": "object" }, "ExternalLegacyPatientCarePlanImportSchema": { "description": "Schema for importing a legacy patient care plan via the external API.", "properties": { "amount_paid": { "description": "The amount paid for the care plan", "minimum": 0, "title": "Amount Paid", "type": "integer" }, "care_benefits": { "description": "The care benefits to import for the care plan", "items": { "$ref": "#/components/schemas/ExternalLegacyPatientCareBenefitImportSchema" }, "title": "Care Benefits", "type": "array" }, "care_plan_id": { "description": "The core Care Plan ID to enroll the patient into", "title": "Care Plan Id", "type": "integer" }, "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional Vetcove client ID. When provided, bypasses PIM ID lookup and resolves the client by primary key (scoped to clinic). Use this to disambiguate when multiple clients share the same pim_client_id.", "title": "Clinic Client Id" }, "clinic_id": { "description": "The clinic ID for the patient and client being imported", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional Vetcove patient ID. When provided, bypasses PIM ID lookup and resolves the patient by primary key (scoped to clinic). Use this to disambiguate when multiple patients share the same pim_patient_id.", "title": "Clinic Patient Id" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "is_billed_monthly": { "description": "Whether billing is monthly (True) or upfront (False)", "title": "Is Billed Monthly", "type": "boolean" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional next core Care Plan ID for automatic renewal", "title": "Next Plan Id" }, "payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional Vetcove payment method ID. When provided, takes precedence over stripe_payment_method_id and resolves the payment method by primary key (scoped to the client). Both payment method fields are optional for all statuses. Omitting both means the payment method must be updated later before billing.", "title": "Payment Method Id" }, "pim_client_id": { "description": "The PIM client ID to import the care plan for", "title": "Pim Client Id", "type": "string" }, "pim_patient_id": { "description": "The PIM patient ID to import the care plan for", "title": "Pim Patient Id", "type": "string" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "should_renew": { "description": "Whether the plan should automatically renew at the end of term", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "Start date for the enrollment (YYYY-MM-DD)", "format": "date", "title": "Start Date", "type": "string" }, "status": { "$ref": "#/components/schemas/PatientCarePlanStatus", "description": "The status of the care plan. Must be one of: IMPORTED, ACTIVE, TERMINATED" }, "stripe_payment_method_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional legacy Stripe payment method ID to use for billing. payment_method_id takes precedence when both fields are provided. Both payment method fields are optional for all statuses. Omitting both means the payment method must be updated later before billing.", "title": "Stripe Payment Method Id" } }, "required": [ "clinic_id", "pim_patient_id", "pim_client_id", "care_plan_id", "start_date", "end_date", "plan_cost", "enrollment_fee", "is_billed_monthly", "should_renew", "status", "amount_paid", "care_benefits" ], "title": "ExternalLegacyPatientCarePlanImportSchema", "type": "object" }, "ExternalMedicalRecordSchema": { "description": "A medical record represents a veterinary visit or consultation. It contains SOAP notes (Subjective, Objective, Assessment, Plan) and is associated with assessments, treatments, and other medical data.", "properties": { "appointment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the appointment associated with this medical record, if any.", "title": "Appointment Id" }, "assessment_ids": { "default": [], "description": "List of assessment IDs associated with this medical record.", "items": { "type": "integer" }, "title": "Assessment Ids", "type": "array" }, "clinic_client_id": { "description": "The ID of the client this medical record belongs to.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this medical record belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the patient this medical record belongs to.", "title": "Clinic Patient Id", "type": "integer" }, "date_posted": { "description": "The date this medical record was posted.", "format": "date-time", "title": "Date Posted", "type": "string" }, "finalized_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this medical record was finalized, if applicable.", "title": "Finalized At" }, "followup_appointment_ids": { "default": [], "description": "List of followup appointment IDs associated with this medical record.", "items": { "type": "integer" }, "title": "Followup Appointment Ids", "type": "array" }, "id": { "description": "The unique identifier for the medical record.", "title": "Id", "type": "integer" }, "invoice_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the invoice associated with this medical record, if any.", "title": "Invoice Id" }, "objective": { "default": [], "description": "Objective SOAP notes extracted as a list of strings.", "items": { "type": "string" }, "title": "Objective", "type": "array" }, "plan": { "default": [], "description": "Plan SOAP notes extracted as a list of strings.", "items": { "type": "string" }, "title": "Plan", "type": "array" }, "subjective": { "default": [], "description": "Subjective SOAP notes extracted as a list of strings.", "items": { "type": "string" }, "title": "Subjective", "type": "array" } }, "required": [ "id", "clinic_patient_id", "clinic_client_id", "clinic_id", "appointment_id", "invoice_id", "date_posted", "finalized_at" ], "title": "Medical Record", "type": "object" }, "ExternalOnboardingEventSchema": { "properties": { "created": { "description": "Timestamp when the event was created", "format": "date-time", "title": "Created", "type": "string" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingEventKind" }, { "const": "", "type": "string" } ], "description": "Type of onboarding event", "title": "Kind" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Additional notes about the event", "title": "Note" } }, "required": [ "kind", "created" ], "title": "ExternalOnboardingEventSchema", "type": "object" }, "ExternalOrderAnalyticsSchema": { "properties": { "cart_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cart ID used to generate the order", "title": "Cart Id" }, "charge_capture_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Date when the payment charge was captured", "title": "Charge Capture Date" }, "client_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Note from the client", "title": "Client Note" }, "client_service_fee": { "description": "This fee is configured by your clinic and can cover additional expenses such as order processing, administrative support, or compliance costs. Often referred to as 'Service Fees' in your storefront.", "title": "Client Service Fee", "type": "number" }, "client_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The classification of the client (e.g. first-time, returning)", "title": "Client Type" }, "clinic_client_id": { "description": "ID of the client that placed the order", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "ID of the clinic that received the order", "title": "Clinic Id", "type": "integer" }, "clinic_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Note from the clinic", "title": "Clinic Note" }, "creator_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "How the order was created (e.g. client, clinic)", "title": "Creator Type" }, "discount": { "description": "Total discount applied", "title": "Discount", "type": "number" }, "display_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "User-facing display number", "title": "Display Number" }, "handling_fee": { "description": "Handling fee applied to the order", "title": "Handling Fee", "type": "number" }, "id": { "description": "Unique ID of the order", "title": "Id", "type": "integer" }, "is_urgent": { "description": "Whether this order was marked as urgent", "title": "Is Urgent", "type": "boolean" }, "last_modified": { "description": "Alias for the most recent update time", "format": "date-time", "title": "Last Modified", "type": "string" }, "order_item_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "List of order items included in this order", "title": "Order Item Ids" }, "order_placed_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Datetime when the order was placed", "title": "Order Placed Datetime" }, "payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the payment method used for this order", "title": "Payment Method Id" }, "refund_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "List of refund records associated with this order", "title": "Refund Ids" }, "shipping": { "description": "Shipping amount paid by the client on the order", "title": "Shipping", "type": "number" }, "shipping_address": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAddressSchema" }, { "type": "null" } ], "description": "Shipping address for the order" }, "status": { "description": "Internal status code for the order", "title": "Status", "type": "string" }, "status_display": { "description": "Human-readable status for the order", "title": "Status Display", "type": "string" }, "subtotal": { "description": "Subtotal amount in dollars", "title": "Subtotal", "type": "number" }, "tax": { "description": "Tax amount", "title": "Tax", "type": "number" }, "total": { "description": "Total amount charged including fees and tax", "title": "Total", "type": "number" }, "transfer_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "List of transfer records associated with this order", "title": "Transfer Ids" }, "urgency_fee": { "description": "Urgency fee amount", "title": "Urgency Fee", "type": "number" }, "wholesale_tax": { "description": "Amount paid by clinic in wholesale tax upon item sale to the clinic", "title": "Wholesale Tax", "type": "number" } }, "required": [ "id", "last_modified", "clinic_id", "clinic_client_id", "subtotal", "total", "tax", "shipping", "handling_fee", "discount", "status", "status_display", "is_urgent", "urgency_fee", "wholesale_tax", "client_service_fee" ], "title": "Order", "type": "object" }, "ExternalOrderAnalyticsSortOptions": { "enum": [ "ORDER_PLACED_TIME_ASC", "ORDER_PLACED_TIME_DESC", "ORDER_PLACED_TIME_ASC_V2", "ORDER_PLACED_TIME_DESC_V2", "MODIFIED_ASC", "MODIFIED_DESC" ], "title": "ExternalOrderAnalyticsSortOptions", "type": "string" }, "ExternalOrderItemRevenuePayoutSchema": { "properties": { "created": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Date the payout was created.", "title": "Created" }, "stripe_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stripe ID for the payout.", "title": "Stripe Id" } }, "required": [ "stripe_id", "created" ], "title": "ExternalOrderItemRevenuePayoutSchema", "type": "object" }, "ExternalOrderItemSchema": { "properties": { "authorizing_vet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of prescribing vet", "title": "Authorizing Vet" }, "authorizing_vet_doctor_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the prescribing vet (Doctor). Use with the Doctors endpoint to look up full doctor details and disambiguate vets who share the same name.", "title": "Authorizing Vet Doctor Id" }, "client_price": { "description": "Subtotal charged to the client for this item, in cents.", "title": "Client Price", "type": "integer" }, "client_service_fee": { "description": "This fee is configured by your clinic and can cover additional expenses such as order processing, administrative support, or compliance costs. Often referred to as 'Service Fees' in your storefront.", "title": "Client Service Fee", "type": "integer" }, "clinic_discounts": { "default": 0, "description": "Incentive-based clinic discount", "title": "Clinic Discounts", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "credit_card_processing_fee": { "description": "Credit card processing fee in cents", "title": "Credit Card Processing Fee", "type": "integer" }, "current_chewy_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The current price of this item on chewy.com, in cents. Used for price comparison.", "title": "Current Chewy Price" }, "delivered_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Delivery date of the order item", "title": "Delivered Date" }, "diet_fulfillment_fee": { "description": "Amortized diet fulfillment fee paid to vendor", "title": "Diet Fulfillment Fee", "type": "integer" }, "dvm_authorization_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Date DVM authorized the prescription", "title": "Dvm Authorization Date" }, "gl_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Associated GL codes", "title": "Gl Codes" }, "handling_fee": { "description": "Handling fees your clinic charged for compounded medications", "title": "Handling Fee", "type": "integer" }, "id": { "description": "Unique identifier for the order item.", "title": "Id", "type": "integer" }, "is_pickup": { "description": "Indicates if this is a pickup item", "title": "Is Pickup", "type": "boolean" }, "is_subscription": { "description": "Whether the item is part of a subscription", "title": "Is Subscription", "type": "boolean" }, "item_id": { "description": "ID of the catalog item that was ordered.", "title": "Item Id", "type": "integer" }, "loyalty_savings": { "description": "Loyalty program discount on clinic's COGS in cents", "title": "Loyalty Savings", "type": "integer" }, "margin": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "Profit margin as a percentage. Margin = Net Profit / Revenue. Revenue includes product revenue, client-paid shipping fees, and client-paid handling fees. Null when profit is unavailable or revenue is zero.", "title": "Margin" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "net_payout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Total amount paid out to clinic", "title": "Net Payout" }, "note_to_client": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Client-facing note entered by the clinic for this item.", "title": "Note To Client" }, "order_processing_fee": { "description": "Vetcove service fee in cents", "title": "Order Processing Fee", "type": "integer" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the clinic patient this order item is for.", "title": "Patient Id" }, "pharmacy_fulfillment_fee": { "description": "Pharmacy fulfillment fee in cents", "title": "Pharmacy Fulfillment Fee", "type": "integer" }, "prescription_history_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the individual prescription history entry associated with this order item.", "title": "Prescription History Id" }, "prescription_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the prescription record associated with this item and patient, reflecting the latest prescription details.", "title": "Prescription Id" }, "profit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Clinic profit for this item, in cents. Profit = Revenue - Costs. Zero when canceled.", "title": "Profit" }, "quantity": { "description": "The quantity of the item ordered.", "title": "Quantity", "type": "integer" }, "rebate_discounts": { "default": 0, "description": "Promotions funded by Vetcove or manufacturers; decreases client price but does not impact clinic profits", "title": "Rebate Discounts", "type": "integer" }, "refunded_amount": { "description": "Total amortized refund amount, including non-clinic sponsored refunds", "title": "Refunded Amount", "type": "integer" }, "revenue": { "description": "Clinic revenue for this item, in cents, including wholesale tax. Zero when the item is canceled.", "title": "Revenue", "type": "integer" }, "ship_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Date the item was shipped", "title": "Ship Date" }, "shipping": { "description": "Amortized shipping amount paid by the client on the order item", "title": "Shipping", "type": "integer" }, "sponsored_refund_amount": { "description": "Amortized refund amount sponsored by clinics", "title": "Sponsored Refund Amount", "type": "integer" }, "status": { "$ref": "#/components/schemas/OrderItemStatus", "description": "Status of the order item" }, "stripe_payouts": { "description": "Sorted Stripe payouts", "items": { "$ref": "#/components/schemas/ExternalOrderItemRevenuePayoutSchema" }, "title": "Stripe Payouts", "type": "array" }, "unit_price": { "description": "The unit price of the item, in cents.", "title": "Unit Price", "type": "integer" }, "urgency_fee": { "default": 0, "description": "Not applicable to home delivery orders; only pertains to buy online, pickup in clinic orders", "title": "Urgency Fee", "type": "integer" }, "vc_marketplace_facilitator_tax": { "description": "Tax charged to client on total order; this is collected and remitted by Vetcove", "title": "Vc Marketplace Facilitator Tax", "type": "integer" }, "vendor_fees": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Fees charged by the vendor for this item, in cents. Zero when the item is canceled.", "title": "Vendor Fees" }, "vendor_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vendor name", "title": "Vendor Name" }, "vendor_shipping": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Shipping cost paid to the vendor for this item, in cents. Zero when the item is canceled.", "title": "Vendor Shipping" }, "vendor_subtotal": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Subtotal charged by the vendor for this item, in cents. Zero when the item is canceled.", "title": "Vendor Subtotal" }, "wholesale_tax": { "description": "Amortized amount paid by clinic in wholesale tax upon item sale to the clinic", "title": "Wholesale Tax", "type": "integer" } }, "required": [ "created", "modified", "id", "item_id", "quantity", "unit_price", "handling_fee", "status", "is_subscription", "is_pickup", "patient_id", "client_price", "revenue", "ship_date", "vc_marketplace_facilitator_tax", "diet_fulfillment_fee", "refunded_amount", "stripe_payouts", "delivered_date", "credit_card_processing_fee", "order_processing_fee", "sponsored_refund_amount", "loyalty_savings", "pharmacy_fulfillment_fee", "wholesale_tax", "shipping", "client_service_fee", "note_to_client" ], "title": "External Order Item", "type": "object" }, "ExternalOrganizationClientDetailSchema": { "properties": { "clinic_clients": { "$ref": "#/components/schemas/ExternalClinicClientSchemaList", "description": "A list of all clinic clients that are associated with this organization client." }, "primary_clinic_id": { "description": "The ID of the primary clinic that this organization client is associated with.", "title": "Primary Clinic Id", "type": "integer" } }, "required": [ "primary_clinic_id", "clinic_clients" ], "title": "ExternalOrganizationClientDetailSchema", "type": "object" }, "ExternalOrganizationPatientDetailSchema": { "properties": { "clinic_patients": { "description": "A list of all clinic patients that are associated with this organization patient.", "items": { "$ref": "#/components/schemas/ClinicPatientForOrganizationPatientListSchemaList" }, "title": "Clinic Patients", "type": "array" }, "primary_clinic_id": { "description": "The ID of the primary clinic that this organization patient is associated with.", "title": "Primary Clinic Id", "type": "integer" } }, "required": [ "primary_clinic_id", "clinic_patients" ], "title": "ExternalOrganizationPatientDetailSchema", "type": "object" }, "ExternalPDFInvoiceSchema": { "description": "Schema for generating an invoice PDF", "properties": { "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the patient to generate the PDF for, leave blank to include all patients", "title": "Clinic Patient Id" }, "include_discharge_notes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Whether to include discharge notes", "title": "Include Discharge Notes" }, "include_upcoming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "description": "Whether to include upcoming invoices", "title": "Include Upcoming" }, "invoice_id": { "description": "The ID of the invoice to generate the PDF for", "title": "Invoice Id", "type": "integer" }, "kind": { "const": "INVOICE", "description": "The kind of PDF to generate", "title": "Kind", "type": "string" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated: Use clinic_patient_id instead.", "title": "Patient Id" } }, "required": [ "kind", "invoice_id" ], "title": "ExternalPDFInvoiceSchema", "type": "object" }, "ExternalPDFPatientTimelineSchema": { "description": "Schema for generating a patient timeline PDF", "properties": { "clinic_patient_id": { "description": "The ID of the patient to generate the timeline PDF for", "title": "Clinic Patient Id", "type": "integer" }, "end_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Optional end date to filter timeline entries", "title": "End Date" }, "include_alerts": { "default": false, "description": "Whether to include patient alerts and alert tags on the PDF", "title": "Include Alerts", "type": "boolean" }, "kind": { "const": "PATIENT_TIMELINE", "description": "The kind of PDF to generate", "title": "Kind", "type": "string" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Optional start date to filter timeline entries", "title": "Start Date" } }, "required": [ "kind", "clinic_patient_id" ], "title": "ExternalPDFPatientTimelineSchema", "type": "object" }, "ExternalPDFRabiesCertificateSchema": { "description": "Schema for generating a rabies certificate PDF", "properties": { "historical_treatment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the historical rabies vaccine treatment to generate the PDF for", "title": "Historical Treatment Id" }, "kind": { "const": "RABIES_CERTIFICATE", "description": "The kind of PDF to generate", "title": "Kind", "type": "string" }, "treatment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the rabies vaccine treatment to generate the PDF for", "title": "Treatment Id" } }, "required": [ "kind" ], "title": "ExternalPDFRabiesCertificateSchema", "type": "object" }, "ExternalPDFSchema": { "description": "Schema for the PDF detail view", "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An error message if the PDF generation failed. Null on success.", "title": "Error" }, "file_name": { "description": "The filename of the generated PDF document.", "title": "File Name", "type": "string" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A pre-signed URL to download the generated PDF. Null if the PDF is still being generated or generation failed.", "title": "File Url" }, "key": { "description": "The unique key used to identify and retrieve this generated PDF.", "title": "Key", "type": "string" }, "name": { "description": "A human-readable name describing the type of PDF that was generated.", "title": "Name", "type": "string" }, "status": { "$ref": "#/components/schemas/APIConnectFileStatus", "description": "The current generation status of the PDF." } }, "required": [ "key", "name", "status", "file_name", "file_url", "error" ], "title": "ExternalPDFSchema", "type": "object" }, "ExternalPatientBreedSchema": { "properties": { "display": { "description": "The display name of the breed.", "title": "Display", "type": "string" }, "name": { "description": "The name of the breed.", "title": "Name", "type": "string" }, "patient_kind": { "$ref": "#/components/schemas/PatientKind", "description": "The kind of the patient this breed is applicable to." } }, "required": [ "name", "display", "patient_kind" ], "title": "ExternalPatientBreedSchema", "type": "object" }, "ExternalPatientBreedSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPatientBreedSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPatientBreedSchemaList", "type": "object" }, "ExternalPatientCarePlanCreateSchema": { "description": "Schema for creating a patient care plan via the external API.", "properties": { "add_on_care_plan_ids": { "description": "Optional list of add-on Care Plan IDs to enroll alongside the core plan", "items": { "type": "integer" }, "title": "Add On Care Plan Ids", "type": "array" }, "clinic_client_id": { "description": "The clinic client ID who will be billed for these care plans", "title": "Clinic Client Id", "type": "integer" }, "clinic_patient_id": { "description": "The clinic patient ID to enroll into care plans", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "description": "The core Care Plan ID to enroll the patient into", "title": "Core Plan Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether billing is monthly (True) or upfront (False)", "title": "Is Billed Monthly", "type": "boolean" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional next core Care Plan ID for automatic renewal", "title": "Next Plan Id" }, "should_renew": { "description": "Whether the plan should automatically renew at the end of term", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "Start date for the enrollment", "format": "date", "title": "Start Date", "type": "string" } }, "required": [ "clinic_patient_id", "clinic_client_id", "core_plan_id", "start_date", "is_billed_monthly", "should_renew" ], "title": "ExternalPatientCarePlanCreateSchema", "type": "object" }, "ExternalPatientCarePlanDetailSchema": { "description": "", "properties": { "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "care_plan_kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan_name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan Name", "type": "string" }, "clinic_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "invoice_history": { "description": "The history of invoices for this patient care plan", "items": { "$ref": "#/components/schemas/ExternalPatientCarePlanInvoiceHistorySchema" }, "title": "Invoice History", "type": "array" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "clinic_id", "clinic_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan_name", "care_plan_kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "payment_method_id", "invoice_history" ], "title": "ExternalPatientCarePlanDetailSchema", "type": "object" }, "ExternalPatientCarePlanInvoiceHistorySchema": { "properties": { "billing_status": { "$ref": "#/components/schemas/ClientInvoiceBillingStatus", "description": "The billing status of the invoice" }, "invoice_id": { "description": "The ID of the invoice", "title": "Invoice Id", "type": "integer" }, "invoice_items": { "description": "The care plan invoice items in the invoice", "items": { "$ref": "#/components/schemas/ExternalPatientCarePlanInvoiceItemSchema" }, "title": "Invoice Items", "type": "array" } }, "required": [ "invoice_id", "billing_status", "invoice_items" ], "title": "ExternalPatientCarePlanInvoiceHistorySchema", "type": "object" }, "ExternalPatientCarePlanInvoiceItemSchema": { "properties": { "amount": { "description": "The amount of the invoice item", "title": "Amount", "type": "integer" }, "invoice_item_id": { "description": "The ID of the invoice item", "title": "Invoice Item Id", "type": "integer" }, "kind": { "$ref": "#/components/schemas/CarePatientInvoiceItemKind", "description": "The kind of the invoice item" } }, "required": [ "invoice_item_id", "kind", "amount" ], "title": "ExternalPatientCarePlanInvoiceItemSchema", "type": "object" }, "ExternalPatientCarePlanSchema": { "properties": { "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "care_plan_kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan_name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan Name", "type": "string" }, "clinic_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "clinic_id", "clinic_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan_name", "care_plan_kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "payment_method_id" ], "title": "ExternalPatientCarePlanSchema", "type": "object" }, "ExternalPatientCarePlanSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPatientCarePlanSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPatientCarePlanSchemaList", "type": "object" }, "ExternalPatientCarePlanWithAddOnPlansSchema": { "properties": { "add_on_plans": { "description": "Add-on patient care plans created alongside the core plan", "items": { "$ref": "#/components/schemas/ExternalPatientCarePlanSchema" }, "title": "Add On Plans", "type": "array" }, "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "care_plan_kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan_name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan Name", "type": "string" }, "clinic_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "invoice_id": { "description": "The ID of the invoice created for the care plan enrollment", "title": "Invoice Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "clinic_id", "clinic_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan_name", "care_plan_kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "payment_method_id", "add_on_plans", "invoice_id" ], "title": "ExternalPatientCarePlanWithAddOnPlansSchema", "type": "object" }, "ExternalPatientClientRelationshipCreateSchema": { "properties": { "clinic_client_id": { "description": "The ID of the clinic client.", "title": "Clinic Client Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient.", "title": "Clinic Patient Id", "type": "integer" }, "relationship_kind": { "allOf": [ { "$ref": "#/components/schemas/PatientClientRelationshipKind" } ], "default": "OWNER", "description": "The kind of relationship. Defaults to OWNER." } }, "required": [ "clinic_client_id", "clinic_patient_id" ], "title": "ExternalPatientClientRelationshipCreateSchema", "type": "object" }, "ExternalPatientClientRelationshipPatientViewSchema": { "properties": { "clinic_client_id": { "description": "The ID of the clinic client associated with this clinic patient.", "title": "Clinic Client Id", "type": "integer" }, "is_active": { "description": "Whether the clinic patient is currently associated with this clinic client.", "title": "Is Active", "type": "boolean" } }, "required": [ "clinic_client_id", "is_active" ], "title": "ExternalPatientClientRelationshipPatientViewSchema", "type": "object" }, "ExternalPatientClientRelationshipSchema": { "description": "A relationship between a clinic client (pet owner) and a clinic patient (pet).", "properties": { "clinic_client_id": { "description": "The ID of the clinic client in this relationship.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this relationship belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient in this relationship.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "title": "Id", "type": "integer" }, "is_active": { "description": "Whether this relationship is currently active.", "title": "Is Active", "type": "boolean" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "relationship_kind": { "$ref": "#/components/schemas/PatientClientRelationshipKind" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_client_id", "clinic_patient_id", "relationship_kind", "is_active", "clinic_id" ], "title": "PatientClientRelationship", "type": "object" }, "ExternalPatientCustomCareReminderSchema": { "properties": { "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The due date of the patient care reminder.", "title": "Due Date" }, "id": { "description": "The ID of the this patient care reminder.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_past_due": { "description": "Whether the patient standard care is past due.", "title": "Is Past Due", "type": "boolean" }, "kind": { "const": "CUSTOM", "default": "CUSTOM", "description": "The type of patient care reminder.", "title": "Kind", "type": "string" }, "last_fulfilled_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date the patient care reminder was last fulfilled.", "title": "Last Fulfilled Date" }, "name": { "description": "The name of the patient care reminder.", "title": "Name", "type": "string" }, "organization_patient_id": { "description": "The organization patient ID this custom reminder is for.", "title": "Organization Patient Id", "type": "integer" }, "patient_standard_care_id": { "description": "The ID of the patient standard care which this patient care reminder is associated with.", "title": "Patient Standard Care Id", "type": "integer" }, "standard_care_reminder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the standard care reminder which this patient care reminder is associated with. Only patient care reminders with kind `STANDARD` will be associated with a standard care reminder.", "title": "Standard Care Reminder Id" }, "status": { "$ref": "#/components/schemas/PatientOneOffReminderStatus", "description": "The status of the patient care reminder." } }, "required": [ "is_deleted", "deleted", "id", "status", "name", "organization_patient_id", "last_fulfilled_date", "due_date", "is_past_due", "patient_standard_care_id" ], "title": "ExternalPatientCustomCareReminderSchema", "type": "object" }, "ExternalPatientCustomCareReminderSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPatientCustomCareReminderSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPatientCustomCareReminderSchemaList", "type": "object" }, "ExternalPatientLabDetailSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic the patient lab belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the patient the patient lab belongs to.", "title": "Clinic Patient Id", "type": "integer" }, "code": { "description": "The lab panel code (e.g., test code from the lab provider). Empty string if no code is available.", "title": "Code", "type": "string" }, "collected_at": { "description": "The date and time the lab was collected.", "format": "date-time", "title": "Collected At", "type": "string" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "description": "The ID of the patient lab.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_pending": { "description": "Whether the patient lab results are still pending.", "title": "Is Pending", "type": "boolean" }, "lab_provider_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the lab provider who provided this lab. Only available for integrated labs.", "title": "Lab Provider Name" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The display name of the patient lab.", "title": "Name", "type": "string" }, "ordering_clinic_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic user who ordered this lab, if available.", "title": "Ordering Clinic User Id" }, "ordering_clinic_user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the clinic user who ordered this lab, if available.", "title": "Ordering Clinic User Name" }, "results": { "description": "The structured results of the patient lab test.", "items": { "$ref": "#/components/schemas/ExternalLabResultSchema" }, "title": "Results", "type": "array" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time the lab was completed.", "title": "Reviewed At" }, "status": { "$ref": "#/components/schemas/LabOrderDashboardStatus", "description": "The status of the patient lab." }, "type": { "$ref": "#/components/schemas/PatientLabType", "description": "The type of patient lab. IN_CLINIC and EXTERNAL are ordered labs." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "clinic_patient_id", "name", "code", "type", "status", "is_pending", "collected_at", "results" ], "title": "ExternalPatientLabDetailSchema", "type": "object" }, "ExternalPatientLabListItemSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic the patient lab belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the patient the patient lab belongs to.", "title": "Clinic Patient Id", "type": "integer" }, "code": { "description": "The lab panel code (e.g., test code from the lab provider). Empty string if no code is available.", "title": "Code", "type": "string" }, "collected_at": { "description": "The date and time the lab was collected.", "format": "date-time", "title": "Collected At", "type": "string" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "id": { "description": "The ID of the patient lab.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_pending": { "description": "Whether the patient lab results are still pending.", "title": "Is Pending", "type": "boolean" }, "lab_provider_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the lab provider who provided this lab. Only available for integrated labs.", "title": "Lab Provider Name" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The display name of the patient lab.", "title": "Name", "type": "string" }, "ordering_clinic_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic user who ordered this lab, if available.", "title": "Ordering Clinic User Id" }, "ordering_clinic_user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The display name of the clinic user who ordered this lab, if available.", "title": "Ordering Clinic User Name" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ExternalLabResultSchema" }, "type": "array" }, { "type": "null" } ], "description": "The structured results of the patient lab test. Only included when include_results=true is passed as a query parameter.", "title": "Results" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time the lab was completed.", "title": "Reviewed At" }, "status": { "$ref": "#/components/schemas/LabOrderDashboardStatus", "description": "The status of the patient lab." }, "type": { "$ref": "#/components/schemas/PatientLabType", "description": "The type of patient lab. IN_CLINIC and EXTERNAL are ordered labs." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "clinic_patient_id", "name", "code", "type", "status", "is_pending", "collected_at" ], "title": "ExternalPatientLabListItemSchema", "type": "object" }, "ExternalPatientLabListItemSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPatientLabListItemSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPatientLabListItemSchemaList", "type": "object" }, "ExternalPatientNoteCreateSchema": { "properties": { "clinic_patient_id": { "description": "The ID of the clinic patient this note is associated with", "title": "Clinic Patient Id", "type": "integer" }, "created_by_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the user who created this note", "title": "Created By Id" }, "is_internal": { "default": true, "description": "Whether this note is internal or visible to clients", "title": "Is Internal", "type": "boolean" }, "kind": { "$ref": "#/components/schemas/ExternalPatientNoteKindForCreate", "description": "The kind of patient note. Documentation notes are not supported via external API." }, "note": { "description": "The note content as plain text", "title": "Note", "type": "string" } }, "required": [ "clinic_patient_id", "kind", "note" ], "title": "ExternalPatientNoteCreateSchema", "type": "object" }, "ExternalPatientNoteDetailSchema": { "description": "Patient notes are used to record information about a patient that should appear on their timeline. Notes can be of different kinds (general, communication, documentation) and can be marked as internal (visible only to clinic staff) or external (visible to clients as well).", "properties": { "clinic_patient_id": { "description": "The ID of the clinic patient this note is associated with", "title": "Clinic Patient Id", "type": "integer" }, "created_by_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full name of the user who created this note", "title": "Created By Name" }, "date": { "description": "The date and time when the note was created", "format": "date-time", "title": "Date", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "details": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Additional details about the note in JSON format", "title": "Details" }, "id": { "description": "The unique identifier for the patient note", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_internal": { "description": "Whether this note is internal or visible to clients", "title": "Is Internal", "type": "boolean" }, "is_locked": { "description": "Whether this note is locked and cannot be modified", "title": "Is Locked", "type": "boolean" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/PatientNoteKind" }, { "const": "", "type": "string" } ], "description": "The kind of patient note", "title": "Kind" } }, "required": [ "is_deleted", "deleted", "id", "clinic_patient_id", "kind", "is_internal", "is_locked", "details", "date" ], "title": "ExternalPatientNoteDetailSchema", "type": "object" }, "ExternalPatientNoteKindForCreate": { "enum": [ "GENERAL", "COMMUNICATION" ], "title": "ExternalPatientNoteKindForCreate", "type": "string" }, "ExternalPatientNoteSchema": { "properties": { "clinic_patient_id": { "description": "The ID of the clinic patient this note is associated with", "title": "Clinic Patient Id", "type": "integer" }, "created_by_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full name of the user who created this note", "title": "Created By Name" }, "date": { "description": "The date and time when the note was created", "format": "date-time", "title": "Date", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "details": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Additional details about the note in JSON format", "title": "Details" }, "id": { "description": "The unique identifier for the patient note", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_internal": { "description": "Whether this note is internal or visible to clients", "title": "Is Internal", "type": "boolean" }, "is_locked": { "description": "Whether this note is locked and cannot be modified", "title": "Is Locked", "type": "boolean" }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/PatientNoteKind" }, { "const": "", "type": "string" } ], "description": "The kind of patient note", "title": "Kind" } }, "required": [ "is_deleted", "deleted", "id", "clinic_patient_id", "kind", "is_internal", "is_locked", "details", "date" ], "title": "ExternalPatientNoteSchema", "type": "object" }, "ExternalPatientNoteSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPatientNoteSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPatientNoteSchemaList", "type": "object" }, "ExternalPatientStandardCareReminderSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic associated with this reminder's patient.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The due date of the patient care reminder.", "title": "Due Date" }, "id": { "description": "The ID of the this patient care reminder.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_past_due": { "description": "Whether the patient standard care is past due.", "title": "Is Past Due", "type": "boolean" }, "kind": { "const": "STANDARD", "default": "STANDARD", "description": "The type of patient care reminder.", "title": "Kind", "type": "string" }, "last_fulfilled_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date the patient care reminder was last fulfilled.", "title": "Last Fulfilled Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "The name of the patient care reminder.", "title": "Name", "type": "string" }, "organization_client_id": { "description": "The organization client ID of the client who owns the patient this reminder is for.", "title": "Organization Client Id", "type": "integer" }, "organization_patient_id": { "description": "The organization patient ID this standard reminder is for.", "title": "Organization Patient Id", "type": "integer" }, "patient_standard_care_id": { "description": "The ID of the patient standard care which this patient care reminder is associated with.", "title": "Patient Standard Care Id", "type": "integer" }, "standard_care_reminder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the standard care reminder which this patient care reminder is associated with. Only patient care reminders with kind `STANDARD` will be associated with a standard care reminder.", "title": "Standard Care Reminder Id" }, "status": { "$ref": "#/components/schemas/PatientStandardCareReminderStatus", "description": "The status of the patient care reminder." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "status", "name", "organization_patient_id", "organization_client_id", "clinic_id", "last_fulfilled_date", "due_date", "is_past_due", "patient_standard_care_id", "standard_care_reminder_id" ], "title": "ExternalPatientStandardCareReminderSchema", "type": "object" }, "ExternalPatientStandardCareReminderSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPatientStandardCareReminderSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPatientStandardCareReminderSchemaList", "type": "object" }, "ExternalPaymentDetailSchema": { "description": "A payment represents a payment made by a clinic client (pet parent). Payments can be made via credit card, cash, check, client credit, or other external payment methods. Each payment records the amount, type, and current status of the transaction.", "properties": { "amount": { "description": "The payment amount in cents.", "title": "Amount", "type": "integer" }, "clinic_client_id": { "description": "The ID of the clinic client who made this payment.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic associated with this payment.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "currency": { "$ref": "#/components/schemas/Currency", "description": "The currency of this payment." }, "id": { "description": "The unique identifier for the payment.", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "payment_link_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment link used for this payment, if any.", "title": "Payment Link Id" }, "payment_type": { "$ref": "#/components/schemas/PaymentType", "description": "The method used to make this payment." }, "recorded_at": { "description": "When this payment was officially recorded.", "format": "date-time", "title": "Recorded At", "type": "string" }, "status": { "$ref": "#/components/schemas/ClientPaymentStatus", "description": "The current status of this payment." }, "void_reason": { "description": "The reason this payment was voided, if applicable.", "title": "Void Reason", "type": "string" }, "voided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this payment was voided, if applicable.", "title": "Voided At" } }, "required": [ "created", "modified", "id", "clinic_client_id", "clinic_id", "amount", "status", "payment_type", "recorded_at", "currency", "voided_at", "void_reason", "payment_link_id" ], "title": "PaymentDetail", "type": "object" }, "ExternalPaymentLinkCreateErrorSchema": { "properties": { "error": { "description": "Details for why this operation could not be completed", "title": "Error", "type": "string" } }, "required": [ "error" ], "title": "ExternalPaymentLinkCreateErrorSchema", "type": "object" }, "ExternalPaymentLinkCreateSchema": { "description": "Fields required to create a PaymentLink", "properties": { "callback_urls": { "anyOf": [ { "$ref": "#/components/schemas/PaymentLinkCallbackUrlsSchema" }, { "type": "null" } ], "description": "Callback URLs for redirecting after payment completion or cancellation." }, "clinic_client_id": { "description": "The ID of the client this payment link is for.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this payment link is for.", "title": "Clinic Id", "type": "integer" }, "connect_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "Metadata to be set by the client on the payment link.", "title": "Connect Metadata" }, "custom_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional plain-text message for the payment link (max 500 characters). Send a string only \u2014 rich-text JSON is not accepted. The value is stored internally as rich text.", "title": "Custom Text" }, "entity_ids": { "description": "IDs of entities to be paid based on the payment link kind: for INVOICE kind, provide one or more Invoice IDs (e.g., [123, 456]); for CARE_PLAN_PAYMENT_METHOD_UPDATE kind, provide exactly one Patient Care Plan ID (e.g., [456]).", "items": { "type": "integer" }, "title": "Entity Ids", "type": "array" }, "kind": { "$ref": "#/components/schemas/SupportedPaymentLinkKind", "description": "The kind of entity to be included in this payment link." } }, "required": [ "clinic_id", "entity_ids", "kind", "clinic_client_id" ], "title": "ExternalPaymentLinkCreateSchema", "type": "object" }, "ExternalPaymentLinkDetailSchema": { "description": "Additional fields for list/detail views", "properties": { "callback_urls": { "anyOf": [ { "$ref": "#/components/schemas/PaymentLinkCallbackUrlsSchema" }, { "type": "null" } ], "description": "Callback URLs for redirecting after payment completion or cancellation." }, "client_payment_ids": { "default": [], "description": "The ID's of the client payments associated with this payment link, if any payments have been made.", "items": { "type": "integer" }, "title": "Client Payment Ids", "type": "array" }, "clinic_client_id": { "description": "The ID of the client this payment link is for.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this payment link is for.", "title": "Clinic Id", "type": "integer" }, "connect_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "Metadata to be set by the client on the payment link.", "title": "Connect Metadata" }, "custom_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional plain-text message for the payment link. Notes written in the clinic app as rich text are flattened here; formatting and paragraph breaks are not preserved.", "title": "Custom Text" }, "entity_ids": { "description": "IDs of entities to be paid based on the payment link kind: for INVOICE kind, provide one or more Invoice IDs (e.g., [123, 456]); for CARE_PLAN_PAYMENT_METHOD_UPDATE kind, provide exactly one Patient Care Plan ID (e.g., [456]).", "items": { "type": "integer" }, "title": "Entity Ids", "type": "array" }, "expires_on": { "description": "The timestamp at which this payment link will expire.", "format": "date-time", "title": "Expires On", "type": "string" }, "id": { "description": "The unique identifier for the payment link.", "title": "Id", "type": "integer" }, "is_deleted": { "default": false, "description": "Whether this payment link has been deleted.", "title": "Is Deleted", "type": "boolean" }, "is_expired": { "description": "Whether this payment link has expired.", "title": "Is Expired", "type": "boolean" }, "kind": { "$ref": "#/components/schemas/PaymentLinkKind", "description": "The kind of entity to be included in this payment link." }, "url": { "description": "The URL for the payment link.", "title": "Url", "type": "string" } }, "required": [ "clinic_id", "entity_ids", "kind", "id", "clinic_client_id", "expires_on", "is_expired", "url" ], "title": "ExternalPaymentLinkDetailSchema", "type": "object" }, "ExternalPaymentLinkDetailSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPaymentLinkDetailSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPaymentLinkDetailSchemaList", "type": "object" }, "ExternalPaymentLinkUpdateSchema": { "description": "Schema for the PaymentLinksUpdateExternalAPIController request body", "properties": { "callback_urls": { "anyOf": [ { "$ref": "#/components/schemas/PaymentLinkCallbackUrlsSchema" }, { "type": "null" } ], "description": "Callback URLs for redirecting after payment completion or cancellation." }, "connect_metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "description": "Metadata to be set by the client on the payment link.", "title": "Connect Metadata" }, "custom_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional plain-text message for the payment link (max 500 characters). Send a string only \u2014 rich-text JSON is not accepted. The value is stored internally as rich text.", "title": "Custom Text" } }, "title": "ExternalPaymentLinkUpdateSchema", "type": "object" }, "ExternalPaymentMethodDetailSchema": { "description": "A payment method represents a saved card or payment account belonging to a clinic client, used to pay for orders, invoices, and other charges.", "properties": { "brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Brand of the card (e.g., Visa, Mastercard).", "title": "Brand" }, "clinic_client_id": { "description": "The ID of the clinic client this payment method belongs to.", "title": "Clinic Client Id", "type": "integer" }, "expiration_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Card expiration month (1-12).", "title": "Expiration Month" }, "expiration_year": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Card expiration year (4-digit).", "title": "Expiration Year" }, "id": { "description": "The unique identifier for the payment method.", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the payment method is active.", "title": "Is Active", "type": "boolean" }, "is_expired": { "description": "Whether the payment method is expired.", "title": "Is Expired", "type": "boolean" }, "is_klarna": { "description": "Whether the payment method is Klarna.", "title": "Is Klarna", "type": "boolean" }, "last_four": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last four digits of the card.", "title": "Last Four" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name on the card or payment account.", "title": "Name" }, "wallet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Wallet provider (e.g., Apple Pay, Google Pay).", "title": "Wallet" } }, "required": [ "id", "clinic_client_id", "is_active", "is_expired", "last_four", "brand", "is_klarna" ], "title": "PaymentMethodDetail", "type": "object" }, "ExternalPaymentMethodSchema": { "properties": { "brand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Brand of the card (e.g., Visa, Mastercard).", "title": "Brand" }, "clinic_client_id": { "description": "The ID of the clinic client this payment method belongs to.", "title": "Clinic Client Id", "type": "integer" }, "expiration_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Card expiration month (1-12).", "title": "Expiration Month" }, "expiration_year": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Card expiration year (4-digit).", "title": "Expiration Year" }, "id": { "description": "The unique identifier for the payment method.", "title": "Id", "type": "integer" }, "is_active": { "description": "Whether the payment method is active.", "title": "Is Active", "type": "boolean" }, "is_expired": { "description": "Whether the payment method is expired.", "title": "Is Expired", "type": "boolean" }, "is_klarna": { "description": "Whether the payment method is Klarna.", "title": "Is Klarna", "type": "boolean" }, "last_four": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last four digits of the card.", "title": "Last Four" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name on the card or payment account.", "title": "Name" }, "wallet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Wallet provider (e.g., Apple Pay, Google Pay).", "title": "Wallet" } }, "required": [ "id", "clinic_client_id", "is_active", "is_expired", "last_four", "brand", "is_klarna" ], "title": "ExternalPaymentMethodSchema", "type": "object" }, "ExternalPaymentMethodSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPaymentMethodSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPaymentMethodSchemaList", "type": "object" }, "ExternalPaymentSchema": { "properties": { "amount": { "description": "The payment amount in cents.", "title": "Amount", "type": "integer" }, "clinic_client_id": { "description": "The ID of the clinic client who made this payment.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic associated with this payment.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "currency": { "$ref": "#/components/schemas/Currency", "description": "The currency of this payment." }, "id": { "description": "The unique identifier for the payment.", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "payment_link_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment link used for this payment, if any.", "title": "Payment Link Id" }, "payment_type": { "$ref": "#/components/schemas/PaymentType", "description": "The method used to make this payment." }, "recorded_at": { "description": "When this payment was officially recorded.", "format": "date-time", "title": "Recorded At", "type": "string" }, "status": { "$ref": "#/components/schemas/ClientPaymentStatus", "description": "The current status of this payment." }, "void_reason": { "description": "The reason this payment was voided, if applicable.", "title": "Void Reason", "type": "string" }, "voided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this payment was voided, if applicable.", "title": "Voided At" } }, "required": [ "created", "modified", "id", "clinic_client_id", "clinic_id", "amount", "status", "payment_type", "recorded_at", "currency", "voided_at", "void_reason", "payment_link_id" ], "title": "ExternalPaymentSchema", "type": "object" }, "ExternalPaymentSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPaymentSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPaymentSchemaList", "type": "object" }, "ExternalPayoutSchema": { "description": "Schema representing a payout for an organization (external view)", "properties": { "amount": { "description": "Payout amount in cents", "title": "Amount", "type": "integer" }, "amount_display": { "description": "Human-readable payout amount (e.g., $100.00)", "title": "Amount Display", "type": "string" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "currency": { "description": "Currency code for the payout (e.g., USD, CAD)", "title": "Currency", "type": "string" }, "id": { "description": "Unique ID of the payout", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/StripePayoutStatus" }, { "const": "", "type": "string" } ], "description": "Current status of the payout", "title": "Status" }, "stripe_account_id": { "description": "ID of the Stripe account receiving the payout", "title": "Stripe Account Id", "type": "integer" }, "stripe_arrival_date": { "description": "Stripe's estimated/actual arrival date for the funds", "format": "date-time", "title": "Stripe Arrival Date", "type": "string" }, "stripe_created": { "description": "Timestamp when the payout was created in Stripe", "format": "date-time", "title": "Stripe Created", "type": "string" }, "stripe_id": { "description": "Stripe ID for this payout", "title": "Stripe Id", "type": "string" }, "stripe_trace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trace ID of the payout (useful for bank statement reconciliation)", "title": "Stripe Trace Id" } }, "required": [ "created", "modified", "id", "amount", "amount_display", "status", "stripe_id", "stripe_account_id", "stripe_created", "stripe_arrival_date", "stripe_trace_id", "currency" ], "title": "ExternalPayoutSchema", "type": "object" }, "ExternalPayoutSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPayoutSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPayoutSchemaList", "type": "object" }, "ExternalPrescriptionRequestSchema": { "description": "Schema for prescription request details.", "properties": { "clinic_id": { "description": "ID of the clinic this prescription request belongs to", "title": "Clinic Id", "type": "integer" }, "closed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the user who approved or denied the request", "title": "Closed By" }, "conflicting_cart_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of a conflicting cart item, if any", "title": "Conflicting Cart Id" }, "conflicting_order_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of a conflicting order, if any", "title": "Conflicting Order Id" }, "conflicting_order_item_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of a conflicting order item, if any", "title": "Conflicting Order Item Id" }, "conflicting_prescription_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of a conflicting prescription, if any", "title": "Conflicting Prescription Id" }, "etailer_name": { "description": "Name of the etailer that submitted the request", "title": "Etailer Name", "type": "string" }, "etailer_response_reason": { "anyOf": [ { "$ref": "#/components/schemas/PrescriptionRequestEtailerStatusReason" }, { "type": "null" } ], "description": "Reason for the current etailer response status" }, "etailer_response_status": { "$ref": "#/components/schemas/PrescriptionRequestEtailerResponseStatus", "description": "Etailer response status of the prescription request" }, "group_id": { "description": "ID of the prescription request group this request belongs to", "title": "Group Id", "type": "integer" }, "id": { "description": "Unique identifier for the prescription request", "title": "Id", "type": "integer" }, "item_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the associated item", "title": "Item Id" }, "item_name": { "description": "Name of the item", "title": "Item Name", "type": "string" }, "item_qty": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Quantity of the prescription", "title": "Item Qty" }, "last_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Most recent note added to the prescription request", "title": "Last Note" }, "last_note_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Date when the last note was added", "title": "Last Note Datetime" }, "medical_review_status": { "$ref": "#/components/schemas/PrescriptionRequestMedicalReviewStatus", "description": "Medical review status of the prescription request" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the associated patient", "title": "Patient Id" }, "pdf_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to the source PDF document", "title": "Pdf Url" }, "received_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Date when the prescription request was received", "title": "Received Datetime" }, "request_status": { "$ref": "#/components/schemas/PrescriptionRequestStatus", "description": "Current status of the prescription request" }, "status_modified_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Date when the status was last modified", "title": "Status Modified Datetime" } }, "required": [ "id", "group_id", "request_status", "etailer_name", "item_qty", "medical_review_status", "etailer_response_status", "etailer_response_reason", "conflicting_prescription_id", "conflicting_order_item_id", "item_id", "item_name", "patient_id", "clinic_id" ], "title": "ExternalPrescriptionRequestSchema", "type": "object" }, "ExternalPrescriptionRequestSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPrescriptionRequestSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPrescriptionRequestSchemaList", "type": "object" }, "ExternalPricingGroupDetailSchema": { "description": "Detailed information about a pricing group including all configuration options.", "properties": { "auto_enable_compounds": { "description": "Whether to automatically enable compounds.", "title": "Auto Enable Compounds", "type": "boolean" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The unique identifier for the clinic.", "title": "Clinic Id" }, "compound_handling_fixed_fee": { "description": "Fixed fee for compound handling in cents.", "title": "Compound Handling Fixed Fee", "type": "integer" }, "created": { "description": "When this pricing group was created.", "format": "date-time", "title": "Created", "type": "string" }, "free_shipping_over": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Free shipping threshold in cents.", "title": "Free Shipping Over" }, "id": { "description": "The unique identifier for the pricing group.", "title": "Id", "type": "integer" }, "initial_catalog_configured_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the initial catalog was configured.", "title": "Initial Catalog Configured At" }, "minimum_margin_percentage": { "description": "Minimum margin percentage as a decimal string.", "title": "Minimum Margin Percentage", "type": "number" }, "name": { "description": "The name of this pricing group.", "title": "Name", "type": "string" }, "recurring_subscription_discount": { "description": "Recurring subscription discount as a percentage.", "title": "Recurring Subscription Discount", "type": "number" }, "standard_shipping_cost_override": { "description": "Standard shipping cost override in cents.", "title": "Standard Shipping Cost Override", "type": "integer" } }, "required": [ "id", "name", "created", "compound_handling_fixed_fee", "free_shipping_over", "minimum_margin_percentage", "initial_catalog_configured_at", "auto_enable_compounds", "standard_shipping_cost_override", "recurring_subscription_discount" ], "title": "PricingGroupDetail", "type": "object" }, "ExternalPricingGroupListSchema": { "properties": { "auto_enable_compounds": { "description": "Whether to automatically enable compounds.", "title": "Auto Enable Compounds", "type": "boolean" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The unique identifier for the clinic.", "title": "Clinic Id" }, "compound_handling_fixed_fee": { "description": "Fixed fee for compound handling in cents.", "title": "Compound Handling Fixed Fee", "type": "integer" }, "created": { "description": "When this pricing group was created.", "format": "date-time", "title": "Created", "type": "string" }, "free_shipping_over": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Free shipping threshold in cents.", "title": "Free Shipping Over" }, "id": { "description": "The unique identifier for the pricing group.", "title": "Id", "type": "integer" }, "initial_catalog_configured_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the initial catalog was configured.", "title": "Initial Catalog Configured At" }, "minimum_margin_percentage": { "description": "Minimum margin percentage as a decimal string.", "title": "Minimum Margin Percentage", "type": "number" }, "name": { "description": "The name of this pricing group.", "title": "Name", "type": "string" }, "recurring_subscription_discount": { "description": "Recurring subscription discount as a percentage.", "title": "Recurring Subscription Discount", "type": "number" }, "standard_shipping_cost_override": { "description": "Standard shipping cost override in cents.", "title": "Standard Shipping Cost Override", "type": "integer" } }, "required": [ "id", "name", "created", "compound_handling_fixed_fee", "free_shipping_over", "minimum_margin_percentage", "initial_catalog_configured_at", "auto_enable_compounds", "standard_shipping_cost_override", "recurring_subscription_discount" ], "title": "PricingGroup", "type": "object" }, "ExternalPricingGroupPricingDetailSchema": { "properties": { "group_services_with_prices": { "description": "A list of group-defined services with their associated prices.", "items": { "$ref": "#/components/schemas/ExternalGroupServiceWithPricingSchema" }, "title": "Group Services With Prices", "type": "array" }, "service_pricing_group_id": { "description": "The unique ID of the service pricing group these prices are for.", "title": "Service Pricing Group Id", "type": "integer" } }, "required": [ "service_pricing_group_id", "group_services_with_prices" ], "title": "ExternalPricingGroupPricingDetailSchema", "type": "object" }, "ExternalProductDetailSchema": { "properties": { "alt_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alternative URL to the product's image", "title": "Alt Image Url" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "default_sig": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The default directions for the Product, if available", "title": "Default Sig" }, "full_name": { "description": "Complete name of the Product", "title": "Full Name", "type": "string" }, "id": { "description": "Unique identifier for the product", "title": "Id", "type": "integer" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to the product's image", "title": "Image Url" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Name of the Product itself. For the complete name of the Product, see the full_name field.", "title": "Name", "type": "string" }, "product_line": { "$ref": "#/components/schemas/ExternalProductLineSchema", "description": "Product line of the product" } }, "required": [ "created", "modified", "id", "default_sig", "name", "full_name", "product_line" ], "title": "ExternalProductDetailSchema", "type": "object" }, "ExternalProductLineSchema": { "properties": { "alt_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alternative URL to the product line's image", "title": "Alt Image Url" }, "brand_name": { "description": "The brand name of the product line.", "title": "Brand Name", "type": "string" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A description of the Product Line, if available", "title": "Description" }, "grouping": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Indicates whether the Product Line is a prescription item or OTC item", "title": "Grouping" }, "id": { "description": "Unique identifier for the product line.", "title": "Id", "type": "integer" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to the product line's image", "title": "Image Url" }, "manufacturer_id": { "description": "ID of the manufacturer that produces this product line.", "title": "Manufacturer Id", "type": "integer" }, "manufacturer_name": { "description": "The manufacturer of the Product Line", "title": "Manufacturer Name", "type": "string" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "prescription_required": { "description": "Indicates whether the Product Line requires a prescription", "title": "Prescription Required", "type": "boolean" }, "primary_category_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The primary product category this product line belongs to.", "title": "Primary Category Name" }, "refrigeration_required": { "description": "Indicates whether the Product Line requires refrigeration", "title": "Refrigeration Required", "type": "boolean" }, "secondary_category_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Additional product categories this product line belongs to.", "title": "Secondary Category Names" } }, "required": [ "created", "modified", "id", "manufacturer_id", "brand_name", "description", "manufacturer_name", "grouping", "prescription_required", "refrigeration_required" ], "title": "ExternalProductLineSchema", "type": "object" }, "ExternalProductLineSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalProductLineSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalProductLineSchemaList", "type": "object" }, "ExternalProductListSchema": { "properties": { "alt_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alternative URL to the product's image", "title": "Alt Image Url" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "default_sig": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The default directions for the Product, if available", "title": "Default Sig" }, "full_name": { "description": "Complete name of the Product", "title": "Full Name", "type": "string" }, "id": { "description": "Unique identifier for the product", "title": "Id", "type": "integer" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to the product's image", "title": "Image Url" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "name": { "description": "Name of the Product itself. For the complete name of the Product, see the full_name field.", "title": "Name", "type": "string" }, "product_line_id": { "description": "ID of the associated product line", "title": "Product Line Id", "type": "integer" } }, "required": [ "created", "modified", "id", "default_sig", "name", "full_name", "product_line_id" ], "title": "ExternalProductListSchema", "type": "object" }, "ExternalProductListSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalProductListSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalProductListSchemaList", "type": "object" }, "ExternalPurchaseOrderItemSchema": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "id": { "description": "The unique identifier for the purchase order item", "title": "Id", "type": "integer" }, "inventory_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The inventory id for this item", "title": "Inventory Id" }, "inventory_shortcode": { "default": "", "description": "The inventory shortcode (human-readable code) for this item", "title": "Inventory Shortcode", "type": "string" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The quantity ordered", "title": "Quantity" }, "sku": { "description": "The SKU identifier for this item", "title": "Sku", "type": "string" }, "total_price": { "description": "The total price for this line item, in cents", "title": "Total Price", "type": "integer" }, "unit_of_measure": { "description": "The unit of measure for this item", "title": "Unit Of Measure", "type": "string" } }, "required": [ "created", "modified", "id", "inventory_id", "sku", "quantity", "total_price", "unit_of_measure" ], "title": "ExternalPurchaseOrderItemSchema", "type": "object" }, "ExternalPurchaseOrderSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic this purchase order belongs to", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "effective_total": { "description": "The effective total of the order, in cents", "title": "Effective Total", "type": "integer" }, "id": { "description": "The unique identifier for the purchase order", "title": "Id", "type": "integer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "order_datetime": { "description": "The datetime when the order was placed", "format": "date-time", "title": "Order Datetime", "type": "string" }, "po_number": { "description": "The purchase order number", "title": "Po Number", "type": "string" }, "purchase_order_items": { "description": "The line items included in this purchase order", "items": { "$ref": "#/components/schemas/ExternalPurchaseOrderItemSchema" }, "title": "Purchase Order Items", "type": "array" }, "raw_total": { "description": "The raw total of the order, in cents", "title": "Raw Total", "type": "integer" }, "status": { "$ref": "#/components/schemas/PurchaseOrderStatus", "description": "The current status of the purchase order" }, "supplier": { "description": "The name of the supplier for this order", "title": "Supplier", "type": "string" } }, "required": [ "created", "modified", "id", "clinic_id", "order_datetime", "po_number", "supplier", "status", "raw_total", "effective_total", "purchase_order_items" ], "title": "ExternalPurchaseOrderSchema", "type": "object" }, "ExternalPurchaseOrderSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPurchaseOrderSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalPurchaseOrderSchemaList", "type": "object" }, "ExternalRefundSchema": { "description": "Schema representing a refund for clinic groups (external view)", "properties": { "amount": { "description": "Refund amount in cents", "title": "Amount", "type": "integer" }, "amount_display": { "description": "Human-readable refund amount (e.g., $10.00)", "title": "Amount Display", "type": "string" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/Currency" }, { "const": "", "type": "string" } ], "description": "The currency of the refund", "title": "Currency" }, "id": { "description": "Unique ID of the refund", "title": "Id", "type": "integer" }, "is_urgency_fee_refund": { "description": "Indicates if this refund was for an urgency fee", "title": "Is Urgency Fee Refund", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "num_order_items": { "description": "Number of order items associated with this refund", "title": "Num Order Items", "type": "integer" }, "sponsored_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Entity sponsoring the refund, if any", "title": "Sponsored By" } }, "required": [ "created", "modified", "id", "amount", "amount_display", "currency", "is_urgency_fee_refund", "num_order_items", "sponsored_by" ], "title": "ExternalRefundSchema", "type": "object" }, "ExternalRefundSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalRefundSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalRefundSchemaList", "type": "object" }, "ExternalResourceScheduleBlockSchema": { "properties": { "resource_id": { "description": "The ID of the resource this schedule block belongs to.", "title": "Resource Id", "type": "integer" }, "time_blocks": { "description": "The time blocks of this schedule block.", "items": { "$ref": "#/components/schemas/ResourceScheduleBlockTimeRange" }, "title": "Time Blocks", "type": "array" } }, "required": [ "resource_id", "time_blocks" ], "title": "ExternalResourceScheduleBlockSchema", "type": "object" }, "ExternalResourceScheduleBlockSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalResourceScheduleBlockSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalResourceScheduleBlockSchemaList", "type": "object" }, "ExternalResourceScheduleExceptionSchema": { "properties": { "calendar_resource_id": { "description": "The ID of the calendar resource this exception is for.", "title": "Calendar Resource Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this schedule exception belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted end datetime of the exception in UTC. Null when is_unavailable or use_clinic_hours is true.", "title": "End Datetime" }, "id": { "description": "The unique identifier for this schedule exception.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_unavailable": { "description": "Whether the resource is entirely unavailable during this exception.", "title": "Is Unavailable", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the exception in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" }, "use_clinic_hours": { "description": "Whether the resource should use the clinic's business hours for this exception day.", "title": "Use Clinic Hours", "type": "boolean" } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "clinic_id", "calendar_resource_id", "start_datetime", "end_datetime", "is_unavailable", "use_clinic_hours" ], "title": "ExternalResourceScheduleExceptionSchema", "type": "object" }, "ExternalResourceScheduleExceptionSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalResourceScheduleExceptionSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalResourceScheduleExceptionSchemaList", "type": "object" }, "ExternalResourceScheduleSchema": { "properties": { "calendar_resource_id": { "description": "The ID of the calendar resource this schedule is for.", "title": "Calendar Resource Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this resource schedule belongs to.", "title": "Clinic Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted end datetime of the schedule in UTC. Null when use_clinic_hours is true.", "title": "End Datetime" }, "id": { "description": "The unique identifier for this resource schedule.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "description": "Structured recurrence pattern, if recurring." }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the schedule in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" }, "use_clinic_hours": { "description": "Whether this resource follows the clinic's business hours instead of a custom end time.", "title": "Use Clinic Hours", "type": "boolean" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "clinic_id", "calendar_resource_id", "start_datetime", "end_datetime", "use_clinic_hours" ], "title": "ExternalResourceScheduleSchema", "type": "object" }, "ExternalResourceScheduleSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalResourceScheduleSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalResourceScheduleSchemaList", "type": "object" }, "ExternalRevenueCategoryDetailSchema": { "description": "A revenue category is used to classify services for financial reporting purposes. Each service can be assigned to a revenue category to help clinics track and categorize their income streams.", "properties": { "id": { "description": "The unique identifier for the revenue category.", "title": "Id", "type": "integer" }, "name": { "description": "The name of this revenue category.", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "Revenue Category", "type": "object" }, "ExternalRevenueCategorySchema": { "properties": { "id": { "description": "The unique identifier for the revenue category.", "title": "Id", "type": "integer" }, "name": { "description": "The name of this revenue category.", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "ExternalRevenueCategorySchema", "type": "object" }, "ExternalRevenueCategorySchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalRevenueCategorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalRevenueCategorySchemaList", "type": "object" }, "ExternalServicePrice": { "properties": { "current_price": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The current price for this service.", "title": "Current Price" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The unique identifier for the service price.", "title": "Id" }, "service_pricing_group_id": { "description": "The unique ID of the service pricing group these prices are for.", "title": "Service Pricing Group Id", "type": "integer" }, "strategy_kind": { "anyOf": [ { "$ref": "#/components/schemas/ServicePriceStrategyKind" }, { "const": "", "type": "string" } ], "description": "The pricing strategy used for this service.", "title": "Strategy Kind" }, "strategy_value": { "description": "The values used to calculate price, based on the pricing strategy.", "title": "Strategy Value", "type": "object" } }, "required": [ "id", "service_pricing_group_id", "strategy_kind", "strategy_value" ], "title": "ExternalServicePrice", "type": "object" }, "ExternalServicePricingCategoryDetailSchema": { "description": "A service pricing category is the top-level grouping in the service pricing hierarchy. Each category contains one or more service pricing groups, which in turn contain the individual services and their prices.", "properties": { "id": { "description": "The unique identifier for the pricing category.", "title": "Id", "type": "integer" }, "name": { "description": "The name of this pricing category.", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "Service Pricing Category", "type": "object" }, "ExternalServicePricingCategorySchema": { "properties": { "id": { "description": "The unique identifier for the pricing category.", "title": "Id", "type": "integer" }, "name": { "description": "The name of this pricing category.", "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "ExternalServicePricingCategorySchema", "type": "object" }, "ExternalServicePricingCategorySchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalServicePricingCategorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalServicePricingCategorySchemaList", "type": "object" }, "ExternalServicePricingGroupDetailSchema": { "description": "A service pricing group sits within a service pricing category and defines a set of prices for services. Clinics are assigned to pricing groups, which determines the prices they charge for each service.", "properties": { "id": { "description": "The unique identifier for the service pricing group.", "title": "Id", "type": "integer" }, "in_clinic_dispense_fee": { "description": "The dispense fee for services that administered in the clinic, in cents.", "minimum": 0, "title": "In Clinic Dispense Fee", "type": "integer" }, "name": { "description": "The name of this service pricing group.", "title": "Name", "type": "string" }, "service_pricing_category_id": { "description": "The ID of the pricing category for this service pricing group.", "title": "Service Pricing Category Id", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ServicePricingGroupStatus" }, { "const": "", "type": "string" } ], "description": "The current status of the service pricing group.", "title": "Status" }, "take_home_dispense_fee": { "description": "The dispense fee for services that are taken home by the pet parent, in cents.", "minimum": 0, "title": "Take Home Dispense Fee", "type": "integer" } }, "required": [ "id", "status", "name", "service_pricing_category_id", "in_clinic_dispense_fee", "take_home_dispense_fee" ], "title": "Service Pricing Group", "type": "object" }, "ExternalServicePricingGroupSchema": { "properties": { "id": { "description": "The unique identifier for the service pricing group.", "title": "Id", "type": "integer" }, "in_clinic_dispense_fee": { "description": "The dispense fee for services that administered in the clinic, in cents.", "minimum": 0, "title": "In Clinic Dispense Fee", "type": "integer" }, "name": { "description": "The name of this service pricing group.", "title": "Name", "type": "string" }, "service_pricing_category_id": { "description": "The ID of the pricing category for this service pricing group.", "title": "Service Pricing Category Id", "type": "integer" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ServicePricingGroupStatus" }, { "const": "", "type": "string" } ], "description": "The current status of the service pricing group.", "title": "Status" }, "take_home_dispense_fee": { "description": "The dispense fee for services that are taken home by the pet parent, in cents.", "minimum": 0, "title": "Take Home Dispense Fee", "type": "integer" } }, "required": [ "id", "status", "name", "service_pricing_category_id", "in_clinic_dispense_fee", "take_home_dispense_fee" ], "title": "ExternalServicePricingGroupSchema", "type": "object" }, "ExternalServicePricingGroupSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalServicePricingGroupSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalServicePricingGroupSchemaList", "type": "object" }, "ExternalServiceVaccineDefaultDurationCreateOrUpdateSchema": { "properties": { "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit of the default duration for this vaccine reminder." }, "default_duration_value": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The value of the default duration for this vaccine reminder.", "title": "Default Duration Value" }, "standard_care_reminder_id": { "description": "The ID of the active standard care reminder linked to this vaccine service.", "title": "Standard Care Reminder Id", "type": "integer" } }, "required": [ "standard_care_reminder_id" ], "title": "ExternalServiceVaccineDefaultDurationCreateOrUpdateSchema", "type": "object" }, "ExternalServiceVaccineDefaultDurationSchema": { "properties": { "default_duration_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "type": "null" } ], "description": "The unit of the default duration for this vaccine reminder." }, "default_duration_value": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "The value of the default duration for this vaccine reminder.", "title": "Default Duration Value" }, "standard_care_reminder_id": { "description": "The ID of the active standard care reminder linked to this vaccine service.", "title": "Standard Care Reminder Id", "type": "integer" }, "standard_care_reminder_name": { "description": "The name of the active standard care reminder linked to this vaccine service.", "title": "Standard Care Reminder Name", "type": "string" } }, "required": [ "standard_care_reminder_id", "standard_care_reminder_name" ], "title": "ExternalServiceVaccineDefaultDurationSchema", "type": "object" }, "ExternalSmsNotificationSchema": { "properties": { "body": { "description": "The SMS message body.", "title": "Body", "type": "string" }, "client_communication_number_id": { "description": "The ID of the client communication number the SMS was sent to.", "title": "Client Communication Number Id", "type": "integer" }, "clinic_client_id": { "description": "The ID of the clinic client the SMS was sent to.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic the SMS was sent from.", "title": "Clinic Id", "type": "integer" }, "created_at": { "description": "When the SMS notification was created.", "format": "date-time", "title": "Created At", "type": "string" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error code from the SMS provider if sending failed.", "title": "Error Code" }, "error_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable reason for the error, if the error code is recognized.", "title": "Error Reason" }, "id": { "description": "The ID of the SMS notification.", "title": "Id", "type": "integer" }, "status": { "$ref": "#/components/schemas/ExternalSmsNotificationStatus", "description": "The delivery status of the SMS.\n- `SENT`: Message was sent but delivery is not yet confirmed.\n- `DELIVERED`: Message was successfully delivered.\n- `FAILED_TO_SEND`: Message failed to send." } }, "required": [ "id", "clinic_client_id", "client_communication_number_id", "clinic_id", "body", "status", "created_at", "error_code", "error_reason" ], "title": "ExternalSmsNotificationSchema", "type": "object" }, "ExternalSmsNotificationSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalSmsNotificationSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalSmsNotificationSchemaList", "type": "object" }, "ExternalSmsNotificationStatus": { "description": "Delivery status of an SMS notification sent via the Connect API.", "enum": [ "SENT", "DELIVERED", "FAILED_TO_SEND" ], "title": "ExternalSmsNotificationStatus", "type": "string" }, "ExternalSubscriptionDetailSchema": { "description": "A subscription represents a recurring autoship order for a product, such as monthly flea medication delivery. Subscriptions are associated with a specific clinic, client, patient, and item, and define the frequency and quantity of each recurring order.", "properties": { "autoship_url_client": { "description": "The client url for this subscription.", "title": "Autoship Url Client", "type": "string" }, "autoship_url_clinic": { "description": "The clinic url for this subscription.", "title": "Autoship Url Clinic", "type": "string" }, "clinic_client_id": { "description": "The ID of the client this subscription belongs to.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this subscription belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the patient for this subscription.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "frequency": { "description": "The number of interval units between subscription orders.", "title": "Frequency", "type": "integer" }, "id": { "description": "The unique identifier for this subscription.", "title": "Id", "type": "integer" }, "interval_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of time between subscription orders.", "title": "Interval Unit" }, "is_imported": { "description": "Whether this subscription was imported from an external site.", "title": "Is Imported", "type": "boolean" }, "item_id": { "description": "The ID of the item for this subscription.", "title": "Item Id", "type": "integer" }, "last_order_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date of the most recent order for this subscription.", "title": "Last Order Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "next_order_date": { "description": "The date of the next scheduled order for this subscription.", "format": "date-time", "title": "Next Order Date", "type": "string" }, "quantity": { "description": "The quantity of the item for this subscription.", "title": "Quantity", "type": "integer" }, "status": { "$ref": "#/components/schemas/SubscriptionStatus", "description": "The status of the subscription." }, "status_changed": { "description": "The time at which the subscription status was last changed.", "format": "date-time", "title": "Status Changed", "type": "string" } }, "required": [ "created", "modified", "id", "clinic_id", "clinic_client_id", "clinic_patient_id", "item_id", "quantity", "interval_unit", "frequency", "status", "status_changed", "last_order_date", "next_order_date", "is_imported", "autoship_url_clinic", "autoship_url_client" ], "title": "Subscription", "type": "object" }, "ExternalSubscriptionSchema": { "properties": { "autoship_url_client": { "description": "The client url for this subscription.", "title": "Autoship Url Client", "type": "string" }, "autoship_url_clinic": { "description": "The clinic url for this subscription.", "title": "Autoship Url Clinic", "type": "string" }, "clinic_client_id": { "description": "The ID of the client this subscription belongs to.", "title": "Clinic Client Id", "type": "integer" }, "clinic_id": { "description": "The ID of the clinic this subscription belongs to.", "title": "Clinic Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the patient for this subscription.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "frequency": { "description": "The number of interval units between subscription orders.", "title": "Frequency", "type": "integer" }, "id": { "description": "The unique identifier for this subscription.", "title": "Id", "type": "integer" }, "interval_unit": { "anyOf": [ { "$ref": "#/components/schemas/FrequencyUnit" }, { "const": "", "type": "string" } ], "description": "The unit of time between subscription orders.", "title": "Interval Unit" }, "is_imported": { "description": "Whether this subscription was imported from an external site.", "title": "Is Imported", "type": "boolean" }, "item_id": { "description": "The ID of the item for this subscription.", "title": "Item Id", "type": "integer" }, "last_order_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date of the most recent order for this subscription.", "title": "Last Order Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "next_order_date": { "description": "The date of the next scheduled order for this subscription.", "format": "date-time", "title": "Next Order Date", "type": "string" }, "quantity": { "description": "The quantity of the item for this subscription.", "title": "Quantity", "type": "integer" }, "status": { "$ref": "#/components/schemas/SubscriptionStatus", "description": "The status of the subscription." }, "status_changed": { "description": "The time at which the subscription status was last changed.", "format": "date-time", "title": "Status Changed", "type": "string" } }, "required": [ "created", "modified", "id", "clinic_id", "clinic_client_id", "clinic_patient_id", "item_id", "quantity", "interval_unit", "frequency", "status", "status_changed", "last_order_date", "next_order_date", "is_imported", "autoship_url_clinic", "autoship_url_client" ], "title": "ExternalSubscriptionSchema", "type": "object" }, "ExternalSubscriptionSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalSubscriptionSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalSubscriptionSchemaList", "type": "object" }, "ExternalTaxCategoryDetailSchema": { "description": "Each tax category has a code and status, and tax statuses at the state, county, and city level can be configured per clinic for each category, determining whether the clinic's tax rates apply to items in that category.", "properties": { "code": { "description": "The code representing this tax category.", "title": "Code", "type": "string" }, "id": { "description": "The unique identifier for the tax category.", "title": "Id", "type": "integer" }, "name": { "description": "The display name of this tax category.", "title": "Name", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/TaxCategoryStatus" }, { "const": "", "type": "string" } ], "description": "The status of this tax category.", "title": "Status" } }, "required": [ "id", "name", "code", "status" ], "title": "Tax Category", "type": "object" }, "ExternalTaxCategorySchema": { "properties": { "code": { "description": "The code representing this tax category.", "title": "Code", "type": "string" }, "id": { "description": "The unique identifier for the tax category.", "title": "Id", "type": "integer" }, "name": { "description": "The display name of this tax category.", "title": "Name", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/TaxCategoryStatus" }, { "const": "", "type": "string" } ], "description": "The status of this tax category.", "title": "Status" } }, "required": [ "id", "name", "code", "status" ], "title": "ExternalTaxCategorySchema", "type": "object" }, "ExternalTaxCategorySchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalTaxCategorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalTaxCategorySchemaList", "type": "object" }, "ExternalTaxSettingDetailSchema": { "properties": { "city_rate": { "description": "The city tax rate.", "minimum": 0.0, "title": "City Rate", "type": "number" }, "clinic_id": { "description": "The ID of the clinic this tax clinic is for.", "title": "Clinic Id", "type": "integer" }, "county_rate": { "description": "The county tax rate.", "minimum": 0.0, "title": "County Rate", "type": "number" }, "federal_rate": { "description": "The federal tax rate.", "minimum": 0.0, "title": "Federal Rate", "type": "number" }, "state_rate": { "description": "The state tax rate.", "minimum": 0.0, "title": "State Rate", "type": "number" } }, "required": [ "clinic_id", "state_rate", "county_rate", "city_rate", "federal_rate" ], "title": "ExternalTaxSettingDetailSchema", "type": "object" }, "ExternalTransferSchema": { "description": "Schema representing clinic transfers for clinic groups (external view)", "properties": { "amount": { "description": "Transfer amount in cents", "title": "Amount", "type": "integer" }, "amount_display": { "description": "Human-readable transfer amount (e.g., $100.00)", "title": "Amount Display", "type": "string" }, "currency": { "anyOf": [ { "$ref": "#/components/schemas/Currency" }, { "const": "", "type": "string" } ], "description": "The currency of the transfer", "title": "Currency" }, "id": { "description": "Unique ID of the transfer", "title": "Id", "type": "integer" }, "order_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the order associated with this transfer (if applicable)", "title": "Order Id" }, "payment": { "deprecated": true, "description": "Deprecated. Use payment_id and payment_stripe_id instead.", "title": "Payment", "type": "string" }, "payment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the PaymentIntent used as the source of the transfer", "title": "Payment Id" }, "payment_stripe_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stripe ID of the PaymentIntent used as the source of the transfer", "title": "Payment Stripe Id" }, "payout_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the payout associated with this transfer (if applicable)", "title": "Payout Id" }, "stripe_account": { "description": "Name of the Stripe account receiving the transfer", "title": "Stripe Account", "type": "string" }, "stripe_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stripe ID of the transfer (nullable if amount is 0)", "title": "Stripe Id" } }, "required": [ "id", "amount", "amount_display", "currency", "stripe_account", "payment", "payment_id", "payment_stripe_id", "stripe_id", "order_id", "payout_id" ], "title": "ExternalTransferSchema", "type": "object" }, "ExternalTransferSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalTransferSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalTransferSchemaList", "type": "object" }, "ExternalUploadedFileCreateSchema": { "properties": { "filename": { "description": "The filename of the file that was uploaded", "title": "Filename", "type": "string" }, "key": { "description": "The key to which the file was uploaded", "title": "Key", "type": "string" } }, "required": [ "key", "filename" ], "title": "ExternalUploadedFileCreateSchema", "type": "object" }, "ExternalUploadedFileSchema": { "properties": { "filename": { "description": "The filename of the file that was uploaded", "title": "Filename", "type": "string" }, "filesize": { "description": "The size of the uploaded file in bytes", "title": "Filesize", "type": "integer" }, "id": { "description": "The unique identifier of the file that was uploaded", "title": "Id", "type": "integer" }, "url": { "description": "A pre-signed URL good for 1 hour which can be used to download this file", "title": "Url", "type": "string" } }, "required": [ "id", "url", "filename", "filesize" ], "title": "ExternalUploadedFileSchema", "type": "object" }, "ExternalUploadedFileSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalUploadedFileSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalUploadedFileSchemaList", "type": "object" }, "ExternalVaccineHistoricalTreatmentSchema": { "description": "Schema for vaccine HistoricalTreatment objects in the external API", "properties": { "administered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the vaccine treatment was administered.", "title": "Administered At" }, "clinic_patient_id": { "description": "The ID of the patient who received this vaccine treatment.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The group service display name of the vaccine treatment.", "title": "Display Name" }, "expires_at": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "When the vaccine treatment expires.", "title": "Expires At" }, "id": { "description": "The unique identifier for the vaccine historical treatment.", "title": "Id", "type": "integer" }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The lot number recorded for this vaccine, if any.", "title": "Lot Number" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The vaccine manufacturer name, if any.", "title": "Manufacturer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "next_due": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "When the vaccine treatment is next due.", "title": "Next Due" }, "patient_standard_care_reminder_id": { "description": "The ID of the standard care reminder this vaccine treatment is associated with.", "title": "Patient Standard Care Reminder Id", "type": "integer" }, "patient_standard_care_reminder_name": { "description": "The name of the standard care reminder this vaccine treatment is associated with.", "title": "Patient Standard Care Reminder Name", "type": "string" }, "rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The rabies tag recorded on this vaccine treatment, if any. Typically only populated for RABIES-kind vaccines where a tag was entered.", "title": "Rabies Tag" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The serial number recorded for this vaccine, if any.", "title": "Serial Number" }, "vaccine_kind": { "$ref": "#/components/schemas/VaccineKind", "description": "The vaccine kind (e.g. RABIES, OTHER)." } }, "required": [ "created", "modified", "id", "clinic_patient_id", "patient_standard_care_reminder_id", "display_name", "patient_standard_care_reminder_name", "administered_at", "expires_at", "next_due", "vaccine_kind", "rabies_tag", "lot_number", "serial_number", "manufacturer" ], "title": "Vaccine Historical Treatment", "type": "object" }, "ExternalVaccineTreatmentPatientStandardCareReminder": { "description": "Schema for patient standard care reminders associated with a vaccine treatment.", "properties": { "id": { "description": "The unique identifier for the patient standard care reminder.", "title": "Id", "type": "integer" }, "is_current": { "description": "Whether the associated vaccine treatment is the most recent for this reminder.", "title": "Is Current", "type": "boolean" }, "name": { "description": "The name of the standard care reminder.", "title": "Name", "type": "string" }, "next_due": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The next due date for this reminder. Only set when is_current is True.", "title": "Next Due" } }, "required": [ "id", "name", "next_due", "is_current" ], "title": "ExternalVaccineTreatmentPatientStandardCareReminder", "type": "object" }, "ExternalVaccineTreatmentSchema": { "description": "Schema for vaccine Treatment objects in the external API", "properties": { "administered_at": { "description": "When the vaccine treatment was administered.", "format": "date-time", "title": "Administered At", "type": "string" }, "clinic_patient_id": { "description": "The ID of the patient this vaccine treatment belongs to.", "title": "Clinic Patient Id", "type": "integer" }, "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "display_name": { "description": "The group service display name of the vaccine treatment.", "title": "Display Name", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "When the vaccine treatment expires.", "title": "Expires At" }, "id": { "description": "The unique identifier for the vaccine treatment.", "title": "Id", "type": "integer" }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The lot number recorded for this vaccine, if any.", "title": "Lot Number" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The vaccine manufacturer name, if any.", "title": "Manufacturer" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_standard_care_reminders": { "description": "The patient standard care reminders associated with this vaccine treatment.", "items": { "$ref": "#/components/schemas/ExternalVaccineTreatmentPatientStandardCareReminder" }, "title": "Patient Standard Care Reminders", "type": "array" }, "rabies_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The rabies tag recorded on this vaccine treatment, if any. Typically only populated for RABIES-kind vaccines where a tag was entered.", "title": "Rabies Tag" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The serial number recorded for this vaccine, if any.", "title": "Serial Number" }, "vaccine_kind": { "$ref": "#/components/schemas/VaccineKind", "description": "The vaccine kind (e.g. RABIES, OTHER)." } }, "required": [ "created", "modified", "id", "clinic_patient_id", "display_name", "administered_at", "expires_at", "patient_standard_care_reminders", "vaccine_kind", "rabies_tag", "lot_number", "serial_number", "manufacturer" ], "title": "Vaccine Treatment", "type": "object" }, "ExternalVitalReadingSchema": { "properties": { "created": { "description": "The datetime when this vital was created.", "format": "date-time", "title": "Created", "type": "string" }, "id": { "description": "The ID for this vital reading", "title": "Id", "type": "integer" }, "medical_record_id": { "description": "The ID of the medical record this vital reading belongs to.", "title": "Medical Record Id", "type": "integer" }, "units": { "anyOf": [ { "$ref": "#/components/schemas/VitalUnitOfMeasure" }, { "const": "", "type": "string" } ], "description": "The units of measurement for the vital value.", "title": "Units" }, "value": { "description": "The value of the vital measurement.", "title": "Value", "type": "string" }, "vital_reading_group_id": { "description": "The unique identifier for the vital reading group.", "title": "Vital Reading Group Id", "type": "integer" }, "vital_type": { "description": "The type of vital.", "title": "Vital Type", "type": "string" } }, "required": [ "id", "vital_reading_group_id", "medical_record_id", "value", "units", "vital_type", "created" ], "title": "ExternalVitalReadingSchema", "type": "object" }, "ExternalVitalReadingSchemaList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalVitalReadingSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "ExternalVitalReadingSchemaList", "type": "object" }, "External_Order_ItemList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalOrderItemSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "External Order ItemList", "type": "object" }, "FixedPricingStrategyRule": { "properties": { "price_input": { "description": "The fixed price to set for this service, in cents.", "title": "Price Input", "type": "integer" } }, "required": [ "price_input" ], "title": "FixedPricingStrategyRule", "type": "object" }, "FormRequestListQueryParamsSchema": { "description": "Query parameters for listing form requests via the Connect API.", "properties": { "appointment_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests linked to the appointment with this ID.", "title": "Appointment Id" }, "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests for the clinic client with this ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests for the clinic with this ID.", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests for the clinic patient with this ID.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "FormRequestListQueryParamsSchema", "type": "object" }, "FrequencyUnit": { "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ], "title": "FrequencyUnit", "type": "string" }, "GenerateUploadUrlPayloadSchema": { "properties": { "content_type": { "description": "The content type of the file to upload", "title": "Content Type", "type": "string" }, "filename": { "description": "The filename of the file to upload", "title": "Filename", "type": "string" } }, "required": [ "filename", "content_type" ], "title": "GenerateUploadUrlPayloadSchema", "type": "object" }, "GenerateUploadUrlResponseSchema": { "properties": { "key": { "description": "The key of the file to upload", "title": "Key", "type": "string" }, "post_data": { "description": "The POST data of the file to upload", "title": "Post Data", "type": "object" }, "url": { "description": "The URL to upload the file to. Good for one hour after creation", "title": "Url", "type": "string" } }, "required": [ "key", "url", "post_data" ], "title": "GenerateUploadUrlResponseSchema", "type": "object" }, "GlobalInventoryKind": { "enum": [ "STANDARD", "CUSTOM_ROLLUP", "CUSTOM" ], "title": "GlobalInventoryKind", "type": "string" }, "GlobalInventoryPreference": { "properties": { "name": { "description": "The global name assigned to this type of inventory at Vetcove", "title": "Name", "type": "string" }, "unit_of_measure": { "$ref": "#/components/schemas/InventoryUnitOfMeasure", "description": "The global settings for how units of this inventory are measured at Vetcove" } }, "required": [ "name", "unit_of_measure" ], "title": "GlobalInventoryPreference", "type": "object" }, "GroupServiceDetailPathParamsSchema": { "properties": { "group_service_id": { "description": "The ID of the group service to fetch", "title": "Group Service Id", "type": "integer" } }, "required": [ "group_service_id" ], "title": "GroupServiceDetailPathParamsSchema", "type": "object" }, "GroupServiceListQueryParamsSchema": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to the group service with this service code.", "title": "Code" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "GroupServiceListQueryParamsSchema", "type": "object" }, "GroupServiceUpdatePathParamsSchema": { "properties": { "group_service_id": { "description": "The ID of the group service to update", "title": "Group Service Id", "type": "integer" } }, "required": [ "group_service_id" ], "title": "GroupServiceUpdatePathParamsSchema", "type": "object" }, "HistoricalTreatmentDetailPathParamsSchema": { "description": "Schema for the HistoricalTreatmentDetailExternalAPIController path parameters", "properties": { "historical_treatment_id": { "description": "The ID of the historical treatment to retrieve.", "title": "Historical Treatment Id", "type": "integer" } }, "required": [ "historical_treatment_id" ], "title": "HistoricalTreatmentDetailPathParamsSchema", "type": "object" }, "HistoricalTreatmentListQueryParamsSchema": { "description": "Schema for the HistoricalTreatmentListExternalAPIController query parameters", "properties": { "clinic_patient_id": { "description": "Filters to historical treatments associated with the clinic patient with the given ID.", "title": "Clinic Patient Id", "type": "integer" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "required": [ "clinic_patient_id" ], "title": "HistoricalTreatmentListQueryParamsSchema", "type": "object" }, "HistoryActionKind": { "enum": [ "CREATE", "UPDATE", "DELETE" ], "title": "HistoryActionKind", "type": "string" }, "HospitalizationServiceBillingType": { "enum": [ "FIXED_RATE", "MAX_USES_PER_CHARGE", "NON_CHARGEABLE" ], "title": "HospitalizationServiceBillingType", "type": "string" }, "ImportedConversationDetailPathParamsSchema": { "properties": { "imported_conversation_id": { "title": "Imported Conversation Id", "type": "integer" } }, "required": [ "imported_conversation_id" ], "title": "ImportedConversationDetailPathParamsSchema", "type": "object" }, "ImportedConversationListQueryParamsSchema": { "description": "Schema for the ImportedConversation list endpoint query parameters.", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to imported conversations for the clinic client with this ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to imported conversations for the clinic with this ID.", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to imported conversations attached to the clinic patient with this ID.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ImportedConversationListQueryParamsSchema", "type": "object" }, "IndividualServicePricingGroupPricingUpdateSchema": { "properties": { "group_service_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The unique ID of the group service to set a price for. Exactly one of `service_code` and `group_service_id` must be set.", "title": "Group Service Id" }, "service_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The service code of the group service to set a price for. Exactly one of `service_code` and `group_service_id` must be set.", "title": "Service Code" }, "strategy_kind": { "$ref": "#/components/schemas/ServicePriceStrategyKind", "description": "The pricing strategy used for this service." }, "strategy_value": { "anyOf": [ { "$ref": "#/components/schemas/FixedPricingStrategyRule" }, { "type": "null" } ], "description": "The values used to calculate price, based on the pricing strategy. Only necessary when using a FIXED_PRICING strategy." } }, "required": [ "strategy_kind" ], "title": "IndividualServicePricingGroupPricingUpdateSchema", "type": "object" }, "InsuranceProviderDetailPathParamsSchema": { "description": "Schema for the InsuranceProviderDetailExternalAPIController path parameters", "properties": { "insurance_provider_id": { "description": "The ID of the insurance provider to fetch", "title": "Insurance Provider Id", "type": "integer" } }, "required": [ "insurance_provider_id" ], "title": "InsuranceProviderDetailPathParamsSchema", "type": "object" }, "InsuranceProviderListQueryParamsSchema": { "description": "Schema for the InsuranceProviderListExternalAPIController path parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "InsuranceProviderListQueryParamsSchema", "type": "object" }, "InventoryCategoryDetailPathParamsSchema": { "properties": { "inventory_category_id": { "description": "The ID of the inventory category to fetch", "title": "Inventory Category Id", "type": "integer" } }, "required": [ "inventory_category_id" ], "title": "InventoryCategoryDetailPathParamsSchema", "type": "object" }, "InventoryCodeDetailPathParamsSchema": { "properties": { "inventory_code_id": { "description": "The ID of the inventory code to fetch", "title": "Inventory Code Id", "type": "integer" } }, "required": [ "inventory_code_id" ], "title": "InventoryCodeDetailPathParamsSchema", "type": "object" }, "InventoryCodeListQueryParamsSchema": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters inventory codes by the code", "title": "Code" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "InventoryCodeListQueryParamsSchema", "type": "object" }, "InventoryGrade": { "enum": [ "A", "B", "C", "D", "X" ], "title": "InventoryGrade", "type": "string" }, "InventoryStatus": { "enum": [ "OUT_OF_STOCK", "LOW_STOCK", "IN_STOCK", "UNKNOWN" ], "title": "InventoryStatus", "type": "string" }, "InventoryUnitOfMeasure": { "enum": [ "APPLICATOR", "BAG", "BOTTLE", "BOX", "BUCKET", "CAN", "CAPLET", "CAPSULE", "CASE", "CATHETER", "CHEW", "COLLAR", "DOSE", "EACH", "GRAM", "GALLON", "JAR", "KIT", "POUND", "LITER", "MILLILITER", "NEEDLE", "OUNCE", "PACKET", "PAIR", "PIPETTE", "PURCHASING_UNIT", "QUART", "ROLL", "SUTURE", "SYRINGE", "TABLET", "TEST", "TRAY", "TUB", "TUBE", "VIAL", "YARD" ], "title": "InventoryUnitOfMeasure", "type": "string" }, "InvoiceDetailPathParamsSchema": { "description": "Schema for the InvoiceDetailExternalAPIController path parameters", "properties": { "invoice_id": { "description": "The ID of the invoice to fetch", "title": "Invoice Id", "type": "integer" } }, "required": [ "invoice_id" ], "title": "InvoiceDetailPathParamsSchema", "type": "object" }, "InvoiceItemListQueryParamsSchema": { "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items for this clinic client.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items for this clinic.", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items for this clinic patient.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "invoice_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items on this invoice.", "title": "Invoice Id" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "InvoiceItemListQueryParamsSchema", "type": "object" }, "InvoiceItemNotRenderedList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoiceItemNotRenderedSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "InvoiceItemNotRenderedList", "type": "object" }, "InvoiceItemNotRenderedParamsSchema": { "description": "Schema for the InvoiceItemNotRenderedExternalAPIController path parameters", "properties": { "invoice_id": { "description": "The ID of the invoice to fetch not fully rendered items for", "title": "Invoice Id", "type": "integer" } }, "required": [ "invoice_id" ], "title": "InvoiceItemNotRenderedParamsSchema", "type": "object" }, "InvoiceItemRefundList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoiceItemRefundSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "InvoiceItemRefundList", "type": "object" }, "InvoiceItemRefundPathParamsSchema": { "description": "Schema for the InvoiceItemRefundExternalAPIController path parameters", "properties": { "invoice_id": { "description": "The ID of the invoice to fetch item refunds for", "title": "Invoice Id", "type": "integer" } }, "required": [ "invoice_id" ], "title": "InvoiceItemRefundPathParamsSchema", "type": "object" }, "InvoiceListQueryParamsSchema": { "description": "Schema for the InvoiceListExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoices for this clinic client", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoices for this clinic", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "status": { "default": [ "FINALIZED", "LOCKED", "IMPORTED" ], "description": "List of invoice status values to filter by.", "items": { "enum": [ "IN_PROGRESS", "READY_FOR_PAYMENT", "FINALIZED", "LOCKED", "IMPORTED" ], "title": "ClientInvoiceStatus", "type": "string" }, "title": "Status", "type": "array" } }, "title": "InvoiceListQueryParamsSchema", "type": "object" }, "InvoiceManualDiscountHistoryList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoiceManualDiscountHistorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "InvoiceManualDiscountHistoryList", "type": "object" }, "InvoiceManualDiscountHistoryPathParamsSchema": { "description": "Schema for the InvoiceManualDiscountHistoryExternalAPIController path parameters", "properties": { "invoice_id": { "description": "The ID of the invoice to fetch history for", "title": "Invoice Id", "type": "integer" } }, "required": [ "invoice_id" ], "title": "InvoiceManualDiscountHistoryPathParamsSchema", "type": "object" }, "InvoicePaymentDetailPathParamsSchema": { "properties": { "invoice_payment_id": { "description": "The ID of the invoice payment to fetch", "title": "Invoice Payment Id", "type": "integer" } }, "required": [ "invoice_payment_id" ], "title": "InvoicePaymentDetailPathParamsSchema", "type": "object" }, "InvoicePaymentDisputePathParamsSchema": { "description": "Schema for the InvoicePaymentDisputeExternalAPIController path parameters", "properties": { "invoice_id": { "description": "The ID of the invoice to fetch disputes for", "title": "Invoice Id", "type": "integer" } }, "required": [ "invoice_id" ], "title": "InvoicePaymentDisputePathParamsSchema", "type": "object" }, "InvoicePaymentDisputesList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoicePaymentDisputeSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "InvoicePaymentDisputesList", "type": "object" }, "InvoicePaymentHistoryList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoicePaymentHistorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "InvoicePaymentHistoryList", "type": "object" }, "InvoicePaymentHistoryPathParamsSchema": { "description": "Schema for the InvoicePaymentHistoryExternalAPIController path parameters", "properties": { "invoice_id": { "description": "The ID of the invoice to fetch payment history for", "title": "Invoice Id", "type": "integer" } }, "required": [ "invoice_id" ], "title": "InvoicePaymentHistoryPathParamsSchema", "type": "object" }, "InvoicePaymentListQueryParamsSchema": { "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice payments for this clinic client.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice payments for this clinic.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "invoice_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice payments on this invoice.", "title": "Invoice Id" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "InvoicePaymentListQueryParamsSchema", "type": "object" }, "InvoiceRefundList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalInvoiceRefundSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "InvoiceRefundList", "type": "object" }, "InvoiceRefundPathParamsSchema": { "description": "Schema for the InvoiceRefundExternalAPIController path parameters", "properties": { "invoice_id": { "description": "The ID of the invoice to fetch refunds for", "title": "Invoice Id", "type": "integer" } }, "required": [ "invoice_id" ], "title": "InvoiceRefundPathParamsSchema", "type": "object" }, "InvoiceRefundReason": { "description": "Reasons for refunds (including concepts of \"crediting\" / \"not rendered\",\nwhich are effectively refunds on the BE)", "enum": [ "Management Discretion", "Damaged Product", "Out of Stock", "Service Not Rendered", "Invoice Error" ], "title": "InvoiceRefundReason", "type": "string" }, "InvoiceRefundTopLevelListQueryParamsSchema": { "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice refunds for this clinic client.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice refunds for this clinic.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "invoice_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice refunds on this invoice.", "title": "Invoice Id" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "InvoiceRefundTopLevelListQueryParamsSchema", "type": "object" }, "ItemDetailPathParamsSchema": { "description": "Schema for catalog item detail path parameters.", "properties": { "item_id": { "description": "The ID of the catalog item", "title": "Item Id", "type": "integer" } }, "required": [ "item_id" ], "title": "ItemDetailPathParamsSchema", "type": "object" }, "LabOrderDashboardStatus": { "description": "Filters that FE might pass in for lab order list 'status' (map to result_states)", "enum": [ "PENDING", "COMPLETE", "ERROR", "IMPORTED" ], "title": "LabOrderDashboardStatus", "type": "string" }, "MedicalRecordDetailPathParamsSchema": { "description": "Schema for the MedicalRecordDetailExternalAPIController path parameters", "properties": { "medical_record_id": { "description": "The ID of the medical record to retrieve.", "title": "Medical Record Id", "type": "integer" } }, "required": [ "medical_record_id" ], "title": "MedicalRecordDetailPathParamsSchema", "type": "object" }, "MedicalRecordListQueryParamsSchema": { "description": "Schema for the MedicalRecordListExternalAPIController query parameters", "properties": { "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to medical records associated with the clinic patient with the given ID.", "title": "Clinic Patient Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "invoice_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to medical records associated with the invoice with the given ID.", "title": "Invoice Id" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "MedicalRecordListQueryParamsSchema", "type": "object" }, "Medical_RecordList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalMedicalRecordSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "Medical RecordList", "type": "object" }, "MinuteIncrements": { "enum": [ 10, 15, 20, 30, 40, 45, 50, 60 ], "title": "MinuteIncrements", "type": "integer" }, "NameOperator": { "enum": [ "EXACT", "PREFIX", "CONTAINS" ], "title": "NameOperator", "type": "string" }, "OnboardingEventKind": { "enum": [ "LINK_SENDING", "REMINDER_LINK_SENDING", "LINK_SENT", "LINK_FAILED_TO_SEND", "LINK_OPENED", "LINK_SUBMITTED", "CALLED", "SCHEDULED", "LEGACY_PHARMACY_LINK_CLICKED", "NOTE" ], "title": "OnboardingEventKind", "type": "string" }, "OrderAnalyticsListQueryParamsSchema": { "description": "Schema for the OrderListExternalAPIController query parameters", "properties": { "end_date__lte": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "End date (YYYY-MM-DD). Defaults to today", "title": "End Date Lte" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "last_modified__gte": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds", "title": "Last Modified Gte" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "order_item_statuses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderItemStatus" }, "type": "array" }, { "type": "null" } ], "description": "List of Order Item Status values to filter by", "title": "Order Item Statuses" }, "order_statuses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderStatus" }, "type": "array" }, { "type": "null" } ], "description": "List of Order Status values to filter by", "title": "Order Statuses" }, "sort_by": { "anyOf": [ { "$ref": "#/components/schemas/ExternalOrderAnalyticsSortOptions" }, { "type": "null" } ], "description": "Parameter to sort results by" }, "start_date__gte": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Start date (YYYY-MM-DD). Defaults to 4 weeks ago", "title": "Start Date Gte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "OrderAnalyticsListQueryParamsSchema", "type": "object" }, "OrderItemListQueryParamsSchema": { "description": "Schema for the OrderItemListExternalAPIController query parameters", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "order_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the order to filter by", "title": "Order Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "OrderItemListQueryParamsSchema", "type": "object" }, "OrderItemStatus": { "enum": [ "APPROVAL_NEEDED", "APPROVED", "CLINIC_CANCELED", "CLIENT_CANCELED", "CLINIC_CANCELED_REFUNDED", "CLINIC_CANCELED_CREDITED", "FAILED_SEND_TO_VENDOR", "SENT_TO_VENDOR", "TRIAGED", "VENDOR_CANCELED", "FULLY_SHIPPED", "PARTIALLY_SHIPPED", "DELIVERED" ], "title": "OrderItemStatus", "type": "string" }, "OrderList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalOrderAnalyticsSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "OrderList", "type": "object" }, "OrderStatus": { "enum": [ "APPROVAL_NEEDED", "APPROVED", "CANCELED", "PAYMENT_FAILED", "SENT_TO_VENDOR", "SHIPPED", "COMPLETED", "TRIAGED" ], "title": "OrderStatus", "type": "string" }, "OrganizationClientDetailPathParamsSchema": { "description": "Schema for the OrganizationClientDetailExternalAPIController path parameters", "properties": { "organization_client_id": { "description": "The ID of the organization client", "title": "Organization Client Id", "type": "integer" } }, "required": [ "organization_client_id" ], "title": "OrganizationClientDetailPathParamsSchema", "type": "object" }, "OrganizationClientPatchSchema": { "description": "Schema for the OrganizationClientPatchExternalAPIController request body", "properties": { "primary_clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to make this organization client's primary clinic. The clinic must be an eligible clinic in the current primary clinic's active clinic network.", "title": "Primary Clinic Id" } }, "title": "OrganizationClientPatchSchema", "type": "object" }, "OrganizationInventoryPreference": { "properties": { "clinic_location_group_ids": { "description": "Which clinic location groups this inventory code is relevant to within your organization", "items": { "type": "integer" }, "title": "Clinic Location Group Ids", "type": "array" }, "grade": { "anyOf": [ { "$ref": "#/components/schemas/InventoryGrade" }, { "const": "", "type": "string" } ], "description": "The grade (importance) assigned to this type of inventory by your organization", "title": "Grade" }, "is_enabled": { "description": "Whether this inventory code is enabled for your organization", "title": "Is Enabled", "type": "boolean" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name assigned to this type of inventory by your organization. Can be null if you are inheriting Vetcove's default", "title": "Name" }, "unit_of_measure": { "anyOf": [ { "$ref": "#/components/schemas/InventoryUnitOfMeasure" }, { "type": "null" } ], "description": "The settings for how units of this inventory are measured as set by your organization. Can be null if you are inheriting Vetcove's default" } }, "required": [ "is_enabled", "name", "unit_of_measure", "grade", "clinic_location_group_ids" ], "title": "OrganizationInventoryPreference", "type": "object" }, "OrganizationPatientDetailPathParamsSchema": { "description": "Schema for the OrganizationPatientDetailExternalAPIController path parameters", "properties": { "organization_patient_id": { "description": "The ID of the organization patient to fetch", "title": "Organization Patient Id", "type": "integer" } }, "required": [ "organization_patient_id" ], "title": "OrganizationPatientDetailPathParamsSchema", "type": "object" }, "PDFDetailPathParamsSchema": { "description": "Schema for the PDFDetailExternalAPIController path parameters", "properties": { "key": { "description": "The key of the generated PDF to fetch", "title": "Key", "type": "string" } }, "required": [ "key" ], "title": "PDFDetailPathParamsSchema", "type": "object" }, "PastelColor": { "enum": [ "SLATE", "RED", "POMEGRANATE", "ORANGE", "AMBER", "YELLOW", "LIME", "GREEN", "EMERALD", "TEAL", "CYAN", "SKY", "BLUE", "INDIGO", "VIOLET", "PURPLE", "FUCHSIA", "PINK", "WATERMELON", "ROSE" ], "title": "PastelColor", "type": "string" }, "PatientBreed": { "enum": [ "AFFENPINSCHER", "AFGHAN_HOUND", "AFRICAN_VILLAGE_DOG", "AIREDALE_TERRIER", "AKITA", "AKITA_INU", "JAPANESE_AKITA", "ALASKAN_KLEE_KAI", "ALASKAN_MALAMUTE", "ALASKAN_TYPE_HUSKY", "AMERICAN_BULLDOG", "AMERICAN_ENGLISH_COONHOUND", "REDTICK_COONHOUND", "ENGLISH_COONHOUND", "AMERICAN_ESKIMO_DOG", "AMERICAN_FOXHOUND", "AMERICAN_HAIRLESS_TERRIER", "AMERICAN_LEOPARD_HOUND", "AMERICAN_PIT_BULL_TERRIER", "AMERICAN_STAFFORDSHIRE_TERRIER", "AMERICAN_VILLAGE_DOG", "AMERICAN_WATER_SPANIEL", "ANATOLIAN_SHEPHERD_DOG", "KANGAL", "APPENZELLER_SENNENHUND", "ARABIAN_VILLAGE_DOG", "ARMENIAN_GAMPR", "AUSTRALIAN_CATTLE_DOG", "BLUE_HEELER", "AUSTRALIAN_KELPIE", "AUSTRALIAN_SHEPHERD", "AUSTRALIAN_TERRIER", "AZAWAKH", "BARBET", "BASENJI", "BASSET_FAUVE_DE_BRETAGNE", "BASSET_HOUND", "BAVARIAN_MOUNTAIN_SCENT_HOUND", "BAVARIAN_MOUNTAIN_HOUND", "BEAGLE", "BEARDED_COLLIE", "BEAUCERON", "BEDLINGTON_TERRIER", "BELGIAN_LAEKENOIS", "BELGIAN_MALINOIS", "BELGIAN_SHEEPDOG", "GROENENDAEL", "BELGIAN_TERVUREN", "BERGAMASCO_SHEEPDOG", "BERGER_PICARD", "BERNESE_MOUNTAIN_DOG", "BICHON_FRISE", "BIEWER_TERRIER", "BLACK_RUSSIAN_TERRIER", "BLACK_AND_TAN_COONHOUND", "BLOODHOUND", "BLUE_LACY", "BLUE_PICARDY_SPANIEL", "BLUETICK_COONHOUND", "BOERBOEL", "SOUTH_AFRICAN_MASTIFF", "BOHEMIAN_SHEPHERD", "BOLOGNESE", "BORDER_COLLIE", "BORDER_TERRIER", "BORZOI", "BOSTON_TERRIER", "BOUVIER_DES_FLANDRES", "BOXER", "BOYKIN_SPANIEL", "BRACCO_ITALIANO", "BRAQUE_DAUVERGNE", "BRAQUE_DU_BOURBONNAIS", "BRAQUE_FRANCAIS_PYRENEAN", "BRIARD", "BRITTANY", "BRUSSELS_GRIFFON", "BULL_TERRIER", "BULLDOG", "ENGLISH_BULLDOG", "BULLMASTIFF", "CAIRN_TERRIER", "CANAAN_DOG", "CANADIAN_ESKIMO_DOG", "CANE_CORSO", "CANE_DI_FONNI", "CARDIGAN_WELSH_CORGI", "CAROLINA_DOG", "AMERICAN_DINGO", "CATAHOULA_LEOPARD_DOG", "CAUCASIAN_OVCHARKA", "CAUCASIAN_SHEPHERD_DOG", "CAVALIER_KING_CHARLES_SPANIEL", "CENTRAL_ASIAN_SHEPHERD_DOG", "CENTRAL_ASIAN_VILLAGE_DOG", "CENTRAL_AND_EAST_AFRICAN_VILLAGE_DOG", "CESKY_FOUSEK", "CESKY_TERRIER", "CHESAPEAKE_BAY_RETRIEVER", "CHIHUAHUA", "CHINESE_CHONGQING_DOG", "CHINESE_CRESTED", "CHINESE_SHAR_PEI", "CHINESE_VILLAGE_DOG", "CHINOOK", "CHOW_CHOW", "CIMARRON_URUGUAYO", "CIRNECO_DELL_ETNA", "CLUMBER_SPANIEL", "COCKER_SPANIEL", "COLLIE", "COLOMBIAN_FINO_HOUND", "COTON_DE_TULEAR", "COYOTE", "CURLY_COATED_RETRIEVER", "CZECHOSLOVAKIAN_VLCAK", "DACHSHUND", "DALMATIAN", "DACHSHUND_STANDARD", "DACHSHUND_MINIATURE", "DANDIE_DINMONT_TERRIER", "DANISH_SWEDISH_FARMDOG", "DINGO", "DOBERMAN_PINSCHER", "DOGO_ARGENTINO", "DOGUE_DE_BORDEAUX", "FRENCH_MASTIFF", "DRENTSCHE_PATRIJSHOND", "DUTCH_SHEPHERD", "EAST_ASIAN_VILLAGE_DOG", "EASTERN_EUROPEAN_VILLAGE_DOG", "ENGLISH_COCKER_SPANIEL", "ENGLISH_FOXHOUND", "ENGLISH_SETTER", "ENGLISH_SHEPHERD", "ENGLISH_SPRINGER_SPANIEL", "ENGLISH_TOY_SPANIEL", "ENTLEBUCHER_MOUNTAIN_DOG", "EURASIER", "EUROPEAN_VILLAGE_DOG", "FIELD_SPANIEL", "FILA_BRASILEIRO", "FINNISH_LAPPHUND", "FINNISH_SPITZ", "FLAT_COATED_RETRIEVER", "FORMOSAN_MOUNTAIN_DOG", "TAIWAN_DOG", "FRENCH_BULLDOG", "FRENCH_SPANIEL", "GERMAN_LONGHAIRED_POINTER", "DEUTSCH_LANGHAAR", "GERMAN_PINSCHER", "GERMAN_SHEPHERD_DOG", "GERMAN_SHORTHAIRED_POINTER", "GERMAN_SPITZ", "GERMAN_WIREHAIRED_POINTER", "GIANT_SCHNAUZER", "GLEN_OF_IMAAL_TERRIER", "GOLDEN_RETRIEVER", "GORDON_SETTER", "GRAND_BASSET_GRIFFON_VENDEEN", "GRAY_WOLF", "GREAT_DANE", "GREAT_PYRENEES", "GREATER_SWISS_MOUNTAIN_DOG", "GREENLAND_DOG", "GREENLAND_SLEDGE_DOG", "GREYHOUND", "HAMILTONSTOVARE", "HARRIER", "HAVANESE", "HOKKAIDO", "HOVAWART", "IBIZAN_HOUND", "ICELANDIC_SHEEPDOG", "INDIAN_INDIGENOUS_DOG", "IRISH_RED_AND_WHITE_SETTER", "IRISH_SETTER", "IRISH_TERRIER", "IRISH_WATER_SPANIEL", "IRISH_WOLFHOUND", "ISTRIAN_SHORTHAIRED_HOUND", "ITALIAN_GREYHOUND", "JAGDTERRIER", "JAMTHUND", "JAPANESE_CHIN", "JAPANESE_SPITZ", "JINDO", "KAI_KEN", "KARAKACHAN", "KARELIAN_BEAR_DOG", "KEESHOND", "KERRY_BLUE_TERRIER", "KISHU_KEN", "KOMONDOR", "KUVASZ", "LABRADOR_RETRIEVER", "LAGOTTO_ROMAGNOLO", "LAKELAND_TERRIER", "LANCASHIRE_HEELER", "LAPPONIAN_HERDER", "LEONBERGER", "LEVRIERO_MERIDIONALE", "LHASA_APSO", "LLEWELLIN_SETTER", "LOWCHEN", "MALTESE", "MANCHESTER_TERRIER_STANDARD", "MANCHESTER_TERRIER_TOY", "MAREMMA_SHEEPDOG", "MARKIESJE", "DUTCH_TULIP_HOUND", "MASTIFF", "ENGLISH_MASTIFF", "MI_KI", "MINIATURE_BULL_TERRIER", "MINIATURE_PINSCHER", "MINIATURE_SCHNAUZER", "MINIATURE_AUSTRALIAN_SHEPHERD", "MOUNTAIN_CUR", "MUDI", "MUNSTERLANDER_LARGE", "MUNSTERLANDER_SMALL", "MURRAY_RIVER_RETRIEVER", "MURRAY_RIVER_CURLY_COATED_RETRIEVER", "NEAPOLITAN_MASTIFF", "NEDERLANDSE_KOOIKERHONDJE", "NEW_GUINEA_SINGING_DOG", "NEW_ZEALAND_HUNTAWAY", "NEWFOUNDLAND", "NORFOLK_TERRIER", "NORRBOTTENSPETS", "NORTHERN_EAST_AFRICAN_VILLAGE_DOG", "NORWEGIAN_BUHUND", "NORWEGIAN_ELKHOUND", "NORWEGIAN_LUNDEHUND", "NORWICH_TERRIER", "NOVA_SCOTIA_DUCK_TOLLING_RETRIEVER", "OLD_ENGLISH_SHEEPDOG", "OTTERHOUND", "PAPILLON", "PEKINGESE", "PEMBROKE_WELSH_CORGI", "PERDIGUERO_DE_BURGOS", "PERRO_DE_PRESA_CANARIO", "PERUVIAN_INCA_ORCHID", "PETIT_BASSET_GRIFFON_VENDEEN", "PHARAOH_HOUND", "PHU_QUOC_RIDGEBACK", "PICARDY_SPANIEL", "PLOTT", "POINTER", "ENGLISH_POINTER", "POLISH_LOWLAND_SHEEPDOG", "POLISH_TATRA_SHEEPDOG", "POLYNESIAN_VILLAGE_DOG", "POMERANIAN", "TOY_POODLE", "MINIATURE_POODLE", "POODLE_STANDARD", "PORTUGUESE_PODENGO", "PORTUGUESE_PODENGO_PEQUENO", "PORTUGUESE_POINTER", "PORTUGUESE_WATER_DOG", "PRAGUE_RATTER", "PUDELPOINTER", "PUG", "PULI", "PUMI", "PUNGSAN", "PYRENEAN_MASTIFF", "PYRENEAN_SHEPHERD", "RAT_TERRIER", "REDBONE_COONHOUND", "RHODESIAN_RIDGEBACK", "ROTTWEILER", "JACK_RUSSELL_TERRIER", "RUSSIAN_TOY", "RUSSIAN_TSVETNAYA_BOLONKA", "RUSSELL_TERRIER", "PARSON_RUSSELL_TERRIER", "SAINT_BERNARD", "SALUKI", "SAMOYED", "SARPLANINAC", "SCHAPENDOES", "SCHIPPERKE", "SCOTTISH_DEERHOUND", "SCOTTISH_TERRIER", "SEALYHAM_TERRIER", "SHETLAND_SHEEPDOG", "SHIBA_INU", "SHIH_TZU", "SHIKOKU", "SHILOH_SHEPHERD", "SIBERIAN_HUSKY", "SILKEN_WINDHOUND", "MIXED_BREED", "SILKY_TERRIER", "SKYE_TERRIER", "SLOUGHI", "SLOVENSKY_CUVAC", "SMOOTH_FOX_TERRIER", "SOFT_COATED_WHEATEN_TERRIER", "SPANISH_GALGO", "SPANISH_MASTIFF", "SPANISH_WATER_DOG", "SPINONE_ITALIANO", "STABYHOUN", "STAFFORDSHIRE_BULL_TERRIER", "STANDARD_SCHNAUZER", "SUSSEX_SPANIEL", "SWEDISH_LAPPHUND", "SWEDISH_VALLHUND", "TEDDY_ROOSEVELT_TERRIER", "TERRIER_BRASILEIRO", "THAI_BANGKAEW", "THAI_RIDGEBACK", "TIBETAN_MASTIFF", "TIBETAN_SPANIEL", "TIBETAN_TERRIER", "TOSA_INU", "TOY_FOX_TERRIER", "TREEING_WALKER_COONHOUND", "VIETNAMESE_VILLAGE_DOG", "VIZSLA", "VOLPINO_ITALIANO", "WEIMARANER", "WELSH_SHEEPDOG", "WELSH_SPRINGER_SPANIEL", "WELSH_TERRIER", "WEST_HIGHLAND_WHITE_TERRIER", "WEST_SIBERIAN_LAIKA", "WESTERN_EUROPEAN_VILLAGE_DOG", "WETTERHOUN", "FRISIAN_WATER_DOG", "WHIPPET", "WHITE_SHEPHERD", "WHITE_SWISS_SHEPHERD", "BERGER_BLANC_SUISSE", "WINDSPRITE", "LONGHAIRED_WHIPPET", "WIRE_FOX_TERRIER", "WIREHAIRED_POINTING_GRIFFON", "WIREHAIRED_VIZSLA", "XOLOITZCUINTLI", "MEXICAN_HAIRLESS", "YAKUTIAN_LAIKA", "YORKSHIRE_TERRIER", "SILKEN_WINDSPRITE", "GOLDENDOODLE", "LABRADOODLE", "BERNEDOODLE", "AUSSIEDOODLE", "SHEEPADOODLE", "FEIST", "MINIATURE_AMERICAN_SHEPHERD", "CAVACHON", "ARCTIC_FOX", "FENNEC_FOX", "GREY_FOX", "RED_FOX", "SWIFT_FOX", "ABYSSINIAN", "AMERICAN_BOBTAIL", "AMERICAN_CURL", "AMERICAN_SHORTHAIR", "AMERICAN_WIREHAIR", "BALINESE", "BENGAL", "BIRMAN", "BOMBAY", "BRITISH_SHORTHAIR", "BURMESE", "BURMILLA", "CHARTREUX", "COLORPOINT_SHORTHAIR", "CORNISH_REX", "DEVON_REX", "EGYPTIAN_MAU", "EUROPEAN_BURMESE", "EXOTIC", "HAVANA_BROWN", "JAPANESE_BOBTAIL", "KHAO_MANEE", "KORAT", "LAPERM", "LYKOI", "MAINE_COON", "MANX", "MUNCHKIN", "NORWEGIAN_FOREST_CAT", "OCICAT", "ORIENTAL", "PERSIAN", "RAGAMUFFIN", "RAGDOLL", "RUSSIAN_BLUE", "SCOTTISH_FOLD", "SELKIRK_REX", "SIAMESE", "SIBERIAN", "SINGAPURA", "SOMALI", "SPHYNX", "TONKINESE", "TOYBOB", "TURKISH_ANGORA", "TURKISH_VAN", "DOMESTIC_SHORTHAIR_DSH", "DOMESTIC_LONGHAIR_DLH", "DOMESTIC_MEDIUMHAIR_DMH", "HIMALAYAN", "NEBELUNG", "COLD_BLOOD", "PINTO", "PAINT", "QUARTER_HORSE", "SADDLEBRED", "THOROUGHBRED", "BELGIAN", "GRADE", "PONY", "BELGIUM_WARMBLOOD", "CLEVELAND_BAY", "DONKEY", "DUTCH_WARMBLOOD", "HACKNEY", "HAFLINGER", "HANOVERIAN", "IRISH_SPORTHORSE", "KENTUCKY_MOUNTAIN_HORSE", "MINIATURE_DONKEY", "MULE", "PERCHERON", "ROCKY_MOUNTAIN_HORSE", "SHETLAND_PONY", "STANDARDBRED", "SWEDISH_WARMBLOOD", "AMERICAN_SADDLEBRED", "APPALOOSA", "ARABIAN", "CLYDESDALE", "MINIATURE_HORSE", "MISSOURI_FOX_TROTTER", "MORGAN", "MUSTANG", "PALAMINO", "PERUVIAN_PASO_FINO", "TENNESSEE_WALKER", "WARMBLOOD", "ANDALUSIAN", "FRIESIAN", "BURRO", "ARAB_CROSS", "GYPSY_VANNER", "LIPPIZZAN", "LUSITANO", "QUARTER_HORSE_CROSS", "SPANISH_BARB", "THOROUGHBRED_CROSS", "WARMBLOOD_CROSS", "WELSH", "AMERICAN_QUARTER_HORSE", "ARDENNES", "AUSTRALIAN_WARMBLOOD", "AMERICAN_WARMBLOOD", "BURMESE_HORSE", "CASPIAN_HORSE", "CORSICAN_HORSE", "DANISH_WARMBLOOD", "ESTONIAN_DRAFT", "FLEUVE", "OLDENBURG", "SPOTTED_SADDLE_HORSE", "IRISH_DRAFT", "DRAFT", "FJORD", "BUDGIE", "BLUE_FRONTED_AMAZON", "MACAW", "COCKATIEL", "COCKATOO", "ORANGE_WINGED_AMAZON", "WHITE_FRONTED_AMAZON", "YELLOW_NAPED_AMAZON", "FISCHERS_LOVEBIRD", "GREEN_WINGED_MACAW", "SCARLET_MACAW", "SENEGAL_PARROT", "LORY", "CONURE", "PARROTLET", "BLUE_AND_GOLD_MACAW", "CHESTNUT_FRONTED_MACAW", "HAHNS_MACAW", "HYACINTH_MACAW", "MILITARY_MACAW", "NOBLE_MACAW", "RED_BELLIED_MACAW", "RED_SHOULDERED_MACAW", "SEVERE_MACAW", "AFRICAN_GREY", "CONGO_AFRICAN_GREY", "TIMNEH_AFRICAN_GREY", "AMAZON", "CUBAN_AMAZON", "DOUBLE_YELLOW_HEADED_AMAZON", "FINSCHS_AMAZON", "GREEN_CHEEKED_AMAZON", "HISPANIOLAN_AMAZON", "LILAC_CROWNED_AMAZON", "MEALY_AMAZON", "MEXICAN_RED_HEAD_AMAZON", "PUERTO_RICAN_AMAZON", "RED_LORED_AMAZON", "SPECTACLED_AMAZON", "TUCUMAN_AMAZON", "YELLOW_CROWNED_AMAZON", "YELLOW_HEADED_AMAZON", "BLACK_HEADED_CAIQUE", "WHITE_BELLIED_CAIQUE", "BLACK_CAPPED_CONURE", "BLUE_CROWNED_CONURE", "CITRON_CRESTED_COCKATOO", "CORELLA", "DUSKY_HEADED_CONURE", "GALAH", "GREEN_CHEEKED_CONURE", "GOFFINS_COCKATOO", "GREEN_CONURE", "JENDAYA_CONURE", "LEADBEATER_COCKATOO", "MAROON_BELLIED_CONURE", "MITRED_CONURE", "MAJOR_MITCHELL_COCKATOO", "MOLUCCAN_COCKATOO", "NANDAY_CONURE", "ORANGE_FRONTED_CONURE", "PALM_COCKATOO", "PAINTED_CONURE", "PATAGONIAN_CONURE", "ROSE_BREASTED_COCKATOO", "SALMON_CRESTED_COCKATOO", "SUN_CONURE", "SULFUR_CRESTED_COCKATOO", "UMBRELLA_COCKATOO", "WHITE_EYED_CONURE", "WHITE_COCKATOO", "ECLECTUS", "HAWKHEAD", "LORIKEET", "GOLDIES_LORIKEET", "MUSK_LORIKEET", "PERFECT_LORIKEET", "RAINBOW_LORIKEET", "BLACK_CAPPED_LORY", "BLUE_STREAKED_LORY", "CHATTERING_LORY", "RED_LORY", "LOVEBIRD", "PEACHFACED_LOVEBIRD", "PARROT", "BROWN_HEADED_PARROT", "CAPE_PARROT", "GREY_HEADED_PARROT", "JARDINES_PARROT", "MEYERS_PARROT", "RED_BELLIED_PARROT", "PIONUS", "BLUE_HEADED_PIONUS", "BRONZE_WINGED_PIONUS", "DUSKY_PIONUS", "MAXIMILIANS_PIONUS", "SCALY_HEADED_PIONUS", "WHITE_CAPPED_PIONUS", "AFRICAN_RINGNECK", "ALEXANDRINE_PARAKEET", "INDIAN_RINGNECK", "MOUSTACH_PARAKEET", "ROSE_BREASTED_PARAKEET", "ROSE_RINGED_PARAKEET", "MONK_QUAKER", "ROSELLA", "GREY_CHEEKED_PARAKEET", "BOURKES_PARAKEET", "REAGENT_PARAKEET", "SPLENDID_PARAKEET", "SUPERB_PARAKEET", "ROCK_PEBBLER_PARAKEET", "PARAKEET", "YELLOW_COLLARED", "CAIQUE", "BARE_EYED_COCKATOO", "DOMESTIC_DUCK", "DUCK", "MALLARD_DUCK", "PEKIN_DUCK", "DOMESTIC_GOOSE", "GOOSE", "BLACK_SWAN", "MUTE_SWAN", "SWAN", "TRUMPTER_SWAN", "WHISTLING_SWAN", "WHOOPER_SWAN", "HERON", "IBIS", "LOON", "STORK", "DOVE", "MOURNING_DOVE", "RING_NECK_DOVE", "PIGEON", "ROCK_DOVE", "CHICKEN_HEN", "CHICKEN", "CHICKEN_ROOSTER", "GROUSE", "GUINEAFOWL", "PARTRIDGE", "PEACOCK", "PEAFOWL", "PEAHEN", "PHEASANT", "QUAIL", "DOMESTIC_TURKEY", "TURKEY", "WILD_TURKEY", "AFRICAN_CROWNED_CRANE", "CRANE", "SANDHILL_CRANE", "WHOOPING_CRANE", "BLACKBIRD", "CROW", "BENGALESE_FINCH", "FINCH", "GOLDFINCH", "GOULDIAN_FINCH", "HOUSE_FINCH", "SOCIETY_FINCH", "ZEBRA_FINCH", "GRACKLE", "MYNAH", "RAVEN", "ROBIN", "PASSERINE", "SONGBIRD", "SPARROW", "STARLING", "CORMORANT", "PELICAN", "PHOENICOPTERIFORME_FLAMINGO", "KEEL_BILLED_TOUCAN", "TOUCAN", "TOCO_TOUCAN", "CONDOR", "BALD_EAGLE", "EAGLE", "GOLDEN_EAGLE", "FALCON", "PEREGRINE", "BAY_WINGED_HAWK", "HAWK", "HARRIS_HAWK", "RED_TAIL_HAWK", "KESTREL", "OSPREY", "BARN_OWL", "BARRED_OWL", "GREAT_GREY_OWL", "GREAT_HORNED_OWL", "OWL", "SCREECH_OWL", "SNOWY_OWL", "TURKEY_VULTURE", "VULTURE", "AFRICAN_PENGUIN", "JACKASS_PENGUIN", "PENGUIN", "HORNBILL", "ROOSTER", "CANARY", "HOLSTEIN", "BLACK_ANGUS", "CHAROLAIS", "GELBVIEH", "HEREFORD", "HIGHLANDS", "LIMOUSIN", "RED_ANGUS", "SIMMENTAL", "TEXAS_LONGHORN", "KUDU", "BISON", "ANGORA", "DUTCH_BELTED_RABBIT", "DWARF_RABBIT", "FLEMISH_RABBIT", "LION_HEAD_RABBIT", "LOP_EARED_RABBIT", "NEW_ZEALAND_WHITE_RABBIT", "MINI_LOP", "REX_RABBIT", "DOMESTIC_RABBIT", "NETHERLAND_DWARF", "POLISH", "CALIFORNIAN", "JERSEY_WOOLY", "HOTOT", "MINI_REX", "HOLLAND_LOP", "FRENCH_LOP", "SATIN", "ENGLISH_SPOT", "NEW_ZEALAND", "CHECKERED", "HARLEQUIN", "CHINCHILLA", "CHINESE_STRIPED_HAMSTER", "DEGU", "DUPRASI_FAT_TAILED_GERBIL", "GOLDEN_SYRIAN_HAMSTER", "GUINEA_PIG", "JIRD_GERBIL", "MOUSE", "NMRI_MOUSE", "PRAIRIE_DOG", "RAT", "RUSSIAN_DWARF_HAMSTER", "SPRAGUE_DAWLEY_RAT", "SQUIRREL", "SQUIRREL_GREY_BLACK", "BEAVER", "PORCUPINE", "CAPYBARA", "CAVY", "CHIPMUNK", "BEARDED_DRAGON", "BOA_CONSTRICTOR", "BOA", "EMERALD_TREE_BOA", "RED_TAILED_BOA", "ALLIGATOR", "CAIMAN", "CROCODILE", "CHAMELEON", "JACKSONS_CHAMELEON", "PANTHER_CHAMELEON", "REUNION_ISLAND_CHAMELEON", "VEILED_CHAMELEON", "CRESTED_GECKO", "GECKO", "LEOPARD_GECKO", "NEW_CALEDONIAN_GECKO", "GREEN_IGUANA", "IGUANA", "KOMODO_DRAGON", "LIZARD", "DUMERILS_MONITOR", "MONITOR", "SAVANNA_MONITOR", "WATER_MONITOR", "WHITE_THROATED_MONITOR", "ASIAN_ROCK_PYTHON", "BALL_PYTHON", "BURMESE_PYTHON", "CARPET_PYTHON", "DIAMOND_PYTHON", "PYTHON", "ROYAL_PYTHON", "TREE_PYTHON", "SKINK", "TEGU", "SNAKE", "CORN_SNAKE", "GARTER_SNAKE", "GOPHER_SNAKE", "HOG_NOSED_SNAKE", "KING_SNAKE", "MILK_SNAKE", "PINE_SNAKE", "RAT_SNAKE", "RATTLESNAKE", "VIPER", "TORTOISE", "ALDABRA_TORTOISE", "AFRICAN_SPURRED_TORTOISE", "DESERT_TORTOISE", "EGYPTIAN_TORTOISE", "GALAPAGOS_TORTOISE", "GOPHER_TORTOISE", "GREEK_TORTOISE", "LEOPARD_TORTOISE", "RUSSIAN_TORTOISE", "STAR_TORTOISE", "SULCATA_TORTOISE", "CHERRY_HEAD_TORTOISE", "RED_FOOTED_TORTOISE", "YELLOW_FOOTED_TORTOISE", "ATLANTIC_GREEN_TURTLE", "ATLANTIC_RIDLEY_TURTLE", "AFRICAN_SIDE_NECK_TURTLE", "BOX_TURTLE", "DIAMONDBACK_TERRAPIN", "LOGGERHEAD_TURTLE", "PAINTED_TURTLE", "RED_EAR_SLIDER_TURTLE", "TURTLE", "SLIDER", "SNAPPING_TURTLE", "YELLOW_BELLIED_SLIDER", "SPINY_TAILED_LIZARD", "UROMASTYX", "AUSTRALIAN_WATER_DRAGON", "CHINESE_WATER_DRAGON", "FRILLED_DRAGON", "WATER_DRAGON", "SERRATED_FOREST_HINGEBACK_TORTOISE", "WOOD_TURTLE", "ANOLE", "FALSE_CHAMELEON", "ALLIGATOR_LIZARD", "AXOLOTL", "FROG", "MUD_PUPPY", "SALAMANDER", "TOAD", "TREE_FROG", "PACMAN_FROG", "BULL_FROG", "AFRICAN_DWARF_FROG", "AFRICAN_CLAWED_FROG", "GOLDFISH", "KOI", "EEL", "RAY", "SHARK", "GOTTINGEN_MINI", "COMMERCIAL_CROSS", "LARGE_WHITE_X", "HANFORD", "MINI_PIG", "POT_BELLIED_PIG", "SINCLAIR", "YORKSHIRE_X", "YUCATAN", "YUCATAN_MINI", "AFRICANBUSH_PIG", "BABIRUSA_PIG", "CWARTHOG_PIG", "DOMESTIC_PIG", "YORKSHIRE", "HAMPSHIRE_PIG", "VIETNAMESE_POTBELLIED_PIG", "WHITE_YORKSHIRE_LANDRACE", "ALPINE_X", "ALPINE", "BOER_X", "BOER", "CASHMERE", "LA_MANCHA", "NUBIAN", "NIGERIAN_DWARF", "OBERHASLI", "NUBIAN_X", "PYGMY_GOAT", "PYGORA", "SAANEN", "TOGGENBURG", "DOMESTIC_GOAT", "ANGORA_GOAT", "ROCKY_MOUNTAIN_GOAT", "BARBADO", "BORDER_LEICESTER", "BIGHORN_SHEEP", "DORSET", "CHEVIOT", "DORSET_X", "HAMPSHIRE_SHEEP", "MERINO", "SHETLAND", "SUFFOLK_X", "SUFFOLK", "DOMESTIC_SHEEP", "DALL_SHEEP", "LLAMA", "ALPACA", "CAMEL", "ALPACA_HUACAYA", "ALPACA_SURI", "ARABIAN_DROMEDARIAN_CAMEL", "BACTRIAN_CAMEL", "EMU", "OSTRICH", "SUGAR_GLIDER", "OPOSSUM", "FERRET", "WEASEL", "MINK", "ELK", "DEER", "RACCOON", "COATI", "HEDGEHOG", "SKUNK", "UNKNOWN" ], "title": "PatientBreed", "type": "string" }, "PatientBreedListQueryParamsSchema": { "description": "Schema for the PatientBreedListExternalAPIController query parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "patient_kind": { "$ref": "#/components/schemas/PatientKind", "description": "Required. Filters to breeds applicable to patients of the given kind / species." }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "required": [ "patient_kind" ], "title": "PatientBreedListQueryParamsSchema", "type": "object" }, "PatientCarePlanActivatedWebhookPayload": { "properties": { "data": { "properties": { "care_plan.kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan.name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan.Name", "type": "string" }, "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "patient_care.billing_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Patient Care.Billing Client Id", "type": "integer" }, "patient_care.billing_clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Patient Care.Billing Clinic Id", "type": "integer" }, "patient_care.payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Patient Care.Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "patient_care.billing_clinic_id", "patient_care.billing_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan.name", "care_plan.kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "patient_care.payment_method_id" ], "title": "ExternalPatientCarePlanSchema", "type": "object" }, "type": { "const": "patient_care_plan.activated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_care_plan.activated payload", "type": "object" }, "PatientCarePlanCreatedWebhookPayload": { "properties": { "data": { "properties": { "care_plan.kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan.name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan.Name", "type": "string" }, "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "patient_care.billing_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Patient Care.Billing Client Id", "type": "integer" }, "patient_care.billing_clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Patient Care.Billing Clinic Id", "type": "integer" }, "patient_care.payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Patient Care.Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "patient_care.billing_clinic_id", "patient_care.billing_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan.name", "care_plan.kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "patient_care.payment_method_id" ], "title": "ExternalPatientCarePlanSchema", "type": "object" }, "type": { "const": "patient_care_plan.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_care_plan.created payload", "type": "object" }, "PatientCarePlanCurrentQueryParamsSchema": { "description": "Schema for the PatientCarePlanCurrentExternalAPIController path parameters", "properties": { "clinic_patient_id": { "description": "The ID of the patient to fetch the current care plan for", "title": "Clinic Patient Id", "type": "integer" } }, "required": [ "clinic_patient_id" ], "title": "PatientCarePlanCurrentQueryParamsSchema", "type": "object" }, "PatientCarePlanDeletedWebhookPayload": { "properties": { "data": { "properties": { "care_plan.kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan.name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan.Name", "type": "string" }, "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "patient_care.billing_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Patient Care.Billing Client Id", "type": "integer" }, "patient_care.billing_clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Patient Care.Billing Clinic Id", "type": "integer" }, "patient_care.payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Patient Care.Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "patient_care.billing_clinic_id", "patient_care.billing_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan.name", "care_plan.kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "patient_care.payment_method_id" ], "title": "ExternalPatientCarePlanSchema", "type": "object" }, "type": { "const": "patient_care_plan.deleted", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_care_plan.deleted payload", "type": "object" }, "PatientCarePlanDetailPathParamsSchema": { "description": "Schema for the PatientCarePlanDetailExternalAPIController path parameters", "properties": { "patient_care_plan_id": { "description": "The ID of the patient care plan to fetch", "title": "Patient Care Plan Id", "type": "integer" } }, "required": [ "patient_care_plan_id" ], "title": "PatientCarePlanDetailPathParamsSchema", "type": "object" }, "PatientCarePlanListQueryParamsSchema": { "description": "Schema for the PatientCarePlanListExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to patient care plans for the clinic client with this ID", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to patient care plans for the clinic with this ID", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to patient care plans for the clinic patient with this ID", "title": "Clinic Patient Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_billed_monthly": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When provided, filters to patient care plans by billing type. True returns plans billed monthly, False returns plans billed upfront.", "title": "Is Billed Monthly" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "type": "null" } ], "description": "When provided, filters to patient care plans with this status" } }, "title": "PatientCarePlanListQueryParamsSchema", "type": "object" }, "PatientCarePlanRenewedWebhookPayload": { "properties": { "data": { "properties": { "care_plan.kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan.name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan.Name", "type": "string" }, "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "patient_care.billing_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Patient Care.Billing Client Id", "type": "integer" }, "patient_care.billing_clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Patient Care.Billing Clinic Id", "type": "integer" }, "patient_care.payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Patient Care.Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "patient_care.billing_clinic_id", "patient_care.billing_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan.name", "care_plan.kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "patient_care.payment_method_id" ], "title": "ExternalPatientCarePlanSchema", "type": "object" }, "type": { "const": "patient_care_plan.renewed", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_care_plan.renewed payload", "type": "object" }, "PatientCarePlanStatus": { "enum": [ "IMPORTED", "CLIENT_CREATED", "CLINIC_CREATED", "ACTIVE", "TERMINATED", "PAYMENT_FAILED", "SUSPENDED" ], "title": "PatientCarePlanStatus", "type": "string" }, "PatientCarePlanUpdatedWebhookPayload": { "properties": { "data": { "properties": { "care_plan.kind": { "$ref": "#/components/schemas/CarePlanKind", "description": "The type of the care plan" }, "care_plan.name": { "description": "The name of the care plan this patient care plan is linked to", "title": "Care Plan.Name", "type": "string" }, "care_plan_id": { "description": "The ID of the Care Plan this patient-specific plan is linked to", "title": "Care Plan Id", "type": "integer" }, "clinic_patient_id": { "description": "The ID of the clinic patient this care plan is associated with", "title": "Clinic Patient Id", "type": "integer" }, "core_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the core patient care plan this one is linked to, if this is an add-on plan", "title": "Core Plan Id" }, "deactivated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this care plan was deactivated, if applicable", "title": "Deactivated At" }, "deactivated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the user who deactivated the care plan, if applicable", "title": "Deactivated By" }, "end_date": { "description": "End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.", "format": "date", "title": "End Date", "type": "string" }, "enrollment_fee": { "description": "The enrollment fee of the care plan", "minimum": 0, "title": "Enrollment Fee", "type": "integer" }, "id": { "description": "The unique identifier for the patient care plan", "title": "Id", "type": "integer" }, "is_billed_monthly": { "description": "Whether the care plan is billed monthly or upfront", "title": "Is Billed Monthly", "type": "boolean" }, "monthly_cost": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.", "title": "Monthly Cost" }, "next_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date of the next payment for the care plan, if applicable", "title": "Next Payment Date" }, "next_plan_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the next care plan, if applicable", "title": "Next Plan Id" }, "patient_care.billing_client_id": { "description": "The ID of the clinic client this patient care plan is associated with", "title": "Patient Care.Billing Client Id", "type": "integer" }, "patient_care.billing_clinic_id": { "description": "The ID of the clinic this patient care plan is associated with", "title": "Patient Care.Billing Clinic Id", "type": "integer" }, "patient_care.payment_method_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the payment method associated with this care plan", "title": "Patient Care.Payment Method Id" }, "plan_cost": { "description": "The cost of the care plan", "minimum": 0, "title": "Plan Cost", "type": "integer" }, "remaining_balance": { "description": "The remaining balance of the care plan, in cents", "title": "Remaining Balance", "type": "integer" }, "should_renew": { "description": "Whether this care plan will automatically be renewed", "title": "Should Renew", "type": "boolean" }, "start_date": { "description": "The start date of the care plan", "format": "date", "title": "Start Date", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "const": "", "type": "string" } ], "description": "The status of the patient care plan", "title": "Status" } }, "required": [ "id", "clinic_patient_id", "patient_care.billing_clinic_id", "patient_care.billing_client_id", "care_plan_id", "start_date", "end_date", "deactivated_at", "status", "core_plan_id", "next_plan_id", "should_renew", "plan_cost", "enrollment_fee", "care_plan.name", "care_plan.kind", "deactivated_by", "next_payment_date", "remaining_balance", "is_billed_monthly", "monthly_cost", "patient_care.payment_method_id" ], "title": "ExternalPatientCarePlanSchema", "type": "object" }, "type": { "const": "patient_care_plan.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_care_plan.updated payload", "type": "object" }, "PatientClientRelationshipDetailPathParamsSchema": { "properties": { "patient_client_relationship_id": { "description": "The ID of the patient client relationship to fetch", "title": "Patient Client Relationship Id", "type": "integer" } }, "required": [ "patient_client_relationship_id" ], "title": "PatientClientRelationshipDetailPathParamsSchema", "type": "object" }, "PatientClientRelationshipKind": { "enum": [ "OWNER" ], "title": "PatientClientRelationshipKind", "type": "string" }, "PatientClientRelationshipList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "PatientClientRelationshipList", "type": "object" }, "PatientClientRelationshipListQueryParamsSchema": { "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to relationships associated with the clinic client with the given ID.", "title": "Clinic Client Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to relationships associated with the clinic patient with the given ID.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filters to relationships with the given active status.", "title": "Is Active" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PatientClientRelationshipListQueryParamsSchema", "type": "object" }, "PatientColor": { "enum": [ "BLACK", "BROWN", "GRAY", "SILVER", "LILAC", "LIGHT_SILVER", "WHITE", "CREAM", "LIGHT_BROWN", "DARK_BROWN", "FAWN", "APRICOT", "TAN", "RUST", "CHESTNUT", "WHITE_FAWN", "BLACK_SILVER", "WHITE_LILAC", "LILAC_APRICOT", "WHITE_GRAY", "WHITE_BLACK", "BLACK_RUST", "BROWN_TAN", "BLACK_DARK_BROWN", "WHITE_SILVER", "WHITE_APRICOT", "BLACK_GRAY", "LIGHT_BROWN_FAWN", "BLACK_CREAM", "WHITE_BROWN", "WHITE_TAN", "BLACK_TAN", "BRINDLE", "RED", "BLUE", "BLACK_MERLE", "HARLEQUIN", "BLUE_MERLE", "RED_MERLE", "GOLDEN", "WHITE_BLACK_SPOTTED", "LILAC_WHITE", "ORANGE", "ORANGE_WHITE", "TABBY", "BROWN_TABBY", "GRAY_TABBY", "ORANGE_TABBY", "SEAL_POINT", "FLAME_POINT", "TORTOISESHELL", "DILUTE_TORTOISESHELL", "CALICO", "TUXEDO", "BROWN_WHITE", "BLACK_BROWN", "TRI_COLOR", "RED_TRI_COLOR", "BLUE_POINT", "YELLOW", "GREEN", "CHINCHILLA" ], "title": "PatientColor", "type": "string" }, "PatientCustomCareReminderCreatedWebhookPayload": { "properties": { "data": { "properties": { "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The due date of the patient care reminder.", "title": "Due Date" }, "id": { "description": "The ID of the this patient care reminder.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_past_due": { "description": "Whether the patient standard care is past due.", "title": "Is Past Due", "type": "boolean" }, "kind": { "const": "CUSTOM", "default": "CUSTOM", "description": "The type of patient care reminder.", "title": "Kind", "type": "string" }, "last_fulfilled_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date the patient care reminder was last fulfilled.", "title": "Last Fulfilled Date" }, "name": { "description": "The name of the patient care reminder.", "title": "Name", "type": "string" }, "patient_standard_care.universal_patient_id": { "description": "The organization patient ID this custom reminder is for.", "title": "Patient Standard Care.Universal Patient Id", "type": "integer" }, "patient_standard_care_id": { "description": "The ID of the patient standard care which this patient care reminder is associated with.", "title": "Patient Standard Care Id", "type": "integer" }, "standard_care_reminder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the standard care reminder which this patient care reminder is associated with. Only patient care reminders with kind `STANDARD` will be associated with a standard care reminder.", "title": "Standard Care Reminder Id" }, "status": { "$ref": "#/components/schemas/PatientOneOffReminderStatus", "description": "The status of the patient care reminder." } }, "required": [ "is_deleted", "deleted", "id", "status", "name", "patient_standard_care.universal_patient_id", "last_fulfilled_date", "due_date", "is_past_due", "patient_standard_care_id" ], "title": "ExternalPatientCustomCareReminderSchema", "type": "object" }, "type": { "const": "patient_custom_care_reminder.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_custom_care_reminder.created payload", "type": "object" }, "PatientCustomCareReminderListQueryParamsSchema": { "description": "Schema for the PatientCustomCareReminderExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client to which the clinic client with this ID belongs. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "title": "Clinic Client Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient to which the clinic patient with this ID belongs. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "title": "Clinic Patient Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "organization_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client with this ID. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`,or `organization_patient_id`.", "title": "Organization Client Id" }, "organization_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient with this ID. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "title": "Organization Patient Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PatientCustomCareReminderListQueryParamsSchema", "type": "object" }, "PatientCustomCareReminderUpdatedWebhookPayload": { "properties": { "data": { "properties": { "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The due date of the patient care reminder.", "title": "Due Date" }, "id": { "description": "The ID of the this patient care reminder.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_past_due": { "description": "Whether the patient standard care is past due.", "title": "Is Past Due", "type": "boolean" }, "kind": { "const": "CUSTOM", "default": "CUSTOM", "description": "The type of patient care reminder.", "title": "Kind", "type": "string" }, "last_fulfilled_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date the patient care reminder was last fulfilled.", "title": "Last Fulfilled Date" }, "name": { "description": "The name of the patient care reminder.", "title": "Name", "type": "string" }, "patient_standard_care.universal_patient_id": { "description": "The organization patient ID this custom reminder is for.", "title": "Patient Standard Care.Universal Patient Id", "type": "integer" }, "patient_standard_care_id": { "description": "The ID of the patient standard care which this patient care reminder is associated with.", "title": "Patient Standard Care Id", "type": "integer" }, "standard_care_reminder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The ID of the standard care reminder which this patient care reminder is associated with. Only patient care reminders with kind `STANDARD` will be associated with a standard care reminder.", "title": "Standard Care Reminder Id" }, "status": { "$ref": "#/components/schemas/PatientOneOffReminderStatus", "description": "The status of the patient care reminder." } }, "required": [ "is_deleted", "deleted", "id", "status", "name", "patient_standard_care.universal_patient_id", "last_fulfilled_date", "due_date", "is_past_due", "patient_standard_care_id" ], "title": "ExternalPatientCustomCareReminderSchema", "type": "object" }, "type": { "const": "patient_custom_care_reminder.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_custom_care_reminder.updated payload", "type": "object" }, "PatientKind": { "enum": [ "CANINE", "FELINE", "EQUINE", "AVIAN", "BOVINE", "FERRET", "RABBIT", "RODENT", "REPTILE", "AMPHIBIAN", "FISH", "PORCINE", "CAPRINE", "SHEEP", "CAMELID", "RATITE", "MARSUPIAL", "MUSTELID", "CERVID", "PROCYONIDAE", "ERINACEIDAE", "MEPHITIDAE", "OTHER", "UNSPECIFIED" ], "title": "PatientKind", "type": "string" }, "PatientLabDetailPathParamsSchema": { "description": "Schema for the PatientLabDetailExternalAPIController path parameters", "properties": { "patient_lab_id": { "description": "The ID of the patient lab to fetch", "title": "Patient Lab Id", "type": "integer" } }, "required": [ "patient_lab_id" ], "title": "PatientLabDetailPathParamsSchema", "type": "object" }, "PatientLabListQueryParamsSchema": { "description": "Schema for the PatientLabListExternalAPIController query parameters", "properties": { "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patient labs for the clinic with the given ID.", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patient labs for the patient with the given ID.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "include_results": { "default": false, "description": "When true, each patient lab in the response includes a nested 'results' array with structured lab result data. Default is false for performance.", "title": "Include Results", "type": "boolean" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/LabOrderDashboardStatus" }, { "type": "null" } ], "description": "Filters to patient labs with the given status." }, "types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PatientLabType" }, "type": "array" }, { "type": "null" } ], "description": "Filters to patient labs with the given list of types. IN_CLINIC and EXTERNAL are ordered labs.", "title": "Types" } }, "title": "PatientLabListQueryParamsSchema", "type": "object" }, "PatientLabType": { "description": "The different kinds of labs for dashboard", "enum": [ "IN_CLINIC", "EXTERNAL", "MANUAL", "IMPORTED" ], "title": "PatientLabType", "type": "string" }, "PatientNoteDetailPathParamsSchema": { "properties": { "patient_note_id": { "description": "The ID of the patient note to fetch or delete", "title": "Patient Note Id", "type": "integer" } }, "required": [ "patient_note_id" ], "title": "PatientNoteDetailPathParamsSchema", "type": "object" }, "PatientNoteKind": { "enum": [ "GENERAL", "COMMUNICATION", "DOCUMENTATION" ], "title": "PatientNoteKind", "type": "string" }, "PatientNoteListQueryParamsSchema": { "description": "Schema for the PatientNoteListExternalAPIController query parameters", "properties": { "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patient notes for the clinic patient with the given ID.", "title": "Clinic Patient Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PatientNoteListQueryParamsSchema", "type": "object" }, "PatientOneOffReminderStatus": { "enum": [ "ACTIVE", "INACTIVE", "NOT_MEDICALLY_NECESSARY", "DECLINED" ], "title": "PatientOneOffReminderStatus", "type": "string" }, "PatientStandardCareReminderCreatedWebhookPayload": { "properties": { "data": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The due date of the patient care reminder.", "title": "Due Date" }, "id": { "description": "The ID of the this patient care reminder.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_past_due": { "description": "Whether the patient standard care is past due.", "title": "Is Past Due", "type": "boolean" }, "kind": { "const": "STANDARD", "default": "STANDARD", "description": "The type of patient care reminder.", "title": "Kind", "type": "string" }, "last_fulfilled_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date the patient care reminder was last fulfilled.", "title": "Last Fulfilled Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_standard_care.universal_patient.universal_client.primary_clinic_id": { "description": "The ID of the clinic associated with this reminder's patient.", "title": "Patient Standard Care.Universal Patient.Universal Client.Primary Clinic Id", "type": "integer" }, "patient_standard_care.universal_patient.universal_client_id": { "description": "The organization client ID of the client who owns the patient this reminder is for.", "title": "Patient Standard Care.Universal Patient.Universal Client Id", "type": "integer" }, "patient_standard_care.universal_patient_id": { "description": "The organization patient ID this standard reminder is for.", "title": "Patient Standard Care.Universal Patient Id", "type": "integer" }, "patient_standard_care_id": { "description": "The ID of the patient standard care which this patient care reminder is associated with.", "title": "Patient Standard Care Id", "type": "integer" }, "standard_care_reminder.name": { "description": "The name of the patient care reminder.", "title": "Standard Care Reminder.Name", "type": "string" }, "standard_care_reminder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the standard care reminder which this patient care reminder is associated with. Only patient care reminders with kind `STANDARD` will be associated with a standard care reminder.", "title": "Standard Care Reminder Id" }, "status": { "$ref": "#/components/schemas/PatientStandardCareReminderStatus", "description": "The status of the patient care reminder." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "status", "standard_care_reminder.name", "patient_standard_care.universal_patient_id", "patient_standard_care.universal_patient.universal_client_id", "patient_standard_care.universal_patient.universal_client.primary_clinic_id", "last_fulfilled_date", "due_date", "is_past_due", "patient_standard_care_id", "standard_care_reminder_id" ], "title": "ExternalPatientStandardCareReminderSchema", "type": "object" }, "type": { "const": "patient_standard_care_reminder.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_standard_care_reminder.created payload", "type": "object" }, "PatientStandardCareReminderListQueryParamsSchema": { "description": "Schema for the PatientStandardCareReminderExternalAPIController query parameters.", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client to which the clinic client with this ID belongs.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for patients belonging to the clinic with this ID.", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient to which the clinic patient with this ID belongs.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "organization_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client with this ID.", "title": "Organization Client Id" }, "organization_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient with this ID.", "title": "Organization Patient Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PatientStandardCareReminderListQueryParamsSchema", "type": "object" }, "PatientStandardCareReminderStatus": { "enum": [ "ACTIVE", "INACTIVE", "NOT_MEDICALLY_NECESSARY", "DECLINED" ], "title": "PatientStandardCareReminderStatus", "type": "string" }, "PatientStandardCareReminderUpdatedWebhookPayload": { "properties": { "data": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The due date of the patient care reminder.", "title": "Due Date" }, "id": { "description": "The ID of the this patient care reminder.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_past_due": { "description": "Whether the patient standard care is past due.", "title": "Is Past Due", "type": "boolean" }, "kind": { "const": "STANDARD", "default": "STANDARD", "description": "The type of patient care reminder.", "title": "Kind", "type": "string" }, "last_fulfilled_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date the patient care reminder was last fulfilled.", "title": "Last Fulfilled Date" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "patient_standard_care.universal_patient.universal_client.primary_clinic_id": { "description": "The ID of the clinic associated with this reminder's patient.", "title": "Patient Standard Care.Universal Patient.Universal Client.Primary Clinic Id", "type": "integer" }, "patient_standard_care.universal_patient.universal_client_id": { "description": "The organization client ID of the client who owns the patient this reminder is for.", "title": "Patient Standard Care.Universal Patient.Universal Client Id", "type": "integer" }, "patient_standard_care.universal_patient_id": { "description": "The organization patient ID this standard reminder is for.", "title": "Patient Standard Care.Universal Patient Id", "type": "integer" }, "patient_standard_care_id": { "description": "The ID of the patient standard care which this patient care reminder is associated with.", "title": "Patient Standard Care Id", "type": "integer" }, "standard_care_reminder.name": { "description": "The name of the patient care reminder.", "title": "Standard Care Reminder.Name", "type": "string" }, "standard_care_reminder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the standard care reminder which this patient care reminder is associated with. Only patient care reminders with kind `STANDARD` will be associated with a standard care reminder.", "title": "Standard Care Reminder Id" }, "status": { "$ref": "#/components/schemas/PatientStandardCareReminderStatus", "description": "The status of the patient care reminder." } }, "required": [ "created", "modified", "is_deleted", "deleted", "id", "status", "standard_care_reminder.name", "patient_standard_care.universal_patient_id", "patient_standard_care.universal_patient.universal_client_id", "patient_standard_care.universal_patient.universal_client.primary_clinic_id", "last_fulfilled_date", "due_date", "is_past_due", "patient_standard_care_id", "standard_care_reminder_id" ], "title": "ExternalPatientStandardCareReminderSchema", "type": "object" }, "type": { "const": "patient_standard_care_reminder.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "patient_standard_care_reminder.updated payload", "type": "object" }, "PaymentDetailPathParamsSchema": { "properties": { "payment_id": { "description": "The ID of the payment to fetch", "title": "Payment Id", "type": "integer" } }, "required": [ "payment_id" ], "title": "PaymentDetailPathParamsSchema", "type": "object" }, "PaymentDisputeStatus": { "description": "Internal payment dispute status", "enum": [ "ACCEPTED", "DECLINED", "PENDING", "UNKNOWN" ], "title": "PaymentDisputeStatus", "type": "string" }, "PaymentLinkCallbackUrlsSchema": { "description": "Schema for payment link callback URLs", "properties": { "on_cancel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Redirect URL when payment is cancelled", "title": "On Cancel" }, "on_success": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Redirect URL after successful payment completion", "title": "On Success" } }, "title": "PaymentLinkCallbackUrlsSchema", "type": "object" }, "PaymentLinkDetailPathParamsSchema": { "description": "Schema for the PaymentLinkDetailExternalAPIController path parameters", "properties": { "payment_link_id": { "description": "The ID of the payment link to fetch", "title": "Payment Link Id", "type": "integer" } }, "required": [ "payment_link_id" ], "title": "PaymentLinkDetailPathParamsSchema", "type": "object" }, "PaymentLinkKind": { "enum": [ "INVOICE", "ESTIMATE", "APPOINTMENT", "CARE_PLAN", "CARE_PLAN_PAYMENT_METHOD_UPDATE" ], "title": "PaymentLinkKind", "type": "string" }, "PaymentLinkListQueryParamsSchema": { "description": "Query parameters for listing payment links", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters payment links by clinic client ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters payment links by clinic ID.", "title": "Clinic Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_expired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to payment links that have expired, and when `False`, filters to payment links that are still active. When `None`, then both are included.", "title": "Is Expired" }, "is_paid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to payment links that have been paid, and when `False`, filters to payment links that have no been paid. When `None`, then both are included.", "title": "Is Paid" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PaymentLinkListQueryParamsSchema", "type": "object" }, "PaymentLinkUpdatePathParamsSchema": { "description": "Schema for the PaymentLinksUpdateExternalAPIController path parameters", "properties": { "payment_link_id": { "description": "The ID of the payment link to update", "title": "Payment Link Id", "type": "integer" } }, "required": [ "payment_link_id" ], "title": "PaymentLinkUpdatePathParamsSchema", "type": "object" }, "PaymentListQueryParamsSchema": { "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to payments for this clinic client.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to payments for this clinic.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PaymentListQueryParamsSchema", "type": "object" }, "PaymentMethodDetailPathParamsSchema": { "description": "Schema for the PaymentMethodDetailExternalAPIController path parameters", "properties": { "payment_method_id": { "description": "The ID of the payment method to fetch", "title": "Payment Method Id", "type": "integer" } }, "required": [ "payment_method_id" ], "title": "PaymentMethodDetailPathParamsSchema", "type": "object" }, "PaymentMethodListQueryParamsSchema": { "description": "Schema for the PaymentMethodListExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": false, "description": "When provided, filters to payment methods for the clinic client with this ID", "title": "Clinic Client Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PaymentMethodListQueryParamsSchema", "type": "object" }, "PaymentType": { "enum": [ "CARD_SAVED", "CARD_READER", "CLIENT_CREDIT", "CASH", "CHECK", "CUSTOM" ], "title": "PaymentType", "type": "string" }, "PayoutDetailPathParamsSchema": { "description": "Path parameters for payout detail endpoint", "properties": { "payout_id": { "description": "ID of the payout to retrieve", "title": "Payout Id", "type": "integer" } }, "required": [ "payout_id" ], "title": "PayoutDetailPathParamsSchema", "type": "object" }, "PayoutListQueryParamsSchema": { "description": "Query parameters for listing payouts", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/StripePayoutStatus" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "Filter payouts by status. If omitted, defaults to 'paid'. Pass empty string ('') to get all statuses.", "title": "Status" } }, "title": "PayoutListQueryParamsSchema", "type": "object" }, "PhoneNumberOperator": { "enum": [ "EXACT", "SUFFIX" ], "title": "PhoneNumberOperator", "type": "string" }, "PrescriptionDetailPathParamsSchema": { "description": "Schema for the PrescriptionDetailExternalAPIController path parameters", "properties": { "prescription_id": { "description": "The ID of the prescription to fetch", "title": "Prescription Id", "type": "integer" } }, "required": [ "prescription_id" ], "title": "PrescriptionDetailPathParamsSchema", "type": "object" }, "PrescriptionHistoryListQueryParamsSchema": { "description": "Schema for the PrescriptionHistoryListExternalAPIController query parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the clinic client with this ID", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the clinic with this ID", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the clinic patient with this ID", "title": "Clinic Patient Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "prescription_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the prescription record with this ID", "title": "Prescription Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PrescriptionHistoryListQueryParamsSchema", "type": "object" }, "PrescriptionListQueryParamsSchema": { "description": "Schema for the PrescriptionListExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescriptions for the clinic client with this ID", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescriptions for the clinic with this ID", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescriptions for the clinic patient with this ID", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PrescriptionListQueryParamsSchema", "type": "object" }, "PrescriptionRequestEtailerResponseStatus": { "enum": [ "PENDING", "READY_TO_DENY", "READY_TO_APPROVE", "DENIED", "APPROVED" ], "title": "PrescriptionRequestEtailerResponseStatus", "type": "string" }, "PrescriptionRequestEtailerStatusReason": { "enum": [ "EXAM_OR_BLOODWORK_NEEDED", "CORRECT_PRODUCT_LINE_INCORRECT_ITEM", "NOT_A_PATIENT", "NOT_MEDICALLY_APPROPRIATE", "CONFLICTING_ORDER", "NO_CLIENT_RESPONSE", "PRICE", "AVAILABILITY", "STRONG_CLIENT_PREFERENCE", "SHIPPING_TIMES" ], "title": "PrescriptionRequestEtailerStatusReason", "type": "string" }, "PrescriptionRequestListQueryParamsSchema": { "properties": { "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to prescription requests belonging to the clinic with the given ID.", "title": "Clinic Id" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PrescriptionRequestListQueryParamsSchema", "type": "object" }, "PrescriptionRequestMedicalReviewStatus": { "enum": [ "UNREVIEWED", "NEEDS_REVIEW", "APPROVED", "DENIED" ], "title": "PrescriptionRequestMedicalReviewStatus", "type": "string" }, "PrescriptionRequestStatus": { "enum": [ "UNREVIEWED", "NEEDS_DOCTOR_REVIEW", "MEDICALLY_APPROVED", "MEDICALLY_DENIED", "READY_TO_DENY_FOR_ETAILER", "READY_TO_APPROVE_FOR_ETAILER", "DENIED_FOR_ETAILER", "APPROVED_FOR_ETAILER", "SPAM", "DUPLICATE" ], "title": "PrescriptionRequestStatus", "type": "string" }, "PrescriptionStatus": { "enum": [ "ACTIVE", "DRAFT", "DECLINED", "IMPORTED" ], "title": "PrescriptionStatus", "type": "string" }, "PricingGroupDetailPathParamsSchema": { "description": "Schema for the PricingGroupDetailExternalAPIController path parameters", "properties": { "pricing_group_id": { "description": "The ID of the pricing group to fetch", "title": "Pricing Group Id", "type": "integer" } }, "required": [ "pricing_group_id" ], "title": "PricingGroupDetailPathParamsSchema", "type": "object" }, "PricingGroupList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalPricingGroupListSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "PricingGroupList", "type": "object" }, "PricingGroupListQueryParamsSchema": { "description": "Schema for the PricingGroupListExternalAPIController query parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "PricingGroupListQueryParamsSchema", "type": "object" }, "ProductDetailPathParamsSchema": { "description": "Schema for catalog product detail path parameters.", "properties": { "product_id": { "description": "The ID of the catalog product", "title": "Product Id", "type": "integer" } }, "required": [ "product_id" ], "title": "ProductDetailPathParamsSchema", "type": "object" }, "ProductLineDetailPathParamsSchema": { "description": "Schema for catalog product line detail path parameters.", "properties": { "product_line_id": { "description": "The ID of the catalog product line", "title": "Product Line Id", "type": "integer" } }, "required": [ "product_line_id" ], "title": "ProductLineDetailPathParamsSchema", "type": "object" }, "ProductLineListQueryParamsSchema": { "description": "Schema for catalog product line list query parameters.", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ProductLineListQueryParamsSchema", "type": "object" }, "ProductListQueryParamsSchema": { "description": "Schema for catalog product list query parameters.", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ProductListQueryParamsSchema", "type": "object" }, "PurchaseOrderCreateSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic this purchase order belongs to", "title": "Clinic Id", "type": "integer" }, "order_datetime": { "description": "The datetime when the order was placed", "format": "date-time", "title": "Order Datetime", "type": "string" }, "po_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An optional purchase order number. If omitted, one is auto-generated.", "title": "Po Number" }, "purchase_order_items": { "description": "The line items to include in the purchase order", "items": { "$ref": "#/components/schemas/PurchaseOrderItemCreateSchema" }, "minItems": 1, "title": "Purchase Order Items", "type": "array" }, "supplier": { "description": "The name of the supplier for this order", "title": "Supplier", "type": "string" } }, "required": [ "clinic_id", "order_datetime", "supplier", "purchase_order_items" ], "title": "PurchaseOrderCreateSchema", "type": "object" }, "PurchaseOrderDetailPathParamsSchema": { "properties": { "purchase_order_id": { "description": "The ID of the purchase order to fetch", "title": "Purchase Order Id", "type": "integer" } }, "required": [ "purchase_order_id" ], "title": "PurchaseOrderDetailPathParamsSchema", "type": "object" }, "PurchaseOrderItemCreateSchema": { "properties": { "inventory_id": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The inventory id identifying the item to order. Must provide exactly one of inventory_shortcode or inventory_id, not both", "title": "Inventory Id" }, "inventory_shortcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The inventory shortcode (human-readable code) identifying the item to order. Must provide exactly one of inventory_shortcode or inventory_id, not both. Inventory shortcodes are deprecated for new integrations; supported during a deprecation window for existing callers.", "title": "Inventory Shortcode" }, "quantity": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "number" }, { "type": "string" } ], "description": "The quantity to order (must be greater than 0)", "title": "Quantity" }, "sku": { "default": "", "description": "An optional SKU identifier for this item", "title": "Sku", "type": "string" }, "total_price": { "default": 0, "description": "The total price for this line item, in cents", "minimum": 0, "title": "Total Price", "type": "integer" } }, "required": [ "quantity" ], "title": "PurchaseOrderItemCreateSchema", "type": "object" }, "PurchaseOrderItemDetailPathParamsSchema": { "properties": { "purchase_order_item_id": { "description": "The ID of the purchase order item", "title": "Purchase Order Item Id", "type": "integer" } }, "required": [ "purchase_order_item_id" ], "title": "PurchaseOrderItemDetailPathParamsSchema", "type": "object" }, "PurchaseOrderItemPatchSchema": { "properties": { "quantity": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "number" }, { "type": "string" }, { "type": "null" } ], "description": "Updated quantity (must be greater than 0)", "title": "Quantity" }, "sku": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Updated SKU identifier", "title": "Sku" }, "total_price": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Updated total price for this line item, in cents", "title": "Total Price" } }, "title": "PurchaseOrderItemPatchSchema", "type": "object" }, "PurchaseOrderItemStandaloneCreateSchema": { "properties": { "inventory_id": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The inventory id identifying the item to order. Must provide exactly one of inventory_shortcode or inventory_id, not both", "title": "Inventory Id" }, "inventory_shortcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The inventory shortcode (human-readable code) identifying the item to order. Must provide exactly one of inventory_shortcode or inventory_id, not both. Inventory shortcodes are deprecated for new integrations; supported during a deprecation window for existing callers.", "title": "Inventory Shortcode" }, "purchase_order_id": { "description": "The ID of the purchase order to add this item to", "title": "Purchase Order Id", "type": "integer" }, "quantity": { "anyOf": [ { "exclusiveMinimum": 0.0, "type": "number" }, { "type": "string" } ], "description": "The quantity to order (must be greater than 0)", "title": "Quantity" }, "sku": { "default": "", "description": "An optional SKU identifier for this item", "title": "Sku", "type": "string" }, "total_price": { "default": 0, "description": "The total price for this line item, in cents", "minimum": 0, "title": "Total Price", "type": "integer" } }, "required": [ "quantity", "purchase_order_id" ], "title": "PurchaseOrderItemStandaloneCreateSchema", "type": "object" }, "PurchaseOrderListQueryParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to list purchase orders for", "title": "Clinic Id", "type": "integer" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "required": [ "clinic_id" ], "title": "PurchaseOrderListQueryParamsSchema", "type": "object" }, "PurchaseOrderPatchSchema": { "properties": { "order_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Updated order datetime", "title": "Order Datetime" }, "po_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Updated purchase order number", "title": "Po Number" }, "supplier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Updated supplier name", "title": "Supplier" } }, "title": "PurchaseOrderPatchSchema", "type": "object" }, "PurchaseOrderStatus": { "enum": [ "DRAFT", "PENDING", "PARTIALLY_RECEIVED", "FULLY_RECEIVED", "CANCELED", "RETURNED", "CLOSED" ], "title": "PurchaseOrderStatus", "type": "string" }, "RecurrenceBreakdownSchema": { "description": "Structured representation of an RFC 2445 recurrence rule.", "properties": { "days_of_week": { "description": "Two-letter day codes. Applicable for WEEKLY and some MONTHLY patterns.", "items": { "enum": [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ], "type": "string" }, "title": "Days Of Week", "type": "array" }, "end_after_occurrences": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Total number of occurrences before the recurrence ends, if bounded by count.", "title": "End After Occurrences" }, "end_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 date (YYYY-MM-DD) when the recurrence ends, if bounded by date.", "title": "End Date" }, "frequency": { "description": "The base recurring frequency.", "enum": [ "YEARLY", "MONTHLY", "WEEKLY", "DAILY", "HOURLY", "MINUTELY", "SECONDLY" ], "title": "Frequency", "type": "string" }, "interval": { "description": "The interval between each frequency iteration (e.g., 2 means every 2 weeks for WEEKLY).", "title": "Interval", "type": "integer" } }, "required": [ "frequency", "interval" ], "title": "RecurrenceBreakdownSchema", "type": "object" }, "RefundListQueryParamsSchema": { "description": "Query parameters for listing refunds", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "order_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter refunds by order ID", "title": "Order Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "RefundListQueryParamsSchema", "type": "object" }, "RefundType": { "enum": [ "CLIENT_CREDIT", "STRIPE", "EXTERNAL" ], "title": "RefundType", "type": "string" }, "ResourceScheduleBlockListQueryParamsSchema": { "properties": { "calendar_id": { "description": "Required. The ID of the calendar to fetch resource schedule blocks for", "title": "Calendar Id", "type": "integer" }, "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional. The ID of the calendar resource to fetch event blocks for", "title": "Calendar Resource Id" }, "end_datetime__lte": { "description": "Required. End date for fetching resource schedule blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_datetime__gte`. Format: YYYY-MM-DD", "title": "End Datetime Lte", "type": "string" }, "start_datetime__gte": { "description": "Required. Start date for fetching resource schedule blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_datetime__lte`. Format: YYYY-MM-DD", "title": "Start Datetime Gte", "type": "string" } }, "required": [ "calendar_id", "start_datetime__gte", "end_datetime__lte" ], "title": "ResourceScheduleBlockListQueryParamsSchema", "type": "object" }, "ResourceScheduleBlockTimeRange": { "properties": { "end_datetime": { "description": "The ending datetime of this schedule block, in UTC.", "format": "date-time", "title": "End Datetime", "type": "string" }, "start_datetime": { "description": "The starting datetime of this schedule block, in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" } }, "required": [ "start_datetime", "end_datetime" ], "title": "ResourceScheduleBlockTimeRange", "type": "object" }, "ResourceScheduleCreatedWebhookPayload": { "properties": { "data": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted end datetime of the schedule in UTC. Null when use_clinic_hours is true.", "title": "End Datetime" }, "id": { "description": "The unique identifier for this resource schedule.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "resource.calendar.clinic_id": { "description": "The ID of the clinic this resource schedule belongs to.", "title": "Resource.Calendar.Clinic Id", "type": "integer" }, "resource_id": { "description": "The ID of the calendar resource this schedule is for.", "title": "Resource Id", "type": "integer" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the schedule in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" }, "use_clinic_hours": { "description": "Whether this resource follows the clinic's business hours instead of a custom end time.", "title": "Use Clinic Hours", "type": "boolean" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "resource.calendar.clinic_id", "resource_id", "start_datetime", "end_datetime", "use_clinic_hours" ], "title": "ExternalResourceScheduleSchema", "type": "object" }, "type": { "const": "resource_schedule.created", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "resource_schedule.created payload", "type": "object" }, "ResourceScheduleDeletedWebhookPayload": { "properties": { "data": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted end datetime of the schedule in UTC. Null when use_clinic_hours is true.", "title": "End Datetime" }, "id": { "description": "The unique identifier for this resource schedule.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "resource.calendar.clinic_id": { "description": "The ID of the clinic this resource schedule belongs to.", "title": "Resource.Calendar.Clinic Id", "type": "integer" }, "resource_id": { "description": "The ID of the calendar resource this schedule is for.", "title": "Resource Id", "type": "integer" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the schedule in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" }, "use_clinic_hours": { "description": "Whether this resource follows the clinic's business hours instead of a custom end time.", "title": "Use Clinic Hours", "type": "boolean" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "resource.calendar.clinic_id", "resource_id", "start_datetime", "end_datetime", "use_clinic_hours" ], "title": "ExternalResourceScheduleSchema", "type": "object" }, "type": { "const": "resource_schedule.deleted", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "resource_schedule.deleted payload", "type": "object" }, "ResourceScheduleDetailPathParamsSchema": { "properties": { "resource_schedule_id": { "description": "The ID of the resource schedule to fetch.", "title": "Resource Schedule Id", "type": "integer" } }, "required": [ "resource_schedule_id" ], "title": "ResourceScheduleDetailPathParamsSchema", "type": "object" }, "ResourceScheduleExceptionDetailPathParamsSchema": { "properties": { "resource_schedule_exception_id": { "description": "The ID of the resource schedule exception to fetch.", "title": "Resource Schedule Exception Id", "type": "integer" } }, "required": [ "resource_schedule_exception_id" ], "title": "ResourceScheduleExceptionDetailPathParamsSchema", "type": "object" }, "ResourceScheduleExceptionListQueryParamsSchema": { "properties": { "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedule exceptions for the calendar resource with this ID.", "title": "Calendar Resource Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedule exceptions belonging to the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ResourceScheduleExceptionListQueryParamsSchema", "type": "object" }, "ResourceScheduleListQueryParamsSchema": { "properties": { "calendar_resource_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedules for the calendar resource with this ID.", "title": "Calendar Resource Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedules belonging to the clinic with this ID.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ResourceScheduleListQueryParamsSchema", "type": "object" }, "ResourceScheduleUpdatedWebhookPayload": { "properties": { "data": { "properties": { "created": { "description": "The datetime this object was created.", "format": "date-time", "title": "Created", "type": "string" }, "deleted": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The datetime this record was soft deleted.", "title": "Deleted" }, "end_datetime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "ISO 8601 formatted end datetime of the schedule in UTC. Null when use_clinic_hours is true.", "title": "End Datetime" }, "id": { "description": "The unique identifier for this resource schedule.", "title": "Id", "type": "integer" }, "is_deleted": { "description": "Whether this record is soft deleted or not.", "title": "Is Deleted", "type": "boolean" }, "is_recurring": { "description": "Whether this record follows a recurrence pattern.", "title": "Is Recurring", "type": "boolean" }, "modified": { "description": "The datetime this object was last modified; changes to related entities will not update this field.", "format": "date-time", "title": "Modified", "type": "string" }, "recurrence": { "anyOf": [ { "$ref": "#/components/schemas/RecurrenceBreakdownSchema" }, { "type": "null" } ], "default": null, "description": "Structured recurrence pattern, if recurring." }, "resource.calendar.clinic_id": { "description": "The ID of the clinic this resource schedule belongs to.", "title": "Resource.Calendar.Clinic Id", "type": "integer" }, "resource_id": { "description": "The ID of the calendar resource this schedule is for.", "title": "Resource Id", "type": "integer" }, "rrule": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw RFC 2445 RRule string, if recurring.", "title": "Rrule" }, "start_datetime": { "description": "ISO 8601 formatted start datetime of the schedule in UTC.", "format": "date-time", "title": "Start Datetime", "type": "string" }, "use_clinic_hours": { "description": "Whether this resource follows the clinic's business hours instead of a custom end time.", "title": "Use Clinic Hours", "type": "boolean" } }, "required": [ "created", "modified", "is_deleted", "deleted", "is_recurring", "id", "resource.calendar.clinic_id", "resource_id", "start_datetime", "end_datetime", "use_clinic_hours" ], "title": "ExternalResourceScheduleSchema", "type": "object" }, "type": { "const": "resource_schedule.updated", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "resource_schedule.updated payload", "type": "object" }, "ResuscitateStatus": { "enum": [ "DNR", "CPR" ], "title": "ResuscitateStatus", "type": "string" }, "RevenueCategoryDetailPathParamsSchema": { "description": "Schema for the RevenueCategoryDetailExternalAPIController path parameters", "properties": { "revenue_category_id": { "description": "The ID of the revenue category to fetch", "title": "Revenue Category Id", "type": "integer" } }, "required": [ "revenue_category_id" ], "title": "RevenueCategoryDetailPathParamsSchema", "type": "object" }, "RevenueCategoryListQueryParamsSchema": { "description": "Schema for the RevenueCategoryListExternalAPIController path parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "RevenueCategoryListQueryParamsSchema", "type": "object" }, "SMSPreference": { "enum": [ "NA", "ALL", "TRANSACTIONAL", "UNSUBSCRIBED" ], "title": "SMSPreference", "type": "string" }, "Schema": { "properties": {}, "title": "Schema", "type": "object" }, "ServiceClinicUpdatePathParamsSchema": { "properties": { "clinic_id": { "description": "The ID of the clinic to update mappings for", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "ServiceClinicUpdatePathParamsSchema", "type": "object" }, "ServiceClinicUpdateSchema": { "properties": { "assigned_service_pricing_group_ids": { "description": "The IDs of the service pricing groups assigned to this clinic.", "items": { "type": "integer" }, "title": "Assigned Service Pricing Group Ids", "type": "array" } }, "required": [ "assigned_service_pricing_group_ids" ], "title": "ServiceClinicUpdateSchema", "type": "object" }, "ServiceKind": { "enum": [ "PROCEDURE", "PRODUCT", "MEDICATION", "VACCINE", "LAB", "FEE", "SERVICE", "UNKNOWN", "CARE_PLAN" ], "title": "ServiceKind", "type": "string" }, "ServicePriceStrategyKind": { "enum": [ "FIXED_PRICING", "STANDARD_PRICING", "EXTERNAL_LAB_PRICING" ], "title": "ServicePriceStrategyKind", "type": "string" }, "ServicePricingCategoryDetailPathParamsSchema": { "properties": { "service_pricing_category_id": { "description": "The ID of the service pricing category to fetch", "title": "Service Pricing Category Id", "type": "integer" } }, "required": [ "service_pricing_category_id" ], "title": "ServicePricingCategoryDetailPathParamsSchema", "type": "object" }, "ServicePricingGroupDetailPathParamsSchema": { "properties": { "service_pricing_group_id": { "description": "The ID of the service pricing group to fetch", "title": "Service Pricing Group Id", "type": "integer" } }, "required": [ "service_pricing_group_id" ], "title": "ServicePricingGroupDetailPathParamsSchema", "type": "object" }, "ServicePricingGroupListQueryParamsSchema": { "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "service_pricing_category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to service pricing groups for the service pricing category with this ID", "title": "Service Pricing Category Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "ServicePricingGroupListQueryParamsSchema", "type": "object" }, "ServicePricingGroupPricingDetailPathParamsSchema": { "properties": { "service_pricing_group_id": { "description": "The ID of the service pricing group to fetch", "title": "Service Pricing Group Id", "type": "integer" } }, "required": [ "service_pricing_group_id" ], "title": "ServicePricingGroupPricingDetailPathParamsSchema", "type": "object" }, "ServicePricingGroupPricingUpdatePathParamsSchema": { "properties": { "service_pricing_group_id": { "description": "The ID of the service pricing group to update", "title": "Service Pricing Group Id", "type": "integer" } }, "required": [ "service_pricing_group_id" ], "title": "ServicePricingGroupPricingUpdatePathParamsSchema", "type": "object" }, "ServicePricingGroupPricingUpdateSchema": { "properties": { "prices": { "items": { "$ref": "#/components/schemas/IndividualServicePricingGroupPricingUpdateSchema" }, "maxItems": 10, "title": "Prices", "type": "array" } }, "required": [ "prices" ], "title": "ServicePricingGroupPricingUpdateSchema", "type": "object" }, "ServicePricingGroupStatus": { "enum": [ "ACTIVE", "INACTIVE" ], "title": "ServicePricingGroupStatus", "type": "string" }, "ServicePricingGroupUpdatePathParamsSchema": { "properties": { "service_pricing_group_id": { "description": "The ID of the service pricing group to update", "title": "Service Pricing Group Id", "type": "integer" } }, "required": [ "service_pricing_group_id" ], "title": "ServicePricingGroupUpdatePathParamsSchema", "type": "object" }, "ServicePricingGroupUpdateSchema": { "properties": { "in_clinic_dispense_fee": { "description": "The dispense fee for services that administered in the clinic, in cents.", "minimum": 0, "title": "In Clinic Dispense Fee", "type": "integer" }, "take_home_dispense_fee": { "description": "The dispense fee for services that are taken home by the pet parent, in cents.", "minimum": 0, "title": "Take Home Dispense Fee", "type": "integer" } }, "required": [ "in_clinic_dispense_fee", "take_home_dispense_fee" ], "title": "ServicePricingGroupUpdateSchema", "type": "object" }, "ServiceProcedureKind": { "enum": [ "EUTHANASIA", "SPAY", "NEUTER", "OTHER" ], "title": "ServiceProcedureKind", "type": "string" }, "ServiceProductLocation": { "enum": [ "RIGHT_SHOULDER", "RIGHT_REAR", "LEFT_SHOULDER", "LEFT_REAR", "RIGHT_CEPHALIC", "LEFT_CEPHALIC", "RIGHT_SAPHENOUS", "LEFT_SAPHENOUS", "RIGHT_EPAXIAL", "LEFT_EPAXIAL", "JUGULAR", "ORAL", "INTRANASAL", "INTERSCAPULAR", "LEFT_EYE", "RIGHT_EYE", "BOTH_EYES", "EYELIDS", "LEFT_EAR", "RIGHT_EAR", "BOTH_EARS", "EARS", "OTHER", "BACK_OF_NECK", "MOUTH", "INTERDIGITAL", "PAWS", "TESTICLES", "LOWER_RIGHT_QUADRANT", "LOWER_LEFT_QUADRANT", "INTRACARDIAC", "PROXIMAL_TIBIA", "PROXIMAL_FEMUR", "PROXIMAL_HUMERUS", "EPAXIAL", "INTRASCAPULAR" ], "title": "ServiceProductLocation", "type": "string" }, "ServiceProductRoute": { "enum": [ "INTRACARDIAC", "INTRAMUSCULAR", "INTRANASAL", "INTRAPERITONEAL", "INTRAOSSEOUS", "INTRATESTICULAR", "INTRAVENOUS", "OCULAR", "ORAL", "ORAL_NERVE_BLOCK", "OTIC", "SUBCUTANEOUS", "TOPICAL" ], "title": "ServiceProductRoute", "type": "string" }, "SexKind": { "enum": [ "MALE", "FEMALE", "UNKNOWN" ], "title": "SexKind", "type": "string" }, "SmsNotificationDeliveredWebhookPayload": { "properties": { "data": { "properties": { "client.clinic_id": { "description": "The ID of the clinic the SMS was sent from.", "title": "Client.Clinic Id", "type": "integer" }, "client_id": { "description": "The ID of the clinic client the SMS was sent to.", "title": "Client Id", "type": "integer" }, "created": { "description": "When the SMS notification was created.", "format": "date-time", "title": "Created", "type": "string" }, "error_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable reason for the error, if the error code is recognized.", "title": "Error Reason" }, "id": { "description": "The ID of the SMS notification.", "title": "Id", "type": "integer" }, "status": { "$ref": "#/components/schemas/ExternalSmsNotificationStatus", "description": "The delivery status of the SMS.\n- `SENT`: Message was sent but delivery is not yet confirmed.\n- `DELIVERED`: Message was successfully delivered.\n- `FAILED_TO_SEND`: Message failed to send." }, "text_message.body": { "description": "The SMS message body.", "title": "Text Message.Body", "type": "string" }, "text_message.client_communication_number_id": { "description": "The ID of the client communication number the SMS was sent to.", "title": "Text Message.Client Communication Number Id", "type": "integer" }, "text_message.error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error code from the SMS provider if sending failed.", "title": "Text Message.Error Code" } }, "required": [ "id", "client_id", "text_message.client_communication_number_id", "client.clinic_id", "text_message.body", "status", "created", "text_message.error_code", "error_reason" ], "title": "ExternalSmsNotificationSchema", "type": "object" }, "type": { "const": "sms_notification.delivered", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "sms_notification.delivered payload", "type": "object" }, "SmsNotificationDetailPathParamsSchema": { "properties": { "sms_notification_id": { "title": "Sms Notification Id", "type": "integer" } }, "required": [ "sms_notification_id" ], "title": "SmsNotificationDetailPathParamsSchema", "type": "object" }, "SmsNotificationFailedWebhookPayload": { "properties": { "data": { "properties": { "client.clinic_id": { "description": "The ID of the clinic the SMS was sent from.", "title": "Client.Clinic Id", "type": "integer" }, "client_id": { "description": "The ID of the clinic client the SMS was sent to.", "title": "Client Id", "type": "integer" }, "created": { "description": "When the SMS notification was created.", "format": "date-time", "title": "Created", "type": "string" }, "error_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable reason for the error, if the error code is recognized.", "title": "Error Reason" }, "id": { "description": "The ID of the SMS notification.", "title": "Id", "type": "integer" }, "status": { "$ref": "#/components/schemas/ExternalSmsNotificationStatus", "description": "The delivery status of the SMS.\n- `SENT`: Message was sent but delivery is not yet confirmed.\n- `DELIVERED`: Message was successfully delivered.\n- `FAILED_TO_SEND`: Message failed to send." }, "text_message.body": { "description": "The SMS message body.", "title": "Text Message.Body", "type": "string" }, "text_message.client_communication_number_id": { "description": "The ID of the client communication number the SMS was sent to.", "title": "Text Message.Client Communication Number Id", "type": "integer" }, "text_message.error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error code from the SMS provider if sending failed.", "title": "Text Message.Error Code" } }, "required": [ "id", "client_id", "text_message.client_communication_number_id", "client.clinic_id", "text_message.body", "status", "created", "text_message.error_code", "error_reason" ], "title": "ExternalSmsNotificationSchema", "type": "object" }, "type": { "const": "sms_notification.failed", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "sms_notification.failed payload", "type": "object" }, "SmsNotificationListQueryParamsSchema": { "description": "Schema for the SMS notification list endpoint query parameters.", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to SMS notifications for the clinic client with this ID. At least one of `clinic_id` or `clinic_client_id` is required.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to SMS notifications for the clinic with this ID. At least one of `clinic_id` or `clinic_client_id` is required.", "title": "Clinic Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "SmsNotificationListQueryParamsSchema", "type": "object" }, "SmsNotificationSentWebhookPayload": { "properties": { "data": { "properties": { "client.clinic_id": { "description": "The ID of the clinic the SMS was sent from.", "title": "Client.Clinic Id", "type": "integer" }, "client_id": { "description": "The ID of the clinic client the SMS was sent to.", "title": "Client Id", "type": "integer" }, "created": { "description": "When the SMS notification was created.", "format": "date-time", "title": "Created", "type": "string" }, "error_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable reason for the error, if the error code is recognized.", "title": "Error Reason" }, "id": { "description": "The ID of the SMS notification.", "title": "Id", "type": "integer" }, "status": { "$ref": "#/components/schemas/ExternalSmsNotificationStatus", "description": "The delivery status of the SMS.\n- `SENT`: Message was sent but delivery is not yet confirmed.\n- `DELIVERED`: Message was successfully delivered.\n- `FAILED_TO_SEND`: Message failed to send." }, "text_message.body": { "description": "The SMS message body.", "title": "Text Message.Body", "type": "string" }, "text_message.client_communication_number_id": { "description": "The ID of the client communication number the SMS was sent to.", "title": "Text Message.Client Communication Number Id", "type": "integer" }, "text_message.error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error code from the SMS provider if sending failed.", "title": "Text Message.Error Code" } }, "required": [ "id", "client_id", "text_message.client_communication_number_id", "client.clinic_id", "text_message.body", "status", "created", "text_message.error_code", "error_reason" ], "title": "ExternalSmsNotificationSchema", "type": "object" }, "type": { "const": "sms_notification.sent", "description": "The event type identifier.", "type": "string" } }, "required": [ "type", "data" ], "title": "sms_notification.sent payload", "type": "object" }, "States": { "enum": [ "AL", "AK", "AS", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ], "title": "States", "type": "string" }, "StripePayoutStatus": { "enum": [ "PAID", "PENDING", "IN_TRANSIT", "CANCELED", "FAILED" ], "title": "StripePayoutStatus", "type": "string" }, "SubscriptionDetailPathParamsSchema": { "description": "Schema for the SubscriptionDetailExternalAPIController path parameters", "properties": { "subscription_id": { "description": "The ID of the subscription to fetch", "title": "Subscription Id", "type": "integer" } }, "required": [ "subscription_id" ], "title": "SubscriptionDetailPathParamsSchema", "type": "object" }, "SubscriptionListQueryParamsSchema": { "description": "Schema for the SubscriptionListExternalAPIController path parameters", "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this clinic client", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this clinic", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this clinic patient", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/SubscriptionStatus" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this status" } }, "title": "SubscriptionListQueryParamsSchema", "type": "object" }, "SubscriptionStatus": { "enum": [ "ACTIVE", "CANCELED_VIA_CLINIC", "CANCELED_VIA_CLIENT", "CANCELED_DENIED", "CANCELED_VIA_ADMIN", "FAILED_PAYMENT", "PAUSED_VIA_CLIENT", "PAUSED_VIA_CLINIC", "PAUSED_BAD_ADDRESS", "PAUSED_PRESCRIPTION", "PAUSED_OUT_OF_STOCK", "PAUSED_MISSING_CLIENT_INFO", "PAUSED_FLAVOR_UNAVAILABLE", "PAUSED_OTHER", "IMPORTED" ], "title": "SubscriptionStatus", "type": "string" }, "SupportedPaymentLinkKind": { "enum": [ "INVOICE", "CARE_PLAN_PAYMENT_METHOD_UPDATE" ], "title": "SupportedPaymentLinkKind", "type": "string" }, "TaxCategoryDetailPathParamsSchema": { "description": "Schema for the TaxCategoryDetailExternalAPIController path parameters", "properties": { "tax_category_id": { "description": "The ID of the tax category to fetch", "title": "Tax Category Id", "type": "integer" } }, "required": [ "tax_category_id" ], "title": "TaxCategoryDetailPathParamsSchema", "type": "object" }, "TaxCategoryListQueryParamsSchema": { "description": "Schema for the TaxCategoryListExternalAPIController path parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "TaxCategoryListQueryParamsSchema", "type": "object" }, "TaxCategoryStatus": { "enum": [ "ACTIVE", "INACTIVE" ], "title": "TaxCategoryStatus", "type": "string" }, "TaxSettingDetailPathParamsSchema": { "description": "Schema for the TaxSettingDetailExternalAPIController path parameters", "properties": { "clinic_id": { "description": "The clinic ID of the tax setting to fetch", "title": "Clinic Id", "type": "integer" } }, "required": [ "clinic_id" ], "title": "TaxSettingDetailPathParamsSchema", "type": "object" }, "TaxStatus": { "enum": [ "NONE", "EXEMPT", "TAXED" ], "title": "TaxStatus", "type": "string" }, "ThrottledResponseSchema": { "properties": { "detail": { "title": "Detail", "type": "string" } }, "required": [ "detail" ], "title": "ThrottledResponseSchema", "type": "object" }, "TransferListQueryParamsSchema": { "description": "Query parameters for listing transfers", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "order_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter transfers by order ID", "title": "Order Id" }, "payout_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter transfers by payout IDs. Accepts multiple IDs.", "title": "Payout Ids" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "TransferListQueryParamsSchema", "type": "object" }, "TreatmentDetailPathParamsSchema": { "description": "Schema for the TreatmentDetailExternalAPIController path parameters", "properties": { "treatment_id": { "description": "The ID of the treatment to retrieve.", "title": "Treatment Id", "type": "integer" } }, "required": [ "treatment_id" ], "title": "TreatmentDetailPathParamsSchema", "type": "object" }, "TreatmentKind": { "enum": [ "IN_CLINIC", "TAKE_HOME" ], "title": "TreatmentKind", "type": "string" }, "TreatmentListQueryParamsSchema": { "description": "Schema for the TreatmentListExternalAPIController query parameters", "properties": { "clinic_patient_id": { "description": "Filters to treatments associated with the clinic patient with the given ID.", "title": "Clinic Patient Id", "type": "integer" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "required": [ "clinic_patient_id" ], "title": "TreatmentListQueryParamsSchema", "type": "object" }, "TreatmentSheetSeriesCategory": { "enum": [ "BUNDLE", "VITAL", "TASK", "NUTRITION", "FLUID", "PATIENT_CARE", "PROCEDURE", "PRODUCT", "MEDICATION", "VACCINE", "LAB", "SERVICE" ], "title": "TreatmentSheetSeriesCategory", "type": "string" }, "UniversalPrescriptionDetailPathParamsSchema": { "properties": { "universal_prescription_id": { "description": "The ID of the universal prescription to fetch.", "title": "Universal Prescription Id", "type": "integer" } }, "required": [ "universal_prescription_id" ], "title": "UniversalPrescriptionDetailPathParamsSchema", "type": "object" }, "UniversalPrescriptionHistoryListQueryParamsSchema": { "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescription history for the clinic client with this ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescription history for the clinic with this ID.", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescription history for the clinic patient with this ID.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "prescription_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to all versions of the prescription with this ID.", "title": "Prescription Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "UniversalPrescriptionHistoryListQueryParamsSchema", "type": "object" }, "UniversalPrescriptionListQueryParamsSchema": { "properties": { "clinic_client_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescriptions for the clinic client with this ID.", "title": "Clinic Client Id" }, "clinic_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescriptions for the clinic with this ID.", "title": "Clinic Id" }, "clinic_patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescriptions for the clinic patient with this ID.", "title": "Clinic Patient Id" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" }, "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "is_deleted": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "modified__gte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" }, "modified__lte": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, "title": "UniversalPrescriptionListQueryParamsSchema", "type": "object" }, "Universal_PrescriptionList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ConnectUniversalPrescriptionSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "Universal PrescriptionList", "type": "object" }, "Universal_Prescription_HistoryList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ConnectUniversalPrescriptionHistorySchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "Universal Prescription HistoryList", "type": "object" }, "UploadedFileDetailPathParamsSchema": { "properties": { "uploaded_file_id": { "description": "The ID of the uploaded file to fetch", "title": "Uploaded File Id", "type": "integer" } }, "required": [ "uploaded_file_id" ], "title": "UploadedFileDetailPathParamsSchema", "type": "object" }, "VaccineKind": { "enum": [ "RABIES", "OTHER" ], "title": "VaccineKind", "type": "string" }, "Vaccine_Historical_TreatmentList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalVaccineHistoricalTreatmentSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "Vaccine Historical TreatmentList", "type": "object" }, "Vaccine_TreatmentList": { "properties": { "data": { "description": "A single page of data contained within this list.", "items": { "$ref": "#/components/schemas/ExternalVaccineTreatmentSchema" }, "title": "Data", "type": "array" }, "has_more": { "default": false, "description": "Whether there are more pages or data in this list.", "title": "Has More", "type": "boolean" }, "next_page": { "description": "A URL linking to the next page of this list.", "title": "Next Page", "type": "string" }, "type": { "default": "list", "description": "Type of this object. Always `list`.", "title": "Type", "type": "string" } }, "required": [ "data", "next_page" ], "title": "Vaccine TreatmentList", "type": "object" }, "VendorSupplyAvailability": { "enum": [ "IN_STOCK", "BACKORDERED", "UNAVAILABLE", "UNKNOWN", "LOW_STOCK" ], "title": "VendorSupplyAvailability", "type": "string" }, "VisibleUniversalPrescriptionStatus": { "enum": [ "ACTIVE", "DISCONTINUED", "DEACTIVATED", "DECLINED", "EXPIRED", "DRAFT", "IMPORTED", "IMPORTED_VOIDED" ], "title": "VisibleUniversalPrescriptionStatus", "type": "string" }, "VitalReadingDetailPathParamsSchema": { "description": "Schema for the VitalReadingDetailExternalAPIController path parameters", "properties": { "vital_reading_id": { "description": "The ID of the vital reading to retrieve.", "title": "Vital Reading Id", "type": "integer" } }, "required": [ "vital_reading_id" ], "title": "VitalReadingDetailPathParamsSchema", "type": "object" }, "VitalReadingListQueryParamsSchema": { "description": "Schema for the VitalReadingListExternalAPIController query parameters", "properties": { "ending_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" }, "ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" }, "limit": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "medical_record_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to vital readings associated with the medical record with the given ID.", "title": "Medical Record Id" }, "patient_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to vital readings associated with the patient with the given ID.", "title": "Patient Id" }, "starting_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" }, "vital_reading_group_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to vital readings associated with the vital reading group with the given ID.", "title": "Vital Reading Group Id" } }, "title": "VitalReadingListQueryParamsSchema", "type": "object" }, "VitalUnitOfMeasure": { "enum": [ "FAHRENHEIT", "CELSIUS", "POUND", "KILOGRAM", "GRAM", "OUNCE", "BPM", "SECOND", "DENTAL_SCORE_RANGE", "FAS_SCORE_RANGE", "PAIN_SCORE_RANGE_ONE", "PAIN_SCORE_RANGE_TWO", "BCS_RANGE_ONE", "BCS_RANGE_TWO", "MMHG", "PERCENT", "MILLILITER", "MILLILITER_PER_MINUTE", "MILLILITER_PER_HOUR", "LITER_PER_MINUTE", "MCS_SCORE_RANGE_ONE", "MCS_SCORE_RANGE_TWO" ], "title": "VitalUnitOfMeasure", "type": "string" }, "WeightUnitOfMeasure": { "enum": [ "POUND", "KILOGRAM", "GRAM", "OUNCE" ], "title": "WeightUnitOfMeasure", "type": "string" }, "ZipCodeOperator": { "enum": [ "EXACT", "PREFIX", "CONTAINS" ], "title": "ZipCodeOperator", "type": "string" } }, "securitySchemes": { "ExternalAPIAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "", "title": "NinjaAPI", "version": "2.0.0" }, "openapi": "3.1.0", "paths": { "/ext/v2/accounts/auto-auth/": { "post": { "description": "This endpoint is available to Group API Keys only.\n\nGenerates an auto-authentication token that allows a clinic client (pet parent) to be seamlessly signed into the Vetcove client shopping portal without requiring them to enter credentials.\n\nThis is typically used to provide a direct link from an application or client communication into the Vetcove shopping experience. The client is identified by their email address or phone number.", "operationId": "auto_auth_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAutoAuthRequestSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalDetailAutoAuthSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Auto-authenticate a client", "tags": [ "Accounts" ] } }, "/ext/v2/addresses/": { "get": { "description": "Returns a list of all addresses for clinic clients (pet parents). The addresses are sorted by creation date, with the most recent addresses appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nAn address represents a physical mailing or shipping location associated with a client. Addresses are used as shipping destinations for product orders and may be designated as the client's primary address.", "operationId": "addresses_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to addresses for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to addresses for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filters to addresses for the clinic client with this ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to addresses for the clinic client with this ID.", "title": "Clinic Client Id" } }, { "description": "Filter by active status. Defaults to true (only active addresses). Set to false to include only deactivated addresses, or omit to return all regardless of active status.", "in": "query", "name": "is_active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "Filter by active status. Defaults to true (only active addresses). Set to false to include only deactivated addresses, or omit to return all regardless of active status.", "title": "Is Active" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientAddressSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all addresses", "tags": [ "Accounts" ] }, "post": { "description": "Creates a new address for a clinic client (pet parent).\n\nAn address represents a physical mailing or shipping location associated with a client. Addresses are used as shipping destinations for product orders and may be designated as the client's primary address.", "operationId": "addresses_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientAddressCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientAddressSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create an address", "tags": [ "Accounts" ] } }, "/ext/v2/addresses/{address_id}/": { "delete": { "description": "Deletes a client address by its ID. The address will be deactivated and will no longer appear in address listings.", "operationId": "addresses_delete", "parameters": [ { "description": "The ID of the address.", "in": "path", "name": "address_id", "required": true, "schema": { "description": "The ID of the address.", "title": "Address Id", "type": "integer" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Delete an address", "tags": [ "Accounts" ] }, "get": { "description": "Fetches a client address by its ID.\n\nAn address represents a physical mailing or shipping location associated with a client. Addresses are used as shipping destinations for product orders and may be designated as the client's primary address.", "operationId": "addresses_get", "parameters": [ { "description": "The ID of the address.", "in": "path", "name": "address_id", "required": true, "schema": { "description": "The ID of the address.", "title": "Address Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientAddressSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an address", "tags": [ "Accounts" ] } }, "/ext/v2/appointment-kinds/": { "get": { "description": "Returns a list of all appointment kinds defined at the organization level. The appointment kinds are sorted by creation date, with the most recent appearing first.\n\nAn **appointment kind** defines a type of appointment (e.g., wellness exam, vaccination, surgery, dental cleaning) and is used when creating or categorizing appointments.", "operationId": "appointment_kinds_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentKindList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all appointment kinds", "tags": [ "Scheduler" ] } }, "/ext/v2/appointment-kinds/{appointment_kind_id}/": { "get": { "description": "Fetches an appointment kind by its ID.\n\nAn **appointment kind** defines a type of appointment (e.g., wellness exam, vaccination, surgery, dental cleaning) and is used when creating or categorizing appointments.", "operationId": "appointment_kinds_get", "parameters": [ { "description": "The ID of the appointment kind to fetch", "in": "path", "name": "appointment_kind_id", "required": true, "schema": { "description": "The ID of the appointment kind to fetch", "title": "Appointment Kind Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppointmentKindDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an appointment kind", "tags": [ "Scheduler" ] } }, "/ext/v2/appointments/": { "get": { "description": "Returns a list of all appointments across all clinics in the organization. The appointments are sorted by creation date, with the most recent appointments appearing first.\n\nAn **appointment** represents a scheduled visit for a clinic patient at a clinic, tracking its lifecycle from request through completion or cancellation.", "operationId": "appointments_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to appointments for the clinic client with this ID", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments for the clinic client with this ID", "title": "Clinic Client Id" } }, { "description": "When provided, filters to appointments for the clinic patient with this ID", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments for the clinic patient with this ID", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to appointments for the clinic with this ID", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments for the clinic with this ID", "title": "Clinic Id" } }, { "description": "When provided, filters to appointments with this status.", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentStatus" }, { "type": "null" } ], "description": "When provided, filters to appointments with this status." } }, { "description": "When provided, filters to appointments assigned to the calendar resource with this ID.", "in": "query", "name": "resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to appointments assigned to the calendar resource with this ID.", "title": "Resource Id" } }, { "description": "When provided, filters to appointments ending on or before this datetime. If both end_datetime__lte and start_datetime__gte are provided, end_datetime__lte must be greater than start_datetime__gte.", "in": "query", "name": "end_datetime__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to appointments ending on or before this datetime. If both end_datetime__lte and start_datetime__gte are provided, end_datetime__lte must be greater than start_datetime__gte.", "title": "End Datetime Lte" } }, { "description": "When provided, filters to appointments starting on or after this datetime. If both end_datetime__lte and start_datetime__gte are provided, end_datetime__lte must be greater than start_datetime__gte.", "in": "query", "name": "start_datetime__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to appointments starting on or after this datetime. If both end_datetime__lte and start_datetime__gte are provided, end_datetime__lte must be greater than start_datetime__gte.", "title": "Start Datetime Gte" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all appointments", "tags": [ "Scheduler" ] }, "post": { "description": "Creates a new appointment for a clinic patient. The appointment is created with an initial status of `CLIENT_REQUESTED`.\n\nAn **appointment** represents a scheduled visit for a clinic patient at a clinic, tracking its lifecycle from request through completion or cancellation.", "operationId": "appointments_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppointmentSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create an appointment", "tags": [ "Scheduler" ] } }, "/ext/v2/appointments/{appointment_id}/": { "get": { "description": "Fetches an appointment by its ID.\n\nAn **appointment** represents a scheduled visit for a clinic patient at a clinic, tracking its lifecycle from request through completion or cancellation.", "operationId": "appointments_get", "parameters": [ { "description": "The ID of the appointment to fetch", "in": "path", "name": "appointment_id", "required": true, "schema": { "description": "The ID of the appointment to fetch", "title": "Appointment Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppointmentSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an appointment", "tags": [ "Scheduler" ] }, "put": { "description": "Updates an existing appointment by its ID. Supports status changes, cancellation with reason, rescheduling to new times/resources, and optional client notifications.", "operationId": "appointments_update", "parameters": [ { "description": "The ID of the appointment to update", "in": "path", "name": "appointment_id", "required": true, "schema": { "description": "The ID of the appointment to update", "title": "Appointment Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAppointmentSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update an appointment", "tags": [ "Scheduler" ] } }, "/ext/v2/appointments/{appointment_id}/history/": { "get": { "description": "Returns the change history for a specific appointment. Each history entry records a modification to the appointment (e.g., status change, reschedule, resource reassignment) along with a timestamp. The history is sorted by creation date, with the most recent entries appearing first.", "operationId": "appointments_get_history", "parameters": [ { "description": "The ID of the appointment to fetch history for", "in": "path", "name": "appointment_id", "required": true, "schema": { "description": "The ID of the appointment to fetch history for", "title": "Appointment Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentHistoryList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List appointment history", "tags": [ "Scheduler" ] } }, "/ext/v2/assessments/": { "get": { "description": "Returns a list of all assessments across all clinics in the organization.\n\nAn **assessment** is a veterinarian's clinical evaluation or diagnosis recorded during a clinic patient visit. Each assessment is linked to a clinic patient and optionally to a specific medical record.", "operationId": "assessments_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filters to assessments associated with the medical record with the given ID.", "in": "query", "name": "medical_record_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to assessments associated with the medical record with the given ID.", "title": "Medical Record Id" } }, { "description": "Filters to assessments associated with the patient with the given ID.", "in": "query", "name": "patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to assessments associated with the patient with the given ID.", "title": "Patient Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all assessments", "tags": [ "Medical Records" ] } }, "/ext/v2/assessments/{assessment_id}/": { "get": { "description": "Fetches an assessment by its ID.\n\nAn **assessment** is a veterinarian's clinical evaluation or diagnosis recorded during a clinic patient visit. Each assessment is linked to a clinic patient and optionally to a specific medical record.", "operationId": "assessments_get", "parameters": [ { "description": "The ID of the assessment to retrieve.", "in": "path", "name": "assessment_id", "required": true, "schema": { "description": "The ID of the assessment to retrieve.", "title": "Assessment Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAssessmentSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an assessment", "tags": [ "Medical Records" ] } }, "/ext/v2/calendar-availability/": { "get": { "description": "Returns the bookable appointment slots for a clinic's calendar resources over a date range of up to 7 days.\n\nCalendar availability represents the open appointment slots for each resource on a calendar, with all scheduling rules applied \u2014 resource schedules, existing appointments, calendar events, designations, and business hours are all accounted for. Availability can be requested for one or more resources and one or more appointment kinds at once; the result is computed independently for each resource-and-kind combination, since an appointment kind's configured duration and designation-based restrictions affect which slots are bookable.\n\nThe appointment length used to size the returned slots defaults to the kind's configured duration, but can be overridden with a custom length that applies to every requested kind. Start times are offered on the calendar's block-increment grid rather than stepping by the appointment length, so overlapping start times are returned (for example, a 15-minute grid with a 30-minute appointment offers starts at 8:00, 8:15, and 8:30). Grid alignment is computed in the clinic's local time.\n\nTo keep responses bounded, the number of requested appointment kinds per call is capped, and requests that would produce an excessive number of slots are rejected. If a request is rejected for exceeding the slot cap, or would return a result at that cap, use the paginated endpoint instead: `GET /ext/v2/calendar-availability/paginated/`.", "operationId": "listCalendarAvailability", "parameters": [ { "description": "Required. Start date for fetching availability. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 7 days before `end_date`. Format: YYYY-MM-DD", "in": "query", "name": "start_date", "required": true, "schema": { "description": "Required. Start date for fetching availability. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 7 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, { "description": "End date for fetching availability. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 7 days after `start_date`. Defaults to `start_date` if omitted. Format: YYYY-MM-DD", "in": "query", "name": "end_date", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "End date for fetching availability. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 7 days after `start_date`. Defaults to `start_date` if omitted. Format: YYYY-MM-DD", "title": "End Date" } }, { "description": "Filter to specific calendar resources by ID. Accepts multiple IDs. When omitted, availability is returned for every resource on the calendar.", "in": "query", "name": "calendar_resource_ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter to specific calendar resources by ID. Accepts multiple IDs. When omitted, availability is returned for every resource on the calendar.", "title": "Calendar Resource Ids" } }, { "description": "Filter by appointment kind by ID. Accepts multiple IDs. Controls slot duration and designation filtering; each requested kind produces its own set of response entries. When omitted, a single kind-less pass is returned at the calendar's default duration.", "in": "query", "name": "appointment_kind_ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter by appointment kind by ID. Accepts multiple IDs. Controls slot duration and designation filtering; each requested kind produces its own set of response entries. When omitted, a single kind-less pass is returned at the calendar's default duration.", "title": "Appointment Kind Ids" } }, { "description": "Overrides the appointment kind's default duration, in minutes. When provided it applies to every requested kind. Must be a positive multiple of the calendar's block increment.", "in": "query", "name": "duration", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overrides the appointment kind's default duration, in minutes. When provided it applies to every requested kind. Must be a positive multiple of the calendar's block increment.", "title": "Duration" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarAvailabilitySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List calendar availability", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-availability/paginated/": { "get": { "description": "Returns the bookable appointment slots for a clinic's calendar resources over a date range of up to 7 days.\n\nCalendar availability represents the open appointment slots for each resource on a calendar, with all scheduling rules applied \u2014 resource schedules, existing appointments, calendar events, designations, and business hours are all accounted for. Availability can be requested for one or more resources and one or more appointment kinds at once; the result is computed independently for each resource-and-kind combination, since an appointment kind's configured duration and designation-based restrictions affect which slots are bookable.\n\nThe appointment length used to size the returned slots defaults to the kind's configured duration, but can be overridden with a custom length that applies to every requested kind. Start times are offered on the calendar's block-increment grid rather than stepping by the appointment length, so overlapping start times are returned (for example, a 15-minute grid with a 30-minute appointment offers starts at 8:00, 8:15, and 8:30). Grid alignment is computed in the clinic's local time.\n\nResults are paginated by appointment slot rather than by resource. When a resource's slots span a page boundary, that resource appears on consecutive pages with the remaining slots.\n\nTo keep responses bounded, the number of requested appointment kinds per call is capped, and each page returns a bounded number of slots.", "operationId": "listCalendarAvailabilityPaginated", "parameters": [ { "description": "Required. Start date for fetching availability. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 7 days before `end_date`. Format: YYYY-MM-DD", "in": "query", "name": "start_date", "required": true, "schema": { "description": "Required. Start date for fetching availability. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 7 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, { "description": "End date for fetching availability. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 7 days after `start_date`. Defaults to `start_date` if omitted. Format: YYYY-MM-DD", "in": "query", "name": "end_date", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "End date for fetching availability. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 7 days after `start_date`. Defaults to `start_date` if omitted. Format: YYYY-MM-DD", "title": "End Date" } }, { "description": "Filter to specific calendar resources by ID. Accepts multiple IDs. When omitted, availability is returned for every resource on the calendar.", "in": "query", "name": "calendar_resource_ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter to specific calendar resources by ID. Accepts multiple IDs. When omitted, availability is returned for every resource on the calendar.", "title": "Calendar Resource Ids" } }, { "description": "Filter by appointment kind by ID. Accepts multiple IDs. Controls slot duration and designation filtering; each requested kind produces its own set of response entries. When omitted, a single kind-less pass is returned at the calendar's default duration.", "in": "query", "name": "appointment_kind_ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter by appointment kind by ID. Accepts multiple IDs. Controls slot duration and designation filtering; each requested kind produces its own set of response entries. When omitted, a single kind-less pass is returned at the calendar's default duration.", "title": "Appointment Kind Ids" } }, { "description": "Overrides the appointment kind's default duration, in minutes. When provided it applies to every requested kind. Must be a positive multiple of the calendar's block increment.", "in": "query", "name": "duration", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Overrides the appointment kind's default duration, in minutes. When provided it applies to every requested kind. Must be a positive multiple of the calendar's block increment.", "title": "Duration" } }, { "description": "The maximum number of appointment slots to return per page, counted by summing nested slots across every resource/kind entry on that page. A resource/kind group that spans a page boundary is split, and only the slots on this page count toward the limit. Defaults to 1000; the maximum is 5000.", "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "description": "The maximum number of appointment slots to return per page, counted by summing nested slots across every resource/kind entry on that page. A resource/kind group that spans a page boundary is split, and only the slots on this page count toward the limit. Defaults to 1000; the maximum is 5000.", "maximum": 5000, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token from a previous response's next page URL. Fetches slots after the last slot of the previous page. Omit to start from the first page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token from a previous response's next page URL. Fetches slots after the last slot of the previous page. Omit to start from the first page.", "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarAvailabilitySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List calendar availability (paginated)", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-designation-blocks/": { "get": { "description": "Returns the designation blocks for a clinic's calendar within a date range. The blocks are sorted by datetime in ascending order.\n\nA **calendar designation block** represents a time window on a resource's schedule that is designated for specific appointment kinds only (e.g., a block reserved exclusively for surgeries).", "operationId": "calendar_designation_blocks_list", "parameters": [ { "description": "Required. The ID of the calendar to fetch designation blocks for", "in": "query", "name": "calendar_id", "required": true, "schema": { "description": "Required. The ID of the calendar to fetch designation blocks for", "title": "Calendar Id", "type": "integer" } }, { "description": "Required. Start date for fetching designation blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_date`. Format: YYYY-MM-DD", "in": "query", "name": "start_date", "required": true, "schema": { "description": "Required. Start date for fetching designation blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, { "description": "Required. End date for fetching designation blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_date`. Format: YYYY-MM-DD", "in": "query", "name": "end_date", "required": true, "schema": { "description": "Required. End date for fetching designation blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_date`. Format: YYYY-MM-DD", "title": "End Date", "type": "string" } }, { "description": "Optional. The ID of the calendar resource to fetch designation blocks for", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional. The ID of the calendar resource to fetch designation blocks for", "title": "Calendar Resource Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarDesignationBlockSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List calendar designation blocks", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-designations/": { "get": { "description": "Returns a list of all calendar designations across all clinics in the organization. The calendar designations are sorted by creation date, with the most recent appearing first.\n\nA **calendar designation** defines a time window on a specific resource's schedule that is reserved for particular appointment kinds (e.g., a block reserved exclusively for surgeries or dental cleanings). Designations can be one-off or recurring.\n\nIf a designation is an exception to a recurring series, it references the parent recurring designation.", "operationId": "calendar_designations_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filter to calendar designations belonging to the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar designations belonging to the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filter to calendar designations assigned to the calendar resource with this ID.", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar designations assigned to the calendar resource with this ID.", "title": "Calendar Resource Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarDesignationSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all calendar designations", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-designations/{calendar_designation_id}/": { "get": { "description": "Fetches a calendar designation by its ID.\n\nA **calendar designation** defines a time window on a specific resource's schedule that is reserved for particular appointment kinds (e.g., a block reserved exclusively for surgeries or dental cleanings). Designations can be one-off or recurring.\n\nIf a designation is an exception to a recurring series, it references the parent recurring designation.", "operationId": "calendar_designations_get", "parameters": [ { "description": "The ID of the calendar designation to fetch.", "in": "path", "name": "calendar_designation_id", "required": true, "schema": { "description": "The ID of the calendar designation to fetch.", "title": "Calendar Designation Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarDesignationSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a calendar designation", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-event-blocks/": { "get": { "description": "Returns the calendar event blocks for a clinic's calendar within a date range. The blocks are sorted by datetime in ascending order.\n\nA **calendar event block** represents a non-appointment event on the calendar (e.g., a staff meeting, lunch break, or clinic closure) that may block appointment scheduling.", "operationId": "calendar_event_blocks_list", "parameters": [ { "description": "Required. The ID of the calendar to fetch event blocks for", "in": "query", "name": "calendar_id", "required": true, "schema": { "description": "Required. The ID of the calendar to fetch event blocks for", "title": "Calendar Id", "type": "integer" } }, { "description": "Required. Start date for fetching event blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_date`. Format: YYYY-MM-DD", "in": "query", "name": "start_date", "required": true, "schema": { "description": "Required. Start date for fetching event blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_date`. Format: YYYY-MM-DD", "title": "Start Date", "type": "string" } }, { "description": "Required. End date for fetching event blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_date`. Format: YYYY-MM-DD", "in": "query", "name": "end_date", "required": true, "schema": { "description": "Required. End date for fetching event blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_date`. Format: YYYY-MM-DD", "title": "End Date", "type": "string" } }, { "description": "Optional. The ID of the calendar resource to fetch event blocks for", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional. The ID of the calendar resource to fetch event blocks for", "title": "Calendar Resource Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarEventBlockSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List calendar event blocks", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-event-kinds/": { "get": { "description": "Returns a list of all calendar event kinds defined at the organization level. The calendar event kinds are sorted by creation date, with the most recent appearing first.\n\nA **calendar event kind** categorizes calendar events (e.g., staff meeting, lunch break, training). Event kinds help distinguish between different types of non-appointment blocks on a calendar.", "operationId": "calendar_event_kinds_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarEventKindSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all calendar event kinds", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-event-kinds/{calendar_event_kind_id}/": { "get": { "description": "Fetches a calendar event kind by its ID.\n\nA **calendar event kind** categorizes calendar events (e.g., staff meeting, lunch break, training). Event kinds help distinguish between different types of non-appointment blocks on a calendar.", "operationId": "calendar_event_kinds_get", "parameters": [ { "description": "The ID of the calendar event kind to fetch", "in": "path", "name": "calendar_event_kind_id", "required": true, "schema": { "description": "The ID of the calendar event kind to fetch", "title": "Calendar Event Kind Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarEventKindSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a calendar event kind", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-events/": { "get": { "description": "Returns a list of all calendar events across all clinics in the organization. The calendar events are sorted by creation date, with the most recent appearing first.\n\nA **calendar event** represents a non-appointment block on a clinic's calendar (e.g., a staff meeting, lunch break, out-of-office, or clinic closure). Calendar events can be one-off or recurring, and may block appointment scheduling depending on configuration.\n\nEvents are scoped to specific calendar resources (providers) or can apply to all resources on a calendar. If an event is an exception to a recurring series, it references the parent recurring event.", "operationId": "calendar_events_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filter to calendar events belonging to the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar events belonging to the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filter to calendar events assigned to the calendar resource with this ID.", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to calendar events assigned to the calendar resource with this ID.", "title": "Calendar Resource Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarEventSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all calendar events", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-events/{calendar_event_id}/": { "get": { "description": "Fetches a calendar event by its ID.\n\nA **calendar event** represents a non-appointment block on a clinic's calendar (e.g., a staff meeting, lunch break, out-of-office, or clinic closure). Calendar events can be one-off or recurring, and may block appointment scheduling depending on configuration.\n\nEvents are scoped to specific calendar resources (providers) or can apply to all resources on a calendar. If an event is an exception to a recurring series, it references the parent recurring event.", "operationId": "calendar_events_get", "parameters": [ { "description": "The ID of the calendar event to fetch.", "in": "path", "name": "calendar_event_id", "required": true, "schema": { "description": "The ID of the calendar event to fetch.", "title": "Calendar Event Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarEventSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a calendar event", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-kind-preferences/": { "get": { "description": "Returns a list of all calendar kind preferences across all clinics in the organization. The calendar kind preferences are sorted by creation date, with the most recent appearing first.\n\nA **calendar kind preference** links an appointment kind to specific calendar resources, defining which resources can handle which types of appointments. It also controls whether that appointment kind is bookable by pet parents online.", "operationId": "calendar_kind_preferences_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "The ID of the clinic to fetch calendar kind preferences for", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to fetch calendar kind preferences for", "title": "Clinic Id" } }, { "description": "The ID of the calendar to fetch calendar kind preferences for", "in": "query", "name": "calendar_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar to fetch calendar kind preferences for", "title": "Calendar Id" } }, { "description": "The ID of the calendar resource to fetch calendar kind preferences for", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar resource to fetch calendar kind preferences for", "title": "Calendar Resource Id" } }, { "description": "The ID of the appointment kind to fetch calendar kind preferences for", "in": "query", "name": "appointment_kind_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the appointment kind to fetch calendar kind preferences for", "title": "Appointment Kind Id" } }, { "description": "Whether the calendar kind preference is client bookable", "in": "query", "name": "is_client_bookable", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the calendar kind preference is client bookable", "title": "Is Client Bookable" } }, { "description": "The species to fetch calendar kind preferences for, this is filtering across the resources allowed species list", "in": "query", "name": "species", "required": false, "schema": { "default": [], "description": "The species to fetch calendar kind preferences for, this is filtering across the resources allowed species list", "items": { "enum": [ "CANINE", "FELINE", "EQUINE", "AVIAN", "BOVINE", "FERRET", "RABBIT", "RODENT", "REPTILE", "AMPHIBIAN", "FISH", "PORCINE", "CAPRINE", "SHEEP", "CAMELID", "RATITE", "MARSUPIAL", "MUSTELID", "CERVID", "PROCYONIDAE", "ERINACEIDAE", "MEPHITIDAE", "OTHER", "UNSPECIFIED" ], "title": "PatientKind", "type": "string" }, "title": "Species", "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarKindPreferenceList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all calendar kind preferences", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-kind-preferences/{calendar_kind_preference_id}/": { "get": { "description": "Fetches a calendar kind preference by its ID.\n\nA **calendar kind preference** links an appointment kind to specific calendar resources, defining which resources can handle which types of appointments. It also controls whether that appointment kind is bookable by pet parents online.", "operationId": "calendar_kind_preferences_get", "parameters": [ { "description": "The ID of the calendar kind preference to fetch", "in": "path", "name": "calendar_kind_preference_id", "required": true, "schema": { "description": "The ID of the calendar kind preference to fetch", "title": "Calendar Kind Preference Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarKindPreferenceSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a calendar kind preference", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-resources/": { "get": { "description": "Returns a list of all calendar resources across all clinics in the organization. The calendar resources are sorted by creation date, with the most recent appearing first.\n\nA **calendar resource** represents a schedulable person or asset on a clinic's calendar (typically a veterinarian or technician). Appointments are assigned to calendar resources.", "operationId": "calendar_resource_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters the resources for the clinic with this ID", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters the resources for the clinic with this ID", "title": "Clinic Id" } }, { "description": "When provided, filters the resources for the calendar with this ID", "in": "query", "name": "calendar_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters the resources for the calendar with this ID", "title": "Calendar Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar_ResourceList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all calendar resources", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-resources/{calendar_resource_id}/": { "get": { "description": "Fetches a calendar resource by its ID.\n\nA **calendar resource** represents a schedulable person or asset on a clinic's calendar (typically a veterinarian or technician). Appointments are assigned to calendar resources.", "operationId": "calendar_resources_get", "parameters": [ { "description": "The ID of the calendar resource to fetch", "in": "path", "name": "calendar_resource_id", "required": true, "schema": { "description": "The ID of the calendar resource to fetch", "title": "Calendar Resource Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarResourceSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a calendar resource", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-rooms/": { "get": { "description": "Returns a list of all calendar rooms across all clinics in the organization. The calendar rooms are sorted by creation date, with the most recent appearing first.\n\nA **calendar room** represents a physical room at a clinic (e.g., an exam room, surgery suite) that can be assigned to appointments.", "operationId": "calendar_rooms_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "The ID of the clinic to fetch calendar rooms for", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the clinic to fetch calendar rooms for", "title": "Clinic Id" } }, { "description": "The ID of the calendar to fetch calendar rooms for", "in": "query", "name": "calendar_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The ID of the calendar to fetch calendar rooms for", "title": "Calendar Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarRoomSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all calendar rooms", "tags": [ "Scheduler" ] } }, "/ext/v2/calendar-rooms/{calendar_room_id}/": { "get": { "description": "Fetches a calendar room by its ID.\n\nA **calendar room** represents a physical room at a clinic (e.g., an exam room, surgery suite) that can be assigned to appointments.", "operationId": "calendar_rooms_get", "parameters": [ { "description": "The ID of the calendar room to fetch", "in": "path", "name": "calendar_room_id", "required": true, "schema": { "description": "The ID of the calendar room to fetch", "title": "Calendar Room Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarRoomSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a calendar room", "tags": [ "Scheduler" ] } }, "/ext/v2/calendars/": { "get": { "description": "Returns a list of all calendars across all clinics in the organization. The calendars are sorted by creation date, with the most recent calendars appearing first.\n\nA **calendar** represents a scheduling calendar for a specific clinic. Each clinic typically has one calendar that contains all of its appointments, resources (veterinarians/staff), and rooms.", "operationId": "calendars_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters to calendars for this clinic.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to calendars for this clinic.", "title": "Clinic Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all calendars", "tags": [ "Scheduler" ] } }, "/ext/v2/calendars/{calendar_id}/": { "get": { "description": "Fetches a calendar by its ID.\n\nA **calendar** represents a scheduling calendar for a specific clinic. Each clinic typically has one calendar that contains all of its appointments, resources (veterinarians/staff), and rooms.", "operationId": "calendars_get", "parameters": [ { "description": "The ID of the calendar to fetch.", "in": "path", "name": "calendar_id", "required": true, "schema": { "description": "The ID of the calendar to fetch.", "title": "Calendar Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCalendarDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a calendar", "tags": [ "Scheduler" ] } }, "/ext/v2/care-benefits/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all care benefits included in a specific care plan.\n\nA **care benefit** represents a specific service or group of services that a patient receives as part of their care plan enrollment. Benefits can be point-based (a pool of points the patient can redeem for eligible services) or fixed (specific services included in the plan).", "operationId": "care_benefits_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filter to care benefits for the care plan with this ID", "in": "query", "name": "care_plan_id", "required": true, "schema": { "description": "Filter to care benefits for the care plan with this ID", "title": "Care Plan Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCareBenefitSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all care benefits", "tags": [ "Care Plans" ] } }, "/ext/v2/care-plans/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all care plan templates defined at the organization level. The care plans are sorted by creation date, with the most recent care plans appearing first.\n\nA **care plan** is a template for recurring veterinary care that can be offered to patients. Care plans come in two types:\n\n- **Core Plans**: A plan for some defined period of time that typically include a physical exam, vaccinations, and other routine care.\n- **Add-ons**: Optional plans purchased in addition to a core plan (e.g., 12 months of flea and tick prevention).\n\nThese are organization-level templates. To see which patients are enrolled in care plans, use the patient care plans endpoints.", "operationId": "care_plans_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters to care plans for this species of patient", "in": "query", "name": "species", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "type": "null" } ], "description": "When provided, filters to care plans for this species of patient" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCarePlanSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all care plans", "tags": [ "Care Plans" ] } }, "/ext/v2/care-plans/{care_plan_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a care plan template by its ID.\n\nA **care plan** is a template for recurring veterinary care that can be offered to patients. Care plans come in two types:\n\n- **Core Plans**: A plan for some defined period of time that typically include a physical exam, vaccinations, and other routine care.\n- **Add-ons**: Optional plans purchased in addition to a core plan (e.g., 12 months of flea and tick prevention).\n\nThese are organization-level templates. To see which patients are enrolled in care plans, use the patient care plans endpoints.", "operationId": "care_plans_get", "parameters": [ { "description": "The ID of the care plan to fetch", "in": "path", "name": "care_plan_id", "required": true, "schema": { "description": "The ID of the care plan to fetch", "title": "Care Plan Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCarePlanDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a care plan", "tags": [ "Care Plans" ] } }, "/ext/v2/checkout-links/": { "get": { "description": "Returns a list of checkout links for a clinic. The checkout links are sorted by creation date, with the most recent appearing first.\n\nA **checkout link** is a unique URL sent to a pet parent (clinic client) that allows them to complete a purchase online. Each checkout link is associated with a specific clinic and client, and tracks whether the link has been opened and the communication method used to deliver it (e.g., SMS, email).", "operationId": "checkout_links_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Required. Filters to checkout links for this clinic", "in": "query", "name": "clinic_id", "required": true, "schema": { "description": "Required. Filters to checkout links for this clinic", "title": "Clinic Id", "type": "integer" } }, { "description": "When provided, filters to checkout links for this clinic client", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to checkout links for this clinic client", "title": "Clinic Client Id" } }, { "description": "When provided, filters to checkout links sent on or after this date. This will be translated to a datetime representing the start of the day in the clinic's timezone. Format: YYYY-MM-DD", "in": "query", "name": "start_date__gte", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to checkout links sent on or after this date. This will be translated to a datetime representing the start of the day in the clinic's timezone. Format: YYYY-MM-DD", "title": "Start Date Gte" } }, { "description": "When provided, filters to checkout links sent on or prior to this date. This will be translated to a datetime representing the end of the day in the clinic's timezone. Format: YYYY-MM-DD", "in": "query", "name": "end_date__lte", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to checkout links sent on or prior to this date. This will be translated to a datetime representing the end of the day in the clinic's timezone. Format: YYYY-MM-DD", "title": "End Date Lte" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCheckoutLinkSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List checkout links", "tags": [ "Checkout Links" ] } }, "/ext/v2/client-communication-numbers/": { "get": { "description": "Returns a list of all client communication numbers across all clinics in the organization. The communication numbers are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **client communication number** represents a phone number associated with a clinic client (pet parent). Each client can have multiple phone numbers.", "operationId": "client_communication_numbers_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to phone numbers for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to phone numbers for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filters to phone numbers for the clinic client with this ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to phone numbers for the clinic client with this ID.", "title": "Clinic Client Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientCommunicationNumberSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all client communication numbers", "tags": [ "Inbox" ] } }, "/ext/v2/client-communication-numbers/{client_communication_number_id}/": { "get": { "description": "Retrieves a client communication number by its ID.\n\nA **client communication number** represents a phone number associated with a clinic client (pet parent). Each client can have multiple phone numbers.", "operationId": "client_communication_numbers_get", "parameters": [ { "in": "path", "name": "client_communication_number_id", "required": true, "schema": { "title": "Client Communication Number Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientCommunicationNumberSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a client communication number", "tags": [ "Inbox" ] } }, "/ext/v2/client-email-addresses/": { "get": { "description": "Returns a list of all client email addresses across all clinics in the organization. The email addresses are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **client email address** represents an email address associated with a clinic client (pet parent). Each client can have multiple email addresses.", "operationId": "client_email_addresses_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to email addresses for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to email addresses for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filters to email addresses for the clinic client with this ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to email addresses for the clinic client with this ID.", "title": "Clinic Client Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientEmailAddressSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all client email addresses", "tags": [ "Inbox" ] } }, "/ext/v2/client-email-addresses/{client_email_address_id}/": { "get": { "description": "Retrieves a client email address by its ID.\n\nA **client email address** represents an email address associated with a clinic client (pet parent). Each client can have multiple email addresses.", "operationId": "client_email_addresses_get", "parameters": [ { "in": "path", "name": "client_email_address_id", "required": true, "schema": { "title": "Client Email Address Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientEmailAddressSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a client email address", "tags": [ "Inbox" ] } }, "/ext/v2/client-onboardings/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of client onboarding records across all clinics in the organization. The onboardings are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **client onboarding** tracks a new pet parent's setup process, including their subscriptions (recurring autoship orders), estimated annual value, and prescription status for each subscription.", "operationId": "client_onboarding", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When provided, filters to onboardings created on or after this date", "in": "query", "name": "created__gte", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to onboardings created on or after this date", "title": "Created Gte" } }, { "description": "When provided, filters to onboardings created on or before this date", "in": "query", "name": "created__lte", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "When provided, filters to onboardings created on or before this date", "title": "Created Lte" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClientOnboardingSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all client onboardings", "tags": [ "Onboarding" ] } }, "/ext/v2/clinic-care-plans/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of care plan templates available at a specific clinic, including clinic-specific pricing. The care plans are sorted by creation date, with the most recent care plans appearing first.\n\nThis endpoint is scoped to a single clinic and returns only care plans that are tagged for that clinic's location group. Each care plan includes the price and enrollment fee specific to that clinic's care pricing group.", "operationId": "clinic_care_plans_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters to care plans for this species of patient", "in": "query", "name": "species", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PatientKind" }, { "type": "null" } ], "description": "When provided, filters to care plans for this species of patient" } }, { "description": "Filters to care plans for the clinic with this ID", "in": "query", "name": "clinic_id", "required": true, "schema": { "description": "Filters to care plans for the clinic with this ID", "title": "Clinic Id", "type": "integer" } }, { "description": "When provided, filters to care plans by billing frequency. `MONTHLY` returns plans with a monthly default duration. `ANNUAL` returns plans with a yearly default duration.", "in": "query", "name": "billing_frequency", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExternalBillingFrequency" }, { "type": "null" } ], "description": "When provided, filters to care plans by billing frequency. `MONTHLY` returns plans with a monthly default duration. `ANNUAL` returns plans with a yearly default duration." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicCarePlanSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic care plans for a clinic", "tags": [ "Care Plans" ] } }, "/ext/v2/clinic-client-users/": { "get": { "description": "Returns a list of all clinic client users across all clinics in the organization. The clinic client users are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **clinic client user** represents an individual person associated with a clinic client account. When a pet has multiple owners (co-owners), each person is a separate clinic client user under the same clinic client. The primary clinic client user is the main account holder whose name and contact information appear on the parent clinic client record.", "operationId": "clinic_client_users_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filters to clinic client users for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clinic client users for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filters to clinic client users associated with the clinic client with the given ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clinic client users associated with the clinic client with the given ID.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to clinic client users with this exact primary email address.", "in": "query", "name": "email", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to clinic client users with this exact primary email address.", "title": "Email" } }, { "description": "When provided, filters to clinic client users with this exact 10-digit primary phone number.", "in": "query", "name": "phone_number", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to clinic client users with this exact 10-digit primary phone number.", "title": "Phone Number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientUserSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic client users", "tags": [ "Clients And Patients" ] }, "post": { "description": "Creates a new clinic client user (co-owner) for an existing clinic client account. The new clinic client user will have their own contact information (name, email, phone) and can be associated with a relationship type describing their connection to the account (e.g., spouse, family member).\n\nThis is used when a pet has multiple owners who each need their own contact details and communication preferences.", "operationId": "clinic_client_users_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientUserCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientUserSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a new clinic client user", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-client-users/{clinic_client_user_id}/": { "get": { "description": "Fetches a specific clinic client user by their ID.\n\nA **clinic client user** represents an individual person associated with a clinic client account. When a pet has multiple owners (co-owners), each person is a separate clinic client user under the same clinic client. The primary clinic client user is the main account holder whose name and contact information appear on the parent clinic client record.", "operationId": "clinic_client_users_detail", "parameters": [ { "description": "The ID of the clinic client user to retrieve or update", "in": "path", "name": "clinic_client_user_id", "required": true, "schema": { "description": "The ID of the clinic client user to retrieve or update", "title": "Clinic Client User Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientUserSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a clinic client user", "tags": [ "Clients And Patients" ] }, "patch": { "description": "Partially updates a clinic client user with the given information. Only fields included in the request body will be updated; omitted fields are left unchanged.", "operationId": "clinic_client_users_patch", "parameters": [ { "description": "The ID of the clinic client user to retrieve or update", "in": "path", "name": "clinic_client_user_id", "required": true, "schema": { "description": "The ID of the clinic client user to retrieve or update", "title": "Clinic Client User Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientUserPatchSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientUserSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Partially update a clinic client user", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-clients/": { "get": { "description": "Returns a list of all clinic clients (pet parents) across all clinics in the organization. The clinic clients are sorted by creation date, with the most recent clinic clients appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **clinic client** represents a pet parent at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). When the same person visits multiple clinics in the organization, they will have a separate clinic client record at each location, linked by a shared organization client ID.", "operationId": "clinic_clients_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filters to clients for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clients for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filters to clients associated with the organization client ID.", "in": "query", "name": "organization_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to clients associated with the organization client ID.", "title": "Organization Client Id" } }, { "description": "When provided, filters to clients with this exact email address", "in": "query", "name": "email", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to clients with this exact email address", "title": "Email" } }, { "description": "When provided, filters to clients with this exact 10-digit phone number", "in": "query", "name": "phone_number", "required": false, "schema": { "anyOf": [ { "maximum": 9999999999, "minimum": 1000000000, "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to clients with this exact 10-digit phone number", "title": "Phone Number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic clients", "tags": [ "Clients And Patients" ] }, "post": { "description": "Creates a new clinic client with the given information and, optionally, associated clinic patients.\n\nA **clinic client** represents a pet parent (pet owner) at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). If the same person visits multiple clinics within the same organization, they will have a separate clinic client record at each location, linked by a shared organization client ID.", "operationId": "clinic_clients_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientDetailSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a clinic client", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-clients/search/": { "get": { "description": "Searches for clinic clients by name, email, phone number, or zip code using structured field-level matching. Email and phone searches match any address or number on the client, not only the primary contact.\n\nA **clinic client** represents a pet parent at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). When the same person visits multiple clinics in the organization, they will have a separate clinic client record at each location, linked by a shared organization client ID.", "operationId": "clinic_clients_search", "parameters": [ { "description": "Searches for clients whose name matches this value. Automatically trimmed and lowercased. Requires `name_operator` when provided.", "in": "query", "name": "name", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose name matches this value. Automatically trimmed and lowercased. Requires `name_operator` when provided.", "title": "Name" } }, { "description": "The match mode to use for the `name` field.", "in": "query", "name": "name_operator", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/NameOperator" }, { "type": "null" } ], "description": "The match mode to use for the `name` field." } }, { "description": "Searches for clients whose email matches this value. Automatically trimmed and lowercased. Requires `email_operator` when provided.", "in": "query", "name": "email", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose email matches this value. Automatically trimmed and lowercased. Requires `email_operator` when provided.", "title": "Email" } }, { "description": "The match mode to use for the `email` field.", "in": "query", "name": "email_operator", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EmailOperator" }, { "type": "null" } ], "description": "The match mode to use for the `email` field." } }, { "description": "Searches for clients whose phone number matches this value. Non-numeric characters are automatically stripped. Requires `phone_number_operator` when provided.", "in": "query", "name": "phone_number", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose phone number matches this value. Non-numeric characters are automatically stripped. Requires `phone_number_operator` when provided.", "title": "Phone Number" } }, { "description": "The match mode to use for the `phone_number` field.", "in": "query", "name": "phone_number_operator", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PhoneNumberOperator" }, { "type": "null" } ], "description": "The match mode to use for the `phone_number` field." } }, { "description": "Searches for clients whose zip code matches this value. Automatically trimmed and lowercased. Requires `zip_code_operator` when provided.", "in": "query", "name": "zip_code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Searches for clients whose zip code matches this value. Automatically trimmed and lowercased. Requires `zip_code_operator` when provided.", "title": "Zip Code" } }, { "description": "The match mode to use for the `zip_code` field.", "in": "query", "name": "zip_code_operator", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ZipCodeOperator" }, { "type": "null" } ], "description": "The match mode to use for the `zip_code` field." } }, { "description": "Filters to clients with the given active status.", "in": "query", "name": "is_active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filters to clients with the given active status.", "title": "Is Active" } }, { "description": "The page number to return.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "description": "The page number to return.", "minimum": 1, "title": "Page", "type": "integer" } }, { "description": "The number of results per page.", "in": "query", "name": "page_size", "required": false, "schema": { "default": 20, "description": "The number of results per page.", "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientSearchSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Search clinic clients", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-clients/{clinic_client_id}/": { "get": { "description": "Fetches a clinic client (pet parent) by their ID.\n\nA **clinic client** represents a pet parent at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). When the same person visits multiple clinics in the organization, they will have a separate clinic client record at each location, linked by a shared organization client ID.", "operationId": "clinic_clients_get", "parameters": [ { "description": "The ID of the client to fetch", "in": "path", "name": "clinic_client_id", "required": true, "schema": { "description": "The ID of the client to fetch", "title": "Clinic Client Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a clinic client", "tags": [ "Clients And Patients" ] }, "patch": { "description": "Partially updates a clinic client (pet parent) with the given information. Only fields included in the request body will be updated; omitted fields are left unchanged.\n\nFor clients with multiple users (co-owners), updates to name, phone, and email fields apply to the primary client user only. Use the clinic client users endpoints to manage individual co-owner details.", "operationId": "clinic_clients_patch", "parameters": [ { "description": "The ID of the client to fetch", "in": "path", "name": "clinic_client_id", "required": true, "schema": { "description": "The ID of the client to fetch", "title": "Clinic Client Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientPatchSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicClientDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Partially update a clinic client", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-location-groups/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all clinic location groups in the organization. The clinic location groups are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **clinic location group** is an organizational grouping of clinics within an organization. For example, an organization might group its clinics by region or by brand. Location groups are used to apply shared configuration \u2014 such as pricing, care plan availability, and inventory settings \u2014 to a subset of clinics. Each clinic has a single primary location group from which it inherits these settings, but may also belong to any number of additional location groups.", "operationId": "clinic_location_groups_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicTagSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic location groups", "tags": [ "Clinics" ] } }, "/ext/v2/clinic-location-groups/{clinic_location_group_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a clinic location group by its ID.\n\nA **clinic location group** is an organizational grouping of clinics within an organization. For example, an organization might group its clinics by region or by brand. Location groups are used to apply shared configuration \u2014 such as pricing, care plan availability, and inventory settings \u2014 to a subset of clinics. Each clinic has a single primary location group from which it inherits these settings, but may also belong to any number of additional location groups.", "operationId": "clinic_location_groups_get", "parameters": [ { "description": "The ID of the clinic location group to fetch", "in": "path", "name": "clinic_location_group_id", "required": true, "schema": { "description": "The ID of the clinic location group to fetch", "title": "Clinic Location Group Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicTagDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a clinic location group", "tags": [ "Clinics" ] } }, "/ext/v2/clinic-patient-upload-groups/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a paginated list of clinic patient upload groups.\n\nAn **upload group** is a collection of uploaded files (such as lab results, images, or documents) that are attached to a clinic patient's record and displayed on their timeline in the PIMS.", "operationId": "clinic_patient_upload_groups_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filters to upload groups for the clinic patient with this ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to upload groups for the clinic patient with this ID.", "title": "Clinic Patient Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientUploadGroupSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic patient upload groups", "tags": [ "Clients And Patients" ] }, "post": { "description": "This endpoint is available to Group API Keys only.\n\nCreate an clinic patient upload group after uploading the raw files to our file server.\n\nNewly created upload groups are asynchronously posted to a clinic patient's timeline in our PIMS. They will be\nimmediately visible through this API but may not appear to clinicians utilizing the PIMS for several minutes.\n", "operationId": "clinic_patient_upload_groups_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientUploadGroupCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientUploadGroupSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create an clinic patient upload group", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-patient-upload-groups/{clinic_patient_upload_group_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a clinic patient upload group by its ID.\n\nAn **upload group** is a collection of uploaded files (such as lab results, images, or documents) that are attached to a clinic patient's record and displayed on their timeline in the PIMS.", "operationId": "clinic_patient_upload_groups_get", "parameters": [ { "description": "The ID of the clinic patient upload group to fetch", "in": "path", "name": "clinic_patient_upload_group_id", "required": true, "schema": { "description": "The ID of the clinic patient upload group to fetch", "title": "Clinic Patient Upload Group Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientUploadGroupSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a clinic patient upload group", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-patients/": { "get": { "description": "Returns a list of all clinic patients (pets) across all clinics in the organization. The clinic patients are sorted by creation date, with the most recent clinic patients appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **clinic patient** represents a pet at a specific clinic location. Each clinic patient is associated with one or more clinic clients (pet parents) and belongs to exactly one clinic. When the same pet visits multiple clinics in the organization, it will have a separate clinic patient record at each location, linked by a shared organization patient ID.", "operationId": "clinic_patients_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filters to patients associated with the clinic with the given ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patients associated with the clinic with the given ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "title": "Clinic Id" } }, { "description": "Filters to patients associated with the clinic client with the given ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patients associated with the clinic client with the given ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "title": "Clinic Client Id" } }, { "description": "Filters to patients associated with the organization patient ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "in": "query", "name": "organization_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patients associated with the organization patient ID. At least one of the `clinic_id`, `clinic_client_id`, or `organization_patient_id` fields are required.", "title": "Organization Patient Id" } }, { "description": "Filters to active patients. Active patients are alive, not deleted, not surrendered, and not deactivated.", "in": "query", "name": "is_active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filters to active patients. Active patients are alive, not deleted, not surrendered, and not deactivated.", "title": "Is Active" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic patients", "tags": [ "Clients And Patients" ] }, "post": { "description": "Creates a new clinic patient (pet) and associates it with an existing clinic client (pet parent). The clinic client must belong to a clinic that is accessible to your API key.", "operationId": "clinic_patients_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientDetailSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a clinic patient", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinic-patients/{clinic_patient_id}/": { "get": { "description": "Fetches a clinic patient (pet) by their ID.\n\nA **clinic patient** represents a pet at a specific clinic location. Each clinic patient is associated with one or more clinic clients (pet parents) and belongs to exactly one clinic. When the same pet visits multiple clinics in the organization, it will have a separate clinic patient record at each location, linked by a shared organization patient ID.", "operationId": "clinic_patient_get", "parameters": [ { "description": "The ID of the clinic patient to fetch", "in": "path", "name": "clinic_patient_id", "required": true, "schema": { "description": "The ID of the clinic patient to fetch", "title": "Clinic Patient Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a clinic patient", "tags": [ "Clients And Patients" ] }, "patch": { "description": "Partially updates a clinic patient (pet) with the given information. Only fields included in the request body will be updated; omitted fields are left unchanged.\n\n**Note:** PATCH semantics extend to the `metadata` field. We will merge the provided keys in this request with the existing `metadata`, overwriting any conflicting keys and preserving keys not provided.", "operationId": "clinic_patients_patch", "parameters": [ { "description": "The ID of the clinic patient to update", "in": "path", "name": "clinic_patient_id", "required": true, "schema": { "description": "The ID of the clinic patient to update", "title": "Clinic Patient Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientPatchSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicPatientDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Partially update a clinic patient", "tags": [ "Clients And Patients" ] } }, "/ext/v2/clinics/": { "get": { "description": "Returns a list of all clinics in the organization. The clinics are sorted by creation date, with the most recent clinics appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **clinic** represents a single veterinary clinic location. An organization (clinic group) can have many clinics. Each clinic has its own clients, patients, and operational data.", "operationId": "clinics_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to clinics for the list of group location codes. Group location codes are a group's internal identifier for their clinics.", "in": "query", "name": "group_location_codes", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to clinics for the list of group location codes. Group location codes are a group's internal identifier for their clinics.", "title": "Group Location Codes" } }, { "description": "When `True`, filters to PIMS-enabled clinics. When `False`, filters to non-PIMS clinics. When `None`, then both are included.", "in": "query", "name": "is_pims", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to PIMS-enabled clinics. When `False`, filters to non-PIMS clinics. When `None`, then both are included.", "title": "Is Pims" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClinicList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinics", "tags": [ "Clinics" ] } }, "/ext/v2/clinics/{clinic_id}/": { "get": { "description": "Fetches a clinic by its ID.\n\nA **clinic** represents a single veterinary clinic location. An organization (clinic group) can have many clinics. Each clinic has its own address, timezone, and staff, and serves as the primary scope for most data in the API (clients, patients, orders, invoices, etc.).", "operationId": "clinics_get", "parameters": [ { "description": "The ID of the clinic to fetch", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to fetch", "title": "Clinic Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a clinic", "tags": [ "Clinics" ] } }, "/ext/v2/clinics/{clinic_id}/assigned-service-pricing-groups/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns the list of service pricing groups currently assigned to a specific clinic. The service pricing groups are sorted by creation date, with the most recent service pricing groups appearing first.\n\nEach clinic must have one pricing group assigned per pricing category to determine how its services are priced.", "operationId": "clinic_assigned_pricing_groups_detail", "parameters": [ { "description": "The ID of the clinic to update mappings for", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to update mappings for", "title": "Clinic Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicAssignedPricingGroupsSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch service pricing groups assigned to a clinic", "tags": [ "Service Pricing" ] }, "put": { "description": "This endpoint is available to Group API Keys only.\n\nReplaces the full list of service pricing groups assigned to a clinic. This determines which pricing tier the clinic uses for each service pricing category.", "operationId": "clinic_assigned_pricing_groups_update", "parameters": [ { "description": "The ID of the clinic to update mappings for", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to update mappings for", "title": "Clinic Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceClinicUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicAssignedPricingGroupsSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update service pricing groups assigned to a clinic", "tags": [ "Service Pricing" ] } }, "/ext/v2/clinics/{clinic_id}/care-plan-prices/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns the prices for all care plans available at a specific clinic.\n\nEach entry includes the recurring price and the one-time enrollment fee as configured for the clinic's care pricing group. Care plans without a price set for the clinic's pricing group will not have pricing information.", "operationId": "clinic_care_plan_prices_list", "parameters": [ { "description": "The ID of the clinic to fetch care plan prices for", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to fetch care plan prices for", "title": "Clinic Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicCarePlanPriceSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic care plan prices", "tags": [ "Care Plans" ] } }, "/ext/v2/clinics/{clinic_id}/group-bundles/{group_bundle_id}/bundle-price-override/": { "put": { "description": "This endpoint is available to Group API Keys only.\n\nCreates or replaces the clinic-level bundle price override for this bundle (PUT upsert). If the clinic has no bundle enrollment yet, one is created before applying the price. Clinic bundle enrollment can be enabled or disabled as part of this request; new enrollments are enabled unless specified otherwise.", "operationId": "clinic_bundle_price_override_update", "parameters": [ { "description": "The ID of the clinic whose bundle price override is updated.", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic whose bundle price override is updated.", "title": "Clinic Id", "type": "integer" } }, { "description": "The ID of the organization bundle (group bundle) whose clinic override is updated.", "in": "path", "name": "group_bundle_id", "required": true, "schema": { "description": "The ID of the organization bundle (group bundle) whose clinic override is updated.", "title": "Group Bundle Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClinicBundlePriceOverrideUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicBundlePriceSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update clinic bundle price override", "tags": [ "Service Pricing" ] } }, "/ext/v2/clinics/{clinic_id}/group-services/": { "get": { "description": "Returns all organization-level services as they apply to a specific clinic, including any clinic-level price overrides and the effective pricing from the clinic's assigned pricing group.", "operationId": "clinic_service_list", "parameters": [ { "description": "The ID of the clinic to fetch group service prices for.", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to fetch group service prices for.", "title": "Clinic Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, only return prices for group services with these IDs.", "in": "query", "name": "group_service_ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, only return prices for group services with these IDs.", "title": "Group Service Ids" } }, { "description": "When provided, only return prices for group services with these service codes.", "in": "query", "name": "group_service_codes", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, only return prices for group services with these service codes.", "title": "Group Service Codes" } }, { "description": "When provided, only return prices for group services with these service pricing category IDs.", "in": "query", "name": "service_pricing_category_ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, only return prices for group services with these service pricing category IDs.", "title": "Service Pricing Category Ids" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicServiceDetailSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all group services with a clinic's overrides", "tags": [ "Service Pricing" ] }, "post": { "description": "This endpoint is available to Group API Keys only.\n\nCreates clinic-level overrides for an organization-level service at the specified clinic. This allows a clinic to customize the service configuration (e.g., price, tax category) independently from the organization-level defaults.", "operationId": "clinic_service_create", "parameters": [ { "description": "The ID of the clinic to add clinic-level group service data for.", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to add clinic-level group service data for.", "title": "Clinic Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicServiceCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicServiceDetailSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create clinic overrides for a group service", "tags": [ "Service Pricing" ] } }, "/ext/v2/clinics/{clinic_id}/group-services/{group_service_id}/": { "get": { "description": "Fetches a specific organization-level service as it applies to a given clinic, including any clinic-level overrides and the effective pricing from the clinic's assigned pricing group.", "operationId": "clinic_service_detail", "parameters": [ { "description": "The ID of the group service to fetch clinic-level service data for.", "in": "path", "name": "group_service_id", "required": true, "schema": { "description": "The ID of the group service to fetch clinic-level service data for.", "title": "Group Service Id", "type": "integer" } }, { "description": "The ID of the clinic to fetch the clinic-level service data for.", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to fetch the clinic-level service data for.", "title": "Clinic Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicServiceDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a group service with clinic overrides", "tags": [ "Service Pricing" ] }, "put": { "description": "This endpoint is available to Group API Keys only.\n\nUpdates existing clinic-level overrides for an organization-level service at the specified clinic.", "operationId": "clinic_service_update", "parameters": [ { "description": "The ID of the group service to update clinic-level data for.", "in": "path", "name": "group_service_id", "required": true, "schema": { "description": "The ID of the group service to update clinic-level data for.", "title": "Group Service Id", "type": "integer" } }, { "description": "The ID of the clinic to update the clinic-level service data for.", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to update the clinic-level service data for.", "title": "Clinic Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicServiceUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicServiceDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update clinic overrides for a group service", "tags": [ "Service Pricing" ] } }, "/ext/v2/clinics/{clinic_id}/group-services/{group_service_id}/delete-price-override/": { "delete": { "description": "This endpoint is available to Group API Keys only.\n\nRemoves the clinic-level price override for a specific group service at the given clinic. After deletion, the service will revert to the organization-level pricing defined by the clinic's assigned service pricing group.", "operationId": "clinic_price_override_delete", "parameters": [ { "description": "The ID of the group service to delete clinic price overrides for.", "in": "path", "name": "group_service_id", "required": true, "schema": { "description": "The ID of the group service to delete clinic price overrides for.", "title": "Group Service Id", "type": "integer" } }, { "description": "The ID of the clinic to delete clinic price overrides for.", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to delete clinic price overrides for.", "title": "Clinic Id", "type": "integer" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Delete clinic override for a group service.", "tags": [ "Service Pricing" ] } }, "/ext/v2/clinics/{clinic_id}/inventory-codes/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a clinic-specific view of all relevant inventory codes, including clinic-level configuration such as pricing, stock levels, and enabled/disabled status. The inventory codes are sorted by creation date, with the most recent appearing first.\n\nA **clinic inventory code** is the clinic-level view of an inventory code, including clinic-specific overrides to pricing, stock quantities, reorder points, and enabled/disabled status. ", "operationId": "clinic_inventory_code_list", "parameters": [ { "description": "The ID of the clinic to fetch inventory codes for", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to fetch inventory codes for", "title": "Clinic Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters inventory codes by the code", "in": "query", "name": "code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters inventory codes by the code", "title": "Code" } }, { "description": "When provided, filters inventory codes by their enabled status for the clinic. When true, returns only enabled inventory codes. When false, returns only disabled inventory codes.", "in": "query", "name": "is_enabled", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When provided, filters inventory codes by their enabled status for the clinic. When true, returns only enabled inventory codes. When false, returns only disabled inventory codes.", "title": "Is Enabled" } }, { "description": "When provided, filters inventory codes by their stock status", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InventoryStatus" }, { "type": "null" } ], "description": "When provided, filters inventory codes by their stock status" } }, { "description": "When provided, limits results to inventory codes whose global inventory belongs to this category.", "in": "query", "name": "category_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, limits results to inventory codes whose global inventory belongs to this category.", "title": "Category Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicInventoryCodeSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all inventory codes for a clinic", "tags": [ "Inventory" ] } }, "/ext/v2/clinics/{clinic_id}/inventory-codes/{inventory_code_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a clinic-specific view of an inventory code by its ID.\n\nA **clinic inventory code** is the clinic-level view of an inventory code, including clinic-specific overrides to pricing, stock quantities, reorder points, and enabled/disabled status. ", "operationId": "clinic_inventory_code_get", "parameters": [ { "description": "The ID of the clinic to fetch an inventory code for", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to fetch an inventory code for", "title": "Clinic Id", "type": "integer" } }, { "description": "The ID of the inventory code to fetch", "in": "path", "name": "inventory_code_id", "required": true, "schema": { "description": "The ID of the inventory code to fetch", "title": "Inventory Code Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicInventoryCodeDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an inventory code for a clinic", "tags": [ "Inventory" ] } }, "/ext/v2/clinics/{clinic_id}/tax-categories/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a clinic-specific view of all tax categories, including the tax status at each jurisdiction level (state, county, city) for the specified clinic. The tax categories are sorted by creation date, with the most recent appearing first.", "operationId": "clinic_tax_categories_list", "parameters": [ { "description": "The clinic ID of the tax statuses to fetch", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The clinic ID of the tax statuses to fetch", "title": "Clinic Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalClinicTaxCategorySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all clinic level tax categories", "tags": [ "Taxes" ] } }, "/ext/v2/clinics/{clinic_id}/tax-setting/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches the tax configuration for a specific clinic.\n\nA **tax setting** defines the tax rates that apply at a specific clinic location, broken down by jurisdiction level (state, county, city, and federal). These rates are used to calculate taxes on invoiced services and products.", "operationId": "tax_setting_get", "parameters": [ { "description": "The clinic ID of the tax setting to fetch", "in": "path", "name": "clinic_id", "required": true, "schema": { "description": "The clinic ID of the tax setting to fetch", "title": "Clinic Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalTaxSettingDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a tax setting", "tags": [ "Taxes" ] } }, "/ext/v2/doctors/": { "get": { "description": "Returns a list of all doctors in the organization. The doctors are sorted by creation date, with the most recent doctors appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **doctor** is a veterinarian within an organization.", "operationId": "doctors_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "Filters to doctors associated with the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to doctors associated with the clinic with this ID.", "title": "Clinic Id" } }, { "description": "When `True`, filters to active doctors. When `False`, filters to inactive doctors. When omitted, both are included.", "in": "query", "name": "is_active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to active doctors. When `False`, filters to inactive doctors. When omitted, both are included.", "title": "Is Active" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalDoctorSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all doctors", "tags": [ "Clinics" ] } }, "/ext/v2/doctors/{doctor_id}/": { "get": { "description": "Fetches a doctor by their ID.\n\nA **doctor** is a veterinarian within an organization.", "operationId": "doctors_get", "parameters": [ { "description": "The ID of the doctor to fetch", "in": "path", "name": "doctor_id", "required": true, "schema": { "description": "The ID of the doctor to fetch", "title": "Doctor Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalDoctorDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a doctor", "tags": [ "Clinics" ] } }, "/ext/v2/form-requests/": { "get": { "description": "Returns form requests for an organization, filtered by clinic, client, patient, or appointment.\n\nA **form request** is a client-facing form instance tied to a client and patient, optionally linked to an appointment. Forms are used to collect information from clients before or after visits \u2014 such as intake questionnaires, consent forms, or post-visit surveys.", "operationId": "form_requests_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When provided, filters to form requests for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "When provided, filters to form requests for the clinic client with this ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests for the clinic client with this ID.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to form requests for the clinic patient with this ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests for the clinic patient with this ID.", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to form requests linked to the appointment with this ID.", "in": "query", "name": "appointment_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to form requests linked to the appointment with this ID.", "title": "Appointment Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalFormRequestSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List form requests", "tags": [ "Forms" ] } }, "/ext/v2/group-services/": { "get": { "description": "Returns a list of all services defined at the organization level. The services are sorted by creation date, with the most recent appearing first.\n\nA **group service** (also called a service) represents an in-clinic procedure or treatment defined at the organization level (e.g., an exam, vaccination, dental cleaning, or surgery).", "operationId": "group_service_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters to the group service with this service code.", "in": "query", "name": "code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters to the group service with this service code.", "title": "Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalGroupServiceSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all services", "tags": [ "Service Pricing" ] }, "post": { "description": "This endpoint is available to Group API Keys only.\n\nCreates a new service at the organization level.", "operationId": "group_service_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalGroupServiceCreateOrUpdateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalGroupServiceDetailSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a service", "tags": [ "Service Pricing" ] } }, "/ext/v2/group-services/{group_service_id}/": { "get": { "description": "Fetches a group service by its ID.\n\nA **group service** (also called a service) represents an in-clinic procedure or treatment defined at the organization level (e.g., an exam, vaccination, dental cleaning, or surgery). Each service belongs to a service pricing category and has pricing configured through service pricing groups.", "operationId": "group_service_detail", "parameters": [ { "description": "The ID of the group service to fetch", "in": "path", "name": "group_service_id", "required": true, "schema": { "description": "The ID of the group service to fetch", "title": "Group Service Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalGroupServiceDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a service", "tags": [ "Service Pricing" ] }, "put": { "description": "This endpoint is available to Group API Keys only.\n\nUpdates an existing organization-level service by its ID.", "operationId": "group_service_update", "parameters": [ { "description": "The ID of the group service to update", "in": "path", "name": "group_service_id", "required": true, "schema": { "description": "The ID of the group service to update", "title": "Group Service Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalGroupServiceCreateOrUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalGroupServiceDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update a service", "tags": [ "Service Pricing" ] } }, "/ext/v2/imported-conversations/": { "get": { "description": "Returns a list of all imported conversations across all clinics in the organization. The conversations are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nAn **imported conversation** is a read-only transcript of a completed conversation (typically SMS) written back into Vetcove from a partner communications platform.\n\nImported conversations do not appear in the Vetcove inbox. They surface on the patient timeline so clinic staff can read prior client outreach alongside the rest of the patient record. When a conversation is submitted without a patient, it is attached to every active patient of the clinic client so that it appears on each of their timelines.", "operationId": "imported_conversations_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When provided, filters to imported conversations for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to imported conversations for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "When provided, filters to imported conversations for the clinic client with this ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to imported conversations for the clinic client with this ID.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to imported conversations attached to the clinic patient with this ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to imported conversations attached to the clinic patient with this ID.", "title": "Clinic Patient Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalImportedConversationSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all imported conversations", "tags": [ "Inbox" ] }, "post": { "description": "Writes a completed conversation transcript back into Vetcove so that it surfaces on the clinic's patient timelines.\n\nAttachments must be uploaded via `POST /file-uploads/` before creating the conversation.\n\nAn **imported conversation** is a read-only transcript of a completed conversation (typically SMS) written back into Vetcove from a partner communications platform.\n\nImported conversations do not appear in the Vetcove inbox. They surface on the patient timeline so clinic staff can read prior client outreach alongside the rest of the patient record. When a conversation is submitted without a patient, it is attached to every active patient of the clinic client so that it appears on each of their timelines.", "operationId": "imported_conversations_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportedConversationRequestSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalImportedConversationSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create an imported conversation", "tags": [ "Inbox" ] } }, "/ext/v2/imported-conversations/{imported_conversation_id}/": { "get": { "description": "Retrieves an imported conversation by its ID.\n\nAn **imported conversation** is a read-only transcript of a completed conversation (typically SMS) written back into Vetcove from a partner communications platform.\n\nImported conversations do not appear in the Vetcove inbox. They surface on the patient timeline so clinic staff can read prior client outreach alongside the rest of the patient record. When a conversation is submitted without a patient, it is attached to every active patient of the clinic client so that it appears on each of their timelines.", "operationId": "imported_conversations_get", "parameters": [ { "in": "path", "name": "imported_conversation_id", "required": true, "schema": { "title": "Imported Conversation Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalImportedConversationSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an imported conversation", "tags": [ "Inbox" ] } }, "/ext/v2/insurance-providers/": { "get": { "description": "Returns a list of all recognized pet insurance providers. The insurance providers are sorted by creation date, with the most recent appearing first.\n\n**Insurance providers** are a reference list of pet insurance companies (e.g., Trupanion, Nationwide). When a clinic patient has insurance, their record references one of these providers. This is a global reference table, not scoped to a specific organization.", "operationId": "insurance_providers_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInsuranceProviderSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all insurance providers", "tags": [ "Insurance" ] } }, "/ext/v2/insurance-providers/{insurance_provider_id}/": { "get": { "description": "Fetches a pet insurance provider by its ID.\n\n**Insurance providers** are a reference list of pet insurance companies (e.g., Trupanion, Nationwide). When a clinic patient has insurance, their record references one of these providers. This is a global reference table, not scoped to a specific organization.", "operationId": "insurance_providers_get", "parameters": [ { "description": "The ID of the insurance provider to fetch", "in": "path", "name": "insurance_provider_id", "required": true, "schema": { "description": "The ID of the insurance provider to fetch", "title": "Insurance Provider Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInsuranceProviderDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an insurance provider", "tags": [ "Insurance" ] } }, "/ext/v2/inventory-categories/": { "get": { "description": "Returns a list of all inventory categories. The inventory categories are sorted by creation date, with the most recent appearing first.\n\nAn **inventory category** groups related inventory codes together (e.g., Vaccines, Controlled Substances, General Supplies). This is a global reference table, not scoped to a specific organization.", "operationId": "inventory_category_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInventoryCategorySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all inventory categories", "tags": [ "Inventory" ] } }, "/ext/v2/inventory-categories/{inventory_category_id}/": { "get": { "description": "Fetches an inventory category by its ID.\n\nAn **inventory category** groups related inventory codes together (e.g., Vaccines, Controlled Substances, General Supplies). This is a global reference table, not scoped to a specific organization.", "operationId": "inventory_category_get", "parameters": [ { "description": "The ID of the inventory category to fetch", "in": "path", "name": "inventory_category_id", "required": true, "schema": { "description": "The ID of the inventory category to fetch", "title": "Inventory Category Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInventoryCategoryDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an inventory category", "tags": [ "Inventory" ] } }, "/ext/v2/inventory-codes/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all inventory codes in the organization. The inventory codes are sorted by creation date, with the most recent appearing first.\n\nAn **inventory code** represents a trackable supply item used within a clinic (e.g., a specific medication, vaccine vial, or consumable) and can be configured at the organization level with clinic-specific overrides.", "operationId": "inventory_code_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters inventory codes by the code", "in": "query", "name": "code", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When provided, filters inventory codes by the code", "title": "Code" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInventoryCodeSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all inventory codes", "tags": [ "Inventory" ] } }, "/ext/v2/inventory-codes/{inventory_code_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches an inventory code by its ID.\n\nAn **inventory code** represents a trackable supply item used within a clinic (e.g., a specific medication, vaccine vial, or consumable) and can be configured at the organization level with clinic-specific overrides.", "operationId": "inventory_code_get", "parameters": [ { "description": "The ID of the inventory code to fetch", "in": "path", "name": "inventory_code_id", "required": true, "schema": { "description": "The ID of the inventory code to fetch", "title": "Inventory Code Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInventoryCodeDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an inventory code", "tags": [ "Inventory" ] } }, "/ext/v2/invoice-items/": { "get": { "description": "Returns a list of all invoice items across all clinics in the organization. The items are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted by modification date instead.\n\nAn invoice item represents a single line item on a clinic invoice \u2014 a service rendered, product dispensed, or other billable charge. Each item tracks the quantity, unit price, applicable discounts and taxes, and the resulting total. Each item is associated with a specific patient.", "operationId": "invoiceItems_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to invoice items for this clinic.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items for this clinic.", "title": "Clinic Id" } }, { "description": "When provided, filters to invoice items for this clinic client.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items for this clinic client.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to invoice items for this clinic patient.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items for this clinic patient.", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to invoice items on this invoice.", "in": "query", "name": "invoice_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice items on this invoice.", "title": "Invoice Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoiceItemSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all invoice items", "tags": [ "Invoices" ] } }, "/ext/v2/invoice-items/{pk}/": { "get": { "description": "Retrieves an invoice item by its ID.\n\nAn invoice item represents a single line item on a clinic invoice \u2014 a service rendered, product dispensed, or other billable charge. Each item tracks the quantity, unit price, applicable discounts and taxes, and the resulting total. Each item is associated with a specific patient.", "operationId": "invoiceItems_get", "parameters": [ { "in": "path", "name": "pk", "required": true, "schema": { "title": "Pk", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoiceItemDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an invoice item", "tags": [ "Invoices" ] } }, "/ext/v2/invoice-payments/": { "get": { "description": "Returns a list of all invoice payments across all clinics in the organization. The payments are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted by modification date instead.\n\nAn **invoice payment** represents a payment allocation applied toward a specific clinic invoice. When a client (pet parent) makes a payment, it is split across one or more invoices as individual invoice payment records, each tracking the amount applied. Invoice payments are never deleted.", "operationId": "invoicePayments_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When provided, filters to invoice payments for this clinic.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice payments for this clinic.", "title": "Clinic Id" } }, { "description": "When provided, filters to invoice payments for this clinic client.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice payments for this clinic client.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to invoice payments on this invoice.", "in": "query", "name": "invoice_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice payments on this invoice.", "title": "Invoice Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoicePaymentSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all invoice payments", "tags": [ "Invoices" ] } }, "/ext/v2/invoice-payments/{invoice_payment_id}/": { "get": { "description": "Retrieves an invoice payment by its ID.\n\nAn **invoice payment** represents a payment allocation applied toward a specific clinic invoice. When a client (pet parent) makes a payment, it is split across one or more invoices as individual invoice payment records, each tracking the amount applied. Invoice payments are never deleted.", "operationId": "invoicePayments_get", "parameters": [ { "description": "The ID of the invoice payment to fetch", "in": "path", "name": "invoice_payment_id", "required": true, "schema": { "description": "The ID of the invoice payment to fetch", "title": "Invoice Payment Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoicePaymentDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an invoice payment", "tags": [ "Invoices" ] } }, "/ext/v2/invoice-refunds/": { "get": { "description": "Returns a list of all invoice refunds across all clinics in the organization. The refunds are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted by modification date instead.\n\nAn invoice refund represents a reversal of a payment made on a clinic invoice. Refunds can be issued as store credit, a credit card reversal, or through an external payment processor. Each refund is tied to a specific invoice payment and records the amount returned to the client. Invoice refunds are never deleted.", "operationId": "invoiceRefunds_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When provided, filters to invoice refunds for this clinic.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice refunds for this clinic.", "title": "Clinic Id" } }, { "description": "When provided, filters to invoice refunds for this clinic client.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice refunds for this clinic client.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to invoice refunds on this invoice.", "in": "query", "name": "invoice_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoice refunds on this invoice.", "title": "Invoice Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoiceRefundTopLevelSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all invoice refunds", "tags": [ "Invoices" ] } }, "/ext/v2/invoice-refunds/{pk}/": { "get": { "description": "Retrieves an invoice refund by its ID.\n\nAn invoice refund represents a reversal of a payment made on a clinic invoice. Refunds can be issued as store credit, a credit card reversal, or through an external payment processor. Each refund is tied to a specific invoice payment and records the amount returned to the client. Invoice refunds are never deleted.", "operationId": "invoiceRefunds_get", "parameters": [ { "in": "path", "name": "pk", "required": true, "schema": { "title": "Pk", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoiceRefundTopLevelDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an invoice refund", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/": { "get": { "description": "Returns a list of invoices across all clinics in the organization. By default, only finalized invoices (FINALIZED, LOCKED, IMPORTED) are returned. Use the `status` parameter to filter by specific statuses. The invoices are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nAn **invoice** represents a bill for services rendered to a clinic patient during a visit. Each invoice is associated with a clinic, a client (pet parent), and contains line items for the services and products provided. Invoices track totals, discounts, payments, and remaining balance.", "operationId": "invoices_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to invoices for this clinic", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoices for this clinic", "title": "Clinic Id" } }, { "description": "When provided, filters to invoices for this clinic client", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to invoices for this clinic client", "title": "Clinic Client Id" } }, { "description": "List of invoice status values to filter by.", "in": "query", "name": "status", "required": false, "schema": { "default": [ "FINALIZED", "LOCKED", "IMPORTED" ], "description": "List of invoice status values to filter by.", "items": { "enum": [ "IN_PROGRESS", "READY_FOR_PAYMENT", "FINALIZED", "LOCKED", "IMPORTED" ], "title": "ClientInvoiceStatus", "type": "string" }, "title": "Status", "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoiceSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all invoices", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/{invoice_id}/": { "get": { "description": "Fetches an invoice by its ID.\n\nAn **invoice** represents a bill for services rendered to a clinic patient during a visit. Each invoice is associated with a clinic, a client (pet parent), and contains line items for the services and products provided. Invoices track totals, discounts, payments, and remaining balance.", "operationId": "invoices_get", "parameters": [ { "description": "The ID of the invoice to fetch", "in": "path", "name": "invoice_id", "required": true, "schema": { "description": "The ID of the invoice to fetch", "title": "Invoice Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalInvoiceDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an invoice", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/{invoice_id}/invoice-item-refunds/": { "get": { "description": "Returns a list of refunds applied to individual line items on a specific invoice. The item refunds are sorted by creation date, with the most recent entries appearing first.", "operationId": "invoices_get_invoice_item_refunds", "parameters": [ { "description": "The ID of the invoice to fetch item refunds for", "in": "path", "name": "invoice_id", "required": true, "schema": { "description": "The ID of the invoice to fetch item refunds for", "title": "Invoice Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItemRefundList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List invoice item refunds", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/{invoice_id}/invoice-items-not-rendered/": { "get": { "description": "Returns a list of services on an invoice that were not rendered (i.e., billed but not actually performed). The items not rendered are sorted by creation date, with the most recent entries appearing first.", "operationId": "invoices_get_invoice_items_not_rendered", "parameters": [ { "description": "The ID of the invoice to fetch not fully rendered items for", "in": "path", "name": "invoice_id", "required": true, "schema": { "description": "The ID of the invoice to fetch not fully rendered items for", "title": "Invoice Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItemNotRenderedList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List invoice items not rendered", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/{invoice_id}/invoice-refunds/": { "get": { "description": "Returns a list of payment-level refunds associated with a specific invoice. The refunds are sorted by creation date, with the most recent entries appearing first.", "operationId": "invoices_get_invoice_refunds", "parameters": [ { "description": "The ID of the invoice to fetch refunds for", "in": "path", "name": "invoice_id", "required": true, "schema": { "description": "The ID of the invoice to fetch refunds for", "title": "Invoice Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRefundList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List invoice refunds", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/{invoice_id}/manual-discount-history/": { "get": { "description": "Returns the change history for manual discounts applied to a specific invoice. Each entry records when a discount was added, modified, or removed. The history is sorted by creation date, with the most recent entries appearing first.", "operationId": "invoices_get_manual_discount_history", "parameters": [ { "description": "The ID of the invoice to fetch history for", "in": "path", "name": "invoice_id", "required": true, "schema": { "description": "The ID of the invoice to fetch history for", "title": "Invoice Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceManualDiscountHistoryList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List invoice manual discount history", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/{invoice_id}/payment-disputes/": { "get": { "description": "Returns a list of payment disputes (chargebacks) associated with a specific invoice. The disputes are sorted by creation date, with the most recent entries appearing first.", "operationId": "invoices_get_payment_disputes", "parameters": [ { "description": "The ID of the invoice to fetch disputes for", "in": "path", "name": "invoice_id", "required": true, "schema": { "description": "The ID of the invoice to fetch disputes for", "title": "Invoice Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentDisputesList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List invoice payment disputes", "tags": [ "Invoices" ] } }, "/ext/v2/invoices/{invoice_id}/payment-history/": { "get": { "description": "Returns the payment history for a specific invoice, tracking each payment attempt and its outcome. The history is sorted by creation date, with the most recent entries appearing first.", "operationId": "invoices_get_payment_history", "parameters": [ { "description": "The ID of the invoice to fetch payment history for", "in": "path", "name": "invoice_id", "required": true, "schema": { "description": "The ID of the invoice to fetch payment history for", "title": "Invoice Id", "type": "integer" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentHistoryList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List invoice payment history", "tags": [ "Invoices" ] } }, "/ext/v2/items/": { "get": { "description": "Returns a list of all catalog items. The items are sorted by creation date, with the most recent items appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nThe Vetcove catalog has a three-level hierarchy: **Product Line \u2192 Product \u2192 Item**. An **item** is the most specific level \u2014 a particular SKU with a specific size, count, or formulation (e.g., \"Heartgard Plus 26-50 lbs, 6-pack\"). Each item belongs to a product, which in turn belongs to a product line.", "operationId": "items_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalItemSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all items", "tags": [ "Catalog" ] } }, "/ext/v2/items/{item_id}/": { "get": { "description": "Fetches a catalog item (individual SKU) by its ID.\n\nThe Vetcove catalog has a three-level hierarchy: **Product Line \u2192 Product \u2192 Item**. An **item** is the most specific level \u2014 a particular SKU with a specific size, count, or formulation (e.g., \"Heartgard Plus 26-50 lbs, 6-pack\"). Each item belongs to a product, which in turn belongs to a product line.", "operationId": "item_get", "parameters": [ { "description": "The ID of the catalog item", "in": "path", "name": "item_id", "required": true, "schema": { "description": "The ID of the catalog item", "title": "Item Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalItemSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an item", "tags": [ "Catalog" ] } }, "/ext/v2/medical-records/": { "get": { "description": "Returns a list of all medical records across all clinics in the organization. The medical records are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **medical record** documents a clinic patient visit, including the reason for the visit, clinical notes, and any services performed. Medical records are linked to a clinic patient, a clinic, and optionally to an invoice for billing.", "operationId": "medical_records_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filters to medical records associated with the clinic patient with the given ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to medical records associated with the clinic patient with the given ID.", "title": "Clinic Patient Id" } }, { "description": "Filters to medical records associated with the invoice with the given ID.", "in": "query", "name": "invoice_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to medical records associated with the invoice with the given ID.", "title": "Invoice Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Medical_RecordList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all medical records", "tags": [ "Medical Records" ] } }, "/ext/v2/medical-records/{medical_record_id}/": { "get": { "description": "Fetches a medical record by its ID.\n\nA **medical record** documents a clinic patient visit, including the reason for the visit, clinical notes, and any services performed. Medical records are linked to a clinic patient, a clinic, and optionally to an invoice for billing.", "operationId": "medical_records_get", "parameters": [ { "description": "The ID of the medical record to retrieve.", "in": "path", "name": "medical_record_id", "required": true, "schema": { "description": "The ID of the medical record to retrieve.", "title": "Medical Record Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalMedicalRecordSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a medical record", "tags": [ "Medical Records" ] } }, "/ext/v2/order-analytics/": { "get": { "description": "Returns a paginated list of product orders across all clinics in the organization.\n\nAn **order** represents a product purchase placed through the Vetcove platform on behalf of a clinic client (pet parent). Each order is associated with a clinic and client, and contains one or more order items representing the individual products purchased.", "operationId": "orders_list", "parameters": [ { "description": "Start date (YYYY-MM-DD). Defaults to 4 weeks ago", "in": "query", "name": "start_date__gte", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Start date (YYYY-MM-DD). Defaults to 4 weeks ago", "title": "Start Date Gte" } }, { "description": "End date (YYYY-MM-DD). Defaults to today", "in": "query", "name": "end_date__lte", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "End date (YYYY-MM-DD). Defaults to today", "title": "End Date Lte" } }, { "description": "Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds", "in": "query", "name": "last_modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds", "title": "Last Modified Gte" } }, { "description": "Parameter to sort results by", "in": "query", "name": "sort_by", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExternalOrderAnalyticsSortOptions" }, { "type": "null" } ], "description": "Parameter to sort results by" } }, { "description": "List of Order Status values to filter by", "in": "query", "name": "order_statuses", "required": false, "schema": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderStatus" }, "type": "array" }, { "type": "null" } ], "description": "List of Order Status values to filter by", "title": "Order Statuses" } }, { "description": "List of Order Item Status values to filter by", "in": "query", "name": "order_item_statuses", "required": false, "schema": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderItemStatus" }, "type": "array" }, { "type": "null" } ], "description": "List of Order Item Status values to filter by", "title": "Order Item Statuses" } }, { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List Order Analytics", "tags": [ "Orders" ] } }, "/ext/v2/order-items/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all order items across all clinics in the organization. The order items are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nAn **order item** represents a single product line within an order. Each order item corresponds to a specific product purchased by a clinic client and tracks its pricing, shipping, and fulfillment lifecycle.", "operationId": "order_items_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "ID of the order to filter by", "in": "query", "name": "order_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "ID of the order to filter by", "title": "Order Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/External_Order_ItemList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List Order Items", "tags": [ "Orders" ] } }, "/ext/v2/organization-clients/{organization_client_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches the organization-level view of a client (pet parent) by the organization client's ID. Returns all clinic client records associated with this person across every clinic in the organization. Use this endpoint to get a unified view of a pet parent across all locations.\n\nAn **organization client** is a cross-clinic identity that links together the separate clinic client records that exist when the same person visits multiple clinic locations within the same organization.", "operationId": "organization_client_get", "parameters": [ { "description": "The ID of the organization client", "in": "path", "name": "organization_client_id", "required": true, "schema": { "description": "The ID of the organization client", "title": "Organization Client Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalOrganizationClientDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an organization client", "tags": [ "Clients And Patients" ] }, "patch": { "description": "This endpoint is available to Group API Keys only.\n\nPartially updates an organization client. Only fields included in the request body will be updated; omitted fields are left unchanged.\n\nSetting a primary clinic makes that clinic the source of truth for this person's client and patient records across the organization. Within the request, the client and its patients are copied to that clinic if they aren't there already and it becomes the primary clinic, one organization client per request. Every other clinic's copy is then resynced from it in the background. Returns a 409 if another primary clinic change for this organization client is in progress.\n\nThis endpoint must be enabled for your organization. Until it is, requests return a 403. Contact Vetcove to enable it.\n\nAn **organization client** is a cross-clinic identity that links together the separate clinic client records that exist when the same person visits multiple clinic locations within the same organization.", "operationId": "organization_client_patch", "parameters": [ { "description": "The ID of the organization client", "in": "path", "name": "organization_client_id", "required": true, "schema": { "description": "The ID of the organization client", "title": "Organization Client Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationClientPatchSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalOrganizationClientDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Partially update an organization client", "tags": [ "Clients And Patients" ] } }, "/ext/v2/organization-patients/{organization_patient_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches the organization-level view of a patient (pet) by the organization patient's ID. Returns all clinic patient records associated with this pet across every clinic in the organization.\n\nAn **organization patient** is a cross-clinic identity that links together the separate clinic patient records that exist when the same pet is seen at multiple clinic locations within the same organization. Use this endpoint to get a unified view of a pet across all locations.", "operationId": "organization_patient_get", "parameters": [ { "description": "The ID of the organization patient to fetch", "in": "path", "name": "organization_patient_id", "required": true, "schema": { "description": "The ID of the organization patient to fetch", "title": "Organization Patient Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalOrganizationPatientDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an organization patient", "tags": [ "Clients And Patients" ] } }, "/ext/v2/patient-breeds/": { "get": { "description": "Returns a list of recognized patient breeds for the given species (e.g., Dog, Cat). The breeds are returned in alphabetical order.\n\nUse this endpoint to look up valid breed values before creating or updating a clinic patient.", "operationId": "patient_breeds_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "patient_kind", "required": true, "schema": { "enum": [ "CANINE", "FELINE", "EQUINE", "AVIAN", "BOVINE", "FERRET", "RABBIT", "RODENT", "REPTILE", "AMPHIBIAN", "FISH", "PORCINE", "CAPRINE", "SHEEP", "CAMELID", "RATITE", "MARSUPIAL", "MUSTELID", "CERVID", "PROCYONIDAE", "ERINACEIDAE", "MEPHITIDAE", "OTHER", "UNSPECIFIED" ], "title": "PatientKind", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientBreedSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List patient breeds", "tags": [ "Clients And Patients" ] } }, "/ext/v2/patient-care-plans/": { "get": { "description": "Returns a list of all patient care plan enrollments across the organization. The patient care plans are sorted by creation date, with the most recent appearing first.\n\nA **patient care plan** represents a specific patient's enrollment in a care plan template. It tracks the enrollment status, billing details, start and end dates, and renewal configuration. A single patient can be enrolled in one core plan and multiple add-on plans simultaneously.", "operationId": "patient_care_plans_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters to patient care plans for the clinic with this ID", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to patient care plans for the clinic with this ID", "title": "Clinic Id" } }, { "description": "When provided, filters to patient care plans for the clinic client with this ID", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to patient care plans for the clinic client with this ID", "title": "Clinic Client Id" } }, { "description": "When provided, filters to patient care plans for the clinic patient with this ID", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to patient care plans for the clinic patient with this ID", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to patient care plans with this status", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PatientCarePlanStatus" }, { "type": "null" } ], "description": "When provided, filters to patient care plans with this status" } }, { "description": "When provided, filters to patient care plans by billing type. True returns plans billed monthly, False returns plans billed upfront.", "in": "query", "name": "is_billed_monthly", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When provided, filters to patient care plans by billing type. True returns plans billed monthly, False returns plans billed upfront.", "title": "Is Billed Monthly" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCarePlanSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all patient care plans", "tags": [ "Care Plans" ] }, "post": { "description": "Enrolls a clinic patient into a care plan by creating a new patient care plan with an initial status of `CLIENT_CREATED`. You must specify a core care plan and may optionally include add-on plans.\n\nIf the patient has a pending `CLIENT_CREATED` core plan that was never paid, it is automatically cancelled and removed \u2014 along with its enrollment invoice and any payment links for that invoice \u2014 before the new enrollment is created. A patient with any other in-progress or upcoming core plan cannot be enrolled again and the request is rejected.\n\nThe specified care plans must be active, match the patient's species, and be available at the patient's clinic. The start date must be in the future (relative to the clinic's timezone).", "operationId": "patient_care_plans_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCarePlanCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCarePlanWithAddOnPlansSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a patient care plan", "tags": [ "Care Plans" ] } }, "/ext/v2/patient-care-plans/current/": { "get": { "description": "Returns the currently active care plan enrollments for a specific clinic patient.\n\nThis returns the patient's current core plan and any active add-on plans or service packages associated with it. Unlike the general list endpoint, this filters to only the plans that are part of the patient's current care cycle.", "operationId": "patient_care_plans_current_list", "parameters": [ { "description": "The ID of the patient to fetch the current care plan for", "in": "query", "name": "clinic_patient_id", "required": true, "schema": { "description": "The ID of the patient to fetch the current care plan for", "title": "Clinic Patient Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCarePlanSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all current patient care plans", "tags": [ "Care Plans" ] } }, "/ext/v2/patient-care-plans/import/": { "post": { "description": "Imports or updates a legacy patient care plan for a clinic patient.\n\nIf an existing patient care plan for the same PIM patient ID and core Care Plan ID already exists and has a `status` of `IMPORTED`, it will be updated instead. Patient care plans with any other status, including imported patient care plans that have already been marked `ACTIVE`, cannot be updated through this endpoint.", "operationId": "legacy_patient_care_plans_import", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLegacyPatientCarePlanImportSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCarePlanSchema" } } }, "description": "OK" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCarePlanSchema" } } }, "description": "Created" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalImportDisambiguationErrorSchema" } } }, "description": "Conflict" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Import or update a legacy patient care plan", "tags": [ "Care Plans" ] } }, "/ext/v2/patient-care-plans/{patient_care_plan_id}/": { "get": { "description": "Fetches a patient care plan enrollment by its ID.\n\nA **patient care plan** represents a specific patient's enrollment in a care plan template. It tracks the enrollment status, billing details, start and end dates, and renewal configuration. A single patient can be enrolled in one core plan and multiple add-on plans simultaneously.", "operationId": "patient_care_plans_get", "parameters": [ { "description": "The ID of the patient care plan to fetch", "in": "path", "name": "patient_care_plan_id", "required": true, "schema": { "description": "The ID of the patient care plan to fetch", "title": "Patient Care Plan Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCarePlanDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a patient care plan", "tags": [ "Care Plans" ] } }, "/ext/v2/patient-client-relationships/": { "get": { "description": "Returns a list of all patient client relationships in an organization. The relationships are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.", "operationId": "patient_client_relationships_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filters to relationships associated with the clinic client with the given ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to relationships associated with the clinic client with the given ID.", "title": "Clinic Client Id" } }, { "description": "Filters to relationships associated with the clinic patient with the given ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to relationships associated with the clinic patient with the given ID.", "title": "Clinic Patient Id" } }, { "description": "Filters to relationships with the given active status.", "in": "query", "name": "is_active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filters to relationships with the given active status.", "title": "Is Active" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientClientRelationshipList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all patient client relationships", "tags": [ "Clients And Patients" ] }, "post": { "description": "Creates a new active patient client relationship between a clinic client and clinic patient.", "operationId": "patient_client_relationships_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a patient client relationship", "tags": [ "Clients And Patients" ] } }, "/ext/v2/patient-client-relationships/{patient_client_relationship_id}/": { "get": { "description": "Fetches a patient client relationship object by its ID.", "operationId": "patient_client_relationships_get", "parameters": [ { "description": "The ID of the patient client relationship to fetch", "in": "path", "name": "patient_client_relationship_id", "required": true, "schema": { "description": "The ID of the patient client relationship to fetch", "title": "Patient Client Relationship Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientClientRelationshipSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a patient client relationship", "tags": [ "Clients And Patients" ] } }, "/ext/v2/patient-labs/": { "get": { "description": "Returns a list of all patient lab results across all clinics in the organization. The results are sorted by creation date, with the most recent appearing first.\n\nA **patient lab** represents a diagnostic lab test result for a clinic patient (e.g., bloodwork, urinalysis, fecal test).", "operationId": "patient_labs_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filters to patient labs for the clinic with the given ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patient labs for the clinic with the given ID.", "title": "Clinic Id" } }, { "description": "Filters to patient labs for the patient with the given ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patient labs for the patient with the given ID.", "title": "Clinic Patient Id" } }, { "description": "Filters to patient labs with the given status.", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/LabOrderDashboardStatus" }, { "type": "null" } ], "description": "Filters to patient labs with the given status." } }, { "description": "Filters to patient labs with the given list of types. IN_CLINIC and EXTERNAL are ordered labs.", "in": "query", "name": "types", "required": false, "schema": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PatientLabType" }, "type": "array" }, { "type": "null" } ], "description": "Filters to patient labs with the given list of types. IN_CLINIC and EXTERNAL are ordered labs.", "title": "Types" } }, { "description": "When true, each patient lab in the response includes a nested 'results' array with structured lab result data. Default is false for performance.", "in": "query", "name": "include_results", "required": false, "schema": { "default": false, "description": "When true, each patient lab in the response includes a nested 'results' array with structured lab result data. Default is false for performance.", "title": "Include Results", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientLabListItemSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all patient labs", "tags": [ "Labs" ] } }, "/ext/v2/patient-labs/{patient_lab_id}/": { "get": { "description": "Fetches a patient lab result by its ID.\n\nA **patient lab** represents a diagnostic lab test result for a clinic patient (e.g., bloodwork, urinalysis, fecal test).", "operationId": "patient_labs_detail", "parameters": [ { "description": "The ID of the patient lab to fetch", "in": "path", "name": "patient_lab_id", "required": true, "schema": { "description": "The ID of the patient lab to fetch", "title": "Patient Lab Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientLabDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a patient lab", "tags": [ "Labs" ] } }, "/ext/v2/patient-notes/": { "get": { "description": "Returns a list of patient notes. The notes are sorted by creation date, with the most recent notes appearing first.\n\n**Patient notes** are free-text records attached to a clinic patient's timeline. They can be categorized by kind (e.g., general, communication) and marked as internal (visible only to clinic staff) or external (also visible to pet parents).", "operationId": "patient_notes_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filters to patient notes for the clinic patient with the given ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to patient notes for the clinic patient with the given ID.", "title": "Clinic Patient Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientNoteSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List patient notes", "tags": [ "Clients And Patients" ] }, "post": { "description": "Creates a new patient note for a clinic patient and adds it to the patient's timeline. Notes created via the API are automatically locked (cannot be edited by clinic staff after creation).\n\nPatient notes support different kinds (e.g., general, communication) and can be marked as internal (visible only to clinic staff) or external (also visible to pet parents).", "operationId": "patient_notes_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientNoteCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientNoteDetailSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a patient note", "tags": [ "Clients And Patients" ] } }, "/ext/v2/patient-notes/{patient_note_id}/": { "delete": { "description": "Deletes a patient note and removes it from the patient's timeline.", "operationId": "patient_notes_delete", "parameters": [ { "description": "The ID of the patient note to fetch or delete", "in": "path", "name": "patient_note_id", "required": true, "schema": { "description": "The ID of the patient note to fetch or delete", "title": "Patient Note Id", "type": "integer" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Delete a patient note", "tags": [ "Clients And Patients" ] }, "get": { "description": "Fetches a patient note by its ID.\n\n**Patient notes** are free-text records attached to a clinic patient's timeline. They can be categorized by kind (e.g., general, communication) and marked as internal (visible only to clinic staff) or external (also visible to pet parents).", "operationId": "patient_notes_get", "parameters": [ { "description": "The ID of the patient note to fetch or delete", "in": "path", "name": "patient_note_id", "required": true, "schema": { "description": "The ID of the patient note to fetch or delete", "title": "Patient Note Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientNoteDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a patient note", "tags": [ "Clients And Patients" ] } }, "/ext/v2/payment-links/": { "get": { "description": "Returns a list of all payment links across all clinics in the organization. The payment links are sorted by creation date, with the most recent appearing first.\n\nA **payment link** is a URL sent to a clinic client (pet parent) to collect a specific payment amount, such as for an outstanding invoice balance.", "operationId": "payment_links_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters payment links by clinic ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters payment links by clinic ID.", "title": "Clinic Id" } }, { "description": "When provided, filters payment links by clinic client ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters payment links by clinic client ID.", "title": "Clinic Client Id" } }, { "description": "When `True`, filters to payment links that have expired, and when `False`, filters to payment links that are still active. When `None`, then both are included.", "in": "query", "name": "is_expired", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to payment links that have expired, and when `False`, filters to payment links that are still active. When `None`, then both are included.", "title": "Is Expired" } }, { "description": "When `True`, filters to payment links that have been paid, and when `False`, filters to payment links that have no been paid. When `None`, then both are included.", "in": "query", "name": "is_paid", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "When `True`, filters to payment links that have been paid, and when `False`, filters to payment links that have no been paid. When `None`, then both are included.", "title": "Is Paid" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkDetailSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all payment links", "tags": [ "Payment Methods" ] }, "post": { "description": "Creates a new payment link that can be sent to a clinic client (pet parent) to collect a payment.", "operationId": "payment_link_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkDetailSchema" } } }, "description": "Created" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkCreateErrorSchema" } } }, "description": "Unprocessable Content" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a payment link", "tags": [ "Payment Methods" ] } }, "/ext/v2/payment-links/{payment_link_id}/": { "delete": { "description": "Deletes a payment link by its ID. The link will be deactivated and can no longer be used by the client to make a payment.", "operationId": "payment_link_delete", "parameters": [ { "description": "The ID of the payment link to fetch", "in": "path", "name": "payment_link_id", "required": true, "schema": { "description": "The ID of the payment link to fetch", "title": "Payment Link Id", "type": "integer" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Delete a payment link", "tags": [ "Payment Methods" ] }, "get": { "description": "Fetches a payment link by its ID.\n\nA **payment link** is a URL sent to a clinic client (pet parent) to collect a specific payment amount, such as for an outstanding invoice balance.", "operationId": "payment_link_get", "parameters": [ { "description": "The ID of the payment link to fetch", "in": "path", "name": "payment_link_id", "required": true, "schema": { "description": "The ID of the payment link to fetch", "title": "Payment Link Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a payment link", "tags": [ "Payment Methods" ] }, "put": { "description": "Updates an existing payment link by its ID.", "operationId": "payment_links_update", "parameters": [ { "description": "The ID of the payment link to update", "in": "path", "name": "payment_link_id", "required": true, "schema": { "description": "The ID of the payment link to update", "title": "Payment Link Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkDetailSchema" } } }, "description": "OK" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentLinkCreateErrorSchema" } } }, "description": "Unprocessable Content" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update a payment link", "tags": [ "Payment Methods" ] } }, "/ext/v2/payment-methods/": { "get": { "description": "Returns a list of all saved payment methods across all clinics in the organization. The payment methods are sorted by creation date, with the most recent appearing first.\n\nA **payment method** represents a saved card or payment instrument on file for a clinic client (pet parent). Payment methods are used to process charges for orders and invoices.", "operationId": "payment_methods_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters to payment methods for the clinic client with this ID", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": false, "description": "When provided, filters to payment methods for the clinic client with this ID", "title": "Clinic Client Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentMethodSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all payment methods", "tags": [ "Payment Methods" ] } }, "/ext/v2/payment-methods/{payment_method_id}/": { "get": { "description": "Fetches a payment method object by the payment method's ID.\n\nA **payment method** represents a saved card or payment instrument on file for a clinic client (pet parent). Payment methods are used to process charges for orders and invoices.", "operationId": "payment_methods_get", "parameters": [ { "description": "The ID of the payment method to fetch", "in": "path", "name": "payment_method_id", "required": true, "schema": { "description": "The ID of the payment method to fetch", "title": "Payment Method Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentMethodDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a payment method", "tags": [ "Payment Methods" ] } }, "/ext/v2/payments/": { "get": { "description": "Returns a list of all payments across all clinics in the organization. The payments are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted by modification date instead.\n\nA **payment** represents a payment made by a clinic client (pet parent). Payments can be made via credit card, cash, check, client credit, or other external payment methods. Each payment records the amount, type, and current status of the transaction. Payments are never deleted.", "operationId": "payments_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When provided, filters to payments for this clinic.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to payments for this clinic.", "title": "Clinic Id" } }, { "description": "When provided, filters to payments for this clinic client.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to payments for this clinic client.", "title": "Clinic Client Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all payments", "tags": [ "Payments" ] } }, "/ext/v2/payments/{payment_id}/": { "get": { "description": "Retrieves a payment by its ID.\n\nA **payment** represents a payment made by a clinic client (pet parent). Payments can be made via credit card, cash, check, client credit, or other external payment methods. Each payment records the amount, type, and current status of the transaction. Payments are never deleted.", "operationId": "payments_get", "parameters": [ { "description": "The ID of the payment to fetch", "in": "path", "name": "payment_id", "required": true, "schema": { "description": "The ID of the payment to fetch", "title": "Payment Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPaymentDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a payment", "tags": [ "Payments" ] } }, "/ext/v2/payouts/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of payouts in an organization.\n\nA **payout** represents a disbursement of funds from Stripe to a clinic's bank account.", "operationId": "payouts_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "Filter payouts by status. If omitted, defaults to 'paid'. Pass empty string ('') to get all statuses.", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/StripePayoutStatus" }, { "const": "", "type": "string" }, { "type": "null" } ], "description": "Filter payouts by status. If omitted, defaults to 'paid'. Pass empty string ('') to get all statuses.", "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPayoutSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List All Payouts", "tags": [ "Payment Methods" ] } }, "/ext/v2/payouts/{payout_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a payout by its ID.\n\nA **payout** represents a disbursement of funds from Stripe to a clinic's bank account.", "operationId": "payouts_get", "parameters": [ { "description": "ID of the payout to retrieve", "in": "path", "name": "payout_id", "required": true, "schema": { "description": "ID of the payout to retrieve", "title": "Payout Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPayoutSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a payout", "tags": [ "Payment Methods" ] } }, "/ext/v2/pdfs/generate-pdfs/": { "post": { "description": "This endpoint is available to Group API Keys only.\n\nTriggers the asynchronous generation of a PDF document (e.g., an invoice PDF or a rabies certificate). The response includes a unique key that can be used to poll the fetch endpoint until the PDF is ready for download. Once ready for download, PDFs are only available for download for 24 hours. Beyond that window, the PDF must be regenerated.", "operationId": "pdfs_generate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExternalPDFInvoiceSchema" }, { "$ref": "#/components/schemas/ExternalPDFRabiesCertificateSchema" }, { "$ref": "#/components/schemas/ExternalPDFPatientTimelineSchema" } ], "title": "Body" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPDFSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Generate a PDF", "tags": [ "PDFs" ] } }, "/ext/v2/pdfs/generate-pdfs/{key}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nRetrieves a previously generated PDF by its unique key. The response includes a pre-signed URL to download the PDF file.\n\nPDFs are generated asynchronously and are only available for download for 24 hours after generation. Beyond that window, the PDF must be regenerated.", "operationId": "pdfs_get", "parameters": [ { "description": "The key of the generated PDF to fetch", "in": "path", "name": "key", "required": true, "schema": { "description": "The key of the generated PDF to fetch", "title": "Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPDFSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a Generated PDF", "tags": [ "PDFs" ] } }, "/ext/v2/prescription-history/": { "get": { "description": "Returns a list of all individual prescriptions across all clinics in the organization. This endpoint includes every prescription issued under each prescription record, providing the complete prescription history. Results are sorted by creation date (descending), with the most recently created prescription history entries appearing first. Prescription history entries are not modified after creation.", "operationId": "prescription_history_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to prescription history record for the clinic with this ID", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the clinic with this ID", "title": "Clinic Id" } }, { "description": "When provided, filters to prescription history record for the clinic client with this ID", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the clinic client with this ID", "title": "Clinic Client Id" } }, { "description": "When provided, filters to prescription history record for the clinic patient with this ID", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the clinic patient with this ID", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to prescription history record for the prescription record with this ID", "in": "query", "name": "prescription_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescription history record for the prescription record with this ID", "title": "Prescription Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectPrescriptionHistorySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all prescription history", "tags": [ "Prescriptions" ] } }, "/ext/v2/prescription-requests/": { "get": { "description": "Returns a paginated list of prescription requests across all clinics in the organization.\n\nA **prescription request** (also known as an external Rx) is created when an external pharmacy or e-tailer submits a request to a clinic for prescription authorization. Each request is associated with a specific catalog item and tracks its review status through the approval workflow.", "operationId": "prescription_requests_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filters to prescription requests belonging to the clinic with the given ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to prescription requests belonging to the clinic with the given ID.", "title": "Clinic Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPrescriptionRequestSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all prescription requests", "tags": [ "External Rx" ] } }, "/ext/v2/prescriptions/": { "get": { "description": "Returns a list of prescription records across all clinics in the organization. Each record includes the latest prescription associated with that record. A **prescription** record is uniquely identified by the combination of patient, catalog item, and clinic. A record may have multiple prescriptions over time, but this endpoint returns only the most recent prescription for each record. Results are sorted by creation date (descending), with the most recently created records appearing first. When using modified filters, results are instead sorted by modification date (descending)", "operationId": "prescriptions_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to prescriptions for the clinic client with this ID", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescriptions for the clinic client with this ID", "title": "Clinic Client Id" } }, { "description": "When provided, filters to prescriptions for the clinic patient with this ID", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescriptions for the clinic patient with this ID", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to prescriptions for the clinic with this ID", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to prescriptions for the clinic with this ID", "title": "Clinic Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectPrescriptionSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all prescriptions", "tags": [ "Prescriptions" ] } }, "/ext/v2/prescriptions/{prescription_id}/": { "get": { "description": "Returns a prescription record by ID, including the latest prescription associated with that record. \n \nA **prescription** record is uniquely identified by the combination of patient, catalog item, and clinic. A record may have multiple prescriptions over time, but this endpoint returns only the most recent prescription for the requested record.", "operationId": "prescriptions_get", "parameters": [ { "description": "The ID of the prescription to fetch", "in": "path", "name": "prescription_id", "required": true, "schema": { "description": "The ID of the prescription to fetch", "title": "Prescription Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectPrescriptionDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a prescription", "tags": [ "Prescriptions" ] } }, "/ext/v2/pricing-groups/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all pricing groups in the organization. The pricing groups are sorted by creation date, with the most recent pricing groups appearing first.\n\nA **pricing group** defines a set of pricing rules that can be applied to clinics. Pricing groups allow organizations to manage different price tiers across their clinic locations \u2014 for example, urban clinics may have different pricing than rural clinics.", "operationId": "pricing_groups_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingGroupList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all pricing groups", "tags": [ "Clinics" ] } }, "/ext/v2/pricing-groups/{pricing_group_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a pricing group by its ID.\n\nA **pricing group** defines a set of pricing rules that can be applied to clinics. Pricing groups allow organizations to manage different price tiers across their clinic locations \u2014 for example, urban clinics might have different markup rates than rural clinics.", "operationId": "pricing_groups_get", "parameters": [ { "description": "The ID of the pricing group to fetch", "in": "path", "name": "pricing_group_id", "required": true, "schema": { "description": "The ID of the pricing group to fetch", "title": "Pricing Group Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPricingGroupDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a pricing group", "tags": [ "Clinics" ] } }, "/ext/v2/product-lines/": { "get": { "description": "Returns a list of all catalog product lines. The product lines are sorted by creation date, with the most recent product lines appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **product line** is the top level of the catalog hierarchy, representing a brand or product family (e.g., \"Heartgard Plus\"). Each product line contains one or more products, and is associated with a manufacturer and category.", "operationId": "product_lines_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalProductLineSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all product lines", "tags": [ "Catalog" ] } }, "/ext/v2/product-lines/{product_line_id}/": { "get": { "description": "Fetches a catalog product line by its ID.\n\nA **product line** is the top level of the catalog hierarchy, representing a brand or product family (e.g., \"Heartgard Plus\"). Each product line contains one or more products, and is associated with a manufacturer and category.", "operationId": "product_line_get", "parameters": [ { "description": "The ID of the catalog product line", "in": "path", "name": "product_line_id", "required": true, "schema": { "description": "The ID of the catalog product line", "title": "Product Line Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalProductLineSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a product line", "tags": [ "Catalog" ] } }, "/ext/v2/products/": { "get": { "description": "Returns a list of all catalog products. The products are sorted by creation date, with the most recent products appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **product** represents a specific formulation or variant within a product line (e.g., \"Heartgard Plus Chewables for Dogs\"). Each product belongs to a product line and contains one or more items (individual SKUs).", "operationId": "products_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalProductListSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all products", "tags": [ "Catalog" ] } }, "/ext/v2/products/{product_id}/": { "get": { "description": "Fetches a catalog product by its ID.\n\nA **product** represents a specific formulation or variant within a product line (e.g., \"Heartgard Plus Chewables for Dogs\"). Each product belongs to a product line and contains one or more items (individual SKUs).", "operationId": "product_get", "parameters": [ { "description": "The ID of the catalog product", "in": "path", "name": "product_id", "required": true, "schema": { "description": "The ID of the catalog product", "title": "Product Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalProductDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a product", "tags": [ "Catalog" ] } }, "/ext/v2/purchase-order-items/": { "post": { "description": "This endpoint is available to Group API Keys only.\n\nCreates a new line item on an existing draft purchase order.\n\nA **purchase order item** is a single line item on a purchase order, identifying the inventory being ordered, the quantity, and the price. The quantity specified in the payload is expected to be in the same unit of measure as the configured unit of measure for the inventory code.", "operationId": "purchase_order_item_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderItemStandaloneCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPurchaseOrderItemSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a purchase order item", "tags": [ "Inventory" ] } }, "/ext/v2/purchase-order-items/{purchase_order_item_id}/": { "patch": { "description": "Partially updates a purchase order item. Only fields included in the request body will be updated; omitted fields are left unchanged. Only items on custom draft purchase orders can be updated.\n\nA **purchase order item** is a single line item on a purchase order, identifying the inventory being ordered, the quantity, and the price. The quantity specified in the payload is expected to be in the same unit of measure as the configured unit of measure for the inventory code.", "operationId": "purchase_order_item_patch", "parameters": [ { "description": "The ID of the purchase order item", "in": "path", "name": "purchase_order_item_id", "required": true, "schema": { "description": "The ID of the purchase order item", "title": "Purchase Order Item Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderItemPatchSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPurchaseOrderItemSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update a purchase order item", "tags": [ "Inventory" ] } }, "/ext/v2/purchase-orders/": { "get": { "description": "Returns a list of purchase orders for a clinic. The purchase orders are sorted by creation date, with the most recent appearing first.\n\nA **purchase order** tracks an order placed by a clinic to a supplier for inventory items. Each purchase order contains one or more line items identifying the inventory being ordered, the quantity, and the price. Purchase orders are created in draft status and can later be finalized in the pims web ui.", "operationId": "purchase_order_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "The ID of the clinic to list purchase orders for", "in": "query", "name": "clinic_id", "required": true, "schema": { "description": "The ID of the clinic to list purchase orders for", "title": "Clinic Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPurchaseOrderSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List purchase orders", "tags": [ "Inventory" ] }, "post": { "description": "This endpoint is available to Group API Keys only.\n\nCreates a new purchase order in draft status with the specified line items. The quantities specified in the line items are expected to be in the same unit of measure as the configured unit of measure for the inventory code.\n\nA **purchase order** tracks an order placed by a clinic to a supplier for inventory items. Each purchase order contains one or more line items identifying the inventory being ordered, the quantity, and the price. Purchase orders are created in draft status and can later be finalized in the pims web ui.", "operationId": "purchase_order_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPurchaseOrderSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a purchase order", "tags": [ "Inventory" ] } }, "/ext/v2/purchase-orders/{purchase_order_id}/": { "get": { "description": "Retrieves a purchase order by its ID.\n\nA **purchase order** tracks an order placed by a clinic to a supplier for inventory items. Each purchase order contains one or more line items identifying the inventory being ordered, the quantity, and the price. Purchase orders are created in draft status and can later be finalized in the pims web ui.", "operationId": "purchase_order_get", "parameters": [ { "description": "The ID of the purchase order to fetch", "in": "path", "name": "purchase_order_id", "required": true, "schema": { "description": "The ID of the purchase order to fetch", "title": "Purchase Order Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPurchaseOrderSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a purchase order", "tags": [ "Inventory" ] }, "patch": { "description": "Partially updates a purchase order with the given information. Only fields included in the request body will be updated; omitted fields are left unchanged. Only custom purchase orders (not synced from a purchasing platform) in draft status can be updated.\n\nA **purchase order** tracks an order placed by a clinic to a supplier for inventory items. Each purchase order contains one or more line items identifying the inventory being ordered, the quantity, and the price. Purchase orders are created in draft status and can later be finalized in the pims web ui.", "operationId": "purchase_order_patch", "parameters": [ { "description": "The ID of the purchase order to fetch", "in": "path", "name": "purchase_order_id", "required": true, "schema": { "description": "The ID of the purchase order to fetch", "title": "Purchase Order Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderPatchSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPurchaseOrderSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update a purchase order", "tags": [ "Inventory" ] } }, "/ext/v2/refunds/": { "get": { "description": "Returns a list of all refunds across all clinics in the organization. The refunds are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **refund** represents money returned to a client for a product order.", "operationId": "refunds_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "Filter refunds by order ID", "in": "query", "name": "order_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter refunds by order ID", "title": "Order Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalRefundSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List Refunds", "tags": [ "Payment Methods" ] } }, "/ext/v2/resource-schedule-blocks/": { "get": { "description": "Returns the availability schedule blocks for calendar resources within a date range. The blocks are sorted by datetime in ascending order.\n\nA **resource schedule block** represents a time window during which a calendar resource (e.g., a veterinarian) is available for appointments. Use this endpoint to determine when resources are available for scheduling.", "operationId": "resource_schedule_blocks_list", "parameters": [ { "description": "Required. The ID of the calendar to fetch resource schedule blocks for", "in": "query", "name": "calendar_id", "required": true, "schema": { "description": "Required. The ID of the calendar to fetch resource schedule blocks for", "title": "Calendar Id", "type": "integer" } }, { "description": "Required. Start date for fetching resource schedule blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_datetime__lte`. Format: YYYY-MM-DD", "in": "query", "name": "start_datetime__gte", "required": true, "schema": { "description": "Required. Start date for fetching resource schedule blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_datetime__lte`. Format: YYYY-MM-DD", "title": "Start Datetime Gte", "type": "string" } }, { "description": "Required. End date for fetching resource schedule blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_datetime__gte`. Format: YYYY-MM-DD", "in": "query", "name": "end_datetime__lte", "required": true, "schema": { "description": "Required. End date for fetching resource schedule blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_datetime__gte`. Format: YYYY-MM-DD", "title": "End Datetime Lte", "type": "string" } }, { "description": "Optional. The ID of the calendar resource to fetch event blocks for", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Optional. The ID of the calendar resource to fetch event blocks for", "title": "Calendar Resource Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalResourceScheduleBlockSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List resource schedule blocks", "tags": [ "Scheduler" ] } }, "/ext/v2/resource-schedule-exceptions/": { "get": { "description": "Returns a list of all resource schedule exceptions across all clinics in the organization. The resource schedule exceptions are sorted by creation date, with the most recent appearing first.\n\nA **resource schedule exception** represents a one-off override to a resource's regular schedule. Exceptions can mark a resource as unavailable for the day, set custom hours, or indicate that the resource should use the clinic's hours for that day.\n\nUnlike resource schedules, exceptions are always one-off (non-recurring).", "operationId": "resource_schedule_exceptions_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filter to resource schedule exceptions belonging to the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedule exceptions belonging to the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filter to resource schedule exceptions for the calendar resource with this ID.", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedule exceptions for the calendar resource with this ID.", "title": "Calendar Resource Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalResourceScheduleExceptionSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all resource schedule exceptions", "tags": [ "Scheduler" ] } }, "/ext/v2/resource-schedule-exceptions/{resource_schedule_exception_id}/": { "get": { "description": "Fetches a resource schedule exception by its ID.\n\nA **resource schedule exception** represents a one-off override to a resource's regular schedule. Exceptions can mark a resource as unavailable for the day, set custom hours, or indicate that the resource should use the clinic's hours for that day.\n\nUnlike resource schedules, exceptions are always one-off (non-recurring).", "operationId": "resource_schedule_exceptions_get", "parameters": [ { "description": "The ID of the resource schedule exception to fetch.", "in": "path", "name": "resource_schedule_exception_id", "required": true, "schema": { "description": "The ID of the resource schedule exception to fetch.", "title": "Resource Schedule Exception Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalResourceScheduleExceptionSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a resource schedule exception", "tags": [ "Scheduler" ] } }, "/ext/v2/resource-schedules/": { "get": { "description": "Returns a list of all resource schedules across all clinics in the organization. The resource schedules are sorted by creation date, with the most recent appearing first.\n\nA **resource schedule** defines the working hours or availability window for a calendar resource (typically a veterinarian or technician). Schedules can be one-off or recurring.\n\nWhen `use_clinic_hours` is true, the resource follows the clinic's configured business hours and `end_datetime` will be null.", "operationId": "resource_schedules_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filter to resource schedules belonging to the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedules belonging to the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filter to resource schedules for the calendar resource with this ID.", "in": "query", "name": "calendar_resource_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to resource schedules for the calendar resource with this ID.", "title": "Calendar Resource Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalResourceScheduleSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all resource schedules", "tags": [ "Scheduler" ] } }, "/ext/v2/resource-schedules/{resource_schedule_id}/": { "get": { "description": "Fetches a resource schedule by its ID.\n\nA **resource schedule** defines the working hours or availability window for a calendar resource (typically a veterinarian or technician). Schedules can be one-off or recurring.\n\nWhen `use_clinic_hours` is true, the resource follows the clinic's configured business hours and `end_datetime` will be null.", "operationId": "resource_schedules_get", "parameters": [ { "description": "The ID of the resource schedule to fetch.", "in": "path", "name": "resource_schedule_id", "required": true, "schema": { "description": "The ID of the resource schedule to fetch.", "title": "Resource Schedule Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalResourceScheduleSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a resource schedule", "tags": [ "Scheduler" ] } }, "/ext/v2/revenue-categories/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all revenue categories in the organization. The categories are sorted by creation date, with the most recent appearing first.\n\nA **revenue category** classifies services for financial reporting purposes (e.g., \"Professional Services\", \"Diagnostics\", \"Surgery\"). Each group service is assigned to a revenue category.", "operationId": "revenue_categories_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalRevenueCategorySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all revenue categories", "tags": [ "Service Pricing" ] } }, "/ext/v2/revenue-categories/{revenue_category_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a revenue category by its ID.\n\nA **revenue category** classifies services for financial reporting purposes (e.g., \"Professional Services\", \"Diagnostics\", \"Surgery\"). Each group service is assigned to a revenue category.", "operationId": "revenue_categories_get", "parameters": [ { "description": "The ID of the revenue category to fetch", "in": "path", "name": "revenue_category_id", "required": true, "schema": { "description": "The ID of the revenue category to fetch", "title": "Revenue Category Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalRevenueCategoryDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a revenue category", "tags": [ "Service Pricing" ] } }, "/ext/v2/service-pricing-categories/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all service pricing categories in the organization. The categories are sorted by creation date, with the most recent appearing first.\n\nA **service pricing category** is the top level of the service pricing hierarchy. It groups related services together (e.g., \"Exam Services\", \"Dental Services\"). Each category contains one or more service pricing groups, which in turn define the actual prices for services at different clinics.", "operationId": "service_pricing_categories_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalServicePricingCategorySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all service pricing categories", "tags": [ "Service Pricing" ] } }, "/ext/v2/service-pricing-categories/{service_pricing_category_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a service pricing category by its ID.\n\nA **service pricing category** is the top level of the service pricing hierarchy. It groups related services together (e.g., \"Exam Services\", \"Dental Services\"). Each category contains one or more service pricing groups, which in turn define the actual prices for services at different clinics.", "operationId": "service_pricing_categories_get", "parameters": [ { "description": "The ID of the service pricing category to fetch", "in": "path", "name": "service_pricing_category_id", "required": true, "schema": { "description": "The ID of the service pricing category to fetch", "title": "Service Pricing Category Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalServicePricingCategoryDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a service pricing category", "tags": [ "Service Pricing" ] } }, "/ext/v2/service-pricing-groups/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all service pricing groups in the organization. The groups are sorted by creation date, with the most recent appearing first.\n\nA **service pricing group** sits within a service pricing category and defines a set of prices for the services in that category. Different clinics can be assigned to different pricing groups within the same category, allowing price variation across locations.", "operationId": "service_pricing_groups_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When provided, filters to service pricing groups for the service pricing category with this ID", "in": "query", "name": "service_pricing_category_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to service pricing groups for the service pricing category with this ID", "title": "Service Pricing Category Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalServicePricingGroupSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all service pricing groups", "tags": [ "Service Pricing" ] } }, "/ext/v2/service-pricing-groups/{service_pricing_group_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a service pricing group by its ID.\n\nA **service pricing group** sits within a service pricing category and defines a set of prices for the services in that category. Different clinics can be assigned to different pricing groups, allowing tiered pricing across locations.", "operationId": "service_pricing_groups_get", "parameters": [ { "description": "The ID of the service pricing group to fetch", "in": "path", "name": "service_pricing_group_id", "required": true, "schema": { "description": "The ID of the service pricing group to fetch", "title": "Service Pricing Group Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalServicePricingGroupDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a service pricing group", "tags": [ "Service Pricing" ] }, "put": { "description": "This endpoint is available to Group API Keys only.\n\nUpdates an existing service pricing group by its ID.", "operationId": "service_pricing_groups_update", "parameters": [ { "description": "The ID of the service pricing group to update", "in": "path", "name": "service_pricing_group_id", "required": true, "schema": { "description": "The ID of the service pricing group to update", "title": "Service Pricing Group Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicePricingGroupUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalServicePricingGroupDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update a service pricing group", "tags": [ "Service Pricing" ] } }, "/ext/v2/service-pricing-groups/{service_pricing_group_id}/prices/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nRetrieves the prices for all services within a specific service pricing group.\n\nA **service price** defines how much a clinic charges for a specific service. Prices are configured per service pricing group, allowing different pricing tiers across clinics.", "operationId": "service_pricing_group_pricing_detail", "parameters": [ { "description": "The ID of the service pricing group to fetch", "in": "path", "name": "service_pricing_group_id", "required": true, "schema": { "description": "The ID of the service pricing group to fetch", "title": "Service Pricing Group Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPricingGroupPricingDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch prices for a service pricing group", "tags": [ "Service Pricing" ] }, "put": { "description": "This endpoint is available to Group API Keys only.\n\nUpdates the prices for one or more services within a specific service pricing group.", "operationId": "service_pricing_group_pricing_update", "parameters": [ { "description": "The ID of the service pricing group to update", "in": "path", "name": "service_pricing_group_id", "required": true, "schema": { "description": "The ID of the service pricing group to update", "title": "Service Pricing Group Id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicePricingGroupPricingUpdateSchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPricingGroupPricingDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Update prices for a service pricing group", "tags": [ "Service Pricing" ] } }, "/ext/v2/sms-notifications/": { "get": { "description": "Returns a list of all SMS notifications across all clinics in the organization. The notifications are sorted by creation date, with the most recent appearing first.\n\nAn **SMS notification** represents a text message sent to a clinic client's primary phone number on behalf of a clinic via the API.\n\nOnly SMS notifications initiated through the API are included in this resource. Transactional notifications sent automatically by Vetcove (e.g. order confirmations, appointment reminders) are not returned.", "operationId": "sms_notifications_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "Filters to SMS notifications for the clinic with this ID. At least one of `clinic_id` or `clinic_client_id` is required.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to SMS notifications for the clinic with this ID. At least one of `clinic_id` or `clinic_client_id` is required.", "title": "Clinic Id" } }, { "description": "Filters to SMS notifications for the clinic client with this ID. At least one of `clinic_id` or `clinic_client_id` is required.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to SMS notifications for the clinic client with this ID. At least one of `clinic_id` or `clinic_client_id` is required.", "title": "Clinic Client Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalSmsNotificationSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all SMS notifications", "tags": [ "Inbox" ] }, "post": { "description": "Sends an SMS message to a clinic client on behalf of a clinic.\n\n**Important limitations:**\n\n- **Message length:** Individual carriers impose their own limits on message length, and these limits can change over time. Messages that exceed a carrier's limit may be split, truncated, or outright rejected.\n- **Rate limits:** SMS sending is subject to overall, per-carrier, and daily rate limits. These limits are shared across all messages sent from your clinics \u2014 including messages sent by Vetcove on your behalf through other features in our platform. This endpoint enforces a limit of 20 requests per second and 200,000 requests per day per organization. These limits are not per carrier, so if your messages are not well distributed across carriers it is possible to stay within our limits while still exceeding the per-carrier limits of our third-party SMS provider.\n- **Trust score:** Your organization is assigned a trust score by the underlying SMS provider. The content and volume of messages you send directly affects this score. Sending spammy, inappropriate, or excessive messages can lower your score, resulting in stricter rate limits and reduced deliverability across all of your clinic communications.", "operationId": "sms_notifications_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSmsNotificationRequestSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalSmsNotificationSchema" } } }, "description": "Created" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThrottledResponseSchema" } } }, "description": "Too Many Requests" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Send an SMS notification", "tags": [ "Inbox" ] } }, "/ext/v2/sms-notifications/{sms_notification_id}/": { "get": { "description": "Retrieves an SMS notification by its ID.\n\nAn **SMS notification** represents a text message sent to a clinic client's primary phone number on behalf of a clinic via the API.\n\nOnly SMS notifications initiated through the API are included in this resource. Transactional notifications sent automatically by Vetcove (e.g. order confirmations, appointment reminders) are not returned.", "operationId": "sms_notifications_get", "parameters": [ { "in": "path", "name": "sms_notification_id", "required": true, "schema": { "title": "Sms Notification Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalSmsNotificationSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an SMS notification", "tags": [ "Inbox" ] } }, "/ext/v2/standard-care-reminders/custom/": { "get": { "description": "Returns a list of all patient custom care reminders across the organization. The care reminders are sorted by creation date, with the most recent appearing first.\n\nA **custom care reminder** is a one-off, manually created reminder for a specific patient that is not tied to a standard care protocol (e.g., a follow-up recheck, a specific lab retest).", "operationId": "patient_custom_care_reminder_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to reminders for the organization client to which the clinic client with this ID belongs. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client to which the clinic client with this ID belongs. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to reminders for the organization client with this ID. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`,or `organization_patient_id`.", "in": "query", "name": "organization_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client with this ID. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`,or `organization_patient_id`.", "title": "Organization Client Id" } }, { "description": "When provided, filters to reminders for the organization patient to which the clinic patient with this ID belongs. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient to which the clinic patient with this ID belongs. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to reminders for the organization patient with this ID. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "in": "query", "name": "organization_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient with this ID. You must provide exactly one of `clinic_client_id`, `organization_client_id`, `clinic_patient_id`, or `organization_patient_id`.", "title": "Organization Patient Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientCustomCareReminderSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all patient custom care reminders", "tags": [ "Standard Care" ] } }, "/ext/v2/standard-care-reminders/standard/": { "get": { "description": "Returns a list of all patient standard care reminders across the organization. The care reminders are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **standard care reminder** tracks when a patient is due for routine preventive care (e.g., annual vaccinations, heartworm testing, dental cleanings). Each reminder is linked to a standard care protocol defined at the organization level and tracks the patient's compliance status and next due date.", "operationId": "patient_standard_care_reminder_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "When provided, filters to reminders for patients belonging to the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for patients belonging to the clinic with this ID.", "title": "Clinic Id" } }, { "description": "When provided, filters to reminders for the organization client to which the clinic client with this ID belongs.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client to which the clinic client with this ID belongs.", "title": "Clinic Client Id" } }, { "description": "When provided, filters to reminders for the organization client with this ID.", "in": "query", "name": "organization_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization client with this ID.", "title": "Organization Client Id" } }, { "description": "When provided, filters to reminders for the organization patient to which the clinic patient with this ID belongs.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient to which the clinic patient with this ID belongs.", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to reminders for the organization patient with this ID.", "in": "query", "name": "organization_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to reminders for the organization patient with this ID.", "title": "Organization Patient Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalPatientStandardCareReminderSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all patient standard care reminders", "tags": [ "Standard Care" ] } }, "/ext/v2/subscriptions/": { "get": { "description": "Returns a list of all subscriptions across all clinics in the organization. The subscriptions are sorted by creation date, with the most recent subscriptions appearing first. When using modified filters, results are sorted in descending modification date instead.\n\nA **subscription** represents a recurring autoship order for a product (e.g., monthly flea and tick prevention). Each subscription is tied to a specific clinic patient and clinic client, and tracks the delivery frequency, status, and associated clinic.", "operationId": "subscriptions_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When provided, filters to subscriptions for this clinic", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this clinic", "title": "Clinic Id" } }, { "description": "When provided, filters to subscriptions for this clinic client", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this clinic client", "title": "Clinic Client Id" } }, { "description": "When provided, filters to subscriptions for this clinic patient", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this clinic patient", "title": "Clinic Patient Id" } }, { "description": "When provided, filters to subscriptions for this status", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/SubscriptionStatus" }, { "type": "null" } ], "description": "When provided, filters to subscriptions for this status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalSubscriptionSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all subscriptions", "tags": [ "Subscriptions" ] } }, "/ext/v2/subscriptions/{subscription_id}/": { "get": { "description": "Fetches a subscription by its ID.\n\nA **subscription** represents a recurring autoship order for a product (e.g., monthly flea and tick prevention). Each subscription is associated with a clinic, client, patient, and a specific catalog item, and defines the delivery frequency and quantity.", "operationId": "subscriptions_get", "parameters": [ { "description": "The ID of the subscription to fetch", "in": "path", "name": "subscription_id", "required": true, "schema": { "description": "The ID of the subscription to fetch", "title": "Subscription Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalSubscriptionDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a subscription", "tags": [ "Subscriptions" ] } }, "/ext/v2/tax-categories/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all tax categories defined at the organization level. The tax categories are sorted by creation date, with the most recent appearing first.\n\nA **tax category** groups services and products for tax purposes (e.g., taxable services, exempt medications, taxable products). Each category determines how tax is applied to invoice line items.", "operationId": "tax_categories_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalTaxCategorySchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all tax categories", "tags": [ "Taxes" ] } }, "/ext/v2/tax-categories/{tax_category_id}/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nFetches a tax category by its ID.\n\nA **tax category** groups services and products for tax purposes (e.g., taxable services, exempt medications, taxable products). Each category determines how tax is applied to items in that group.", "operationId": "tax_categories_get", "parameters": [ { "description": "The ID of the tax category to fetch", "in": "path", "name": "tax_category_id", "required": true, "schema": { "description": "The ID of the tax category to fetch", "title": "Tax Category Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalTaxCategoryDetailSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a tax category", "tags": [ "Taxes" ] } }, "/ext/v2/transfers/": { "get": { "description": "This endpoint is available to Group API Keys only.\n\nReturns a list of all transfers for clinic groups.\n\nA **transfer** represents the movement of funds to a clinic's Stripe account for a completed order.", "operationId": "transfers_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filter transfers by order ID", "in": "query", "name": "order_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter transfers by order ID", "title": "Order Id" } }, { "description": "Filter transfers by payout IDs. Accepts multiple IDs.", "in": "query", "name": "payout_ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "Filter transfers by payout IDs. Accepts multiple IDs.", "title": "Payout Ids" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalTransferSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List Transfers", "tags": [ "Payment Methods" ] } }, "/ext/v2/universal-prescription-history/": { "get": { "description": "Returns a list of all universal prescription versions across all clinics in the organization. This includes every version of each prescription, providing the complete history. Results are sorted by creation date (descending). When using modified filters, results are instead sorted by modification date (descending).\n\nA **universal prescription** represents a medication or service prescribed to a patient by a veterinarian. Universal prescriptions unify three fulfillment types \u2014 home delivery, internal (in-clinic), and external (third-party pharmacy) \u2014 into a single record. When a prescription is renewed or edited, a new version is created in the same prescription group, preserving the full history.", "operationId": "universal_prescription_history_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filter to universal prescription history for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescription history for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filter to universal prescription history for the clinic patient with this ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescription history for the clinic patient with this ID.", "title": "Clinic Patient Id" } }, { "description": "Filter to universal prescription history for the clinic client with this ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescription history for the clinic client with this ID.", "title": "Clinic Client Id" } }, { "description": "Filter to all versions of the prescription with this ID.", "in": "query", "name": "prescription_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to all versions of the prescription with this ID.", "title": "Prescription Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Universal_Prescription_HistoryList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all universal prescription history", "tags": [ "Prescriptions" ] } }, "/ext/v2/universal-prescriptions/": { "get": { "description": "Returns a list of current universal prescriptions across all clinics in the organization. Only the latest version of each prescription is returned. Results are sorted by creation date (descending). When using modified filters, results are instead sorted by modification date (descending).\n\nA **universal prescription** represents a medication or service prescribed to a patient by a veterinarian. Universal prescriptions unify three fulfillment types \u2014 home delivery, internal (in-clinic), and external (third-party pharmacy) \u2014 into a single record. When a prescription is renewed or edited, a new version is created in the same prescription group, preserving the full history.", "operationId": "universal_prescriptions_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Cursor" } }, { "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__gte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Gte" } }, { "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "in": "query", "name": "modified__lte", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.", "title": "Modified Lte" } }, { "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.", "in": "query", "name": "is_deleted", "required": false, "schema": { "allOf": [ { "enum": [ "FALSE", "TRUE", "ALL" ], "title": "DeletedFilterOption", "type": "string" } ], "default": "FALSE", "description": "When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records." } }, { "description": "Filter to universal prescriptions for the clinic with this ID.", "in": "query", "name": "clinic_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescriptions for the clinic with this ID.", "title": "Clinic Id" } }, { "description": "Filter to universal prescriptions for the clinic patient with this ID.", "in": "query", "name": "clinic_patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescriptions for the clinic patient with this ID.", "title": "Clinic Patient Id" } }, { "description": "Filter to universal prescriptions for the clinic client with this ID.", "in": "query", "name": "clinic_client_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filter to universal prescriptions for the clinic client with this ID.", "title": "Clinic Client Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Universal_PrescriptionList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all current universal prescriptions", "tags": [ "Prescriptions" ] } }, "/ext/v2/universal-prescriptions/{universal_prescription_id}/": { "get": { "description": "Retrieves a universal prescription by its ID.\n\nA **universal prescription** represents a medication or service prescribed to a patient by a veterinarian. Universal prescriptions unify three fulfillment types \u2014 home delivery, internal (in-clinic), and external (third-party pharmacy) \u2014 into a single record. When a prescription is renewed or edited, a new version is created in the same prescription group, preserving the full history.", "operationId": "universal_prescriptions_get", "parameters": [ { "description": "The ID of the universal prescription to fetch.", "in": "path", "name": "universal_prescription_id", "required": true, "schema": { "description": "The ID of the universal prescription to fetch.", "title": "Universal Prescription Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectUniversalPrescriptionSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a universal prescription", "tags": [ "Prescriptions" ] } }, "/ext/v2/uploaded-files/": { "get": { "description": "Returns a list of all uploaded files for the organization. The files are sorted by creation date, with the most recent appearing first.\n\nAn **uploaded file** is a document or image that has been uploaded to Vetcove's file storage via the upload flow (generate URL \u2192 upload to S3 \u2192 register file).", "operationId": "uploaded_files_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUploadedFileSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all uploaded files", "tags": [ "File Uploads" ] }, "post": { "description": "Create an uploaded file after uploading the raw file to our file server.\n\nThe entire flow for uploaded files to us is as follows:\n1. Call the `generate-upload-url` endpoint to initiate an upload.\n2. POST your file to the returned URL, including the returned form data.\n3. Call this endpoint to register your uploaded file with our system.\n\nIt would look something like this in python:\n```\nimport requests\napi_session = requests.Session()\napi_session.headers.update({\"Authorization\": f\"Bearer {API_KEY}\"})\ns3_session = requests.Session()\n\n# Step 1: Get an upload URL.\nresponse = api_session.post(\n f\"{VETCOVE_API_SERVER}/ext/v2/uploaded-files/generate-upload-url/\",\n json={\n \"filename\": \"example.jpg\",\n \"content_type\": \"image/jpg\"\n }\n)\nresponse.raise_for_status()\n\n# Step 2: Extract the necessary values from the response.\nkey = response.json()[\"key\"]\nupload_url = response.json()[\"url\"]\nupload_post_data = response.json()[\"post_data\"]\n\n# Step 3: Upload the file to our file server (Amazon S3).\nwith open(LOCAL_PATH_TO_FILE_UPLOAD, \"rb\") as f:\n response = s3_session.post(upload_url, data=upload_post_data, files={\"file\": f})\nresponse.raise_for_status()\n\n# Step 4: Register the uploaded file with Vetcove.\nresponse = api_session.post(\n f\"{VETCOVE_API_SERVER}/ext/v2/uploaded-files/\",\n json={\n \"filename\": \"example.jpg\",\n \"key\": key,\n }\n)\nresponse.raise_for_status()\nprint(f\"Created uploaded file with id {response.json()['id']}\")\n```\n", "operationId": "uploaded_files_create", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUploadedFileCreateSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUploadedFileSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create an uploaded file", "tags": [ "File Uploads" ] } }, "/ext/v2/uploaded-files/generate-upload-url/": { "post": { "description": "Generates a pre-signed URL for uploading a file to Vetcove's file storage (Amazon S3). The response includes the upload URL and form data that must be included when POSTing the file. After uploading, call the create uploaded file endpoint to register the file with the system.", "operationId": "generate_upload_url", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateUploadUrlPayloadSchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateUploadUrlResponseSchema" } } }, "description": "Created" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Create a URL for file upload", "tags": [ "File Uploads" ] } }, "/ext/v2/uploaded-files/{uploaded_file_id}/": { "get": { "description": "Fetches an uploaded file by its ID.\n\nAn **uploaded file** is a document or image that has been uploaded to Vetcove's file storage via the upload flow (generate URL \u2192 upload to S3 \u2192 register file).", "operationId": "uploaded_files_get", "parameters": [ { "description": "The ID of the uploaded file to fetch", "in": "path", "name": "uploaded_file_id", "required": true, "schema": { "description": "The ID of the uploaded file to fetch", "title": "Uploaded File Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUploadedFileSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch an uploaded file", "tags": [ "File Uploads" ] } }, "/ext/v2/vaccine-historical-treatments/": { "get": { "description": "Returns a list of all historical vaccine records for a specific clinic patient.\n\nA **vaccine historical treatment** represents a vaccination that was recorded from the clinic patient's history (e.g., imported from a previous clinic or manually entered) rather than administered during a visit. These records help maintain a complete vaccination history for the clinic patient.", "operationId": "vaccine_historical_treatments_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filters to historical treatments associated with the clinic patient with the given ID.", "in": "query", "name": "clinic_patient_id", "required": true, "schema": { "description": "Filters to historical treatments associated with the clinic patient with the given ID.", "title": "Clinic Patient Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vaccine_Historical_TreatmentList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all vaccine historical treatments", "tags": [ "Medical Records" ] } }, "/ext/v2/vaccine-historical-treatments/{historical_treatment_id}/": { "get": { "description": "Fetches a vaccine historical treatment by its ID.\n\nA **vaccine historical treatment** represents a vaccination that was recorded from the clinic patient's history (e.g., imported from a previous clinic or manually entered) rather than administered during a visit. These records help maintain a complete vaccination history for the clinic patient.", "operationId": "vaccine_historical_treatments_get", "parameters": [ { "description": "The ID of the historical treatment to retrieve.", "in": "path", "name": "historical_treatment_id", "required": true, "schema": { "description": "The ID of the historical treatment to retrieve.", "title": "Historical Treatment Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccineHistoricalTreatmentSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a vaccine historical treatment", "tags": [ "Medical Records" ] } }, "/ext/v2/vaccine-treatments/": { "get": { "description": "Returns a list of all vaccine treatments administered to a specific clinic patient.\n\nA **vaccine treatment** represents a vaccination that was administered during a clinic patient visit and billed on an invoice. Each treatment is linked to a vaccine service, a medical record, and may be associated with a standard care reminder.", "operationId": "vaccine_treatments_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filters to treatments associated with the clinic patient with the given ID.", "in": "query", "name": "clinic_patient_id", "required": true, "schema": { "description": "Filters to treatments associated with the clinic patient with the given ID.", "title": "Clinic Patient Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vaccine_TreatmentList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all vaccine treatments", "tags": [ "Medical Records" ] } }, "/ext/v2/vaccine-treatments/{treatment_id}/": { "get": { "description": "Fetches a vaccine treatment by its ID.\n\nA **vaccine treatment** represents a vaccination that was administered during a clinic patient visit and billed on an invoice. Each treatment is linked to a vaccine service, a medical record, and may be associated with a standard care reminder.", "operationId": "vaccine_treatments_get", "parameters": [ { "description": "The ID of the treatment to retrieve.", "in": "path", "name": "treatment_id", "required": true, "schema": { "description": "The ID of the treatment to retrieve.", "title": "Treatment Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccineTreatmentSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a vaccine treatment", "tags": [ "Medical Records" ] } }, "/ext/v2/vital-readings/": { "get": { "description": "Returns a list of vital readings recorded during clinic patient visits.\n\nA **vital reading** is a single measurement taken during a clinic patient visit (e.g., weight, temperature, heart rate). Vital readings are grouped together into a reading group that represents all vitals taken at the same time.", "operationId": "vital_readings_list", "parameters": [ { "description": "When provided, filters to objects with these IDs.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "description": "When provided, filters to objects with these IDs.", "title": "Ids" } }, { "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "in": "query", "name": "ending_before", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`.", "title": "Ending Before" } }, { "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "in": "query", "name": "starting_after", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.", "title": "Starting After" } }, { "description": "The maximum number of items to return per page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "description": "The maximum number of items to return per page.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Filters to vital readings associated with the vital reading group with the given ID.", "in": "query", "name": "vital_reading_group_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to vital readings associated with the vital reading group with the given ID.", "title": "Vital Reading Group Id" } }, { "description": "Filters to vital readings associated with the patient with the given ID.", "in": "query", "name": "patient_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to vital readings associated with the patient with the given ID.", "title": "Patient Id" } }, { "description": "Filters to vital readings associated with the medical record with the given ID.", "in": "query", "name": "medical_record_id", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Filters to vital readings associated with the medical record with the given ID.", "title": "Medical Record Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVitalReadingSchemaList" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "List all vital readings", "tags": [ "Medical Records" ] } }, "/ext/v2/vital-readings/{vital_reading_id}/": { "get": { "description": "Fetches a vital reading by its ID.\n\nA **vital reading** is a single measurement taken during a clinic patient visit (e.g., weight, temperature, heart rate). Vital readings are grouped together into a reading group that represents all vitals taken at the same time.", "operationId": "vital_readings_get", "parameters": [ { "description": "The ID of the vital reading to retrieve.", "in": "path", "name": "vital_reading_id", "required": true, "schema": { "description": "The ID of the vital reading to retrieve.", "title": "Vital Reading Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVitalReadingSchema" } } }, "description": "OK" } }, "security": [ { "ExternalAPIAuth": [] } ], "summary": "Fetch a vital reading", "tags": [ "Medical Records" ] } } }, "servers": [ { "url": "https://connect.vetcove.com/" } ], "webhooks": { "appointment.canceled": { "post": { "description": "Triggered when a client appointment is canceled.", "operationId": "appointment.canceled", "requestBody": { "content": { "application/json": { "example": { "data": { "alert_tags": [ "CONTAGIOUS" ], "calendar.clinic_id": 123, "calendar_id": 123, "cancelation_reason": "PATIENT_SEEN_ELSEWHERE", "cancelation_reason_other": "string", "client_id": 123, "clinic_notes": "string", "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "dropoff_start_datetime": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "followup_appointment_ids": [ 123 ], "id": 123, "is_deleted": true, "kind.label": "string", "kind_id": 123, "medical_record_id": 123, "modified": "2023-11-07T05:31:56Z", "patient_id": 123, "pickup_start_datetime": "2023-11-07T05:31:56Z", "reason": "string", "resource.name": "string", "resource_id": 123, "room.name": "string", "room_id": 123, "start_datetime": "2023-11-07T05:31:56Z", "status": "CREATING" }, "type": "appointment.canceled" }, "schema": { "$ref": "#/components/schemas/AppointmentCanceledWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Appointment canceled", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Appointment canceled\"" } } } }, "appointment.completed": { "post": { "description": "Triggered when a client appointment is completed.", "operationId": "appointment.completed", "requestBody": { "content": { "application/json": { "example": { "data": { "alert_tags": [ "CONTAGIOUS" ], "calendar.clinic_id": 123, "calendar_id": 123, "cancelation_reason": "PATIENT_SEEN_ELSEWHERE", "cancelation_reason_other": "string", "client_id": 123, "clinic_notes": "string", "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "dropoff_start_datetime": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "followup_appointment_ids": [ 123 ], "id": 123, "is_deleted": true, "kind.label": "string", "kind_id": 123, "medical_record_id": 123, "modified": "2023-11-07T05:31:56Z", "patient_id": 123, "pickup_start_datetime": "2023-11-07T05:31:56Z", "reason": "string", "resource.name": "string", "resource_id": 123, "room.name": "string", "room_id": 123, "start_datetime": "2023-11-07T05:31:56Z", "status": "CREATING" }, "type": "appointment.completed" }, "schema": { "$ref": "#/components/schemas/AppointmentCompletedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Appointment completed", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Appointment completed\"" } } } }, "appointment.created": { "post": { "description": "Triggered when a client appointment is created by a clinic user.", "operationId": "appointment.created", "requestBody": { "content": { "application/json": { "example": { "data": { "alert_tags": [ "CONTAGIOUS" ], "calendar.clinic_id": 123, "calendar_id": 123, "cancelation_reason": "PATIENT_SEEN_ELSEWHERE", "cancelation_reason_other": "string", "client_id": 123, "clinic_notes": "string", "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "dropoff_start_datetime": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "followup_appointment_ids": [ 123 ], "form_requests": [ { "appointment_id": 123, "client_id": 123, "completed_at": "2023-11-07T05:31:56Z", "created": "2023-11-07T05:31:56Z", "dashboard_url": "string", "expires_at": "2023-11-07T05:31:56Z", "form_type": { "client_facing_title": "string", "id": 123, "internal_name": "string" }, "id": 123, "modified": "2023-11-07T05:31:56Z", "patient_id": 123, "sent_at": "2023-11-07T05:31:56Z", "started_at": "2023-11-07T05:31:56Z", "status": "CREATED", "url": "string" } ], "id": 123, "is_deleted": true, "kind.label": "string", "kind_id": 123, "medical_record_id": 123, "modified": "2023-11-07T05:31:56Z", "patient_id": 123, "pickup_start_datetime": "2023-11-07T05:31:56Z", "reason": "string", "resource.name": "string", "resource_id": 123, "room.name": "string", "room_id": 123, "start_datetime": "2023-11-07T05:31:56Z", "status": "CREATING" }, "type": "appointment.created" }, "schema": { "$ref": "#/components/schemas/AppointmentCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Appointment created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Appointment created\"" } } } }, "appointment.deleted": { "post": { "description": "Triggered when a client appointment is deleted.", "operationId": "appointment.deleted", "requestBody": { "content": { "application/json": { "example": { "data": { "alert_tags": [ "CONTAGIOUS" ], "calendar.clinic_id": 123, "calendar_id": 123, "cancelation_reason": "PATIENT_SEEN_ELSEWHERE", "cancelation_reason_other": "string", "client_id": 123, "clinic_notes": "string", "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "dropoff_start_datetime": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "followup_appointment_ids": [ 123 ], "id": 123, "is_deleted": true, "kind.label": "string", "kind_id": 123, "medical_record_id": 123, "modified": "2023-11-07T05:31:56Z", "patient_id": 123, "pickup_start_datetime": "2023-11-07T05:31:56Z", "reason": "string", "resource.name": "string", "resource_id": 123, "room.name": "string", "room_id": 123, "start_datetime": "2023-11-07T05:31:56Z", "status": "CREATING" }, "type": "appointment.deleted" }, "schema": { "$ref": "#/components/schemas/AppointmentDeletedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Appointment deleted", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Appointment deleted\"" } } } }, "appointment.started": { "post": { "description": "Triggered when a client appointment is started.", "operationId": "appointment.started", "requestBody": { "content": { "application/json": { "example": { "data": { "alert_tags": [ "CONTAGIOUS" ], "calendar.clinic_id": 123, "calendar_id": 123, "cancelation_reason": "PATIENT_SEEN_ELSEWHERE", "cancelation_reason_other": "string", "client_id": 123, "clinic_notes": "string", "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "dropoff_start_datetime": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "followup_appointment_ids": [ 123 ], "id": 123, "is_deleted": true, "kind.label": "string", "kind_id": 123, "medical_record_id": 123, "modified": "2023-11-07T05:31:56Z", "patient_id": 123, "pickup_start_datetime": "2023-11-07T05:31:56Z", "reason": "string", "resource.name": "string", "resource_id": 123, "room.name": "string", "room_id": 123, "start_datetime": "2023-11-07T05:31:56Z", "status": "CREATING" }, "type": "appointment.started" }, "schema": { "$ref": "#/components/schemas/AppointmentStartedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Appointment started", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Appointment started\"" } } } }, "appointment.updated": { "post": { "description": "Triggered when an appointment is updated in any other way.", "operationId": "appointment.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "alert_tags": [ "CONTAGIOUS" ], "calendar.clinic_id": 123, "calendar_id": 123, "cancelation_reason": "PATIENT_SEEN_ELSEWHERE", "cancelation_reason_other": "string", "client_id": 123, "clinic_notes": "string", "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "dropoff_start_datetime": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "followup_appointment_ids": [ 123 ], "id": 123, "is_deleted": true, "kind.label": "string", "kind_id": 123, "medical_record_id": 123, "modified": "2023-11-07T05:31:56Z", "patient_id": 123, "pickup_start_datetime": "2023-11-07T05:31:56Z", "reason": "string", "resource.name": "string", "resource_id": 123, "room.name": "string", "room_id": 123, "start_datetime": "2023-11-07T05:31:56Z", "status": "CREATING" }, "type": "appointment.updated" }, "schema": { "$ref": "#/components/schemas/AppointmentUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Appointment updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Appointment updated\"" } } } }, "calendar_designation.created": { "post": { "description": "Triggered when a new calendar designation is created.", "operationId": "calendar_designation.created", "requestBody": { "content": { "application/json": { "example": { "data": { "appointment_kind_ids": [ 123 ], "calendar.clinic_id": 123, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "duration_minutes": 123, "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_recurring": true, "modified": "2023-11-07T05:31:56Z", "name": "string", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "recurrence_excluded_datetimes": [ "2023-11-07T05:31:56Z" ], "recurring_designation_id": 123, "resource_id": 123, "rrule": "string", "start_datetime": "2023-11-07T05:31:56Z" }, "type": "calendar_designation.created" }, "schema": { "$ref": "#/components/schemas/CalendarDesignationCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar designation created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar designation created\"" } } } }, "calendar_designation.deleted": { "post": { "description": "Triggered when a calendar designation is deleted.", "operationId": "calendar_designation.deleted", "requestBody": { "content": { "application/json": { "example": { "data": { "appointment_kind_ids": [ 123 ], "calendar.clinic_id": 123, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "duration_minutes": 123, "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_recurring": true, "modified": "2023-11-07T05:31:56Z", "name": "string", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "recurrence_excluded_datetimes": [ "2023-11-07T05:31:56Z" ], "recurring_designation_id": 123, "resource_id": 123, "rrule": "string", "start_datetime": "2023-11-07T05:31:56Z" }, "type": "calendar_designation.deleted" }, "schema": { "$ref": "#/components/schemas/CalendarDesignationDeletedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar designation deleted", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar designation deleted\"" } } } }, "calendar_designation.updated": { "post": { "description": "Triggered when an existing calendar designation is updated, including when a recurring designation's recurrence is ended.", "operationId": "calendar_designation.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "appointment_kind_ids": [ 123 ], "calendar.clinic_id": 123, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "duration_minutes": 123, "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_recurring": true, "modified": "2023-11-07T05:31:56Z", "name": "string", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "recurrence_excluded_datetimes": [ "2023-11-07T05:31:56Z" ], "recurring_designation_id": 123, "resource_id": 123, "rrule": "string", "start_datetime": "2023-11-07T05:31:56Z" }, "type": "calendar_designation.updated" }, "schema": { "$ref": "#/components/schemas/CalendarDesignationUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar designation updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar designation updated\"" } } } }, "calendar_event.created": { "post": { "description": "Triggered when a new calendar event (time block) is created.", "operationId": "calendar_event.created", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar.clinic_id": 123, "calendar_resource_ids": [ 123 ], "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "description": "string", "duration_minutes": 123, "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_applicable_to_all_resources": true, "is_deleted": true, "is_recurring": true, "kind.slug": "string", "kind_id": 123, "modified": "2023-11-07T05:31:56Z", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "recurrence_excluded_datetimes": [ "2023-11-07T05:31:56Z" ], "recurring_event_id": 123, "rrule": "string", "should_block_appointments": true, "start_datetime": "2023-11-07T05:31:56Z" }, "type": "calendar_event.created" }, "schema": { "$ref": "#/components/schemas/CalendarEventCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar event created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar event created\"" } } } }, "calendar_event.deleted": { "post": { "description": "Triggered when a calendar event is deleted.", "operationId": "calendar_event.deleted", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar.clinic_id": 123, "calendar_resource_ids": [ 123 ], "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "description": "string", "duration_minutes": 123, "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_applicable_to_all_resources": true, "is_deleted": true, "is_recurring": true, "kind.slug": "string", "kind_id": 123, "modified": "2023-11-07T05:31:56Z", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "recurrence_excluded_datetimes": [ "2023-11-07T05:31:56Z" ], "recurring_event_id": 123, "rrule": "string", "should_block_appointments": true, "start_datetime": "2023-11-07T05:31:56Z" }, "type": "calendar_event.deleted" }, "schema": { "$ref": "#/components/schemas/CalendarEventDeletedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar event deleted", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar event deleted\"" } } } }, "calendar_event.updated": { "post": { "description": "Triggered when an existing calendar event is updated.", "operationId": "calendar_event.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar.clinic_id": 123, "calendar_resource_ids": [ 123 ], "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "description": "string", "duration_minutes": 123, "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_applicable_to_all_resources": true, "is_deleted": true, "is_recurring": true, "kind.slug": "string", "kind_id": 123, "modified": "2023-11-07T05:31:56Z", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "recurrence_excluded_datetimes": [ "2023-11-07T05:31:56Z" ], "recurring_event_id": 123, "rrule": "string", "should_block_appointments": true, "start_datetime": "2023-11-07T05:31:56Z" }, "type": "calendar_event.updated" }, "schema": { "$ref": "#/components/schemas/CalendarEventUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar event updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar event updated\"" } } } }, "calendar_resource.created": { "post": { "description": "Triggered when a new calendar resource (provider/room) is created.", "operationId": "calendar_resource.created", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar.clinic_id": 123, "calendar_id": 123, "can_client_double_book": true, "can_double_book": true, "clinic_user": { "id": 123, "name": "string" }, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_imported": true, "modified": "2023-11-07T05:31:56Z", "name": "string" }, "type": "calendar_resource.created" }, "schema": { "$ref": "#/components/schemas/CalendarResourceCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar resource created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar resource created\"" } } } }, "calendar_resource.deleted": { "post": { "description": "Triggered when a calendar resource is deleted.", "operationId": "calendar_resource.deleted", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar.clinic_id": 123, "calendar_id": 123, "can_client_double_book": true, "can_double_book": true, "clinic_user": { "id": 123, "name": "string" }, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_imported": true, "modified": "2023-11-07T05:31:56Z", "name": "string" }, "type": "calendar_resource.deleted" }, "schema": { "$ref": "#/components/schemas/CalendarResourceDeletedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar resource deleted", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar resource deleted\"" } } } }, "calendar_resource.updated": { "post": { "description": "Triggered when an existing calendar resource is updated.", "operationId": "calendar_resource.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar.clinic_id": 123, "calendar_id": 123, "can_client_double_book": true, "can_double_book": true, "clinic_user": { "id": 123, "name": "string" }, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_imported": true, "modified": "2023-11-07T05:31:56Z", "name": "string" }, "type": "calendar_resource.updated" }, "schema": { "$ref": "#/components/schemas/CalendarResourceUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Calendar resource updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Calendar resource updated\"" } } } }, "clinic_client.created": { "post": { "description": "Triggered when a new clinic client is created.", "operationId": "clinic_client.created", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar_notes": "string", "can_be_called": true, "clinic_id": 123, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "external_id": "string", "has_unread_messages_for_clinic": true, "id": 123, "is_active": true, "is_co_ownership_client": true, "is_deleted": true, "is_email_unsubscribed": true, "is_subscribed": true, "last_visit_date": "2023-11-07T05:31:56Z", "modified": "2023-11-07T05:31:56Z", "pim_id": "string", "primary_address": { "address_one": "string", "address_two": "string", "city": "string", "country": "string", "county": "string", "id": 123, "name": "string", "phone_number": 123, "state": "string", "zipcode": "string" }, "primary_client_user.first_name": "string", "primary_client_user.last_name": "string", "primary_client_user_id": 123, "primary_communication_number_int": 123, "primary_email_address_str": "string", "primary_payment_method_id": 123, "universal_client_id": 123 }, "type": "clinic_client.created" }, "schema": { "$ref": "#/components/schemas/ClinicClientCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Clinic client created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Clinic client created\"" } } } }, "clinic_client.updated": { "post": { "description": "Triggered when an existing clinic client is updated.", "operationId": "clinic_client.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "calendar_notes": "string", "can_be_called": true, "clinic_id": 123, "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "external_id": "string", "has_unread_messages_for_clinic": true, "id": 123, "is_active": true, "is_co_ownership_client": true, "is_deleted": true, "is_email_unsubscribed": true, "is_subscribed": true, "last_visit_date": "2023-11-07T05:31:56Z", "modified": "2023-11-07T05:31:56Z", "pim_id": "string", "primary_address": { "address_one": "string", "address_two": "string", "city": "string", "country": "string", "county": "string", "id": 123, "name": "string", "phone_number": 123, "state": "string", "zipcode": "string" }, "primary_client_user.first_name": "string", "primary_client_user.last_name": "string", "primary_client_user_id": 123, "primary_communication_number_int": 123, "primary_email_address_str": "string", "primary_payment_method_id": 123, "universal_client_id": 123 }, "type": "clinic_client.updated" }, "schema": { "$ref": "#/components/schemas/ClinicClientUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Clinic client updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Clinic client updated\"" } } } }, "clinic_patient.created": { "post": { "description": "Triggered when a new clinic patient is created.", "operationId": "clinic_patient.created", "requestBody": { "content": { "application/json": { "example": { "data": { "allergies": "string", "auto_rabies_tag": "string", "birth_date": "2023-11-07", "birth_day": 123, "birth_month": 123, "birth_year": 123, "calendar_notes": "string", "client_id": 123, "clinic_id": 123, "color": "BLACK", "created": "2023-11-07T05:31:56Z", "custom_breed": "string", "custom_species": "string", "deactivated_at": "2023-11-07T05:31:56Z", "deceased_date": "2023-11-07", "deleted": "2023-11-07T05:31:56Z", "external_id": "string", "first_visit_date": "2023-11-07", "id": 123, "insurance": { "custom_provider_name": "string", "policy_number": "string", "provider_id": 123 }, "is_active": true, "is_alive": true, "is_altered": true, "is_bam_deleted": true, "is_deactivated": true, "is_deleted": true, "is_surrendered": true, "last_visit_date": "2023-11-07", "microchip_number": "string", "microchip_number_updated_at": "2023-11-07T05:31:56Z", "modified": "2023-11-07T05:31:56Z", "name": "string", "patientclientrelationship_set": [ { "clinic_client_id": 123, "is_active": true } ], "pim_id": "string", "primary_breed": "AFFENPINSCHER", "reissued_rabies_tag": "string", "resuscitate_status": "DNR", "secondary_breeds": [ "AFFENPINSCHER" ], "sex": "MALE", "species": "CANINE", "surrendered_date": "2023-11-07", "universal_patient_id": 123, "weight": 123.45, "weight_in_units": 123.45, "weight_unit_of_measure": "POUND" }, "type": "clinic_patient.created" }, "schema": { "$ref": "#/components/schemas/ClinicPatientCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Clinic patient created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Clinic patient created\"" } } } }, "clinic_patient.updated": { "post": { "description": "Triggered when an existing clinic patient is updated.", "operationId": "clinic_patient.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "allergies": "string", "auto_rabies_tag": "string", "birth_date": "2023-11-07", "birth_day": 123, "birth_month": 123, "birth_year": 123, "calendar_notes": "string", "client_id": 123, "clinic_id": 123, "color": "BLACK", "created": "2023-11-07T05:31:56Z", "custom_breed": "string", "custom_species": "string", "deactivated_at": "2023-11-07T05:31:56Z", "deceased_date": "2023-11-07", "deleted": "2023-11-07T05:31:56Z", "external_id": "string", "first_visit_date": "2023-11-07", "id": 123, "insurance": { "custom_provider_name": "string", "policy_number": "string", "provider_id": 123 }, "is_active": true, "is_alive": true, "is_altered": true, "is_bam_deleted": true, "is_deactivated": true, "is_deleted": true, "is_surrendered": true, "last_visit_date": "2023-11-07", "microchip_number": "string", "microchip_number_updated_at": "2023-11-07T05:31:56Z", "modified": "2023-11-07T05:31:56Z", "name": "string", "patientclientrelationship_set": [ { "clinic_client_id": 123, "is_active": true } ], "pim_id": "string", "primary_breed": "AFFENPINSCHER", "reissued_rabies_tag": "string", "resuscitate_status": "DNR", "secondary_breeds": [ "AFFENPINSCHER" ], "sex": "MALE", "species": "CANINE", "surrendered_date": "2023-11-07", "universal_patient_id": 123, "weight": 123.45, "weight_in_units": 123.45, "weight_unit_of_measure": "POUND" }, "type": "clinic_patient.updated" }, "schema": { "$ref": "#/components/schemas/ClinicPatientUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Clinic patient updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Clinic patient updated\"" } } } }, "patient_care_plan.activated": { "post": { "description": "Triggered when a patient care plan transitions to active status. The status returned in the payload will always be `ACTIVE`.", "operationId": "patient_care_plan.activated", "requestBody": { "content": { "application/json": { "example": { "data": { "care_plan.kind": "CORE", "care_plan.name": "string", "care_plan_id": 123, "clinic_patient_id": 123, "core_plan_id": 123, "deactivated_at": "2023-11-07T05:31:56Z", "deactivated_by": "string", "end_date": "2023-11-07", "enrollment_fee": 123, "id": 123, "is_billed_monthly": true, "monthly_cost": 123, "next_payment_date": "2023-11-07", "next_plan_id": 123, "patient_care.billing_client_id": 123, "patient_care.billing_clinic_id": 123, "patient_care.payment_method_id": 123, "plan_cost": 123, "remaining_balance": 123, "should_renew": true, "start_date": "2023-11-07", "status": "IMPORTED" }, "type": "patient_care_plan.activated" }, "schema": { "$ref": "#/components/schemas/PatientCarePlanActivatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient care plan activated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient care plan activated\"" } } } }, "patient_care_plan.created": { "post": { "description": "Triggered when a new patient care plan is created.", "operationId": "patient_care_plan.created", "requestBody": { "content": { "application/json": { "example": { "data": { "care_plan.kind": "CORE", "care_plan.name": "string", "care_plan_id": 123, "clinic_patient_id": 123, "core_plan_id": 123, "deactivated_at": "2023-11-07T05:31:56Z", "deactivated_by": "string", "end_date": "2023-11-07", "enrollment_fee": 123, "id": 123, "is_billed_monthly": true, "monthly_cost": 123, "next_payment_date": "2023-11-07", "next_plan_id": 123, "patient_care.billing_client_id": 123, "patient_care.billing_clinic_id": 123, "patient_care.payment_method_id": 123, "plan_cost": 123, "remaining_balance": 123, "should_renew": true, "start_date": "2023-11-07", "status": "IMPORTED" }, "type": "patient_care_plan.created" }, "schema": { "$ref": "#/components/schemas/PatientCarePlanCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient care plan created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient care plan created\"" } } } }, "patient_care_plan.deleted": { "post": { "description": "Triggered when a patient care plan is deleted, such as when an unpaid client-created enrollment is automatically removed because a new enrollment superseded it. The status returned in the payload will always be `TERMINATED`.", "operationId": "patient_care_plan.deleted", "requestBody": { "content": { "application/json": { "example": { "data": { "care_plan.kind": "CORE", "care_plan.name": "string", "care_plan_id": 123, "clinic_patient_id": 123, "core_plan_id": 123, "deactivated_at": "2023-11-07T05:31:56Z", "deactivated_by": "string", "end_date": "2023-11-07", "enrollment_fee": 123, "id": 123, "is_billed_monthly": true, "monthly_cost": 123, "next_payment_date": "2023-11-07", "next_plan_id": 123, "patient_care.billing_client_id": 123, "patient_care.billing_clinic_id": 123, "patient_care.payment_method_id": 123, "plan_cost": 123, "remaining_balance": 123, "should_renew": true, "start_date": "2023-11-07", "status": "IMPORTED" }, "type": "patient_care_plan.deleted" }, "schema": { "$ref": "#/components/schemas/PatientCarePlanDeletedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient care plan deleted", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient care plan deleted\"" } } } }, "patient_care_plan.renewed": { "post": { "description": "Triggered when a patient care plan is renewed (replaces created for automatic renewals).", "operationId": "patient_care_plan.renewed", "requestBody": { "content": { "application/json": { "example": { "data": { "care_plan.kind": "CORE", "care_plan.name": "string", "care_plan_id": 123, "clinic_patient_id": 123, "core_plan_id": 123, "deactivated_at": "2023-11-07T05:31:56Z", "deactivated_by": "string", "end_date": "2023-11-07", "enrollment_fee": 123, "id": 123, "is_billed_monthly": true, "monthly_cost": 123, "next_payment_date": "2023-11-07", "next_plan_id": 123, "patient_care.billing_client_id": 123, "patient_care.billing_clinic_id": 123, "patient_care.payment_method_id": 123, "plan_cost": 123, "remaining_balance": 123, "should_renew": true, "start_date": "2023-11-07", "status": "IMPORTED" }, "type": "patient_care_plan.renewed" }, "schema": { "$ref": "#/components/schemas/PatientCarePlanRenewedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient care plan renewed", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient care plan renewed\"" } } } }, "patient_care_plan.updated": { "post": { "description": "Triggered when an existing patient care plan is updated.", "operationId": "patient_care_plan.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "care_plan.kind": "CORE", "care_plan.name": "string", "care_plan_id": 123, "clinic_patient_id": 123, "core_plan_id": 123, "deactivated_at": "2023-11-07T05:31:56Z", "deactivated_by": "string", "end_date": "2023-11-07", "enrollment_fee": 123, "id": 123, "is_billed_monthly": true, "monthly_cost": 123, "next_payment_date": "2023-11-07", "next_plan_id": 123, "patient_care.billing_client_id": 123, "patient_care.billing_clinic_id": 123, "patient_care.payment_method_id": 123, "plan_cost": 123, "remaining_balance": 123, "should_renew": true, "start_date": "2023-11-07", "status": "IMPORTED" }, "type": "patient_care_plan.updated" }, "schema": { "$ref": "#/components/schemas/PatientCarePlanUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient care plan updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient care plan updated\"" } } } }, "patient_custom_care_reminder.created": { "post": { "description": "Triggered when a new patient custom care reminder is created.", "operationId": "patient_custom_care_reminder.created", "requestBody": { "content": { "application/json": { "example": { "data": { "deleted": "2023-11-07T05:31:56Z", "due_date": "2023-11-07", "id": 123, "is_deleted": true, "is_past_due": true, "kind": "CUSTOM", "last_fulfilled_date": "2023-11-07", "name": "string", "patient_standard_care.universal_patient_id": 123, "patient_standard_care_id": 123, "standard_care_reminder_id": 123, "status": "ACTIVE" }, "type": "patient_custom_care_reminder.created" }, "schema": { "$ref": "#/components/schemas/PatientCustomCareReminderCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient custom care reminder created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient custom care reminder created\"" } } } }, "patient_custom_care_reminder.updated": { "post": { "description": "Triggered when an existing patient custom care reminder is updated.", "operationId": "patient_custom_care_reminder.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "deleted": "2023-11-07T05:31:56Z", "due_date": "2023-11-07", "id": 123, "is_deleted": true, "is_past_due": true, "kind": "CUSTOM", "last_fulfilled_date": "2023-11-07", "name": "string", "patient_standard_care.universal_patient_id": 123, "patient_standard_care_id": 123, "standard_care_reminder_id": 123, "status": "ACTIVE" }, "type": "patient_custom_care_reminder.updated" }, "schema": { "$ref": "#/components/schemas/PatientCustomCareReminderUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient custom care reminder updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient custom care reminder updated\"" } } } }, "patient_standard_care_reminder.created": { "post": { "description": "Triggered when a new patient standard care reminder is created.", "operationId": "patient_standard_care_reminder.created", "requestBody": { "content": { "application/json": { "example": { "data": { "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "due_date": "2023-11-07", "id": 123, "is_deleted": true, "is_past_due": true, "kind": "STANDARD", "last_fulfilled_date": "2023-11-07", "modified": "2023-11-07T05:31:56Z", "patient_standard_care.universal_patient.universal_client.primary_clinic_id": 123, "patient_standard_care.universal_patient.universal_client_id": 123, "patient_standard_care.universal_patient_id": 123, "patient_standard_care_id": 123, "standard_care_reminder.name": "string", "standard_care_reminder_id": 123, "status": "ACTIVE" }, "type": "patient_standard_care_reminder.created" }, "schema": { "$ref": "#/components/schemas/PatientStandardCareReminderCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient standard care reminder created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient standard care reminder created\"" } } } }, "patient_standard_care_reminder.updated": { "post": { "description": "Triggered when an existing patient standard care reminder is updated.", "operationId": "patient_standard_care_reminder.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "due_date": "2023-11-07", "id": 123, "is_deleted": true, "is_past_due": true, "kind": "STANDARD", "last_fulfilled_date": "2023-11-07", "modified": "2023-11-07T05:31:56Z", "patient_standard_care.universal_patient.universal_client.primary_clinic_id": 123, "patient_standard_care.universal_patient.universal_client_id": 123, "patient_standard_care.universal_patient_id": 123, "patient_standard_care_id": 123, "standard_care_reminder.name": "string", "standard_care_reminder_id": 123, "status": "ACTIVE" }, "type": "patient_standard_care_reminder.updated" }, "schema": { "$ref": "#/components/schemas/PatientStandardCareReminderUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Patient standard care reminder updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Patient standard care reminder updated\"" } } } }, "resource_schedule.created": { "post": { "description": "Triggered when a new resource schedule is created.", "operationId": "resource_schedule.created", "requestBody": { "content": { "application/json": { "example": { "data": { "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_recurring": true, "modified": "2023-11-07T05:31:56Z", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "resource.calendar.clinic_id": 123, "resource_id": 123, "rrule": "string", "start_datetime": "2023-11-07T05:31:56Z", "use_clinic_hours": true }, "type": "resource_schedule.created" }, "schema": { "$ref": "#/components/schemas/ResourceScheduleCreatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Resource schedule created", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Resource schedule created\"" } } } }, "resource_schedule.deleted": { "post": { "description": "Triggered when a resource schedule is deleted.", "operationId": "resource_schedule.deleted", "requestBody": { "content": { "application/json": { "example": { "data": { "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_recurring": true, "modified": "2023-11-07T05:31:56Z", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "resource.calendar.clinic_id": 123, "resource_id": 123, "rrule": "string", "start_datetime": "2023-11-07T05:31:56Z", "use_clinic_hours": true }, "type": "resource_schedule.deleted" }, "schema": { "$ref": "#/components/schemas/ResourceScheduleDeletedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Resource schedule deleted", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Resource schedule deleted\"" } } } }, "resource_schedule.updated": { "post": { "description": "Triggered when an existing resource schedule is updated, including when a recurring schedule's recurrence is ended.", "operationId": "resource_schedule.updated", "requestBody": { "content": { "application/json": { "example": { "data": { "created": "2023-11-07T05:31:56Z", "deleted": "2023-11-07T05:31:56Z", "end_datetime": "2023-11-07T05:31:56Z", "id": 123, "is_deleted": true, "is_recurring": true, "modified": "2023-11-07T05:31:56Z", "recurrence": { "days_of_week": [ "MO" ], "end_after_occurrences": 123, "end_date": "2023-11-07", "frequency": "YEARLY", "interval": 123 }, "resource.calendar.clinic_id": 123, "resource_id": 123, "rrule": "string", "start_datetime": "2023-11-07T05:31:56Z", "use_clinic_hours": true }, "type": "resource_schedule.updated" }, "schema": { "$ref": "#/components/schemas/ResourceScheduleUpdatedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Resource schedule updated", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Resource schedule updated\"" } } } }, "sms_notification.delivered": { "post": { "description": "Triggered when an API-sent SMS notification is successfully delivered.", "operationId": "sms_notification.delivered", "requestBody": { "content": { "application/json": { "example": { "data": { "client.clinic_id": 123, "client_id": 123, "created": "2023-11-07T05:31:56Z", "error_reason": "string", "id": 123, "status": "SENT", "text_message.body": "string", "text_message.client_communication_number_id": 123, "text_message.error_code": "string" }, "type": "sms_notification.delivered" }, "schema": { "$ref": "#/components/schemas/SmsNotificationDeliveredWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Sms notification delivered", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Sms notification delivered\"" } } } }, "sms_notification.failed": { "post": { "description": "Triggered when an API-sent SMS notification fails to deliver.", "operationId": "sms_notification.failed", "requestBody": { "content": { "application/json": { "example": { "data": { "client.clinic_id": 123, "client_id": 123, "created": "2023-11-07T05:31:56Z", "error_reason": "string", "id": 123, "status": "SENT", "text_message.body": "string", "text_message.client_communication_number_id": 123, "text_message.error_code": "string" }, "type": "sms_notification.failed" }, "schema": { "$ref": "#/components/schemas/SmsNotificationFailedWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Sms notification failed", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Sms notification failed\"" } } } }, "sms_notification.sent": { "post": { "description": "Triggered when an API-sent SMS notification is sent to the carrier.", "operationId": "sms_notification.sent", "requestBody": { "content": { "application/json": { "example": { "data": { "client.clinic_id": 123, "client_id": 123, "created": "2023-11-07T05:31:56Z", "error_reason": "string", "id": 123, "status": "SENT", "text_message.body": "string", "text_message.client_communication_number_id": 123, "text_message.error_code": "string" }, "type": "sms_notification.sent" }, "schema": { "$ref": "#/components/schemas/SmsNotificationSentWebhookPayload" } } }, "required": true }, "responses": { "200": { "description": "Webhook received" } }, "summary": "Sms notification sent", "tags": [ "webhooks" ], "x-mint": { "metadata": { "title": "\"Sms notification sent\"" } } } } } }