List payments
Payments with client, date, amount, type, reference and the invoices they were applied to.
GET https://cotlet.dev/api/v1/invoice-ninja/payments
read
Lists recorded payments, newest first. Status is Unapplied, Partially Unapplied, Paid or Refunded, as in the Payments list. Each item shows the invoices the payment was applied to and how much went to each. Use it before record_payment to check that a bank transfer was not already entered. Pages hold up to 100 payments; pass next_cursor back as cursor for the next page.
Parameters
| Name | Type | Description |
|---|---|---|
| company string | string | Company name, for accounts with several companies. Default: the company open when you signed in. |
| client_id string | string | Only payments of this client. |
| date_from date | date | Only payments dated on or after this day. |
| date_to date | date | Only payments dated on or before this day. |
| limit integer | integer | 1 to 100. Default: 20. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/invoice-ninja/payments \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("invoice-ninja", "list_payments")const result = await cotlet.call('invoice-ninja', 'list_payments');cotlet call invoice-ninja list_paymentsExample response
{
"payments": [
{
"payment_number": "0020",
"client": "Brightwave Ltd",
"payment_date": "2026-10-08",
"payment_type": "Bank Transfer",
"transaction_reference": "BW 0030",
"amount": 1500,
"status": "Paid",
"applied_to": [
{
"invoice_number": "INV-0030",
"amount": 1500
}
]
}
],
"next_cursor": null
}