---
title: "List invoice payment history"
method: GET
path: "/ext/v2/invoices/{invoice_id}/payment-history/"
tags: ["Invoices"]
---

# List invoice payment history

`GET /ext/v2/invoices/{invoice_id}/payment-history/`

## Request

- Base URL: `https://connect.vetcove.com`
- URL: `https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/payment-history/`
- Auth: HTTP bearer

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.

## Path parameters

- `invoice_id` integer, required: The ID of the invoice to fetch payment history for

## Query parameters

- `ids` integer[], nullable: When provided, filters to objects with these IDs.
- `ending_before` integer, nullable: 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`.
- `starting_after` integer, nullable: 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`.
- `limit` integer: The maximum number of items to return per page.

## Response `200`

OK

- InvoicePaymentHistoryList
  - `data` ExternalInvoicePaymentHistorySchema[], required: A single page of data contained within this list.
    - `acting_user_id` integer, required: The ID of the profile of the user who took this action.
    - `action_kind` union, required: The kind of action captured by this event.
      - 'CREATE' | 'UPDATE' | 'DELETE'
      - ''
    - `amount` integer, required: The amount of the payment, in cents.
    - `currency` union, required: The currency of the payment
      - 'USD' | 'CAD'
      - ''
    - `event_datetime` string, date-time, required: The date and time the event occurred.
    - `id` integer, required: 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.
    - `payment_id` integer, required: The ID of the payment this history is tracking.
    - `recorded_at` string, date-time, nullable, required: ISO 8601 formatted datetime for when the payment was recorded.
    - `status` 'PENDING' | 'COMPLETED' | 'CANCELED' | 'FAILED' | 'VOIDED', required
    - `voided_at` string, date-time, nullable, required: ISO 8601 formatted datetime for when the payment was voided.
  - `has_more` boolean: Whether there are more pages or data in this list.
  - `next_page` string, required: A URL linking to the next page of this list.
  - `type` string: Type of this object. Always `list`.

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)