Shepherd Veterinary Software Report API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Report 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: Report
paths:
  /pav2/open-api-reports/accounts-receivable-report:
    post:
      tags:
      - Report
      summary: Gets Accounts Receivable report
      description: 'Example Request

        {

        "toDate": "2025-08-08T11:55:55.000Z"

        }'
      operationId: OpenApiReportAccountsReceivableReportGet
      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: The Accounts Receivable report rendered as CSV, returned as raw bytes.
          content:
            application/json:
              schema:
                format: byte
                type: string
            text/json:
              schema:
                format: byte
                type: string
            application/hal+json:
              schema:
                format: byte
                type: string
        '400':
          description: The request is invalid., with modelState - toDate is missing, or the body is not valid JSON or holds a value that cannot be read as its type. modelState lists every such error.
        '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/OpenApiReportController.AccountsReceivableReportFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiReportController.AccountsReceivableReportFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiReportController.AccountsReceivableReportFilterModel'
        required: true
  /pav2/open-api-reports/revenue-and-cost-overview-report:
    post:
      tags:
      - Report
      summary: Gets Revenue And Cost Overview report
      description: 'Example Request

        {

        "fromDate": "2025-08-08T11:55:55.000Z"

        "toDate": "2025-08-08T11:55:55.000Z"

        "dataSourceName": "revenueAndCostOverviewBundleSaleAnalysisReportDataSource"

        }'
      operationId: OpenApiReportRevenueAndCostOverviewReportGet
      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: The Revenue And Cost Overview report rendered as CSV, returned as raw bytes.
          content:
            application/json:
              schema:
                format: byte
                type: string
            text/json:
              schema:
                format: byte
                type: string
            application/hal+json:
              schema:
                format: byte
                type: string
        '400':
          description: "One of:\n             The request is invalid., with modelState - fromDate is missing, or the body is not valid JSON or holds a value that cannot be read as its type. modelState lists every such error.\n             Date From must not be older than the beginning of last year UTC. - fromDate is earlier than 1 January of last year, 00:00 UTC. The boundary is inclusive."
        '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/OpenApiReportController.RevenueAndCostOverviewReportFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiReportController.RevenueAndCostOverviewReportFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiReportController.RevenueAndCostOverviewReportFilterModel'
        required: true
components:
  schemas:
    OpenApiReportController.AccountsReceivableReportFilterModel:
      description: Accounts Receivable Report Filter REST model
      required:
      - toDate
      type: object
      properties:
        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".

            Default "clientId|desc".'
          type: string
        toDate:
          format: date-time
          description: Filters results whose time overlaps with FromDate - ToDate range. This proprety is required.
          type: string
    OpenApiReportController.RevenueAndCostOverviewReportFilterModel:
      description: Report Filter REST model
      required:
      - fromDate
      type: object
      properties:
        dataSourceName:
          description: 'Which data source to fetch from database.

            Possible options: revenueAndCostOverviewSalesMarginAnalysisReportDataSource, revenueAndCostOverviewBundleSaleAnalysisReportDataSource, revenueAndCostOverviewReferenceLabSaleAnalysisReportDataSource

            If left null will include all.'
          type: string
        fromDate:
          format: date-time
          description: Filters results whose time overlaps with FromDate - ToDate range. This property is required.
          type: string
        sort:
          description: Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc".
          type: string
        toDate:
          format: date-time
          description: Filters results whose time overlaps with FromDate - ToDate range. If left empty will default to current date time.
          type: string