{ "info": { "name": "ezyVet API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.ezyvet.com", "description": "Production base URL" }, { "key": "accessToken", "value": "", "description": "Bearer access token from /v1/oauth/access_token" } ], "item": [ { "name": "Authentication", "item": [ { "name": "get-token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/oauth/access_token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "oauth", "access_token" ] }, "description": "Generates a valid access token, given client credentials. Access tokens have an 12-hour TTL.", "body": { "mode": "raw", "raw": "{\"partner_id\": \"your_partner_id\", \"client_id\": \"your_client_id\", \"client_secret\": \"your_client_secret\", \"grant_type\": \"client_credentials\", \"scope\": \"your_scope\", \"site_uid\": \"your_site_uid\"}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Animal Management", "item": [ { "name": "get-animalcolour", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/animalcolour", "host": [ "{{baseUrl}}" ], "path": [ "v1", "animalcolour" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an AnimalColour.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the AnimalColour is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the AnimalColour was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the AnimalColour was last modified.", "disabled": true }, { "key": "name", "value": "Black", "description": "The name of the AnimalColour.", "disabled": true } ] }, "description": "Fetches a list containing AnimalColour(s). (up to 10)" } }, { "name": "create-animal", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/animal", "host": [ "{{baseUrl}}" ], "path": [ "v1", "animal" ] }, "description": "Deprecated. Its recommended to use the v4/animal endpoint. Creates a single Animal record.", "body": { "mode": "raw", "raw": "{\"contact_id\": 87, \"name\": \"Buddy\", \"sex_id\": 3, \"animalcolour_id\": 5, \"species_id\": 1, \"breed_id\": 12, \"weight\": 28.5, \"weight_unit\": \"kg\", \"resuscitate\": \"1\", \"notes\": \"Friendly dog\", \"notes_important\": false}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-animal", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/animal", "host": [ "{{baseUrl}}" ], "path": [ "v1", "animal" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an Animal.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Animal is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Animal was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Animal was last modified.", "disabled": true }, { "key": "name", "value": "Buddy", "description": "The name of the Animal.", "disabled": true }, { "key": "code", "value": "A0001234567890", "description": "The custom code override for the Animal.", "disabled": true }, { "key": "sex_id", "value": "3", "description": "The ID of the Sex of the Animal.", "disabled": true }, { "key": "is_dead", "value": "false", "description": "If true, the Animal is dead.", "disabled": true }, { "key": "is_hostile", "value": "false", "description": "If true, the Animal is not friendly.", "disabled": true }, { "key": "animalcolour_id", "value": "5", "description": "The ID of the AnimalColour.", "disabled": true }, { "key": "species_id", "value": "1", "description": "The ID of the Species of the Animal.", "disabled": true }, { "key": "breed_id", "value": "12", "description": "The ID of the Breed of the Animal.", "disabled": true }, { "key": "rabies_number", "value": "R123456", "description": "The rabies registration number of the Animal.", "disabled": true }, { "key": "date_of_rabies_vaccination", "value": "1695766710", "description": "The epoch time that the Animal was vaccinated against rabies.", "disabled": true }, { "key": "microchip_number", "value": "982000123456789", "description": "The microchip number of the Animal.", "disabled": true }, { "key": "contact_id", "value": "87", "description": "The ID of the owner of the Animal.", "disabled": true }, { "key": "date_of_birth", "value": "1589500800", "description": "The epoch time the Animal was born.", "disabled": true }, { "key": "is_estimated_date_of_birth", "value": "false", "description": "If true, the date of birth is considered to be an estimate only.", "disabled": true }, { "key": "date_of_death", "value": "1695766710", "description": "The epoch time the Animal died.", "disabled": true }, { "key": "death_reason", "value": "Natural causes", "description": "The reason of the Animal death.", "disabled": true }, { "key": "date_of_desex", "value": "1695766710", "description": "The epoch time the Animal was spayed/neutered.", "disabled": true }, { "key": "referring_clinic_id", "value": "10", "description": "The Contact ID of the clinic that referred the Animal.", "disabled": true }, { "key": "referring_vet_id", "value": "20", "description": "The Contact ID of the vet that referred the Animal.", "disabled": true }, { "key": "residence_contact_id", "value": "30", "description": "The Contact ID for the caretaker of the Animal.", "disabled": true }, { "key": "weight_unit", "value": "kg", "description": "The unit of weight (kg, lb, g).", "disabled": true }, { "key": "weight", "value": "28.5", "description": "The weight of the Animal.", "disabled": true }, { "key": "resuscitate", "value": "1", "description": "Whether the Animal's owner would like it to be resuscitated.", "disabled": true }, { "key": "notes", "value": "Friendly dog", "description": "Notes displayed on the animal page.", "disabled": true }, { "key": "notes_important", "value": "false", "description": "If true, the Animal's notes are marked as important.", "disabled": true } ] }, "description": "Deprecated. Its recommended to use the v4/animal endpoint. Fetches a list of Animals." } }, { "name": "delete-animal", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/animal/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "animal", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the animal to delete" } ] }, "description": "Deletes a single Animal record by its ID." } }, { "name": "update-animal", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/animal/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "animal", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the Animal to update" } ] }, "description": "Deprecated. Its recommended to use the v4/animal endpoint. Updates a single Animal record.", "body": { "mode": "raw", "raw": "{\"name\": \"Buddy\", \"active\": \"1\", \"sex_id\": \"3\", \"is_dead\": \"0\", \"is_hostile\": \"0\", \"animalcolour_id\": \"5\", \"species_id\": \"1\", \"breed_id\": \"12\", \"weight\": \"28.5\", \"weight_unit\": \"kg\", \"resuscitate\": \"1\", \"notes\": \"Friendly dog\", \"notes_important\": \"0\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-breed", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/breed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "breed" ], "query": [ { "key": "species_id", "value": "1", "description": "The ID of the Species to filter breeds by.", "disabled": false }, { "key": "id", "value": "12", "description": "The ID number used by the system to uniquely identify a Breed.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Breed is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Breed was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Breed was last modified.", "disabled": true }, { "key": "name", "value": "Golden Retriever", "description": "The name of the Breed.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned. Default is 10.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result. Default is 1.", "disabled": true } ] }, "description": "Fetches a list containing Breed(s). (up to 10)" } }, { "name": "get-sex", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/sex", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sex" ], "query": [ { "key": "id", "value": "3", "description": "The ID number used by the system to uniquely identify a Sex.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Sex is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Sex was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Sex was last modified.", "disabled": true }, { "key": "name", "value": "Male Neutered", "description": "The name of the Sex.", "disabled": true }, { "key": "abbreviation", "value": "MN", "description": "The abbreviation of the Sex.", "disabled": true }, { "key": "is_desexed", "value": "true", "description": "If true, the Sex is spayed/neutered.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned. Default is 10.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result. Default is 1.", "disabled": true } ] }, "description": "Fetches a list containing Sex(es). (up to 10)" } }, { "name": "get-species", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/species", "host": [ "{{baseUrl}}" ], "path": [ "v1", "species" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Species.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Species is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Species was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Species was last modified.", "disabled": true }, { "key": "name", "value": "Dog", "description": "The name of the Species.", "disabled": true } ] }, "description": "Fetches a list containing Species. (up to 10)" } }, { "name": "get-animalv1-1", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1.1/animal", "host": [ "{{baseUrl}}" ], "path": [ "v1.1", "animal" ], "query": [ { "key": "id", "value": "1", "description": "The ezyVet ID of the record.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the record is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the record was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the record was last modified.", "disabled": true }, { "key": "page_size", "value": "200", "description": "Sets the number of items to be returned in each page. Default is 2000, Limit is 2000.", "disabled": true }, { "key": "next_token", "value": "AB3e7Z2i9FJu0j7hLExLp", "description": "A token to pass back to the server to get the next page of results.", "disabled": true }, { "key": "name", "value": "Buddy", "description": "The name of the Animal.", "disabled": true }, { "key": "code", "value": "A0001234567890", "description": "The custom code override for the Animal.", "disabled": true }, { "key": "sex_id", "value": "3", "description": "The ID of the Sex of the Animal.", "disabled": true }, { "key": "is_dead", "value": "false", "description": "If true, the Animal is dead.", "disabled": true }, { "key": "is_hostile", "value": "false", "description": "If true, the Animal is not friendly.", "disabled": true }, { "key": "animalcolour_id", "value": "5", "description": "The ID of the AnimalColour.", "disabled": true }, { "key": "species_id", "value": "1", "description": "The ID of the Species of the Animal.", "disabled": true }, { "key": "breed_id", "value": "12", "description": "The ID of the Breed of the Animal.", "disabled": true }, { "key": "contact_id", "value": "87", "description": "The ID of the owner of the Animal.", "disabled": true }, { "key": "weight", "value": "28.5", "description": "The weight of the Animal.", "disabled": true }, { "key": "weight_unit", "value": "kg", "description": "The unit of weight (kg, lb, g).", "disabled": true } ] }, "description": "Fetches a list of Animals using token-based pagination." } }, { "name": "get-animalv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/animal", "host": [ "{{baseUrl}}" ], "path": [ "v2", "animal" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an Animal.", "disabled": true }, { "key": "uid", "value": "animal_AB3e7Z2i9FJu0j7hLExLp", "description": "The UID used by the system to uniquely identify an Animal.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Animal is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Animal was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Animal was last modified.", "disabled": true }, { "key": "code", "value": "A0001234567890", "description": "The custom code override for the Animal.", "disabled": true }, { "key": "sex_id", "value": "3", "description": "The ID of the Sex of the Animal.", "disabled": true }, { "key": "is_dead", "value": "false", "description": "If true, the Animal is dead.", "disabled": true }, { "key": "is_hostile", "value": "false", "description": "If true, the Animal is not friendly.", "disabled": true }, { "key": "animalcolour_id", "value": "5", "description": "The ID of the AnimalColour.", "disabled": true }, { "key": "species_id", "value": "1", "description": "The ID of the Species of the Animal.", "disabled": true }, { "key": "breed_id", "value": "12", "description": "The ID of the Breed of the Animal.", "disabled": true }, { "key": "contact_id", "value": "87", "description": "The ID of the owner of the Animal.", "disabled": true }, { "key": "weight_unit", "value": "kg", "description": "The unit of weight (kg, lb, g).", "disabled": true }, { "key": "weight", "value": "28.5", "description": "The weight of the Animal.", "disabled": true }, { "key": "resuscitate", "value": "1", "description": "Resuscitation preference.", "disabled": true }, { "key": "notes", "value": "Friendly dog", "description": "Notes displayed on the animal page.", "disabled": true }, { "key": "notes_important", "value": "false", "description": "If true, the Animal's notes are marked as important.", "disabled": true } ] }, "description": "Fetches a list of Animals using V2 format with typed fields and UID support." } }, { "name": "get-animal-v2.1", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2.1/animal", "host": [ "{{baseUrl}}" ], "path": [ "v2.1", "animal" ], "query": [ { "key": "id", "value": "1", "description": "The ezyVet ID of the record.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the record is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the record was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the record was last modified.", "disabled": true }, { "key": "page_size", "value": "200", "description": "Number of items per page. Default is 2000, maximum is 2000.", "disabled": true }, { "key": "next_token", "value": "AB3e7Z2i9FJu0j7hLExLp", "description": "A token to pass back to the server to get the next page of results.", "disabled": true }, { "key": "name", "value": "Buddy", "description": "The name of the Animal.", "disabled": true }, { "key": "code", "value": "A0001234567890", "description": "The custom code override for the Animal.", "disabled": true }, { "key": "is_dead", "value": "false", "description": "If true, the Animal is dead.", "disabled": true } ] }, "description": "Transitional endpoint bridging legacy v2 and new v4 API." } }, { "name": "get-animal-v4", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v4/animal", "host": [ "{{baseUrl}}" ], "path": [ "v4", "animal" ], "query": [ { "key": "id", "value": "animal_AB3e7Z2i9FJu0j7hLExLp", "description": "The ezyVet UID of the record.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the record is active and usable in ezyVet.", "disabled": true }, { "key": "createdAt", "value": "2024-01-15T10:30:00Z", "description": "The ISO 8601 timestamp when the record was created.", "disabled": true }, { "key": "modifiedAt", "value": "2024-12-20T14:22:00Z", "description": "The ISO 8601 timestamp when the record was last modified.", "disabled": true }, { "key": "pageSize", "value": "200", "description": "Sets the number of items to be returned in each page.", "disabled": true }, { "key": "nextToken", "value": "AB3e7Z2i9FJu0j7hLExLp", "description": "A token to pass back to the server to get the next page of results.", "disabled": true }, { "key": "name", "value": "Buddy", "description": "The name of the Animal.", "disabled": true }, { "key": "code", "value": "A0001234567890", "description": "The custom code override for the Animal.", "disabled": true }, { "key": "ownerId", "value": "contact_Xk9mR4pL2vN8qW1sT7yB3", "description": "The ID of the owner (contact) of the Animal.", "disabled": true }, { "key": "status", "value": "active", "description": "Filter by the status of the Animal (active or inactive).", "disabled": true }, { "key": "isDead", "value": "false", "description": "Filter by death status.", "disabled": true } ] }, "description": "Retrieve a paginated list of all animals using token-based pagination. Default and max page size is 500." } }, { "name": "get-animal-by-id-v4", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v4/animal/:id", "host": [ "{{baseUrl}}" ], "path": [ "v4", "animal", ":id" ], "variable": [ { "key": "id", "value": "animal_AB3e7Z2i9FJu0j7hLExLp", "description": "The unique identifier (uid) of the Animal." } ] }, "description": "Returns a single Animal object directly (no envelope). The id parameter is the unique UID of the Animal." } } ] }, { "name": "Appointment Management", "item": [ { "name": "get-availability", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/ezycab/availability", "host": [ "{{baseUrl}}" ], "path": [ "ezycab", "availability" ], "query": [ { "key": "resources[]", "value": "resource_Tr4l0W5LbTs7aTGSuzi5n", "description": "Resource UID to filter slots by.", "disabled": false }, { "key": "dates[]", "value": "2024-06-09", "description": "Date to fetch availability for. Must be in the future. Format: YYYY-MM-DD.", "disabled": false }, { "key": "duration", "value": "15", "description": "Duration of appointment slots in minutes.", "disabled": false }, { "key": "filter[slots.available][eq]", "value": "true", "description": "Filter by whether appointment slots are available or not.", "disabled": false }, { "key": "filter[slots.appointmentType.id][in]", "value": "appointmentType_0C0qtekyEL2A0XDUUSbDz", "description": "Filter by appointment type UID.", "disabled": true } ] }, "description": "Gets bookable appointment slots. Rate limit: 300 calls/minute. Served from apiv2.ezyvet.com." } }, { "name": "create-booking", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ezycab/booking", "host": [ "{{baseUrl}}" ], "path": [ "ezycab", "booking" ] }, "description": "Creates an appointment with associated consultation and billing triggers in the ezyVet system. Served from apiv2.ezyvet.com.", "body": { "mode": "raw", "raw": "{\"startTime\": \"2025-07-14T09:30:00.000-04:00\", \"type\": \"appointmentType_98765\", \"durationMinutes\": 30, \"appointmentStatus\": \"unconfirmed\", \"description\": \"Routine check-up\", \"animal\": \"animal_f47ac10bassssdasda\", \"contact\": \"contact_f47ac10bxcxasdoaids\", \"provider\": \"resource_0L08Ggnl7UB5AhVOys3t1\", \"additionalResources\": [\"resource_0L08Ggnl7UB5AhVOys3t1\"]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-appointment", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/appointment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "appointment" ], "query": [ { "key": "id", "value": "123", "description": "The ID number used by the system to uniquely identify an Appointment.", "disabled": true }, { "key": "recurrence_number", "value": "0", "description": "The number of the recurring appointment.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Appointment is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Appointment was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Appointment was last modified.", "disabled": true }, { "key": "recurrence_interval", "value": "0", "description": "The interval between recurring appointments (in weeks).", "disabled": true }, { "key": "recurrence_end_time", "value": "1700000000", "description": "The epoch time for when the recurrence ends.", "disabled": true }, { "key": "start_time", "value": "1695800000", "description": "The epoch time for when the Appointment starts.", "disabled": true }, { "key": "duration", "value": "1800", "description": "The duration of the Appointment in seconds.", "disabled": true }, { "key": "appointment_type_id", "value": "5", "description": "Refers to the ID of the AppointmentType of the Appointment.", "disabled": true }, { "key": "appointment_status_id", "value": "2", "description": "Refers to the ID of the AppointmentStatus of the Appointment.", "disabled": true }, { "key": "animal_id", "value": "42", "description": "Refers to the ID of the Animal.", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Refers to the ID of the Consult.", "disabled": true }, { "key": "contact_id", "value": "7", "description": "Refers to the ID of the Contact.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of results returned. Default: 10.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result. Default: 1.", "disabled": true } ] }, "description": "Gets a list of appointments. It's recommended to use the GET /v2/appointment endpoint instead." } }, { "name": "get-appointmentstatus", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/appointmentstatus", "host": [ "{{baseUrl}}" ], "path": [ "v1", "appointmentstatus" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an AppointmentStatus.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the AppointmentStatus is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the AppointmentStatus was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the AppointmentStatus was last modified.", "disabled": true }, { "key": "name", "value": "Confirmed", "description": "The name of the AppointmentStatus.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned. Default: 10.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result. Default: 1.", "disabled": true } ] }, "description": "Fetches a list containing AppointmentStatus(s). (up to 10)" } }, { "name": "get-appointmenttype", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/appointmenttype", "host": [ "{{baseUrl}}" ], "path": [ "v1", "appointmenttype" ], "query": [ { "key": "id", "value": "3", "description": "The ID number used by the system to uniquely identify an AppointmentType.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the AppointmentType is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the AppointmentType was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the AppointmentType was last modified.", "disabled": true }, { "key": "name", "value": "Check-up", "description": "The name of the AppointmentType.", "disabled": true }, { "key": "default_duration", "value": "30", "description": "The default duration of the Appointment in minutes.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of results returned. Default: 10.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result. Default: 1.", "disabled": true } ] }, "description": "Fetches a list containing AppointmentType(s). (up to 10)" } }, { "name": "get-resource", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/resource", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resource" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Resource.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Resource is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Resource was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Resource was last modified.", "disabled": true }, { "key": "ownership_id", "value": "2", "description": "The ID of the Ownership Separation to which the Resource belongs.", "disabled": true }, { "key": "name", "value": "Dr. Smith", "description": "The name of the Resource.", "disabled": true }, { "key": "type", "value": "user", "description": "The type of the Resource: 'user' (default) or 'facility'.", "disabled": true }, { "key": "access", "value": "Member", "description": "The level of access the Resource has.", "disabled": true } ] }, "description": "Fetches a list containing Resource(s). It's recommended to use the v2/resource endpoint." } }, { "name": "create-appointmentv2", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/appointment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "appointment" ] }, "description": "Creates a single Appointment.", "body": { "mode": "raw", "raw": "{\"start_at\": \"1695800000\", \"duration\": \"1800\", \"type_id\": \"5\", \"status_id\": \"2\", \"description\": \"Routine check-up\", \"animal_id\": \"42\", \"consult_id\": null, \"contact_id\": null, \"sales_resource\": 1, \"resources\": [1, 2]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-appointmentv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/appointment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "appointment" ], "query": [ { "key": "id", "value": "123", "description": "The ID number used by the system to uniquely identify an Appointment.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Appointment was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Appointment was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Appointment is active and usable in ezyVet.", "disabled": true }, { "key": "start_at", "value": "1695800000", "description": "The epoch time for when the Appointment starts.", "disabled": true }, { "key": "duration", "value": "1800", "description": "The duration of the Appointment in seconds.", "disabled": true }, { "key": "type_id", "value": "5", "description": "Refers to the ID of the AppointmentType of the Appointment.", "disabled": true }, { "key": "status_id", "value": "2", "description": "Refers to the ID of the AppointmentStatus of the Appointment.", "disabled": true }, { "key": "animal_id", "value": "42", "description": "Refers to the ID of the Animal.", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Refers to the ID of the Consult.", "disabled": true }, { "key": "contact_id", "value": "7", "description": "Refers to the ID of the Contact.", "disabled": true }, { "key": "sales_resource", "value": "1", "description": "ID of the SalesResource allocated to the Appointment.", "disabled": true } ] }, "description": "Fetch a list of Appointment(s). (up to 200)" } }, { "name": "update-appointmentv2", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v2/appointment/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "appointment", ":id" ], "variable": [ { "key": "id", "value": "123", "description": "The ID of the appointment to update." } ], "query": [ { "key": "status_id", "value": "3", "description": "Refers to the ID of the AppointmentStatus of the Appointment.", "disabled": false }, { "key": "cancel", "value": "false", "description": "If true, the Appointment will be cancelled.", "disabled": false }, { "key": "cancellation_reason", "value": "1", "description": "The appointment cancellation reason record ID.", "disabled": false }, { "key": "cancellation_reason_text", "value": "Client requested cancellation", "description": "A custom reason for the appointment being cancelled.", "disabled": true }, { "key": "description", "value": "Follow-up visit", "description": "The Appointment description.", "disabled": true }, { "key": "animal_id", "value": "42", "description": "Refers to the ID of the Animal.", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Refers to the ID of the Consult.", "disabled": true } ] }, "description": "Updates an existing Appointment by ID.", "body": { "mode": "raw", "raw": "{\"status_id\": \"3\", \"cancel\": false, \"cancellation_reason\": 1, \"cancellation_reason_text\": \"Client requested cancellation\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-appointmenttypev2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/appointmenttype", "host": [ "{{baseUrl}}" ], "path": [ "v2", "appointmenttype" ], "query": [ { "key": "id", "value": "3", "description": "The ID number used by the system to uniquely identify an AppointmentType.", "disabled": true }, { "key": "uid", "value": "appointmentType_0C0qtekyEL2A0XDUUSbDz", "description": "The UID used to uniquely identify an AppointmentType across all ezyVet sites.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the AppointmentType is active and usable in ezyVet.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of results returned. Default: 10.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result. Default: 1.", "disabled": true } ] }, "description": "Fetches a list containing AppointmentType(s)." } }, { "name": "get-resourcev2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/resource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "resource" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Resource.", "disabled": true }, { "key": "uid", "value": "resource_Tr4l0W5LbTs7aTGSuzi5n", "description": "The UID used to uniquely identify a Resource across all ezyVet sites.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Resource was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Resource was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Resource is active and usable in ezyVet.", "disabled": true }, { "key": "associated_type", "value": "user", "description": "The type of the Resource: 'user' or 'facility'.", "disabled": true }, { "key": "associated_id", "value": "5", "description": "The ID number used to uniquely identify a user.", "disabled": true }, { "key": "associated_uid", "value": "user_abc123", "description": "The UID used to uniquely identify a user across all ezyVet sites.", "disabled": true }, { "key": "access", "value": "Member", "description": "The access level of the Resource: None, On Calendar, or Member.", "disabled": true }, { "key": "ownership_uid", "value": "ownershipSeparation_xyz", "description": "The UID of the Ownership Separation.", "disabled": true }, { "key": "ownership_id", "value": "2", "description": "The ID of the Ownership Separation.", "disabled": true } ] }, "description": "Fetches a list containing Resource(s)." } }, { "name": "get-shelteranimalbooking", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/shelteranimalbooking/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "shelteranimalbooking", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Shelter Animal Booking." } ] }, "description": "Fetches a specific Shelter Animal Booking specified by its id." } } ] }, { "name": "Billing and Payments", "item": [ { "name": "get-billingcredit", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/billingcredit", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billingcredit" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a BillingCredit.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the BillingCredit is active and visible in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1609459200", "description": "The epoch time when the BillingCredit was created.", "disabled": true }, { "key": "modified_at", "value": "1609459200", "description": "The epoch time when the BillingCredit was last modified.", "disabled": true }, { "key": "wellness_plan_id", "value": "10", "description": "The ID of the Wellness Plan the BillingCredit is associated with.", "disabled": true }, { "key": "wellness_plan_benefit_id", "value": "5", "description": "The ID of the Wellness Plan Benefit the BillingCredit is associated with.", "disabled": true }, { "key": "wellness_plan_membership_id", "value": "3", "description": "The ID of the Wellness Plan Membership the BillingCredit is associated with.", "disabled": true }, { "key": "wellness_plan_membership_status_period_id", "value": "2", "description": "The ID of the Wellness Plan Membership Status Period the BillingCredit is associated with.", "disabled": true }, { "key": "associated_type", "value": "animal", "description": "The name of the record type the BillingCredit is associated with.", "disabled": true }, { "key": "associated_id", "value": "7", "description": "The ID of the record the BillingCredit is associated with.", "disabled": true } ] }, "description": "Fetches a BillingCredit record from the system." } }, { "name": "get-invoice", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/invoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoice" ], "query": [ { "key": "animal_id", "value": "42", "description": "The ID of the Animal associated with the Invoice.", "disabled": true }, { "key": "id", "value": "9", "description": "The ID number used by the system to uniquely identify an Invoice.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Invoice is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1609459200", "description": "The epoch time when the Invoice was created.", "disabled": true }, { "key": "modified_at", "value": "1609459200", "description": "The epoch time when the Invoice was last modified.", "disabled": true }, { "key": "ownership_id", "value": "1", "description": "The ID of the Ownership Separation to which this Invoice belongs.", "disabled": true }, { "key": "code", "value": "INV-0001", "description": "The auto-generated code of the Invoice.", "disabled": true }, { "key": "contact_id", "value": "5", "description": "The ID of the Contact associated with the Invoice.", "disabled": true }, { "key": "consult_id", "value": "3", "description": "The ID of the Consult associated with the Invoice.", "disabled": true }, { "key": "date", "value": "1609459200", "description": "The epoch time of the Invoice transaction date.", "disabled": true }, { "key": "date_due", "value": "1612137600", "description": "The epoch time of when the Invoice transaction is due for payment.", "disabled": true }, { "key": "limit", "value": "10", "description": "Sets the limit on the number of items returned (range: 1 - 50).", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a paginated list of Invoice records from the system." } }, { "name": "get-invoiceline", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/invoiceline", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoiceline" ], "query": [ { "key": "invoice_id", "value": "9", "description": "The ID of the Invoice for which to retrieve InvoiceLines.", "disabled": false }, { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an InvoiceLine.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the InvoiceLine is active.", "disabled": true }, { "key": "created_at", "value": "1609459200", "description": "The epoch time when the InvoiceLine was created.", "disabled": true }, { "key": "modified_at", "value": "1609459200", "description": "The epoch time when the InvoiceLine was last modified.", "disabled": true }, { "key": "ownership_id", "value": "1", "description": "The ID of the Ownership Separation to which this InvoiceLine belongs.", "disabled": true }, { "key": "location_id", "value": "2", "description": "The ID of the Location Separation to which this InvoiceLine belongs.", "disabled": true }, { "key": "product_id", "value": "15", "description": "The ID of the Product used in the InvoiceLine.", "disabled": true }, { "key": "staff_user_id", "value": "4", "description": "The ID of the staff User associated with the InvoiceLine.", "disabled": true }, { "key": "quantity", "value": "2", "description": "The quantity of the Product in the InvoiceLine.", "disabled": true }, { "key": "status", "value": "Pending", "description": "The status of the InvoiceLine.", "disabled": true }, { "key": "tax_code", "value": "GST", "description": "The tax code for the InvoiceLine.", "disabled": true } ] }, "description": "Fetches a list of InvoiceLine records for a specified Invoice." } }, { "name": "get-payment", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/payment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Payment.", "disabled": true }, { "key": "created_at", "value": "1609459200", "description": "The epoch time when the Payment was created.", "disabled": true }, { "key": "modified_at", "value": "1609459200", "description": "The epoch time when the Payment was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Payment is active and usable in ezyVet.", "disabled": true }, { "key": "ownership_id", "value": "1", "description": "The ID of the ownership Separation.", "disabled": true }, { "key": "amount", "value": "150.00", "description": "The amount of the Payment (total amount paid).", "disabled": true }, { "key": "method", "value": "3", "description": "The PaymentMethod used to make the Payment.", "disabled": true }, { "key": "client_id", "value": "5", "description": "The ID of the Client that made the Payment.", "disabled": true }, { "key": "status", "value": "Accepted", "description": "The status of the Payment.", "disabled": true }, { "key": "limit", "value": "10", "description": "The number of results to return (up to 10).", "disabled": true } ] }, "description": "Fetches a list of Payment records from the system." } }, { "name": "get-paymentmethod", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/paymentmethod", "host": [ "{{baseUrl}}" ], "path": [ "v1", "paymentmethod" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a PaymentMethod.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the PaymentMethod is active and usable in ezyVet.", "disabled": true }, { "key": "name", "value": "Credit Card", "description": "The name of the PaymentMethod.", "disabled": true }, { "key": "type", "value": "Direct", "description": "The type of the PaymentMethod.", "disabled": true } ] }, "description": "Fetches a list containing PaymentMethod(s) (up to 10)." } }, { "name": "get-priceadjustment", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/priceadjustment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "priceadjustment" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Price Adjustment.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Price Adjustment is applied to the associated record.", "disabled": true }, { "key": "type", "value": "Discount", "description": "The type of adjustment (e.g. User, Credit, Rounding, Discount, Surcharge).", "disabled": true }, { "key": "associated_type", "value": "invoiceline", "description": "The type of record that was adjusted.", "disabled": true }, { "key": "associated_id", "value": "10", "description": "The associated_type record's ID.", "disabled": true }, { "key": "wellness_plan_id", "value": "3", "description": "The ID of the related Wellness Plan.", "disabled": true } ] }, "description": "Fetches a list of Price Adjustment records from the system." } }, { "name": "get-estimate", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/estimate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "estimate" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an Estimate.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Estimate is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1609459200", "description": "The epoch time when the Estimate was created.", "disabled": true }, { "key": "modified_at", "value": "1609459200", "description": "The epoch time when the Estimate was last modified.", "disabled": true }, { "key": "animal_id", "value": "42", "description": "The ID of the Animal associated with the Estimate.", "disabled": true }, { "key": "contact_id", "value": "5", "description": "The ID of the Contact associated with the Estimate.", "disabled": true } ] }, "description": "Fetches a list of Estimate records from the system." } }, { "name": "create-invoicev2", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/invoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoice" ] }, "description": "Creates a single Invoice.", "body": { "mode": "raw", "raw": "{\"contact_id\": 5, \"animal_id\": 42, \"ownership_id\": 1, \"line_item\": [], \"consult_id\": 3, \"includes_tax\": true, \"date\": 1609459200, \"date_due\": 1612137600, \"date_approved\": 1609545600}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-invoicev2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/invoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoice" ], "query": [ { "key": "id", "value": "9", "description": "The ID number used by the system to uniquely identify an Invoice.", "disabled": true }, { "key": "created_at", "value": "1609459200", "description": "The epoch time when the Invoice was created.", "disabled": true }, { "key": "modified_at", "value": "1609459200", "description": "The epoch time when the Invoice was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Invoice is active and usable in ezyVet.", "disabled": true }, { "key": "code", "value": "INV-0001", "description": "The auto-generated code of the Invoice.", "disabled": true }, { "key": "animal_id", "value": "42", "description": "The ID of the Animal associated with the Invoice.", "disabled": true }, { "key": "consult_id", "value": "3", "description": "The ID of the Consult associated with the Invoice.", "disabled": true }, { "key": "contact_id", "value": "5", "description": "The ID of the Contact associated with the Invoice.", "disabled": true }, { "key": "date", "value": "1609459200", "description": "The epoch time of the Invoice transaction date.", "disabled": true }, { "key": "date_due", "value": "1612137600", "description": "The epoch time of when the Invoice transaction is due for payment.", "disabled": true } ] }, "description": "Fetches a list containing Invoice(s). (up to 10)" } }, { "name": "delete-invoicev2", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/invoice/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoice", ":id" ], "variable": [ { "key": "id", "value": "9", "description": "The ID number used by the system to uniquely identify an Invoice." } ] }, "description": "Deletes a single Invoice by ID." } }, { "name": "update-invoicev2", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v2/invoice/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoice", ":id" ], "variable": [ { "key": "id", "value": "9", "description": "The ID number used by the system to uniquely identify an Invoice." } ] }, "description": "Update a single Invoice.", "body": { "mode": "raw", "raw": "{\"animal_id\": 42, \"consult_id\": 3, \"contact_id\": 5, \"includes_tax\": true, \"date\": 1609459200, \"date_due\": 1612137600, \"customer_reference_number\": \"REF-001\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-invoicelinev2", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/invoiceline", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoiceline" ] }, "description": "Creates a single InvoiceLine and attaches it to the bottom of the referenced invoice.", "body": { "mode": "raw", "raw": "{\"active\": true, \"name\": \"Consultation Fee\", \"product_id\": 15, \"sales_person\": 4, \"invoice_id\": 9, \"quantity\": 1, \"price\": 100.00, \"price_tax\": 15.00, \"standard_price\": 100.00, \"standard_price_tax\": 15.00, \"tax_code\": \"GST\", \"ownership_id\": 1, \"location_id\": 2, \"status\": \"Pending\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "delete-invoicelinev2", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/invoiceline", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoiceline" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an InvoiceLine.", "disabled": false } ] }, "description": "Deletes a single InvoiceLine by ID." } }, { "name": "get-invoicelinev2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/invoiceline", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoiceline" ], "query": [ { "key": "invoice_id", "value": "9", "description": "The ID of the Invoice for which to retrieve InvoiceLines.", "disabled": false }, { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an InvoiceLine.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the InvoiceLine is active.", "disabled": true }, { "key": "product_id", "value": "15", "description": "The ID of the Product used in the InvoiceLine.", "disabled": true }, { "key": "quantity", "value": "2", "description": "The amount of the Product in the InvoiceLine.", "disabled": true }, { "key": "status", "value": "Pending", "description": "The status of the InvoiceLine.", "disabled": true }, { "key": "tax_code", "value": "GST", "description": "The tax code for the InvoiceLine.", "disabled": true } ] }, "description": "Fetches a list of InvoiceLine records for a specified Invoice (V2)." } }, { "name": "update-invoicelinev2", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v2/invoiceline", "host": [ "{{baseUrl}}" ], "path": [ "v2", "invoiceline" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an InvoiceLine.", "disabled": false } ] }, "description": "Update a single InvoiceLine.", "body": { "mode": "raw", "raw": "{\"id\": \"1\", \"name\": \"Consultation Fee\", \"product_id\": \"15\", \"quantity\": \"2\", \"price\": \"100.00\", \"status\": \"Pending\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-ledgeraccount", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/ledgeraccount/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ledgeraccount", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Ledger Account." } ], "query": [ { "key": "items_page", "value": "1", "description": "The page number for pagination.", "disabled": true }, { "key": "items_page_size", "value": "10", "description": "The number of items per page.", "disabled": true } ] }, "description": "Fetches a single Ledger Account record by its ID." } }, { "name": "get-paymentv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/payment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "payment" ], "query": [ { "key": "amount", "value": "150.00", "description": "The amount of the payment in dollars.", "disabled": true }, { "key": "method", "value": "3", "description": "The ID of the payment method.", "disabled": true }, { "key": "client_contact", "value": "5", "description": "The ID of the contact record.", "disabled": true }, { "key": "status", "value": "Accepted", "description": "The status of the payment.", "disabled": true }, { "key": "ownership_id", "value": "1", "description": "The ID of the separation where the payment was taken.", "disabled": true } ] }, "description": "Fetches a list of Payment records from the system (V2)." } }, { "name": "get-taxrate", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/taxrate", "host": [ "{{baseUrl}}" ], "path": [ "v2", "taxrate" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Tax Rate.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Tax Rate is active and usable in ezyVet.", "disabled": true } ] }, "description": "Fetches a list of Tax Rate records from the system." } }, { "name": "get-transaction", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/transaction", "host": [ "{{baseUrl}}" ], "path": [ "v2", "transaction" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Transaction.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Transaction is active and usable in ezyVet.", "disabled": true }, { "key": "payment_id", "value": "10", "description": "The ID of the associated Payment linked to this Transaction.", "disabled": true }, { "key": "ownership_id", "value": "1", "description": "The ID of the Ownership Separation.", "disabled": true } ] }, "description": "Fetches a list containing Transactions." } } ] }, { "name": "Clinical Management", "item": [ { "name": "get-assessment", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/assessment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assessment" ], "query": [ { "key": "id", "value": "1", "description": "Unique identifier of the Assessment", "disabled": true }, { "key": "active", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "created_at", "value": "1700000000", "description": "Filter by creation epoch time", "disabled": true }, { "key": "modified_at", "value": "1700000000", "description": "Filter by last modified epoch time", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Filter by associated Consult ID", "disabled": true }, { "key": "animal_id", "value": "5", "description": "Filter by associated Animal ID", "disabled": true }, { "key": "vet_id", "value": "3", "description": "Filter by associated Vet/User ID", "disabled": true }, { "key": "timestamp", "value": "1700000000", "description": "Filter by assessment timestamp", "disabled": true }, { "key": "notes", "value": "routine checkup", "description": "Filter by notes content", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results to return", "disabled": true }, { "key": "page", "value": "1", "description": "Page number of results", "disabled": true } ] }, "description": "Each Assessment must be linked to a Consult." } }, { "name": "create-consult", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/consult", "host": [ "{{baseUrl}}" ], "path": [ "v1", "consult" ] }, "description": "Creates a new Consult record linked to an Animal.", "body": { "mode": "raw", "raw": "{\"date\": 1700000000, \"animal_id\": 5, \"vet_id\": 3, \"active\": true, \"ownership_id\": \"1\", \"referring_vet_contact_id\": 10, \"referring_clinic_id\": 2, \"description\": \"Routine checkup\", \"presenting_problem_link_list\": [{\"presenting_problem_id\": \"1\"}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-consult", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/consult", "host": [ "{{baseUrl}}" ], "path": [ "v1", "consult" ], "query": [ { "key": "id", "value": "1", "description": "Filter by Consult ID", "disabled": true }, { "key": "active", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "created_at", "value": "1700000000", "description": "Filter by creation epoch time", "disabled": true }, { "key": "modified_at", "value": "1700000000", "description": "Filter by last modified epoch time", "disabled": true }, { "key": "ownership_id", "value": "1", "description": "Filter by Separation/ownership ID", "disabled": true }, { "key": "date", "value": "1700000000", "description": "Filter by consult date", "disabled": true }, { "key": "animal_id", "value": "5", "description": "Filter by Animal ID", "disabled": true }, { "key": "vet_id", "value": "3", "description": "Filter by Vet/User ID", "disabled": true }, { "key": "description", "value": "checkup", "description": "Filter by description text", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "referring_vet_contact_id", "value": "10", "description": "Filter by referring vet contact ID", "disabled": true }, { "key": "referring_clinic_id", "value": "2", "description": "Filter by referring clinic ID", "disabled": true } ] }, "description": "Returns a paginated list of Consult records." } }, { "name": "delete-consult", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/consult/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "consult", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the consult to delete" } ] }, "description": "Deletes the specified Consult by ID." } }, { "name": "update-consult", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/consult/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "consult", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a Consult" } ], "query": [ { "key": "date", "value": "1700000000", "description": "The Consult date of consultation", "disabled": true }, { "key": "animal_id", "value": "5", "description": "The Consult's associated Animal ID", "disabled": true }, { "key": "vet_id", "value": "3", "description": "The Consult's associated User/Vet ID (case owner)", "disabled": true }, { "key": "active", "value": "1", "description": "If true or 1, the Consult is active", "disabled": true }, { "key": "ownership_id", "value": "1", "description": "The Separation ownership ID for this Consult", "disabled": true }, { "key": "description", "value": "Follow-up visit", "description": "The Consult's general description", "disabled": true } ] }, "description": "Update a single Consult. If presenting_problem_link_list is included, you must provide IDs of PresentingProblems not to be removed.", "body": { "mode": "raw", "raw": "{\"date\": 1700000000, \"vet_id\": 3, \"description\": \"Updated description\", \"active\": 1}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-diagnostic", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/diagnostic", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnostic" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a Diagnostic", "disabled": false } ] }, "description": "Fetches a Diagnostic record by its unique ID." } }, { "name": "create-diagnosticrequest", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/diagnosticrequest", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticrequest" ] }, "description": "Creates a DiagnosticRequest linked to a Consult. Items in diagnostic_list each create a DiagnosticRequestItem.", "body": { "mode": "raw", "raw": "{\"status\": \"pending\", \"vet_id\": 3, \"consult_id\": 10, \"ownership_id\": 1, \"specifics\": \"Routine blood panel\", \"diagnostic_list\": [{\"diagnostic_id\": 5, \"diagnostic_class\": \"biochemistry\"}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "delete-diagnosticrequest", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/diagnosticrequest/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticrequest", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a DiagnosticRequest" } ] }, "description": "Deletes the specified DiagnosticRequest by ID." } }, { "name": "get-diagnosticrequest", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/diagnosticrequest/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticrequest", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a DiagnosticRequest" } ] }, "description": "Fetches a single DiagnosticRequest by its ID." } }, { "name": "update-diagnosticrequest", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/diagnosticrequest/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticrequest", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the DiagnosticRequest to update" } ] }, "description": "Updates an existing DiagnosticRequest by its ID.", "body": { "mode": "raw", "raw": "{\"active\": true, \"vet_id\": 3, \"specifics\": \"Updated specifics\", \"status\": \"completed\", \"diagnostic_list\": [{\"diagnostic_id\": 5, \"diagnostic_class\": \"biochemistry\"}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-diagnosticresult", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/diagnosticresult", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresult" ] }, "description": "Creates a single DiagnosticResult.", "body": { "mode": "raw", "raw": "{\"diagnostic_request_id\": \"5\", \"active\": \"true\", \"consult_id\": \"10\", \"animal_id\": \"3\", \"supplier_id\": \"2\", \"vet_id\": \"4\", \"timestamp\": \"1700000000\", \"specifics\": \"Blood panel results\", \"outcome\": \"All values within normal range\", \"external_link\": \"https://lab.example.com/result/123\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-diagnosticresult", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/diagnosticresult", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresult" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a DiagnosticResult", "disabled": true }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Filter by associated Consult ID", "disabled": true }, { "key": "animal_id", "value": "3", "description": "Filter by Animal ID", "disabled": true }, { "key": "supplier_id", "value": "2", "description": "Filter by supplier Contact ID", "disabled": true }, { "key": "vet_id", "value": "4", "description": "Filter by Vet/User ID", "disabled": true }, { "key": "diagnostic_request_id", "value": "5", "description": "Filter by linked DiagnosticRequest ID", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page (range: 1-50)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number of the result", "disabled": true } ] }, "description": "Fetches a list containing DiagnosticResults (up to 10)." } }, { "name": "delete-diagnosticresult", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/diagnosticresult/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresult", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the DiagnosticResult to delete" } ] }, "description": "Deletes a DiagnosticResult with the specified ID." } }, { "name": "update-diagnosticresult", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/diagnosticresult/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresult", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the DiagnosticResult to update" } ], "query": [ { "key": "active", "value": "true", "description": "If true, the DiagnosticResult is active", "disabled": true }, { "key": "consult_id", "value": "10", "description": "ID of the Consult the DiagnosticResult is attached to", "disabled": true }, { "key": "animal_id", "value": "3", "description": "ID of the Animal", "disabled": true }, { "key": "specifics", "value": "Updated notes", "description": "Specifics/notes about the DiagnosticResult", "disabled": true }, { "key": "outcome", "value": "All normal", "description": "Notes about the result (supports markdown)", "disabled": true }, { "key": "external_link", "value": "https://lab.example.com/result/123", "description": "External link for additional data", "disabled": true } ] }, "description": "Updates an existing DiagnosticResult by its ID.", "body": { "mode": "raw", "raw": "{\"specifics\": \"Updated specifics\", \"external_link\": \"https://lab.example.com/result/123\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-diagnosticresultitem", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/diagnosticresultitem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresultitem" ], "query": [ { "key": "timestamp", "value": "1700000000", "description": "Date when the particular item was finished", "disabled": true }, { "key": "diagnostic_result_id", "value": "5", "description": "ID of the DiagnosticResult this item belongs to", "disabled": true }, { "key": "name", "value": "WBC", "description": "Name of the DiagnosticResultItem", "disabled": true }, { "key": "value", "value": "7.5", "description": "Resulting value of the DiagnosticResultItem", "disabled": true }, { "key": "unit", "value": "10^3/uL", "description": "Unit of measurement", "disabled": true }, { "key": "range_low", "value": "4.5", "description": "Low threshold value", "disabled": true }, { "key": "range_high", "value": "11.0", "description": "High threshold value", "disabled": true }, { "key": "qualifier", "value": "Normal", "description": "Qualifier of the DiagnosticResultItem", "disabled": true }, { "key": "notes", "value": "Within range", "description": "Notes about the DiagnosticResultItem", "disabled": true } ] }, "description": "Each DiagnosticResultItem must be linked to a DiagnosticResult. Requires either a name or a value.", "body": { "mode": "raw", "raw": "{\"name\": \"WBC\", \"value\": \"7.5\", \"range_low\": \"4.5\", \"range_high\": \"11.0\", \"unit\": \"10^3/uL\", \"diagnostic_result_id\": \"5\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-diagnosticresultitem", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/diagnosticresultitem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresultitem" ], "query": [ { "key": "diagnostic_result_id", "value": "5", "description": "ID of the parent DiagnosticResult", "disabled": false }, { "key": "id", "value": "1", "description": "Filter by DiagnosticResultItem ID", "disabled": true }, { "key": "active", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "name", "value": "WBC", "description": "Filter by item name", "disabled": true }, { "key": "value", "value": "7.5", "description": "Filter by item value", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true } ] }, "description": "Fetches a list of DiagnosticResultItems for a DiagnosticResult." } }, { "name": "get-eventgroup", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/eventgroup", "host": [ "{{baseUrl}}" ], "path": [ "v2", "eventgroup" ], "query": [ { "key": "id", "value": "1", "description": "Filter by event group ID", "disabled": true }, { "key": "uid", "value": "uid_abc123", "description": "Filter by event group UID", "disabled": true }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "created_at", "value": "1700000000", "description": "Filter by creation epoch time", "disabled": true }, { "key": "modified_at", "value": "1700000000", "description": "Filter by last modified epoch time", "disabled": true }, { "key": "socOnly", "value": "true", "description": "Filter to only standard of care event groups", "disabled": true } ] }, "description": "Returns a list of event groups." } }, { "name": "create-healthstatus", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "url": { "raw": "{{baseUrl}}/v1/healthstatus", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthstatus" ], "query": [ { "key": "consult_id", "value": "10", "description": "ID of the Consult the HealthStatus is attached to", "disabled": false }, { "key": "animal_id", "value": "3", "description": "ID of the Animal", "disabled": false } ] }, "description": "Creates a HealthStatus record linked to a Consult and Animal.", "body": { "mode": "raw", "raw": "consult_id=10&animal_id=3&active=1&weight=25.5&weight_unit=kg&temperature=38.5&heart_rate=80&respiratory_rate=20&bcs=5&max_bcs=9&crt=1-2+sec&mm=Pink&attitude=BAR¬es=Animal+appears+healthy", "options": { "raw": { "language": "text" } } } } }, { "name": "get-healthstatus", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/healthstatus", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthstatus" ], "query": [ { "key": "animal_id", "value": "3", "description": "The ID number used to uniquely identify an Animal", "disabled": false } ] }, "description": "Fetches a list of HealthStatus records for an Animal." } }, { "name": "update-healthstatus", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/healthstatus", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthstatus" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a HealthStatus", "disabled": false }, { "key": "consult_id", "value": "10", "description": "ID of the Consult the HealthStatus is attached to", "disabled": false }, { "key": "animal_id", "value": "3", "description": "ID of the Animal", "disabled": false } ] }, "description": "Updates a HealthStatus record for an Animal linked to a Consult.", "body": { "mode": "raw", "raw": "{\"active\": 1, \"notes\": \"Animal appears healthy\", \"weight\": 25.5, \"weight_unit\": \"kg\", \"temperature\": 38.5, \"heart_rate\": 80, \"respiratory_rate\": 20, \"bcs\": 5, \"max_bcs\": 9, \"crt\": \"1-2 sec\", \"mm\": \"Pink\", \"attitude\": \"BAR\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "delete-healthstatus", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/healthstatus/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "healthstatus", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the HealthStatus to delete" } ] }, "description": "Deletes the specified HealthStatus by ID." } }, { "name": "get-history", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "history" ], "query": [ { "key": "limit", "value": "10", "description": "Number of results to return", "disabled": true }, { "key": "id", "value": "1", "description": "Filter by History ID", "disabled": true }, { "key": "active", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Filter by Consult ID", "disabled": true }, { "key": "animal_id", "value": "3", "description": "Filter by Animal ID", "disabled": true }, { "key": "vet_id", "value": "4", "description": "Filter by Vet/User ID", "disabled": true } ] }, "description": "Fetches a list containing History items (up to 10)." } }, { "name": "get-integrated-diagnostic", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/integrateddiagnostic", "host": [ "{{baseUrl}}" ], "path": [ "v1", "integrateddiagnostic" ], "query": [ { "key": "code", "value": "IDEXX_CBC", "description": "A code assigned to the IntegratedDiagnostic (subject to change)", "disabled": true } ] }, "description": "Fetches a list of IntegratedDiagnostic records." } }, { "name": "get-operation", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/operation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "operation" ], "query": [ { "key": "animal_id", "value": "3", "description": "The ID number used to uniquely identify an Animal", "disabled": false }, { "key": "id", "value": "1", "description": "Filter by Operation ID", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Filter by Consult ID the Operation is attached to", "disabled": true }, { "key": "vet_id", "value": "4", "description": "Filter by Vet/User ID linked to the Operation", "disabled": true }, { "key": "timestamp", "value": "1700000000", "description": "Filter by operation date", "disabled": true }, { "key": "specifics", "value": "spay procedure", "description": "Filter by specifics/notes", "disabled": true }, { "key": "outcome", "value": "successful", "description": "Filter by outcome notes", "disabled": true } ] }, "description": "Fetches a list of Operation records for an Animal." } }, { "name": "create-physicalexam", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/physicalexam", "host": [ "{{baseUrl}}" ], "path": [ "v1", "physicalexam" ] }, "description": "Creates a new PhysicalExam record linked to a Consult and Animal.", "body": { "mode": "raw", "raw": "{\"consult_id\": \"10\", \"animal_id\": \"3\", \"vet_id\": \"4\", \"ownership_id\": \"1\", \"body_system\": \"0\", \"comments\": \"Cardiovascular system normal\", \"timestamp\": \"1700000000\", \"historical_record_id\": \"0\", \"active\": 1}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-physicalexam", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/physicalexam", "host": [ "{{baseUrl}}" ], "path": [ "v1", "physicalexam" ], "query": [ { "key": "id", "value": "1", "description": "Filter by PhysicalExam ID", "disabled": true }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Filter by Consult ID the PhysicalExam is attached to", "disabled": true }, { "key": "animal_id", "value": "3", "description": "Filter by Animal ID", "disabled": true }, { "key": "body_system", "value": "2", "description": "Filter by BodySystem ID", "disabled": true }, { "key": "comments", "value": "normal", "description": "Filter by comments", "disabled": true }, { "key": "vet_id", "value": "4", "description": "Filter by Vet/User ID", "disabled": true } ] }, "description": "Fetches a list containing PhysicalExam records (up to 10)." } }, { "name": "update-physicalexam", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/physicalexam/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "physicalexam", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a PhysicalExam" } ] }, "description": "Updates an existing PhysicalExam by its ID.", "body": { "mode": "raw", "raw": "{\"consult_id\": \"10\", \"animal_id\": \"3\", \"vet_id\": \"4\", \"body_system\": \"2\", \"comments\": \"Updated exam notes\", \"timestamp\": \"1700000000\", \"active\": 1}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-plan", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/plan", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan" ], "query": [ { "key": "id", "value": "1", "description": "Filter by Plan ID", "disabled": true }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Filter by Consult ID the Plan is attached to", "disabled": true }, { "key": "animal_id", "value": "3", "description": "Filter by Animal ID", "disabled": true }, { "key": "vet_id", "value": "4", "description": "Filter by Vet/User ID linked to the Plan", "disabled": true }, { "key": "notes", "value": "follow-up in 2 weeks", "description": "Filter by plan notes", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true } ] }, "description": "Each Plan must be linked to a Consult." } }, { "name": "get-presentingproblem", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/presentingproblem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "presentingproblem" ], "query": [ { "key": "id", "value": "1", "description": "Filter by PresentingProblem ID", "disabled": true }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": true }, { "key": "name", "value": "Limping", "description": "Filter by name of the PresentingProblem", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page (range: 1-50)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true } ] }, "description": "Fetches a list containing PresentingProblem records." } }, { "name": "get-presentingproblemlink", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/presentingproblemlink", "host": [ "{{baseUrl}}" ], "path": [ "v1", "presentingproblemlink" ], "query": [ { "key": "consult_id", "value": "10", "description": "Filter by Consult ID (required)", "disabled": false }, { "key": "id", "value": "1", "description": "Filter by PresentingProblemLink ID", "disabled": true }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": true }, { "key": "presenting_problem_id", "value": "3", "description": "Filter by PresentingProblem ID", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true } ] }, "description": "Fetch all PresentingProblemLinks for a given Consult (up to 10)." } }, { "name": "get-standardofcare", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/standardofcare", "host": [ "{{baseUrl}}" ], "path": [ "v2", "standardofcare" ], "query": [ { "key": "limit", "value": "5000", "description": "Number of items per page. Min: 1, Max: 5000", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "modified_at", "value": "1700000000", "description": "Filter by last modified epoch time", "disabled": true } ] }, "description": "Gets standard of care events." } }, { "name": "create-vaccination", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v1/vaccination", "host": [ "{{baseUrl}}" ], "path": [ "v1", "vaccination" ], "query": [ { "key": "vet_id", "value": "4", "description": "The ID of the Vet who performed the vaccination", "disabled": false }, { "key": "animal_id", "value": "3", "description": "The ID of the Animal the vaccination is assigned to", "disabled": false }, { "key": "product_id", "value": "5", "description": "The ID of the vaccine Product used", "disabled": false }, { "key": "consult_id", "value": "10", "description": "The ID of the Consult related to the Vaccination", "disabled": true }, { "key": "qty", "value": "1", "description": "Amount of product units administered", "disabled": true }, { "key": "description", "value": "Annual rabies vaccine", "description": "Description for the Vaccination", "disabled": true }, { "key": "date_of_administration", "value": "1700000000", "description": "Date the Vaccination was administered", "disabled": true }, { "key": "date_of_next_administration", "value": "1731536000", "description": "Date of next Vaccination administration", "disabled": true } ] }, "description": "Creates a new Vaccination record for an Animal." } }, { "name": "get-vaccination", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/vaccination", "host": [ "{{baseUrl}}" ], "path": [ "v1", "vaccination" ], "query": [ { "key": "id", "value": "1", "description": "Filter by Vaccination ID", "disabled": true }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": true }, { "key": "consult_id", "value": "10", "description": "Filter by Consult ID related to the Vaccination", "disabled": true }, { "key": "product_id", "value": "5", "description": "Filter by vaccine Product ID", "disabled": true }, { "key": "date_of_administration", "value": "1700000000", "description": "Filter by administration epoch date", "disabled": true }, { "key": "limit", "value": "10", "description": "Number of results per page", "disabled": true }, { "key": "page", "value": "1", "description": "Page number", "disabled": true } ] }, "description": "Fetches a paginated list of Vaccination records." } }, { "name": "update-vaccination", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/vaccination/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "vaccination", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the vaccination to update" } ], "query": [ { "key": "vet_id", "value": "4", "description": "The ID of the Vet", "disabled": true }, { "key": "animal_id", "value": "3", "description": "The ID of the Animal", "disabled": true }, { "key": "product_id", "value": "5", "description": "The ID of the vaccine Product", "disabled": true }, { "key": "date_of_administration", "value": "1700000000", "description": "Date the Vaccination was administered", "disabled": true }, { "key": "date_of_next_administration", "value": "1731536000", "description": "Date of next Vaccination", "disabled": true } ] }, "description": "Updates an existing Vaccination record by its ID.", "body": { "mode": "raw", "raw": "{\"vaccination\": {\"notes\": \"Updated notes for this vaccination\"}}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Contact Management", "item": [ { "name": "create-address", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/address", "host": [ "{{baseUrl}}" ], "path": [ "v1", "address" ] }, "description": "Creates a single Address record, optionally linked to a Contact via for_resource.", "body": { "mode": "raw", "raw": "{\"name\": \"Home\", \"street_1\": \"123 Main St\", \"suburb\": \"Westbrook\", \"city\": \"Portland\", \"region\": \"Northeast\", \"post_code\": \"04092\", \"country_id\": \"153\", \"state\": \"Maine\", \"longitude\": \"-70.3\", \"latitude\": \"43.6\", \"for_resource\": {\"Contact\": {\"id\": \"1\"}}}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-address", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/address", "host": [ "{{baseUrl}}" ], "path": [ "v1", "address" ], "query": [ { "key": "id", "value": "1", "description": "The ID of the address.", "disabled": true }, { "key": "active", "value": "1", "description": "Filter by active status.", "disabled": true }, { "key": "name", "value": "Home", "description": "Filter by address name.", "disabled": true }, { "key": "street_1", "value": "123 Main St", "description": "Filter by first street line.", "disabled": true }, { "key": "city", "value": "Portland", "description": "Filter by city.", "disabled": true }, { "key": "state", "value": "Maine", "description": "Filter by state.", "disabled": true }, { "key": "country_id", "value": "153", "description": "Filter by country ID.", "disabled": true } ] }, "description": "Fetches a list of Address records." } }, { "name": "delete-address", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/address/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "address", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the address to delete." } ] }, "description": "Deletes an Address record by ID." } }, { "name": "update-address", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/address/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "address", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the address to update." } ], "query": [ { "key": "name", "value": "Work", "description": "The Address name.", "disabled": true }, { "key": "street_1", "value": "456 Elm St", "description": "First street line.", "disabled": true }, { "key": "city", "value": "Portland", "description": "City.", "disabled": true }, { "key": "state", "value": "Maine", "description": "State, where applicable.", "disabled": true }, { "key": "country_id", "value": "153", "description": "Country ID.", "disabled": true } ] }, "description": "Updates the fields of an existing Address record by ID.", "body": { "mode": "raw", "raw": "{\"name\": \"Work\", \"street_1\": \"456 Elm St\", \"city\": \"Portland\", \"state\": \"Maine\", \"post_code\": \"04092\", \"country_id\": \"153\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-contact", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contact", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact" ] }, "description": "Creates a single Contact record. Requires first_name, last_name, and contact_detail_list.", "body": { "mode": "raw", "raw": "{\"first_name\": \"John\", \"last_name\": \"Smith\", \"is_customer\": true, \"is_business\": false, \"stop_credit\": \"OK\", \"date_of_birth\": 0, \"contact_detail_list\": [{\"name\": \"Home Phone\", \"value\": \"5551234567\", \"contact_detail_type_id\": \"1\", \"preferred\": 1}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-contact", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/contact", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a Contact.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Contact is active and usable in ezyVet.", "disabled": true }, { "key": "first_name", "value": "John", "description": "The Contact's first name.", "disabled": true }, { "key": "last_name", "value": "Smith", "description": "The Contact's last/family name.", "disabled": true }, { "key": "is_customer", "value": "1", "description": "If true, the Contact is a customer.", "disabled": true }, { "key": "is_vet", "value": "0", "description": "If true, the Contact is a vet.", "disabled": true }, { "key": "stop_credit", "value": "OK", "description": "Specifies if the Contact can be invoiced: OK, WARNING, or STOP.", "disabled": true }, { "key": "limit", "value": "10", "description": "Sets the limit on the number of items returned (range: 1-50).", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a paginated list of Contact records." } }, { "name": "delete-contact", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/contact/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the contact to delete." } ] }, "description": "Deletes a Contact record by ID." } }, { "name": "update-contact", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/contact/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contact", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the contact to update." } ] }, "description": "Update a single Contact record by ID.", "body": { "mode": "raw", "raw": "{\"last_name\": \"Johnson\", \"stop_credit\": \"OK\", \"is_no_electronic_marketing\": \"0\", \"contact_detail_list\": [{\"name\": \"Home Email\", \"value\": \"john@example.com\", \"contact_detail_type_id\": \"2\"}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-contactassociation", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/contactassociation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contactassociation" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a ContactAssociation.", "disabled": true }, { "key": "contact_id", "value": "61", "description": "The Contact to fetch the associated contact IDs for.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the ContactAssociation is active.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a list of ContactAssociation records." } }, { "name": "create-contactdetail", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/contactdetail", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contactdetail" ] }, "description": "Creates a single ContactDetail record.", "body": { "mode": "raw", "raw": "{\"name\": \"Home Phone\", \"value\": \"5551234567\", \"contact_id\": \"1\", \"contact_detail_type_id\": \"1\", \"preferred\": false, \"subscription_groups\": [\"General\", \"Reminders\"]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-contactdetail", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/contactdetail", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contactdetail" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a ContactDetail.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the ContactDetail is active.", "disabled": true }, { "key": "name", "value": "Home Phone", "description": "The name of the ContactDetail.", "disabled": true }, { "key": "value", "value": "5551234567", "description": "The value of the ContactDetail.", "disabled": true }, { "key": "contact_id", "value": "1", "description": "The ID of the Contact to whom this ContactDetail is assigned.", "disabled": true }, { "key": "contact_detail_type_id", "value": "1", "description": "The ID of the ContactDetailType.", "disabled": true }, { "key": "preferred", "value": "false", "description": "If true, this is a preferred contact method.", "disabled": true } ] }, "description": "Fetches a list of ContactDetail records (up to 10)." } }, { "name": "update-contactdetail", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/contactdetail/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contactdetail", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the ContactDetail to update." } ], "query": [ { "key": "active", "value": "true", "description": "If true, the ContactDetail is active.", "disabled": true }, { "key": "name", "value": "Home Phone", "description": "The name of the ContactDetail.", "disabled": true }, { "key": "value", "value": "5559876543", "description": "The value of the ContactDetail.", "disabled": true }, { "key": "preferred", "value": "true", "description": "If true, this is a preferred contact method.", "disabled": true } ] }, "description": "Updates an existing ContactDetail record by ID.", "body": { "mode": "raw", "raw": "{\"active\": true, \"name\": \"Home Phone\", \"value\": \"5559876543\", \"contact_id\": \"1\", \"contact_detail_type_id\": \"1\", \"subscription_groups\": [\"General\"]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-contactdetailtype", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/contactdetailtype", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contactdetailtype" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a ContactDetailType.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the ContactDetailType is active.", "disabled": true }, { "key": "name", "value": "Home Phone", "description": "The name of the ContactDetailType.", "disabled": true } ] }, "description": "Fetches a list of ContactDetailType records (up to 10)." } }, { "name": "get-country", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/country", "host": [ "{{baseUrl}}" ], "path": [ "v1", "country" ], "query": [ { "key": "id", "value": "153", "description": "The ID number used to uniquely identify a Country.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Country is active.", "disabled": true }, { "key": "name", "value": "United States", "description": "The name of the Country.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a list of Country records (up to 10)." } }, { "name": "create-communication", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/communication", "host": [ "{{baseUrl}}" ], "path": [ "v2", "communication" ] }, "description": "Creates a single Communication.", "body": { "mode": "raw", "raw": "{\"active\": true, \"associated_type\": \"Contact\", \"associated_id\": 1, \"contact_detail_type_id\": 3, \"destination\": \"demo@demo.com\", \"direction\": \"Outgoing\", \"user_resource\": {}, \"content\": \"Hello, this is a test message.\", \"content_format\": \"PlainText\", \"status\": \"Done\", \"subject\": \"Test Subject\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-communication", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/communication", "host": [ "{{baseUrl}}" ], "path": [ "v2", "communication" ], "query": [ { "key": "uid", "value": "communication_BPSHlXlBrdLKxqyVtEtcz", "description": "The unique identifier of the communication.", "disabled": true }, { "key": "associated_type", "value": "Contact", "description": "The record type the Communication is directed at.", "disabled": true }, { "key": "associated_id", "value": "1", "description": "The ID of the record the Communication is directed at.", "disabled": true }, { "key": "content_format", "value": "PlainText", "description": "The format of the content: SMS, PlainText, or HTML.", "disabled": true }, { "key": "status", "value": "Done", "description": "The status of the Communication.", "disabled": true }, { "key": "communicating_type", "value": "Consult", "description": "The record type the Communication is communicating.", "disabled": true }, { "key": "communicating_id", "value": "2", "description": "The ID of the record the Communication is communicating.", "disabled": true } ] }, "description": "Fetches a list of Communication records." } }, { "name": "delete-communication", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/communication/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "communication", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the communication to delete." } ] }, "description": "Deletes a Communication record by ID." } }, { "name": "update-communication", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/communication/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "communication", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the communication to update." } ] }, "description": "Updates a Communication record by ID.", "body": { "mode": "raw", "raw": "{\"associated_type\": \"Contact\", \"associated_id\": 1, \"destination\": \"demo@demo.com\", \"content\": \"Updated message content.\", \"content_format\": \"PlainText\", \"status\": \"Done\", \"subject\": \"Updated Subject\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-contactv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/contact", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a Contact.", "disabled": true }, { "key": "uid", "value": "contact_HfoQJT3F4pk4DPGPn131C", "description": "The globally unique identifier to identify a Contact.", "disabled": true }, { "key": "first_name", "value": "John", "description": "The Contact's first name.", "disabled": true }, { "key": "last_name", "value": "Smith", "description": "The Contact's last/family name.", "disabled": true }, { "key": "is_customer", "value": "1", "description": "If true, the Contact is a customer.", "disabled": true }, { "key": "stop_credit", "value": "OK", "description": "Specifies if the Contact can be invoiced: OK, WARNING, or STOP.", "disabled": true } ] }, "description": "Updated version of contact retrieval." } }, { "name": "create-contactdetailv2", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/contactdetail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactdetail" ] }, "description": "Updated version of ContactDetail creation.", "body": { "mode": "raw", "raw": "{\"name\": \"Home Phone\", \"value\": \"5551234567\", \"contact_id\": 1, \"contact_uid\": \"contact_HfoQJT3F4pk4DPGPn131C\", \"type_id\": \"1\", \"preferred\": false}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-contactdetailv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/contactdetail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactdetail" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used to uniquely identify a ContactDetail.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the ContactDetail is active.", "disabled": true }, { "key": "name", "value": "Home Phone", "description": "The name of the ContactDetail.", "disabled": true }, { "key": "value", "value": "5551234567", "description": "The value of the ContactDetail.", "disabled": true }, { "key": "contact_id", "value": "1", "description": "The ID of the Contact to whom this ContactDetail is assigned.", "disabled": true }, { "key": "type_id", "value": "1", "description": "The ID of the ContactDetailType.", "disabled": true } ] }, "description": "Updated version of ContactDetail list retrieval." } }, { "name": "create-sent-communication", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v4/communication/sentCommunication", "host": [ "{{baseUrl}}" ], "path": [ "v4", "communication", "sentCommunication" ] }, "description": "Accepts an array of communication records that have already been sent. Max 500 items.", "body": { "mode": "raw", "raw": "[{\"associatedType\": \"Contact\", \"associatedId\": \"contact_HfoQJT3F4pk4DPGPn131C\", \"communicationType\": \"Email\", \"destination\": \"demo@demo.com\", \"direction\": \"Outgoing\", \"content\": \"Wellness Exam Reminder\", \"contentFormat\": \"PlainText\", \"subject\": \"Wellness Exam Reminder\", \"userId\": \"user_B4vrE744DdwUXqFxHntAY\", \"communicationTimestamp\": \"2024-01-15T14:30:00Z\"}]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Inventory Management", "item": [ { "name": "get-barcodes", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/barcode", "host": [ "{{baseUrl}}" ], "path": [ "v1", "barcode" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Barcode.", "disabled": true }, { "key": "for_type", "value": "product", "description": "The type of record that the Barcode is for. EG: 'product'.", "disabled": true }, { "key": "for_id", "value": "42", "description": "The ID of the record that the Barcode is for.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Barcode is active and usable in ezyVet.", "disabled": true }, { "key": "format", "value": "EAN-13", "description": "The format or standard of the system used Barcode. EG: 'EAN-13', or 'CODE128'.", "disabled": true }, { "key": "barcode", "value": "0123456789012", "description": "The text content for the Barcode.", "disabled": true } ] }, "description": "Fetches a list containing Barcodes (up to 10)." } }, { "name": "get-product", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/product", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Product.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Product is active and usable in ezyVet.", "disabled": true }, { "key": "name", "value": "Amoxicillin", "description": "Name of the Product as it is visible on ezyVet.", "disabled": true }, { "key": "product_group_id", "value": "5", "description": "The ID of the ProductGroup where the Product is assigned.", "disabled": true }, { "key": "type", "value": "Medication", "description": "Specifies the Product type.", "disabled": true }, { "key": "is_sold", "value": "1", "description": "If true, the Product can be sold.", "disabled": true }, { "key": "is_purchased", "value": "1", "description": "If true, the Product can be bought.", "disabled": true }, { "key": "product_identifier", "value": "00069153041", "description": "For the US, this is the 11 digit NDC or product ID for compounds.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of results returned.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a list containing Products (up to 10)." } }, { "name": "get-productgroup", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/productgroup", "host": [ "{{baseUrl}}" ], "path": [ "v1", "productgroup" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a ProductGroup.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the ProductGroup is active and usable in ezyVet.", "disabled": true }, { "key": "name", "value": "Medications", "description": "The name of the ProductGroup.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a list containing ProductGroups (up to 10)." } }, { "name": "get-purchaseorder", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/purchaseorder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "purchaseorder" ], "query": [ { "key": "client_id", "value": "10", "description": "The ID of the client linked to the PurchaseOrder.", "disabled": false }, { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a PurchaseOrder.", "disabled": true }, { "key": "supplier_id", "value": "7", "description": "The ID of the supplier to whom the order is sent.", "disabled": true }, { "key": "status", "value": "Created", "description": "The status of the PurchaseOrder.", "disabled": true }, { "key": "ownership_id", "value": "2", "description": "The ID of the Ownership Separation.", "disabled": true } ] }, "description": "Fetches a list containing PurchaseOrders (up to 10)." } }, { "name": "get-purchaseorderitem", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/purchaseorderitem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "purchaseorderitem" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a PurchaseOrderItem.", "disabled": true }, { "key": "purchase_order_id", "value": "5", "description": "The ID of the PurchaseOrder to which this PurchaseOrderItem is linked.", "disabled": true }, { "key": "product_id", "value": "12", "description": "The ID of the product on the PurchaseOrderItem.", "disabled": true }, { "key": "quantity", "value": "120", "description": "The number of units being ordered.", "disabled": true }, { "key": "ownership_id", "value": "2", "description": "The ID of the Ownership Separation.", "disabled": true } ] }, "description": "Fetches a list of PurchaseOrderItems (up to 10)." } }, { "name": "create-receiveinvoice", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "url": { "raw": "{{baseUrl}}/v1/receiveinvoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoice" ], "query": [ { "key": "confirm_invoice_number", "value": "1", "description": "If this contains the value 1, then the validation for duplicate invoice_number will be skipped.", "disabled": true } ] }, "description": "Creates a ReceiveInvoice. It is recommended to use v2/receiveinvoice.", "body": { "mode": "raw", "raw": "invoice_number=INV-001&date=1695766710&due_date=1698358710&freight=15.00&freight_tax=1.50&comments=Urgent+delivery&ownership_id=2", "options": { "raw": { "language": "text" } } } } }, { "name": "get-receiveinvoice", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/receiveinvoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoice" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a ReceiveInvoice.", "disabled": true }, { "key": "invoice_number", "value": "INV-001", "description": "The value given by a Supplier to track the invoice on their end.", "disabled": true }, { "key": "supplier_id", "value": "7", "description": "The ID of the Supplier who sent the ReceiveInvoice.", "disabled": true }, { "key": "ownership_id", "value": "2", "description": "The ID of the Ownership Separation.", "disabled": true } ] }, "description": "Gets a ReceiveInvoice and any included ReceiveInvoiceItems. It is recommended to use v2/receiveinvoice." } }, { "name": "delete-receiveinvoice", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/receiveinvoice/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoice", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the ReceiveInvoice to delete." } ] }, "description": "Deletes a ReceiveInvoice by ID." } }, { "name": "update-receiveinvoice", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/receiveinvoice/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoice", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a ReceiveInvoice." } ], "query": [ { "key": "confirm_invoice_number", "value": "1", "description": "If this contains the value 1, the validation for duplicate invoice_number will be skipped.", "disabled": true } ] }, "description": "Updates a ReceiveInvoice.", "body": { "mode": "raw", "raw": "{\"invoice_number\": \"INV-001\", \"date\": \"1695766710\", \"due_date\": \"1698358710\", \"freight\": \"15.00\", \"freight_tax\": \"1.50\", \"comments\": \"Updated comment\", \"ownership_id\": \"2\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-receiveinvoiceitem", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "url": { "raw": "{{baseUrl}}/v1/receiveinvoiceitem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoiceitem" ], "query": [ { "key": "active", "value": "1", "description": "If true, the ReceiveInvoiceItem is active and usable in ezyVet.", "disabled": true }, { "key": "receive_invoice_id", "value": "5", "description": "The ID of the ReceiveInvoice the ReceiveInvoiceItem is to be linked to.", "disabled": false }, { "key": "quantity", "value": "10", "description": "The quantity of product invoiced.", "disabled": false }, { "key": "price", "value": "5.00", "description": "The price of one selling unit.", "disabled": false }, { "key": "tax", "value": "0.50", "description": "The tax content per selling unit.", "disabled": false }, { "key": "supplier_code", "value": "SUP-001", "description": "The code of the product in the supplier's records.", "disabled": false }, { "key": "ownership_id", "value": "2", "description": "The ID of the Ownership Separation.", "disabled": true } ] }, "description": "Creates a ReceiveInvoiceItem. All ReceiveInvoiceItems must be linked to a ReceiveInvoice.", "body": { "mode": "raw", "raw": "receive_invoice_id=5&quantity=10&price=5.00&tax=0.50&supplier_code=SUP-001&ownership_id=2", "options": { "raw": { "language": "text" } } } } }, { "name": "get-receiveinvoiceitem", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/receiveinvoiceitem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoiceitem" ], "query": [ { "key": "product_id", "value": "12", "description": "The product ID used by the system to uniquely identify a ReceiveInvoiceItem.", "disabled": true } ] }, "description": "Fetches a list containing ReceiveInvoiceItems (up to 10)." } }, { "name": "update-receiveinvoiceitem", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/receiveinvoiceitem/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoiceitem", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a ReceiveInvoiceItem." } ] }, "description": "Updates a ReceiveInvoiceItem.", "body": { "mode": "raw", "raw": "{\"active\": \"1\", \"receive_invoice_id\": \"5\", \"quantity\": \"10\", \"price\": \"5.00\", \"tax\": \"0.50\", \"product_id\": \"12\", \"comments\": \"Updated\", \"ownership_id\": \"2\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "delete-receiveinvoiceitem", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/receiveinvoiceitem/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "receiveinvoiceitem", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the ReceiveInvoiceItem to delete." } ] }, "description": "Deletes a ReceiveInvoiceItem." } }, { "name": "create-batch", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "url": { "raw": "{{baseUrl}}/v2/batch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "batch" ] }, "description": "Creates a Batch used to track a batch of products.", "body": { "mode": "raw", "raw": "name=Batch-2024-01&type=standard&product_id=12", "options": { "raw": { "language": "text" } } } } }, { "name": "get-batch", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/batch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "batch" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Batch.", "disabled": true }, { "key": "uid", "value": "batch_abc123", "description": "The UID used by the system to uniquely identify a Batch across all ezyVet instances.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Batch is active and usable in ezyVet.", "disabled": true }, { "key": "name", "value": "Batch-2024-01", "description": "The name given for a Batch.", "disabled": true }, { "key": "type", "value": "standard", "description": "The type of Batch.", "disabled": true } ] }, "description": "Fetches a list containing Batches (up to 10)." } }, { "name": "get-productminimumstock", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/productminimumstock", "host": [ "{{baseUrl}}" ], "path": [ "v2", "productminimumstock" ], "query": [ { "key": "product_id", "value": "12", "description": "The ID of the Product this ProductMinimumStock relates to.", "disabled": true } ] }, "description": "Fetches a list containing ProductMinimumStocks." } }, { "name": "create-productpricing", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/productpricing", "host": [ "{{baseUrl}}" ], "path": [ "v2", "productpricing" ] }, "description": "Creates a new Product Pricing for the provided Product and Ownership Separation.", "body": { "mode": "raw", "raw": "{\"product_id\": 12, \"ownership_id\": 2, \"based_on\": \"Markup\", \"tax_rate\": 0.10, \"cost_price\": 5.00, \"sell_price\": 7.50}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-productpricing", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/productpricing", "host": [ "{{baseUrl}}" ], "path": [ "v2", "productpricing" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Product Pricing.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Product Pricing is active and usable in ezyVet.", "disabled": true }, { "key": "product_id", "value": "12", "description": "The ID of the Product this Product Pricing relates to.", "disabled": true } ] }, "description": "Fetches a list of Product Pricing records." } }, { "name": "delete-productpricing", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/productpricing/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "productpricing", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Product Pricing." } ] }, "description": "Deletes a Product Pricing record by ID." } }, { "name": "update-productpricing", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/productpricing/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "productpricing", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Product Pricing." } ], "query": [ { "key": "active", "value": "1", "description": "If true, the Product Pricing is active.", "disabled": true }, { "key": "sell_price", "value": "7.50", "description": "The sell price of the product.", "disabled": true }, { "key": "cost_price", "value": "5.00", "description": "The cost price of the product.", "disabled": true } ] }, "description": "Updates an existing Product Pricing record.", "body": { "mode": "raw", "raw": "{\"sell_price\": 8.00}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-productsupplier", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/productsupplier", "host": [ "{{baseUrl}}" ], "path": [ "v2", "productsupplier" ], "query": [ { "key": "product_id", "value": "12", "description": "The ID of the product to filter by.", "disabled": true }, { "key": "supplier_contact_id", "value": "7", "description": "The ID of the supplier contact to filter by.", "disabled": true } ] }, "description": "Fetches a list of product suppliers." } }, { "name": "get-productv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/product/:product_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "product", ":product_id" ], "variable": [ { "key": "product_id", "value": "12", "description": "The ID number used by the system to uniquely identify a Product." } ] }, "description": "Fetches a specific Product by its ID." } }, { "name": "create-receiveinvoicev2", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "url": { "raw": "{{baseUrl}}/v2/receiveinvoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "receiveinvoice" ] }, "description": "Creates a ReceiveInvoice and any included ReceiveInvoiceItems.", "body": { "mode": "raw", "raw": "invoice_number=INV-001&date=1695766710&due_date=1698358710&comments=Urgent+delivery&freight=15.00&freight_tax=1.50&ownership_id=2", "options": { "raw": { "language": "text" } } } } }, { "name": "get-receiveinvoicev2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/receiveinvoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "receiveinvoice" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a ReceiveInvoice.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the ReceiveInvoice is active and usable in ezyVet.", "disabled": true }, { "key": "invoice_number", "value": "INV-001", "description": "The value given by a Supplier to track the invoice on their end.", "disabled": true }, { "key": "supplier_id", "value": "7", "description": "The ID of the Supplier who sent the ReceiveInvoice.", "disabled": true }, { "key": "ownership_id", "value": "2", "description": "The ID of the OwnershipSeparation.", "disabled": true } ] }, "description": "Fetches ReceiveInvoices and their associated ReceiveInvoiceItems (up to 10)." } }, { "name": "create-receiveinvoiceitemv2", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "url": { "raw": "{{baseUrl}}/v2/receiveinvoiceitem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "receiveinvoiceitem" ] }, "description": "Creates a ReceiveInvoiceItem and optionally creates multiple batches.", "body": { "mode": "raw", "raw": "quantity=10&price=5.00&tax=0.50&supplier_code=SUP-001&location_id=3&receive_invoice_id=5", "options": { "raw": { "language": "text" } } } } }, { "name": "get-receiveinvoiceitemv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/receiveinvoiceitem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "receiveinvoiceitem" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a ReceiveInvoiceItem.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the ReceiveInvoiceItem is active and usable in ezyVet.", "disabled": true }, { "key": "receive_invoice_id", "value": "5", "description": "The ID of the ReceiveInvoice the ReceiveInvoiceItem is linked to.", "disabled": true }, { "key": "product_id", "value": "12", "description": "The ID of the Product on the ReceiveInvoiceItem.", "disabled": true }, { "key": "supplier_code", "value": "SUP-001", "description": "The code of the Product in the Supplier's records.", "disabled": true }, { "key": "location_id", "value": "3", "description": "The ID of the LocationSeparation to which this ReceiveInvoiceItem belongs.", "disabled": true } ] }, "description": "Fetches a list of ReceiveInvoiceItems." } }, { "name": "create-stockadjustment", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/stockadjustment", "host": [ "{{baseUrl}}" ], "path": [ "v2", "stockadjustment" ] }, "description": "Adjust stock levels for a product. It is recommended to use inventory/v1/supplied instead.", "body": { "mode": "raw", "raw": "{\"date\": 1695766710, \"comments\": \"Cycle count adjustment\", \"ownership_id\": 2, \"line_item\": [{\"product_id\": 12, \"quantity\": 5, \"price\": 5.00}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-stockadjustment", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/stockadjustment/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "stockadjustment", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the StockAdjustment to fetch." } ], "query": [ { "key": "active", "value": "1", "description": "If true, the StockAdjustment is active and usable in ezyVet.", "disabled": true }, { "key": "date", "value": "1695766710", "description": "The epoch time specified on create of the StockAdjustment.", "disabled": true }, { "key": "ownership_id", "value": "2", "description": "The ID of the ownership Separation.", "disabled": true } ] }, "description": "Fetches a list of StockAdjustment records (up to 10)." } }, { "name": "create-stockadjustmentitem", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/stockadjustmentitem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "stockadjustmentitem" ] }, "description": "Creates a single StockAdjustmentItem linked to a StockAdjustment.", "body": { "mode": "raw", "raw": "{\"stockadjustment_id\": 1, \"product_id\": 12, \"quantity\": 5, \"price\": 5.00, \"ledger_account\": 100, \"location_id\": 3}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-stockadjustmentitem", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/stockadjustmentitem/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "stockadjustmentitem", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the StockAdjustmentItem to fetch." } ], "query": [ { "key": "active", "value": "1", "description": "If true, the StockAdjustmentItem is active.", "disabled": true }, { "key": "stockadjustment_id", "value": "1", "description": "The ID of the StockAdjustment this item belongs to.", "disabled": true }, { "key": "product_id", "value": "12", "description": "The ID of the product on the StockAdjustmentItem.", "disabled": true }, { "key": "quantity", "value": "5", "description": "The quantity adjusted.", "disabled": true } ] }, "description": "Fetches a StockAdjustmentItem by ID." } }, { "name": "get-stocktransaction", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/stocktransaction", "host": [ "{{baseUrl}}" ], "path": [ "v2", "stocktransaction" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a StockTransaction.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the StockTransaction is active and usable in ezyVet.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a list of StockTransaction records." } }, { "name": "bulk-upload-service-fee", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2.1/product/servicefee/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v2.1", "product", "servicefee", "bulk" ] }, "description": "Add or remove service fees to products for given ownerships. Submit only changed associations.", "body": { "mode": "raw", "raw": "[{\"productId\": 132, \"ownershipId\": 465, \"serviceFeeProductId\": 88}, {\"productId\": 132, \"ownershipId\": 466, \"serviceFeeProductId\": null}, {\"productId\": 133, \"ownershipId\": 465, \"serviceFeeProductId\": 91}]", "options": { "raw": { "language": "json" } } } } }, { "name": "get-tracked-products", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "inventory", "v1", "products" ] }, "description": "Returns all inventory tracked products and details pertaining to the measurement systems of those products." } }, { "name": "get-inventory-requirements", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory/v1/requirements", "host": [ "{{baseUrl}}" ], "path": [ "inventory", "v1", "requirements" ], "query": [ { "key": "locationUID", "value": "location_abc123", "description": "The UID of the location or separation.", "disabled": false } ] }, "description": "Returns the current state of products at an inventory location." } }, { "name": "create-product-balance-update", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/inventory/v1/supplied", "host": [ "{{baseUrl}}" ], "path": [ "inventory", "v1", "supplied" ], "query": [ { "key": "locationUID", "value": "location_abc123", "description": "The UID of the location that the products are supplied to.", "disabled": false } ] }, "description": "Supply products to an inventory location, updating the product balance.", "body": { "mode": "raw", "raw": "[{\"productId\": \"product_MZcxwWMf9lprsWC8MH2OF\", \"supplied\": 5, \"batch\": {\"code\": \"777-3321\", \"expireAt\": \"2024-01-23\"}}]", "options": { "raw": { "language": "json" } } } } }, { "name": "getbalances", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory/v2/balances", "host": [ "{{baseUrl}}" ], "path": [ "inventory", "v2", "balances" ], "query": [ { "key": "locationUID", "value": "location_abc123", "description": "UID of the location or organisational unit.", "disabled": false }, { "key": "pageSize", "value": "100", "description": "Number of items returned per page. Maximum value is 2000.", "disabled": true }, { "key": "nextToken", "value": "eyJwYWdlIjoxfQ==", "description": "Opaque pagination token used to retrieve the next page of results.", "disabled": true } ] }, "description": "Returns quantity-on-hand (QOH) for all active tracked products at a given location or organisational unit." } }, { "name": "create-purchaseorder-v4", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v4/purchaseorder", "host": [ "{{baseUrl}}" ], "path": [ "v4", "purchaseorder" ] }, "description": "Accepts an array of 1 to 100 purchase orders and creates them in a single atomic request.", "body": { "mode": "raw", "raw": "[{\"supplierId\": \"contact_AB3e7Z2i9FJu0j7hLExLp\", \"ownershipId\": \"ownership_5Lh7q9XBxT4dfNYwVo2zP\", \"date\": \"2026-05-15T09:30:00Z\", \"shipping\": {\"shipType\": \"practice\"}, \"purchaseOrderNumber\": \"EXT-PO-77882\", \"notes\": \"Auto-generated\", \"freight\": 5, \"freightTaxRate\": 0.10}]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Prescription Management", "item": [ { "name": "create-externalprescription", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/externalprescription", "host": [ "{{baseUrl}}" ], "path": [ "v1", "externalprescription" ] }, "description": "Create a new external prescription record.", "body": { "mode": "raw", "raw": "{\"animal_id\": 101, \"prescribing_vet_user_id\": 5, \"date_of_prescription\": \"1764277366\", \"external_reference\": \"REF-001\", \"total_price\": 49.99, \"consult_id\": 200, \"contact_id\": 300, \"external_prescription_item_list\": [{\"external_product_name\": \"Amoxicillin\", \"external_product_reference\": \"AMOX-500\", \"price\": 49.99, \"qty\": 2, \"remaining\": 0, \"instructions\": \"Give once daily\", \"external_link\": \"https://pharmacy.example.com/order/123\"}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "delete-externalprescription", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/externalprescription", "host": [ "{{baseUrl}}" ], "path": [ "v1", "externalprescription" ], "query": [ { "key": "prescription_uid", "value": "abc123", "description": "The Uid of the prescription that associates with the External Prescription.", "disabled": false } ] }, "description": "Deactivates an External Prescription record and its items." } }, { "name": "update-externalprescription", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/externalprescription", "host": [ "{{baseUrl}}" ], "path": [ "v1", "externalprescription" ] }, "description": "Update an existing external prescription record identified by prescription_uid.", "body": { "mode": "raw", "raw": "{\"prescription_uid\": \"abc123\", \"animal_id\": 101, \"prescribing_vet_user_id\": 5, \"external_reference\": \"REF-001\", \"total_price\": 49.99, \"date_of_lastdispense\": \"1764277366\", \"external_prescription_item_list\": [{\"external_product_name\": \"Amoxicillin\", \"external_product_reference\": \"AMOX-500\", \"price\": 49.99, \"qty\": 2, \"remaining\": 0, \"status\": \"CURRENT\", \"status_date\": 1764277366}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-prescription", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/prescription", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescription" ] }, "description": "Creates a Prescription with PrescriptionItems. Impacts stock levels.", "body": { "mode": "raw", "raw": "{\"animal_id\": \"101\", \"prescribing_vet_user_id\": \"5\", \"consult_id\": \"200\", \"contact_id\": \"300\", \"date_of_prescription\": \"1764277366\", \"prescription_item_list\": [{\"product_id\": \"42\", \"qty\": \"2\"}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-prescription", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/prescription", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescription" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Prescription.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Prescription is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Prescription was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Prescription was last modified.", "disabled": true }, { "key": "animal_id", "value": "101", "description": "The name of the Animal to which the Prescription was issued.", "disabled": true }, { "key": "consult_id", "value": "200", "description": "The name of the Consult to which the Prescription was issued.", "disabled": true }, { "key": "prescribing_vet_user", "value": "Dr. Smith", "description": "The name of the User (a vet) who issued the Prescription.", "disabled": true }, { "key": "date_of_prescription", "value": "1764277366", "description": "The epoch time when the Prescription was issued.", "disabled": true } ] }, "description": "Fetches a list containing Prescriptions (up to 10)." } }, { "name": "delete-prescription", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/prescription/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescription", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the Prescription to delete." } ] }, "description": "Deletes a Prescription." } }, { "name": "update-prescription", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/prescription/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescription", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Prescription." } ], "query": [ { "key": "consult_id", "value": "200", "description": "Refers to the ID of the Consult where the Prescription is attached.", "disabled": true }, { "key": "animal_id", "value": "101", "description": "Refers to the ID of the Animal.", "disabled": true } ] }, "description": "Updates an existing Prescription by ID.", "body": { "mode": "raw", "raw": "{\"animal_id\": \"101\", \"prescribing_vet_user_id\": \"5\", \"consult_id\": \"200\", \"contact_id\": \"300\", \"date_of_prescription\": \"1764277366\", \"prescription_item_list\": [{\"product_id\": \"42\", \"qty\": \"2\"}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-prescriptionitem", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/prescriptionitem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescriptionitem" ] }, "description": "Creates a prescription item for a prescription.", "body": { "mode": "raw", "raw": "{\"prescription_id\": \"10\", \"product_id\": \"42\", \"qty\": \"2\", \"remaining\": \"2\", \"date_start\": \"1764277366\", \"instructions\": \"Give once daily\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-prescriptionitem", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/prescriptionitem", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescriptionitem" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a PrescriptionItem.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the PrescriptionItem is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the PrescriptionItem was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the PrescriptionItem was last modified.", "disabled": true }, { "key": "prescription_id", "value": "10", "description": "Refers to the ID of the Prescription to which the PrescriptionItem belongs.", "disabled": true }, { "key": "product_id", "value": "42", "description": "Refers to the ID of the Product added to the Prescription as a PrescriptionItem.", "disabled": true }, { "key": "qty", "value": "2", "description": "The amount of the PrescriptionItem prescribed.", "disabled": true }, { "key": "remaining", "value": "1", "description": "The amount of the PrescriptionItem remaining from the prescription.", "disabled": true }, { "key": "instructions", "value": "Give once daily", "description": "Instructions on how to use the PrescriptionItem.", "disabled": true }, { "key": "date_start", "value": "1764277366", "description": "The epoch time when the PrescriptionItem must start being taken.", "disabled": true }, { "key": "serial_number", "value": "SN-12345", "description": "The serial number for the PrescriptionItem.", "disabled": true } ] }, "description": "Fetches a list containing PrescriptionItems." } }, { "name": "delete-prescriptionitem", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/prescriptionitem/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescriptionitem", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "ID of the PrescriptionItem to delete." } ] }, "description": "Deletes a PrescriptionItem." } }, { "name": "update-prescriptionitem", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/prescriptionitem/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prescriptionitem", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the PrescriptionItem to update." } ], "query": [ { "key": "prescription_id", "value": "10", "description": "The ID of the Prescription to which the PrescriptionItem belongs.", "disabled": false }, { "key": "product_id", "value": "42", "description": "The ID of the Product for the PrescriptionItem.", "disabled": false }, { "key": "qty", "value": "2", "description": "The amount of the PrescriptionItem prescribed.", "disabled": false }, { "key": "remaining", "value": "1", "description": "The amount of the PrescriptionItem remaining.", "disabled": false }, { "key": "date_start", "value": "1764277366", "description": "The epoch time when the PrescriptionItem must start being taken.", "disabled": false }, { "key": "instructions", "value": "Give once daily", "description": "Instructions on how to use the PrescriptionItem.", "disabled": true }, { "key": "serial_number", "value": "SN-12345", "description": "The serial number for the PrescriptionItem.", "disabled": true } ] }, "description": "Updates a PrescriptionItem.", "body": { "mode": "raw", "raw": "{\"prescription_id\": \"10\", \"product_id\": \"42\", \"qty\": \"2\", \"remaining\": \"1\", \"date_start\": \"1764277366\", \"instructions\": \"Give once daily\", \"serial_number\": \"SN-12345\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-therapeutics", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/therapeutic", "host": [ "{{baseUrl}}" ], "path": [ "v1", "therapeutic" ], "query": [ { "key": "id", "value": "1", "description": "The ID of the Therapeutic record.", "disabled": true }, { "key": "active", "value": "1", "description": "If true, the Therapeutic is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Therapeutic was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Therapeutic was last modified.", "disabled": true }, { "key": "name", "value": "Antibiotics", "description": "The name of the Therapeutic.", "disabled": true }, { "key": "default_template_id", "value": "0", "description": "The default template ID for the Therapeutic.", "disabled": true }, { "key": "department_ids", "value": "1,2,3", "description": "Array of department IDs associated with the Therapeutic.", "disabled": true } ] }, "description": "Fetches a list containing Therapeutic(s) (up to 10)." } } ] }, { "name": "System Admin", "item": [ { "name": "create-attachment", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "url": { "raw": "{{baseUrl}}/v1/attachment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "attachment" ] }, "description": "Creates a single Attachment that links to a record such as a Consult.", "body": { "mode": "raw", "raw": "{\"record_type\": \"Consult\", \"record_id\": 1, \"notes\": \"Attachment notes\", \"file_data\": \"\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-attachment", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/attachment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "attachment" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an Attachment.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Attachment is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Attachment was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Attachment was last modified.", "disabled": true }, { "key": "record_type", "value": "Consult", "description": "The record type the Attachment is for. E.g. Animal, Contact, Consult.", "disabled": true }, { "key": "record_id", "value": "1", "description": "The ID number of the record the Attachment is linked to.", "disabled": true } ] }, "description": "Fetches a list of Attachments." } }, { "name": "download-attachment", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/attachment/download/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "attachment", "download", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Attachment ID" } ] }, "description": "Downloads the file from the attachment. Returns the file as an octet-stream." } }, { "name": "delete-attachment", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/attachment/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "attachment", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the attachment to delete." } ] }, "description": "Deletes an Attachment by ID." } }, { "name": "update-attachment", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/attachment/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "attachment", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify an Attachment." } ], "query": [ { "key": "record_type", "value": "Consult", "description": "The record type the Attachment is for.", "disabled": false }, { "key": "record_id", "value": "1", "description": "The ID number of the record the Attachment is linked to.", "disabled": false }, { "key": "notes", "value": "Updated notes", "description": "Notes that are related to the Attachment.", "disabled": false }, { "key": "active", "value": "true", "description": "If true, the Attachment is active and usable in ezyVet.", "disabled": false } ] }, "description": "Updates an existing Attachment by ID.", "body": { "mode": "raw", "raw": "{\"notes\": \"Updated notes\", \"record_type\": \"Consult\", \"record_id\": 1, \"active\": true}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-file", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "url": { "raw": "{{baseUrl}}/v1/file", "host": [ "{{baseUrl}}" ], "path": [ "v1", "file" ] }, "description": "NOTE: It is recommended to use the attachment endpoint. Uploads a file using multipart/form-data.", "body": { "mode": "raw", "raw": "{\"file_data\": \"\", \"notes\": \"Optional file notes\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-file", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/file/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "file", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the file to fetch." } ], "query": [ { "key": "active", "value": "true", "description": "Filter by active status.", "disabled": true } ] }, "description": "NOTE: It is recommended to use the attachment endpoint. Fetches a file by ID." } }, { "name": "get-separations", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/separation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "separation" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Separation.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Separation is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Separation was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Separation was last modified.", "disabled": true }, { "key": "name", "value": "Main Clinic", "description": "The name of the Separation.", "disabled": true }, { "key": "type", "value": "Location", "description": "The type of Separation: Database, Business, Division or Location.", "disabled": true }, { "key": "parent", "value": "2", "description": "The ID of the parent Separation.", "disabled": true }, { "key": "contact_id", "value": "3", "description": "The ID of the Contact containing business details for this Separation.", "disabled": true } ] }, "description": "DEPRECATED. Recommended to use the v2/separation endpoint." } }, { "name": "get-settings", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/systemsetting", "host": [ "{{baseUrl}}" ], "path": [ "v1", "systemsetting" ] }, "description": "Returns the SystemSetting of the specified site." } }, { "name": "get-tagcategories", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/tagcategory", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tagcategory" ], "query": [ { "key": "id", "value": "1", "description": "The ID of the Tag Category.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Tag Category is active.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Tag Category was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Tag Category was last modified.", "disabled": true }, { "key": "name", "value": "Patient Flags", "description": "The name of the Tag Category.", "disabled": true } ] }, "description": "Fetches a list of Tag Categories." } }, { "name": "get-tagname", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/tagname", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tagname" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Tag Name.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Tag Name was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Tag Name was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Tag Name is active and usable in ezyVet.", "disabled": true }, { "key": "category_id", "value": "2", "description": "The ID of the Tag Category the Tag Name is part of.", "disabled": true } ] }, "description": "Fetches a list containing Tag Names." } }, { "name": "get-tags", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/tag", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tag" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Tag.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Tag is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Tag was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Tag was last modified.", "disabled": true }, { "key": "name", "value": "VIP", "description": "The name of the Tag.", "disabled": true }, { "key": "associated_id", "value": "5", "description": "The ID of the record to which this Tag is associated.", "disabled": true }, { "key": "associated_type", "value": "Animal", "description": "The name of the entity object to which this Tag is associated.", "disabled": true }, { "key": "category_id", "value": "2", "description": "The ID of the TagCategory to which this Tag belongs.", "disabled": true } ] }, "description": "Fetches a list of Tags." } }, { "name": "get-user", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/user", "host": [ "{{baseUrl}}" ], "path": [ "v1", "user" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a User.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the User is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the User was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the User was last modified.", "disabled": true }, { "key": "name", "value": "John Doe", "description": "The name of the User.", "disabled": true }, { "key": "code", "value": "JD", "description": "The code of the User.", "disabled": true }, { "key": "is_vet", "value": "1", "description": "If true, the User is a vet.", "disabled": true }, { "key": "is_salesperson", "value": "0", "description": "If true, the User is a salesperson.", "disabled": true }, { "key": "is_dev", "value": "0", "description": "If true, the User is an internal ezyVet user. When querying, set this to '0'.", "disabled": true }, { "key": "limit", "value": "10", "description": "Limits the number of items returned.", "disabled": true }, { "key": "page", "value": "1", "description": "Specifies the page number of the result.", "disabled": true } ] }, "description": "Fetches a paginated list of ezyVet users." } }, { "name": "create-webhook", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "description": "Subscribe to a webhook event.", "body": { "mode": "raw", "raw": "{\"webhook_url\": \"https://my-webhook-url.com/appointment_created\", \"event\": \"appointment_created\", \"fields\": [\"uid\"], \"active\": true}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-webhook", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Webhook.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Webhook is active and will receive data upon events being fired.", "disabled": true }, { "key": "event", "value": "appointment_created", "description": "The name of the subscribed event.", "disabled": true } ] }, "description": "Fetch a Webhook. Filterable by id, active status, and event name." } }, { "name": "delete-webhook", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the Webhook to delete." } ] }, "description": "Deletes a WebHook by ID. This is a soft delete, which disables the webhook." } }, { "name": "update-webhook", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the Webhook to update." } ], "query": [ { "key": "active", "value": "true", "description": "If true, the WebHook is active.", "disabled": true }, { "key": "webhook_url", "value": "https://my-webhook-url.com/new_url", "description": "The WebHook URL.", "disabled": true }, { "key": "event", "value": "appointment_updated", "description": "The name of the subscribed event.", "disabled": true }, { "key": "fields", "value": "uid", "description": "A subset of fields the WebHook push data will contain.", "disabled": true } ] }, "description": "Partially updates a Webhook by ID.", "body": { "mode": "raw", "raw": "{\"active\": true, \"webhook_url\": \"https://my-webhook-url.com/new_url\", \"event\": \"appointment_updated\", \"fields\": [\"uid\"]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-webhookevents", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v1/webhookevents", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhookevents" ] }, "description": "Returns the list of available WebHook event names that can be subscribed to." } }, { "name": "get-separationv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/separation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "separation" ], "query": [ { "key": "id", "value": "4", "description": "The ID number used by the system to uniquely identify a Separation.", "disabled": true }, { "key": "uid", "value": "ownershipSeparation_d01oHZu5uCuy0VdOgAn23", "description": "The globally unique ID of a Separation across all ezyVet sites.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Separation is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1419765339", "description": "The epoch time when the Separation was created.", "disabled": true }, { "key": "modified_at", "value": "1747002038", "description": "The epoch time when the Separation was last modified.", "disabled": true } ] }, "description": "Fetches a list containing Separations." } }, { "name": "get-separationv2inv", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/separation/withprimaryinventorylocation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "separation", "withprimaryinventorylocation" ], "query": [ { "key": "id", "value": "4", "description": "The ID number used by the system to uniquely identify a Separation.", "disabled": true }, { "key": "uid", "value": "ownershipSeparation_d01oHZu5uCuy0VdOgAn23", "description": "The globally unique ID of a Separation across all ezyVet sites.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Separation is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1419765339", "description": "The epoch time when the Separation was created.", "disabled": true }, { "key": "modified_at", "value": "1747002038", "description": "The epoch time when the Separation was last modified.", "disabled": true } ] }, "description": "Fetches a list of Separations with a reference to each separation's primary inventory location." } }, { "name": "get-siteinfo", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v3/siteInformation", "host": [ "{{baseUrl}}" ], "path": [ "v3", "siteInformation" ] }, "description": "Gets site information pertaining to the site specified in the request URL." } }, { "name": "listroles", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v4/role", "host": [ "{{baseUrl}}" ], "path": [ "v4", "role" ] }, "description": "Retrieve a list of all active role names." } }, { "name": "create-users-bulk", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v4/user/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v4", "user", "bulk" ] }, "description": "Create multiple users in a single request. Maximum of 100 users per request.", "body": { "mode": "raw", "raw": "[{\"name\": \"John Doe\", \"login\": \"johndoe@email.com\"}, {\"name\": \"Mary Smith\", \"login\": \"mary@example.com\"}]", "options": { "raw": { "language": "json" } } } } }, { "name": "update-users-bulk", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v4/user/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v4", "user", "bulk" ] }, "description": "Update multiple users in a single request. Maximum of 100 users per request.", "body": { "mode": "raw", "raw": "[{\"id\": \"user_602aTIeV9XsL0NYzRcy1m\", \"name\": \"John Smith\", \"roles\": [\"Veterinarian\", \"Practice Manager\"]}]", "options": { "raw": { "language": "json" } } } } }, { "name": "create-user", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v4/user", "host": [ "{{baseUrl}}" ], "path": [ "v4", "user" ] }, "description": "Create a new user. All users are created with status active by default.", "body": { "mode": "raw", "raw": "{\"name\": \"John Doe\", \"login\": \"johndoe@email.com\", \"initials\": \"JD\", \"email\": \"johndoe@email.com\", \"password\": \"P@ssword123\", \"resetPassword\": false, \"mobile\": \"021 777 8809\", \"registration\": \"9731319\", \"qualifications\": \"Qualified\", \"isVet\": true, \"isSalesperson\": false, \"roles\": [\"Veterinarian\", \"Practice Manager\"]}", "options": { "raw": { "language": "json" } } } } }, { "name": "list-usersv4", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v4/user", "host": [ "{{baseUrl}}" ], "path": [ "v4", "user" ], "query": [ { "key": "pageSize", "value": "500", "description": "Maximum number of users to return per page. Default 500, max 500.", "disabled": true }, { "key": "nextToken", "value": "eyJpZCI6InVzZXJfNjAyYVRJZVY5WHNMME5ZelJjeTFtIn0", "description": "Token for fetching the next page of results.", "disabled": true }, { "key": "status", "value": "active", "description": "Filter users by status (active or disabled).", "disabled": true } ] }, "description": "Retrieve a paginated list of all users using token-based pagination." } }, { "name": "get-userv4", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v4/user/:id", "host": [ "{{baseUrl}}" ], "path": [ "v4", "user", ":id" ], "variable": [ { "key": "id", "value": "user_602aTIeV9XsL0NYzRcy1m", "description": "Unique identifier (UID) of the user." } ] }, "description": "Retrieve a single user by their unique identifier (UID)." } }, { "name": "update-user", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v4/user/:id", "host": [ "{{baseUrl}}" ], "path": [ "v4", "user", ":id" ], "variable": [ { "key": "id", "value": "user_602aTIeV9XsL0NYzRcy1m", "description": "Unique identifier (UID) of the user." } ] }, "description": "Partially update a user by their unique identifier.", "body": { "mode": "raw", "raw": "{\"name\": \"John Smith\", \"roles\": [\"Veterinarian\", \"Practice Manager\"]}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Wellness Management", "item": [ { "name": "create-wellnessplan", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/wellnessplan", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplan" ] }, "description": "Creates a new Wellness Plan with the specified details.", "body": { "mode": "raw", "raw": "{\"name\": \"Annual Wellness Plan\", \"subscription_cycle_unit\": \"month\", \"subscription_cycle_qty\": 1, \"subscription_fee_product\": 101, \"fixed_subscription_price\": null, \"min_cycle_qty_on_signup\": 3, \"term_qty\": 12, \"pause_limit_qty\": 6, \"extends_end_date\": true, \"portion_revenue_payable\": 0.2, \"enrollment_fee_product\": null, \"replacement_wellness_plan\": null, \"cancellation_product\": 202, \"default_renew\": true, \"renewal_fee_product\": null, \"ownership_id\": 1}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-wellnessplan", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/wellnessplan", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplan" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Wellness Plan.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Wellness Plan is active and usable in ezyVet.", "disabled": true }, { "key": "name", "value": "Annual Wellness Plan", "description": "The name of the Wellness Plan.", "disabled": true } ] }, "description": "Fetches a list of Wellness Plans." } }, { "name": "delete-wellnessplan", "request": { "auth": { "type": "inherit" }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/wellnessplan/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplan", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the Wellness Plan to delete" } ] }, "description": "Deletes a Wellness Plan." } }, { "name": "update-wellnessplan", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/wellnessplan/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplan", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the Wellness Plan to update" } ] }, "description": "Updates a single Wellness Plan.", "body": { "mode": "raw", "raw": "{\"name\": \"Updated Wellness Plan\", \"subscription_cycle_unit\": \"month\", \"subscription_cycle_qty\": 1, \"subscription_fee_product\": 101, \"fixed_subscription_price\": 49.99, \"min_cycle_qty_on_signup\": 3, \"term_qty\": 12, \"pause_limit_qty\": 6, \"portion_revenue_payable\": \"0.2\", \"enrollment_fee_product\": 50, \"replacement_wellness_plan\": null, \"discontinued\": false, \"cancellation_product\": 202, \"default_renew\": true, \"renewal_fee_product\": null, \"ownership_id\": 1}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-wellnessplanbenefit", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/wellnessplanbenefit", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplanbenefit" ] }, "description": "Creates a single Wellness Plan Benefit.", "body": { "mode": "raw", "raw": "{\"name\": \"Annual Checkup Benefit\", \"earn_amount\": 10, \"earn_method\": \"percent\", \"optional\": false, \"benefit_type\": \"percentage\", \"benefit_config\": {\"type\": \"percentage\", \"allocation\": \"unit\", \"type_value\": 10, \"usages\": 1, \"renewable\": true, \"option_cost_exc_tax\": 0, \"refresh_cycle_quantity\": 12}, \"wellnessplan_id\": 1}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-wellnessplanbenefit", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/wellnessplanbenefit", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplanbenefit" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Wellness Plan Benefit.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan Benefit was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan Benefit was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Wellness Plan Benefit is active and usable in ezyVet.", "disabled": true }, { "key": "wellnessplan_id", "value": "1", "description": "The ID of the Wellness Plan that the Wellness Plan Benefit is associated with.", "disabled": true } ] }, "description": "Fetch Wellness Plan Benefit." } }, { "name": "update-wellnessplanbenefit", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/wellnessplanbenefit/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplanbenefit", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "The ID of the Wellness Plan Benefit to update" } ], "query": [ { "key": "active", "value": "true", "description": "If true, the Wellness Plan Benefit is active and usable in ezyVet.", "disabled": true }, { "key": "earn_method", "value": "percent", "description": "This value can be 'default', 'percent' or 'value'.", "disabled": true }, { "key": "earn_amount", "value": "10", "description": "Defines the value of the benefit items discount recorded as earnings.", "disabled": true }, { "key": "optional", "value": "false", "description": "If true, the client can choose to opt in or out at the time of signing up.", "disabled": true }, { "key": "benefit_config", "value": "{\"type\": \"percentage\", \"allocation\": \"unit\", \"renewable\": true, \"option_cost_exc_tax\": 0, \"refresh_cycle_quantity\": 12}", "description": "This object defines how the Wellness Plan Benefit behaves.", "disabled": true }, { "key": "wellnessplan_id", "value": "1", "description": "The ID of the Wellness Plan the Wellness Plan Benefit is associated with.", "disabled": true } ] }, "description": "Update a Wellness Plan Benefit.", "body": { "mode": "raw", "raw": "{\"name\": \"Updated Benefit Name\", \"benefit_config\": {\"type\": \"percentage\", \"allocation\": \"unit\", \"renewable\": true, \"option_cost_exc_tax\": 0, \"refresh_cycle_quantity\": 12}}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-wellnessplanbenefititem", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/wellnessplanbenefititem", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplanbenefititem" ], "query": [ { "key": "wellness_plan_benefit", "value": "1", "description": "The ID of the Wellness Plan Benefit the Wellness Plan Benefit Item is associated with.", "disabled": false }, { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Wellness Plan Benefit Item.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan Benefit Item was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan Benefit Item was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Wellness Plan Benefit Item is active and usable in ezyVet.", "disabled": true } ] }, "description": "Fetches a list of Wellness Plan Benefit Items." } }, { "name": "create-wellnessplanmembership", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/wellnessplanmembership", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplanmembership" ] }, "description": "Adds a new Wellness Plan Membership to an animal.", "body": { "mode": "raw", "raw": "{\"start_date\": 1695766710, \"animal_id\": 42, \"renew_when_expired\": \"1\", \"billing_interval\": 1, \"wellness_plan\": 1, \"resource_id\": 5, \"next_wellness_plan\": null, \"reference\": \"REF-001\", \"ownership_id\": 1}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-wellnessplanmembership", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/wellnessplanmembership", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplanmembership" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Wellness Plan Membership.", "disabled": true }, { "key": "created_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan Membership was created.", "disabled": true }, { "key": "modified_at", "value": "1695766710", "description": "The epoch time when the Wellness Plan Membership was last modified.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Wellness Plan Membership is active and usable in ezyVet.", "disabled": true }, { "key": "wellness_plan", "value": "1", "description": "The ID of the Wellness Plan this Wellness Plan Membership is associated with.", "disabled": true }, { "key": "animal_id", "value": "42", "description": "The ID of the Animal that is enrolled to this Wellness Plan Membership.", "disabled": true }, { "key": "resource_id", "value": "5", "description": "The ID of the Resource that enrolled the Animal into this Wellness Plan Membership.", "disabled": true } ] }, "description": "Fetches a list containing Wellness Plan Memberships." } }, { "name": "update-wellnessplanmembership", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/wellnessplanmembership", "host": [ "{{baseUrl}}" ], "path": [ "v2", "wellnessplanmembership" ] }, "description": "Updates Wellness Plan Membership related to an animal.", "body": { "mode": "raw", "raw": "{\"id\": 1, \"status\": \"Active\", \"cancellation_option\": \"savings_only\", \"cancellation_fee\": 50, \"pause_length\": 2, \"next_wellness_plan\": 2, \"renew_when_expired\": true, \"reference\": \"REF-001\"}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Standard PACS Interface", "item": [ { "name": "get-partner-token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accesstoken", "host": [ "{{baseUrl}}" ], "path": [ "accesstoken" ] }, "description": "This endpoint must be implemented by the Partner. Allows ezyVet to authenticate and use the Partner's web services.", "body": { "mode": "raw", "raw": "{\"client_id\": \"partner-clinic\", \"client_secret\": \"partner-secret\", \"grant_type\": \"client_credentials\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/oauth/access_token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "oauth", "access_token" ] }, "description": "Generates a valid access token, given client credentials. Access tokens have a 12-hour TTL.", "body": { "mode": "raw", "raw": "{\"partner_id\": \"your-partner-id\", \"client_id\": \"your-client-id\", \"client_secret\": \"your-client-secret\", \"grant_type\": \"client_credentials\", \"scope\": \"read-diagnosticresult write-diagnosticresult read-attachment write-attachment read-separation\", \"site_uid\": \"your-site-uid\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-modalities", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/modalities", "host": [ "{{baseUrl}}" ], "path": [ "modalities" ] }, "description": "This endpoint must be implemented by the Partner. Allows ezyVet to get a list of supported modalities." } }, { "name": "get-dx-breeds+species", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/breedsandspecies", "host": [ "{{baseUrl}}" ], "path": [ "breedsandspecies" ] }, "description": "This endpoint must be implemented by the Partner. Allows ezyVet to get a list of animal species and breeds." } }, { "name": "send-partner-pacs-request", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/diagnosticrequest", "host": [ "{{baseUrl}}" ], "path": [ "diagnosticrequest" ] }, "description": "This endpoint must be implemented by the partner. ezyVet pushes diagnostic (PACS) requests as they are made/updated/disabled to the partner's endpoint.", "body": { "mode": "raw", "raw": "{\"id\": 595, \"active\": true, \"reference_number\": \"AU10674-DR595\", \"modality\": \"DX\", \"status\": \"\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-attachment", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "url": { "raw": "{{baseUrl}}/v1/attachment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "attachment" ] }, "description": "Creates a single Attachment that links to a Consult with an ID of 1.", "body": { "mode": "raw", "raw": "{\"record_type\": \"Consult\", \"record_id\": 1, \"notes\": \"X-ray results from today\", \"file_data\": \"\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-separationv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/separation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "separation" ], "query": [ { "key": "id", "value": "1", "description": "The ID number used by the system to uniquely identify a Separation.", "disabled": true }, { "key": "uid", "value": "abc123", "description": "The ID number used by the system to uniquely identify a Separation across all ezyVet sites.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Separation is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1529901719", "description": "The epoch time when the Separation was created.", "disabled": true }, { "key": "modified_at", "value": "1529901719", "description": "The epoch time when the Separation was last modified.", "disabled": true } ] }, "description": "Fetches a list containing Separations." } }, { "name": "create-diagnosticresult", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/diagnosticresult", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresult" ] }, "description": "Creates a single DiagnosticResult.", "body": { "mode": "raw", "raw": "{\"active\": \"true\", \"consult_id\": \"55\", \"animal_id\": \"2\", \"supplier_id\": \"67\", \"vet_id\": \"31\", \"diagnostic_request_id\": \"595\", \"timestamp\": \"1529901719\", \"specifics\": \"Cardiology scan completed\", \"outcome\": \"No abnormalities detected\", \"diagnostic_result_item_list\": [{\"name\": \"Heart Rate\", \"value\": \"72\", \"range_low\": \"60\", \"range_high\": \"100\", \"unit\": \"bpm\"}], \"external_link\": \"https://www.externalimageviewer.example\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "update-diagnosticresult", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/v1/diagnosticresult/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "diagnosticresult", ":id" ], "variable": [ { "key": "id", "value": "123", "description": "ID of the DiagnosticResult to update" } ], "query": [ { "key": "active", "value": "true", "description": "If true, the DiagnosticResult is active and usable in ezyVet.", "disabled": true }, { "key": "consult_id", "value": "55", "description": "Refers to the ID of the Consult where the DiagnosticResult is attached.", "disabled": true }, { "key": "animal_id", "value": "2", "description": "Refers to the ID of the Animal.", "disabled": true }, { "key": "supplier_id", "value": "67", "description": "Refers to the ID of the Contact (who is a supplier) of the diagnostic.", "disabled": true }, { "key": "vet_id", "value": "31", "description": "Refers to the ID of the User (who is a vet) associated with the DiagnosticResult.", "disabled": true }, { "key": "diagnostic_request_id", "value": "595", "description": "Refers to the ID of the DiagnosticRequest linked to the DiagnosticResult.", "disabled": true }, { "key": "timestamp", "value": "1529901719", "description": "Generally refers to the date when the results of the diagnostic were released.", "disabled": true }, { "key": "specifics", "value": "Updated notes", "description": "Specifics/notes about the DiagnosticResult.", "disabled": true }, { "key": "outcome", "value": "No abnormalities detected", "description": "Notes about the result of the DiagnosticResult.", "disabled": true }, { "key": "external_link", "value": "https://www.externalimageviewer.example", "description": "An external link for users to view any additional data.", "disabled": true } ] }, "description": "Updates an existing DiagnosticResult by ID.", "body": { "mode": "raw", "raw": "{\"specifics\": \"Updated specifics notes\", \"external_link\": \"https://www.externalimageviewer.example\"}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Standard Diagnostic Interface", "item": [ { "name": "get-partner-token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accesstoken", "host": [ "{{baseUrl}}" ], "path": [ "accesstoken" ] }, "description": "This endpoint must be implemented by the Partner. Allows ezyVet to authenticate and use the Partner's web services.", "body": { "mode": "raw", "raw": "{\"client_id\": \"partner-clinic\", \"client_secret\": \"partner-secret\", \"grant_type\": \"client_credentials\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/oauth/access_token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "oauth", "access_token" ] }, "description": "Generates a valid access token given client credentials. Access tokens have a 12-hour TTL.", "body": { "mode": "raw", "raw": "{\"partner_id\": \"your-partner-id\", \"client_id\": \"your-client-id\", \"client_secret\": \"your-client-secret\", \"grant_type\": \"client_credentials\", \"scope\": \"read-diagnosticresult write-diagnosticresult\", \"site_uid\": \"your-site-uid\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-separationv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/separation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "separation" ], "query": [ { "key": "id", "value": "42", "description": "The ID number used by the system to uniquely identify a Separation.", "disabled": true }, { "key": "uid", "value": "abc-123-uid", "description": "The ID number used by the system to uniquely identify a Separation across all ezyVet sites.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Separation is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1672531200", "description": "The epoch time when the Separation was created.", "disabled": true }, { "key": "modified_at", "value": "1672617600", "description": "The epoch time when the Separation was last modified.", "disabled": true } ] }, "description": "Fetches a list containing Separations." } }, { "name": "get-dx-breeds+species", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/breedsandspecies", "host": [ "{{baseUrl}}" ], "path": [ "breedsandspecies" ] }, "description": "This endpoint must be implemented by the Partner. Allows ezyVet to get a list of animal species and breeds." } }, { "name": "get-dx-dos", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/diagnosticcodes", "host": [ "{{baseUrl}}" ], "path": [ "diagnosticcodes" ] }, "description": "This endpoint must be implemented by the partner. Allows ezyVet to get a list of diagnostic codes." } }, { "name": "send-partner-dx-request", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/diagnosticrequest", "host": [ "{{baseUrl}}" ], "path": [ "diagnosticrequest" ] }, "description": "This endpoint must be implemented by the partner. ezyVet pushes diagnostic requests as they are made/updated/disabled.", "body": { "mode": "raw", "raw": "{\"labreport\": {\"Identification\": {\"ReportType\": \"request\", \"PracticeRef\": \"NZ0-DR158\", \"PIMSName\": \"ezyVet\"}, \"AnimalDetails\": {\"AnimalID\": 1, \"AnimalName\": \"Mini\", \"Species\": \"Canine\"}, \"LabRequests\": {\"LabRequest\": [{\"TestCode\": \"AR1PE\", \"RequestStatus\": \"request\"}]}}}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-sdi-hotlink", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/externalhotlink", "host": [ "{{baseUrl}}" ], "path": [ "externalhotlink" ], "query": [ { "key": "practice_ref", "value": "US1324-DR158", "description": "The diagnostic request ID.", "disabled": true }, { "key": "client_id", "value": "partner-clinic", "description": "The client_id set up in the SDI record for authentication.", "disabled": true } ] }, "description": "This endpoint must be implemented by the partner. Allows ezyVet to open the partner's portal in a new browser tab." } }, { "name": "get-requisition-form", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/requisitionform", "host": [ "{{baseUrl}}" ], "path": [ "requisitionform" ], "query": [ { "key": "practice_ref", "value": "US1324-DR158", "description": "The diagnostic request ID.", "disabled": true } ] }, "description": "This endpoint must be implemented by the partner. Allows ezyVet to open and print a diagnostics requisition form as PDF." } }, { "name": "create-dx-result", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/standarddiagnostic/labReport", "host": [ "{{baseUrl}}" ], "path": [ "standarddiagnostic", "labReport" ] }, "description": "Creates a single diagnostic result linked to a diagnostic request.", "body": { "mode": "raw", "raw": "{\"labreport\": {\"LabReport\": {\"Identification\": {\"PracticeRef\": \"NZ0-DR158\", \"PIMSName\": \"ezyVet\"}, \"LabResults\": [{\"LabResult\": {\"LabResultHeader\": {\"TestCode\": \"CBC\", \"TestName\": \"New SDI Result\"}}}]}}}", "options": { "raw": { "language": "json" } } } } }, { "name": "update-dx-result", "request": { "auth": { "type": "inherit" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/merge-patch+json" } ], "url": { "raw": "{{baseUrl}}/standarddiagnostic/updateResult", "host": [ "{{baseUrl}}" ], "path": [ "standarddiagnostic", "updateResult" ] }, "description": "Updates an existing diagnostic result matching the same PracticeRef.", "body": { "mode": "raw", "raw": "{\"labreport\": {\"LabReport\": {\"Identification\": {\"PracticeRef\": \"NZ0-DR158\", \"PIMSName\": \"ezyVet\"}, \"LabResults\": [{\"LabResult\": {\"LabResultHeader\": {\"TestCode\": \"CBC\", \"TestName\": \"Updated SDI Result\"}}}]}}}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Standard Product Supplier Integration", "item": [ { "name": "get-partner-token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accesstoken", "host": [ "{{baseUrl}}" ], "path": [ "accesstoken" ] }, "description": "This endpoint must be implemented by the Partner. Allows ezyVet to authenticate and use the Partner's web services.", "body": { "mode": "raw", "raw": "{\"client_id\": \"partner-clinic\", \"client_secret\": \"partner-secret\", \"grant_type\": \"client_credentials\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-token", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/oauth/access_token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "oauth", "access_token" ] }, "description": "Generates a valid access token, given client credentials. Access tokens have a 12-hour TTL.", "body": { "mode": "raw", "raw": "{\"partner_id\": \"your-partner-id\", \"client_id\": \"your-client-id\", \"client_secret\": \"your-client-secret\", \"grant_type\": \"client_credentials\", \"scope\": \"read-separation write-jobqueue\", \"site_uid\": \"your-site-uid\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-separationv2", "request": { "auth": { "type": "inherit" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/separation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "separation" ], "query": [ { "key": "id", "value": "42", "description": "The ID number used by the system to uniquely identify a Separation.", "disabled": true }, { "key": "uid", "value": "abc-123-uid", "description": "The UID used to uniquely identify a Separation across all ezyVet sites.", "disabled": true }, { "key": "active", "value": "true", "description": "If true, the Separation is active and usable in ezyVet.", "disabled": true }, { "key": "created_at", "value": "1514493886", "description": "The epoch time when the Separation was created.", "disabled": true }, { "key": "modified_at", "value": "1514493886", "description": "The epoch time when the Separation was last modified.", "disabled": true } ] }, "description": "Fetches a list containing Separations." } }, { "name": "create-jobqueue", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/jobqueue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "jobqueue" ] }, "description": "Creates a JobQueue job containing parameters needed for a ReceiveInvoice API request to be processed.", "body": { "mode": "raw", "raw": "{\"type\": \"ReceiveInvoice\", \"type_id\": 3, \"action\": \"ApiRequest\", \"data\": {\"method\": \"POST\", \"endpoint\": \"api/v2/receiveinvoice\", \"body\": {\"invoice_number\": \"INV-001\", \"date\": 1514466000, \"ownership_id\": 1, \"line_item\": [{\"purchase_order_item_id\": 26, \"supplier_code\": \"Droid\", \"quantity\": \"1\", \"price\": \"50\", \"tax\": \"0.10\"}]}}}", "options": { "raw": { "language": "json" } } } } }, { "name": "create-receiveinvoicev2", "request": { "auth": { "type": "inherit" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/receiveinvoice", "host": [ "{{baseUrl}}" ], "path": [ "v2", "receiveinvoice" ] }, "description": "Creates a ReceiveInvoice and any included ReceiveInvoiceItems. Should be encapsulated via the v2/jobqueue endpoint.", "body": { "mode": "raw", "raw": "{\"invoice_number\": \"INV-001\", \"date\": 1514466000, \"due_date\": 1514552400, \"comments\": \"\", \"freight\": 0, \"freight_tax\": 0, \"ownership_id\": 1, \"line_item\": [{\"purchase_order_item_id\": 26, \"supplier_code\": \"Droid\", \"quantity\": \"1\", \"price\": \"50\", \"tax\": \"0.10\", \"total\": \"50\", \"total_tax\": \"0.10\", \"location_id\": 3}]}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-partner-catalog-categories", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] }, "description": "This endpoint must be implemented by the partner. Allows ezyVet to gather a list of product categories from the partner." } }, { "name": "send-partner-purchase-order", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/purchaseorder", "host": [ "{{baseUrl}}" ], "path": [ "purchaseorder" ] }, "description": "This endpoint must be implemented by the partner. Allows ezyVet to send purchase orders to the partner.", "body": { "mode": "raw", "raw": "{\"purchaseorder\": {\"id\": \"12\", \"status\": \"Approved\", \"purchase_order_item_list\": [{\"id\": \"9\", \"product_id\": \"50002\", \"supplier_code\": \"TP1\", \"quantity\": \"1\"}]}}", "options": { "raw": { "language": "json" } } } } }, { "name": "get-partner-catalog", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/products", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "name", "value": "[2m-bandage,1m-bandage]", "description": "An array of product names to filter by.", "disabled": true }, { "key": "code", "value": "[BND]", "description": "An array of product codes to filter by.", "disabled": true }, { "key": "category", "value": "[consumable]", "description": "An array of product categories to filter by.", "disabled": true }, { "key": "limit", "value": "[3]", "description": "An array containing one integer: the maximum number of results to return.", "disabled": true }, { "key": "page", "value": "[0]", "description": "An array containing one integer: the page number to return (0-based).", "disabled": true } ] }, "description": "This endpoint must be implemented by the partner. Allows ezyVet to get products from the partner." } } ] } ] }