Summarize a page of payment totals
list_paymentsUse this when the user wants to aggregate one bounded page of recorded Veterical payments by currency and status; this is not a full revenue or settlement report. Returns totals and counts by currency and status for one page of payments, newest first (20 by default), with a cursor for the rest (no client, pet or card data). Not for refunds or charging a client.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Payments to summarize in this page, from 1 to 100; defaults to 20 | |
| cursor | No | The nextCursor of the previous page with the same filters; absent for the first page | |
| endTime | No | Only payments dated before this ISO 8601 date-time | |
| clinicId | No | Only this clinic (24 lowercase hexadecimal characters); every clinic when absent | |
| startTime | No | Only payments dated at or after this ISO 8601 date-time |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| totals | Yes | One row per currency and status within this page only. Transaction identifiers and dates, animal or owner linkage, line items, discounts, payment methods, card or bank data and processor identifiers are never returned. | |
| nextCursor | Yes | Cursor for the next page; null on the last page | |
| recordsSummarized | Yes | How many payment records this page summarized | |
| moreRecordsAvailable | Yes | True when older payments exist beyond this page |