> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List all payments

> Returns a list of all payments across all clinics in the organization. The payments are sorted by creation date, with the most recent appearing first. When using modified filters, results are sorted by modification date instead.

A **payment** represents a payment made by a clinic client (pet parent). Payments can be made via credit card, cash, check, client credit, or other external payment methods. Each payment records the amount, type, and current status of the transaction. Payments are never deleted.



## OpenAPI

````yaml get /ext/v2/payments/
openapi: 3.1.0
info:
  description: ''
  title: NinjaAPI
  version: 2.0.0
servers:
  - url: https://connect.vetcove.com/
security: []
paths:
  /ext/v2/payments/:
    get:
      tags:
        - Payments
      summary: List all payments
      description: >-
        Returns a list of all payments across all clinics in the organization.
        The payments are sorted by creation date, with the most recent appearing
        first. When using modified filters, results are sorted by modification
        date instead.


        A **payment** represents a payment made by a clinic client (pet parent).
        Payments can be made via credit card, cash, check, client credit, or
        other external payment methods. Each payment records the amount, type,
        and current status of the transaction. Payments are never deleted.
      operationId: payments_list
      parameters:
        - description: When provided, filters to objects with these IDs.
          in: query
          name: ids
          required: false
          schema:
            anyOf:
              - items:
                  type: integer
                type: array
              - type: 'null'
            description: When provided, filters to objects with these IDs.
            title: Ids
        - description: >-
            A cursor used for pagination. Fetches the page of results ending
            immediately before the object with the given ID. Cannot be used at
            the same time as `starting_after`.
          in: query
          name: ending_before
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              A cursor used for pagination. Fetches the page of results ending
              immediately before the object with the given ID. Cannot be used at
              the same time as `starting_after`.
            title: Ending Before
        - description: >-
            A cursor used for pagination. Fetches the page of results starting
            immediately after the given ID. Cannot be used at the same time as
            `ending_before`.
          in: query
          name: starting_after
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              A cursor used for pagination. Fetches the page of results starting
              immediately after the given ID. Cannot be used at the same time as
              `ending_before`.
            title: Starting After
        - description: The maximum number of items to return per page.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: The maximum number of items to return per page.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: >-
            A cursor token used for pagination. This token contains encoded
            information about the last seen record in order to continue
            pagination. Cannot be used with `starting_after` or `ending_before`
            parameters.
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              A cursor token used for pagination. This token contains encoded
              information about the last seen record in order to continue
              pagination. Cannot be used with `starting_after` or
              `ending_before` parameters.
            title: Cursor
        - description: >-
            Filters to objects modified on or after this datetime (ISO8601 UTC,
            e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or
            `ending_before` parameters.
          in: query
          name: modified__gte
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            description: >-
              Filters to objects modified on or after this datetime (ISO8601
              UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with
              `starting_after` or `ending_before` parameters.
            title: Modified  Gte
        - description: >-
            Filters to objects modified on or before this datetime (ISO8601 UTC,
            e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or
            `ending_before` parameters.
          in: query
          name: modified__lte
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            description: >-
              Filters to objects modified on or before this datetime (ISO8601
              UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with
              `starting_after` or `ending_before` parameters.
            title: Modified  Lte
        - description: When provided, filters to payments for this clinic.
          in: query
          name: clinic_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: When provided, filters to payments for this clinic.
            title: Clinic Id
        - description: When provided, filters to payments for this clinic client.
          in: query
          name: clinic_client_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: When provided, filters to payments for this clinic client.
            title: Clinic Client Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalPaymentSchemaList'
          description: OK
      security:
        - ExternalAPIAuth: []
components:
  schemas:
    ExternalPaymentSchemaList:
      properties:
        data:
          description: A single page of data contained within this list.
          items:
            $ref: '#/components/schemas/ExternalPaymentSchema'
          title: Data
          type: array
        has_more:
          default: false
          description: Whether there are more pages or data in this list.
          title: Has More
          type: boolean
        next_page:
          description: A URL linking to the next page of this list.
          title: Next Page
          type: string
        type:
          default: list
          description: Type of this object. Always `list`.
          title: Type
          type: string
      required:
        - data
        - next_page
      title: ExternalPaymentSchemaList
      type: object
    ExternalPaymentSchema:
      properties:
        amount:
          description: The payment amount in cents.
          title: Amount
          type: integer
        clinic_client_id:
          description: The ID of the clinic client who made this payment.
          title: Clinic Client Id
          type: integer
        clinic_id:
          description: The ID of the clinic associated with this payment.
          title: Clinic Id
          type: integer
        created:
          description: The datetime this object was created.
          format: date-time
          title: Created
          type: string
        currency:
          $ref: '#/components/schemas/Currency'
          description: The currency of this payment.
        id:
          description: The unique identifier for the payment.
          title: Id
          type: integer
        modified:
          description: >-
            The datetime this object was last modified; changes to related
            entities will not update this field.
          format: date-time
          title: Modified
          type: string
        payment_link_id:
          anyOf:
            - type: integer
            - type: 'null'
          description: The ID of the payment link used for this payment, if any.
          title: Payment Link Id
        payment_type:
          $ref: '#/components/schemas/PaymentType'
          description: The method used to make this payment.
        recorded_at:
          description: When this payment was officially recorded.
          format: date-time
          title: Recorded At
          type: string
        status:
          $ref: '#/components/schemas/ClientPaymentStatus'
          description: The current status of this payment.
        void_reason:
          description: The reason this payment was voided, if applicable.
          title: Void Reason
          type: string
        voided_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When this payment was voided, if applicable.
          title: Voided At
      required:
        - created
        - modified
        - id
        - clinic_client_id
        - clinic_id
        - amount
        - status
        - payment_type
        - recorded_at
        - currency
        - voided_at
        - void_reason
        - payment_link_id
      title: ExternalPaymentSchema
      type: object
    Currency:
      enum:
        - USD
        - CAD
      title: Currency
      type: string
    PaymentType:
      enum:
        - CARD_SAVED
        - CARD_READER
        - CLIENT_CREDIT
        - CASH
        - CHECK
        - CUSTOM
      title: PaymentType
      type: string
    ClientPaymentStatus:
      enum:
        - PENDING
        - COMPLETED
        - CANCELED
        - FAILED
        - VOIDED
      title: ClientPaymentStatus
      type: string
  securitySchemes:
    ExternalAPIAuth:
      scheme: bearer
      type: http

````