> ## 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 invoice payment history

> Returns the payment history for a specific invoice, tracking each payment attempt and its outcome. The history is sorted by creation date, with the most recent entries appearing first.



## OpenAPI

````yaml get /ext/v2/invoices/{invoice_id}/payment-history/
openapi: 3.1.0
info:
  description: ''
  title: NinjaAPI
  version: 2.0.0
servers:
  - url: https://connect.vetcove.com/
security: []
paths:
  /ext/v2/invoices/{invoice_id}/payment-history/:
    get:
      tags:
        - Invoices
      summary: List invoice payment history
      description: >-
        Returns the payment history for a specific invoice, tracking each
        payment attempt and its outcome. The history is sorted by creation date,
        with the most recent entries appearing first.
      operationId: invoices_get_payment_history
      parameters:
        - description: The ID of the invoice to fetch payment history for
          in: path
          name: invoice_id
          required: true
          schema:
            description: The ID of the invoice to fetch payment history for
            title: Invoice Id
            type: integer
        - description: When provided, filters to objects with these IDs.
          in: query
          name: ids
          required: false
          schema:
            anyOf:
              - items:
                  type: integer
                type: array
              - type: 'null'
            description: When provided, filters to objects with these IDs.
            title: Ids
        - description: >-
            A cursor used for pagination. Fetches the page of results ending
            immediately before the object with the given ID. Cannot be used at
            the same time as `starting_after`.
          in: query
          name: ending_before
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              A cursor used for pagination. Fetches the page of results ending
              immediately before the object with the given ID. Cannot be used at
              the same time as `starting_after`.
            title: Ending Before
        - description: >-
            A cursor used for pagination. Fetches the page of results starting
            immediately after the given ID. Cannot be used at the same time as
            `ending_before`.
          in: query
          name: starting_after
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              A cursor used for pagination. Fetches the page of results starting
              immediately after the given ID. Cannot be used at the same time as
              `ending_before`.
            title: Starting After
        - description: The maximum number of items to return per page.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: The maximum number of items to return per page.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoicePaymentHistoryList'
          description: OK
      security:
        - ExternalAPIAuth: []
components:
  schemas:
    InvoicePaymentHistoryList:
      properties:
        data:
          description: A single page of data contained within this list.
          items:
            $ref: '#/components/schemas/ExternalInvoicePaymentHistorySchema'
          title: Data
          type: array
        has_more:
          default: false
          description: Whether there are more pages or data in this list.
          title: Has More
          type: boolean
        next_page:
          description: A URL linking to the next page of this list.
          title: Next Page
          type: string
        type:
          default: list
          description: Type of this object. Always `list`.
          title: Type
          type: string
      required:
        - data
        - next_page
      title: InvoicePaymentHistoryList
      type: object
    ExternalInvoicePaymentHistorySchema:
      description: >-
        Invoice payment history represents all actions taken on an invoice
        payment.
      properties:
        acting_user_id:
          description: The ID of the profile of the user who took this action.
          title: Acting User Id
          type: integer
        action_kind:
          anyOf:
            - $ref: '#/components/schemas/HistoryActionKind'
            - const: ''
              type: string
          description: The kind of action captured by this event.
          title: Action Kind
        amount:
          description: The amount of the payment, in cents.
          title: Amount
          type: integer
        currency:
          anyOf:
            - $ref: '#/components/schemas/Currency'
            - const: ''
              type: string
          description: The currency of the payment
          title: Currency
        event_datetime:
          description: The date and time the event occurred.
          format: date-time
          title: Event Datetime
          type: string
        id:
          description: >-
            The unique identifier for this payment history object. The value of
            this ID may exceed JavaScript's `Number.MAX_SAFE_INTEGER` (2^53 -
            1). JavaScript consumers should handle this value appropriately to
            avoid precision loss.
          format: int64
          title: Id
          type: integer
        payment_id:
          description: The ID of the payment this history is tracking.
          title: Payment Id
          type: integer
        recorded_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: ISO 8601 formatted datetime for when the payment was recorded.
          title: Recorded At
        status:
          $ref: '#/components/schemas/ClientPaymentStatus'
          description: The status of the payment.
        voided_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: ISO 8601 formatted datetime for when the payment was voided.
          title: Voided At
      required:
        - event_datetime
        - action_kind
        - acting_user_id
        - id
        - payment_id
        - recorded_at
        - voided_at
        - amount
        - currency
        - status
      title: InvoicePaymentHistory
      type: object
    HistoryActionKind:
      enum:
        - CREATE
        - UPDATE
        - DELETE
      title: HistoryActionKind
      type: string
    Currency:
      enum:
        - USD
        - CAD
      title: Currency
      type: string
    ClientPaymentStatus:
      enum:
        - PENDING
        - COMPLETED
        - CANCELED
        - FAILED
        - VOIDED
      title: ClientPaymentStatus
      type: string
  securitySchemes:
    ExternalAPIAuth:
      scheme: bearer
      type: http

````