Shepherd Veterinary Software Invoice API
The Invoice API from Shepherd Veterinary Software — 1 operation(s) for invoice.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/shepherd-vet:shepherd-vet-invoice-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: v1
title: Shepherd Open API (v2.248.0.39) Invoice API
description: 'Production Base URL: https://open-api.shepherd.vet/pav2/
Production App URL: https://app.shepherd.vet/
Production Documentation URL: https://app.shepherd.vet/swagger/
Sandbox Base URL: https://demo-open-api.shepherd.vet/pav2/
Sandbox App URL: https://demo.shepherd.vet/
Sandbox Documentation URL: https://demo.shepherd.vet/swagger
Authorization: The integration is authorized by providing two headers in the API call
X-Integration-Private-Key - this contains the private key from your credentials
X-Integration-Public-Key - this contains the public key from your credentials
Additionally, for all requests other than Clinic, the X-Clinic-Id header must be provided with the value of the clinic entity id for which you are running the API requests. You can get the entity id by calling the Clinic endpoint. If authorization fails, the request returns HTTP status 401 and the response body is one of the messages below. Missing X-Integration-Public-Key header - the public key header is absent from the request. Missing X-Integration-Private-Key header - the private key header is absent from the request. Missing X-Clinic-Id header - the clinic identifier header is absent, and the endpoint is clinic scoped. Incorrect API keys provided - both key headers were supplied, but the public key matches no integration, or the private key is not valid for that integration. Integration not enabled for the provided clinic - the key pair is valid, but the integration is not enabled and active for the clinic supplied in X-Clinic-Id. NEW: Each API call will count against your RPH and RPM limits. Once you exhaust those limits, requests will start returning HTTP status 429. The RPH is set to 12000 and RPM to 800 (subject to change). Where an endpoint supports searchQuery, a query longer than 500 characters may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_LONG, and a query with more than 10 words may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_MANY_PHRASES. NOTE: Since this API is WIP, we would be happy to hear any feedback and to implement additional filtering/sorting options etc. **Endpoints:
All endpoints are POST requests that accept JSON bodies. The common request properties for all endpoints are:**
rpp::int - The number of items to return per page. The max is 1000. Defaults to 10. page::int - The page number. Defaults to 1. sort::string - Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". All top-level properties should be sortable, only some nested-fields work and you should probably not use them until this API reaches production and we settle on which nested-field sortings we will support. Default depends on endpoint, usually "id|asc". embed::string - Comma-separated values for nested-fields you want to fetch (eg. "clientPhones,clientPhones.phoneType" on Client endpoint). If a specific embed is not requested, the response will contain either null or an empty array for that value. No default. dateCreatedFrom::date
dateCreatedTo::date
dateUpdatedFrom::date
dateUpdatedTo::date
- Date range filters for either the creation date or last update date. - You can pass in either one end or both of them. *
* Only the date filters listed on an endpoint''s request model are supported; sending another one, or a ''From'' later than its ''To'', returns HTTP status 400. The request responses will come back as a JSON object. The common response properties for all endpoints are:
embed::string - Lists the embed used in the request. This may sometimes be different from what you sent in, if in the future we add that some embeds get set automatically on certain endpoints
links::object[] - Always empty, a leftover from the internal framework we use on our web API. Will be removed in the future if possible so do not rely on this
page::int - Which page was fetched.'
servers:
- url: https://open-api.shepherd.vet
tags:
- name: Invoice
paths:
/pav2/open-api-invoices:
post:
tags:
- Invoice
summary: Retrieves {OpenApiInvoiceController.Invoice} resources that match the specified…
description: 'Example Request
{
"searchQuery": "7",
"embed": "invoiceItems"
}
Example Response
{
"embed": "invoiceItems",
"item": [
{
"balance": 120.5,
"clientId": "f3a2c978-4be3-4d86-9516-9f8c3c9f312a",
"clinicId": "a7b390f3-5f7f-4763-8c77-1f55c2323ce7",
"dateCheckedOut": "2025-06-20T14:18:32.124Z",
"dateIssued": "2025-06-20T14:17:00.000Z",
"discount": 5,
"invoiceItems": [
{
"bottleNumber": null,
"clinicId": "a7b390f3-5f7f-4763-8c77-1f55c2323ce7",
"deleted": false,
"discount": 0,
"discountGroup": "",
"discountNote": "",
"discountRate": null,
"dispensingFee": 0,
"includedInMedicalRecord": true,
"invoiceId": "ae68dbf1-c379-4cc3-9910-9f21f7b65027",
"invoiceItemSectionId": "bd8c9ae3-b6a3-41d7-8e56-09e645d6c233",
"isControlled": false,
"isDeclined": false,
"isDiscountPercent": true,
"isDiscountable": false,
"isLegacyData": false,
"isLegacyPrice": false,
"isMicrochip": false,
"isParentInvoiceItem": false,
"isPetAssureDiscountable": false,
"isReturned": false,
"isTaxable": true,
"lineNumber": 1,
"lotNumber": null,
"manufacturer": null,
"medicationVolumeId": "7fa38963-4c31-4e4e-a4b0-d0e3d59b913e",
"minPrice": 2,
"name": "Return: Omega Capsules - 500mg",
"parentInvoiceItemId": null,
"patientId": "45e0788d-8af7-4919-8105-93d5b616b9e4",
"price": 2,
"priceManuallySet": false,
"productBundleId": null,
"productCategoryId": "d8f6eec7-e8cb-4b6d-babc-191e340007f6",
"productId": "e564b9f1-89de-4054-b5c2-5c59ff70f94d",
"productQuantity": -1,
"productTypeId": "9203e1d5-c60c-4221-9eec-cc3425b5f3b1",
"production": 0,
"productionRate": 0,
"productionUserId": null,
"refillId": "c72fef24-4bb2-4a10-958c-ec515a6c9475",
"refundedPaymentId": null,
"returnedItemId": "8a132cb3-bca6-4d0a-8912-727bd8c8ddaf",
"returnedQuantity": 0,
"returnedTotal": 0,
"revision": 1,
"serialNumber": null,
"soapId": null,
"subTotal": -2,
"tax": -0.04,
"taxRate": 2,
"timeAdministered": "2025-06-20T14:17:00.000Z",
"total": -2.04,
"dateCreated": "2025-06-20T14:17:00.000Z",
"dateUpdated": "2025-06-20T14:18:00.000Z",
"id": "43a1241d-49b2-4fe0-a991-d8e191728452"
}
],
"invoiceNumber": 7,
"invoiceStatus": null,
"isDeleted": false,
"isPaid": false,
"isReturn": false,
"isTaxExempt": false,
"paid": 0,
"statusId": "3bce64e1-2f4b-4ef4-a4f0-13dcbc2a1ff9",
"subtotal": -2,
"tax": -0.04,
"total": -120.54,
"dateCreated": "2025-06-20T14:17:00.000Z",
"dateUpdated": "2025-06-20T14:18:32.124Z",
"id": "ae68dbf1-c379-4cc3-9910-9f21f7b65027"
}
],
"links": [],
"page": 1,
"recordsPerPage": 10,
"searchQuery": "7",
"sort": null,
"totalRecords": 1
}'
operationId: OpenApiInvoiceGet
parameters:
- name: x-integration-public-key
in: header
description: Your public API key
required: true
schema:
type: string
- name: x-integration-private-key
in: header
description: Your private API key
required: true
schema:
type: string
- name: x-clinic-id
in: header
description: The clinic uuid identifier
required: true
schema:
type: string
responses:
'200':
description: A paged collection of invoices matching the search criteria.
content:
application/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiInvoiceController.Invoice'
text/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiInvoiceController.Invoice'
application/hal+json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiInvoiceController.Invoice'
'401':
description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id header, Incorrect API keys provided, or Integration not enabled for the provided clinic.'
'429':
description: Request rate limit exceeded. Please wait before making further requests. Returned once the integration passes its configured hourly or per-minute request allowance.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OpenApiInvoiceController.InvoiceFilterModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiInvoiceController.InvoiceFilterModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiInvoiceController.InvoiceFilterModel'
description: The model.
required: true
components:
schemas:
OpenApiInvoiceController.InvoiceFilterModel:
description: Invoice Filter REST model
type: object
properties:
clientIds:
description: 'Comma-separated list of Client identifiers, Cannot be used with searchQuery.
If both are provided, searchQuery takes priority. Defaults to null.'
type: string
clinicIds:
description: Comma-separated list of Clinic identifiers. Defaults to null. The filter is applicable only if the group to which the clinic belongs shares clients and patients.
type: string
isDeleted:
description: Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entities).
type: boolean
searchQuery:
description: If numeric, filters by invoice number; if text, filters by client name. Takes priority over clientIds.
type: string
dateCreatedFrom:
format: date-time
description: 'Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or
the request returns 400. Defaults to null.'
type: string
dateCreatedTo:
format: date-time
description: The end of the date range filter on the entity creation date. Defaults to null.
type: string
dateUpdatedFrom:
format: date-time
description: 'The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the
request returns 400. Defaults to null.'
type: string
dateUpdatedTo:
format: date-time
description: The end of the date range filter on the entity last update date. Defaults to null.
type: string
embed:
description: Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., "client.clientPhones"). Defaults to null.
type: string
excludeIds:
description: Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.
type: string
ids:
description: Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.
type: string
page:
format: int32
description: The page number. Defaults to 1.
type: integer
rpp:
format: int32
description: The number of items to return per page. The max is 1000. Defaults to 10.
type: integer
sort:
description: Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". The default sort field depends on the endpoint, typically "id|asc"
type: string
OpenApiInvoiceController.Invoice:
description: Invoice REST model.
type: object
properties:
balance:
format: double
description: Remaining unpaid amount on the invoice.
type: number
clientId:
description: Unique identifier representing the related Client entity.
type: string
clinicId:
description: Unique identifier representing the related Clinic entity.
type: string
dateCheckedOut:
format: date-time
description: The invoice checkout date.
type: string
dateIssued:
format: date-time
description: The invoice issue date.
type: string
discount:
format: double
description: The invoice discount amount.
type: number
invoiceItems:
description: List of the objects representing the invoice items on this invoice.
type: array
items:
$ref: '#/components/schemas/OpenApiInvoiceController.InvoiceItem'
invoiceNumber:
format: int32
description: The unique number assigned to the invoice.
type: integer
invoiceStatus:
$ref: '#/components/schemas/OpenApiInvoiceController.InvoiceStatus'
description: Object representing the related InvoiceStatus entity.
isDeleted:
description: Flag indicating whether invoice is deleted.
type: boolean
isPaid:
description: Flag indicating whether the invoice is completely paid.
type: boolean
isReturn:
description: Flag indicating whether this invoice is a product return.
type: boolean
isTaxExempt:
description: Flag indicating whether this invoice is tax exempt.
type: boolean
paid:
format: double
description: The total amount paid towards the invoice.
type: number
statusId:
format: uuid
description: Unique identifier representing the related InvoiceStatus entity.
type: string
example: 00000000-0000-0000-0000-000000000000
subtotal:
format: double
description: Amount on the invoice before taxes and discounts.
type: number
tax:
format: double
description: Tax amount applied to the invoice.
type: number
total:
format: double
description: Final invoice total after all calculations.
type: number
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiInvoiceController.InvoiceStatus:
description: InvoiceStatus REST model
type: object
properties:
abrv:
description: Short unique identifier for the lookup.
type: string
description:
description: The description of the lookup entry.
type: string
name:
description: The name of the lookup entry.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiInvoiceController.InvoiceItem:
description: InvoiceItem REST model.
type: object
properties:
bottleNumber:
description: The bottle number.
type: string
clinicId:
description: Unique identifier representing the related Clinic entity.
type: string
deleted:
description: Flag indicating whether invoice item is deleted.
type: boolean
discount:
format: double
description: The discount amount.
type: number
discountGroup:
description: The discount group.
type: string
discountNote:
description: Free-text field for the discount note.
type: string
discountRate:
format: double
description: The discount rate amount.
type: number
dispensingFee:
format: double
description: The dispensing fee amount.
type: number
includedInMedicalRecord:
description: Flag indicating whether if this invoice item is included in medical record.
type: boolean
invoiceId:
description: Unique identifier representing the related Invoice entity.
type: string
invoiceItemSectionId:
format: uuid
description: Unique identifier representing the related Invoiceitemsection entity.
type: string
example: 00000000-0000-0000-0000-000000000000
isControlled:
description: Flag indicating whether this invoice item is controlled.
type: boolean
isDeclined:
description: Flag indicating whether this invoice item is declined.
type: boolean
isDiscountPercent:
description: Flag indicating whether this invoice item uses a discount percentage or a flat amount. When set to true, the discount is applied as a percentage or when set to false, a flat amount is used.
type: boolean
isDiscountable:
description: Flag indicating whether this invoice item is discountable.
type: boolean
isLegacyData:
description: Flag indicating whether this invoice item is legacy data.
type: boolean
isLegacyPrice:
description: Flag indicating whether this invoice item has legacy price.
type: boolean
isMicrochip:
description: Flag indicating whether this invoice item is microchip.
type: boolean
isParentInvoiceItem:
description: Flag indicating whether this invoice item is parent invoice item.
type: boolean
isPetAssureDiscountable:
description: Flag indicating whether this invoice item is pet assure discountable. If true pet assure discount is applied.
type: boolean
isReturned:
description: Flag indicating whether this invoice item is returned.
type: boolean
isTaxable:
description: Flag indicating whether this invoice item is taxable.
type: boolean
lineNumber:
format: int32
description: The line number value.
type: integer
lotNumber:
description: The lot number.
type: string
manufacturer:
description: The manufacturer of the invoice item.
type: string
medicationVolumeId:
format: uuid
description: Unique identifier representing the related medication volume entity.
type: string
example: 00000000-0000-0000-0000-000000000000
minPrice:
format: double
description: The invoice item's minimum price.
type: number
name:
description: Name displayed on the invoice item.
type: string
parentInvoiceItemId:
format: uuid
description: Unique identifier representing the related parent invoice item entity.
type: string
example: 00000000-0000-0000-0000-000000000000
patientId:
description: Unique identifier representing the related Patient entity.
type: string
price:
format: double
description: The product price.
type: number
priceManuallySet:
description: Flag indicating whether invoice item's price is manually set.
type: boolean
productBundleId:
format: uuid
description: Unique identifier representing the related product bundle entity.
type: string
example: 00000000-0000-0000-0000-000000000000
productCategoryId:
description: Unique identifier representing the related ProductCategory entity.
type: string
productId:
description: Unique identifier representing the related Product entity.
type: string
productQuantity:
format: double
description: The product quantity value.
type: number
productTypeId:
description: Unique identifier representing the related ProductType entity.
type: string
production:
format: double
description: The production amount.
type: number
productionRate:
format: double
description: The production rate.
type: number
productionUserId:
format: uuid
description: Unique identifier representing the related production user entity.
type: string
example: 00000000-0000-0000-0000-000000000000
refillId:
description: Unique identifier representing the related Refill entity connecting invoice item to the refill and prescription.
type: string
refundedPaymentId:
description: Unique identifier of the original payment this item is refunding.
type: string
returnedItemId:
description: Unique identifier of the item being returned.
type: string
returnedQuantity:
format: double
description: Quantity of product returned.
type: number
returnedTotal:
format: double
description: Total monetary amount returned.
type: number
revision:
format: int32
description: Number of revisions
type: integer
serialNumber:
description: The serial number assigned to the invoice item.
type: string
soapId:
description: Unique identifier representing the related SOAP entity.
type: string
subTotal:
format: double
description: Amount on the invoice before taxes and discounts.
type: number
tax:
format: double
description: The tax amount on the invoice item.
type: number
taxRate:
format: double
description: The tax rate value on the invoice item.
type: number
timeAdministered:
format: date-time
description: Date when invoice item was administered.
type: string
total:
format: double
description: The total amount on the invoice item.
type: number
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
RESTCollectionModelBase_OpenApiInvoiceController.Invoice:
type: object
properties:
embed:
type: string
item:
type: array
items:
$ref: '#/components/schemas/OpenApiInvoiceController.Invoice'
page:
format: int32
type: integer
recordsPerPage:
format: int32
type: integer
searchQuery:
type: string
sort:
type: string
totalRecords:
format: int32
type: integer