*REST API › Endpoint reference › Finance › Invoices*

# List the payments of an invoice

> Returns the treasury payments assigned to an invoice, newest first, with the same projection as `GET /api/v1/treasury/payments/{paymentId}`.

What it reads are treasury payments, so it takes the treasury scope, not the invoices one. The invoice must belong to the account: an unknown or foreign invoice is a 404, not an empty list.

`GET /api/v1/invoices/{invoiceId}/payments` — scope `treasury:read`

Scope: `treasury:read` · 120/min · Strict tenancy · MCP: `filmo_invoices_payments_list`

## Authorizations

Bearer API key with the scope below. `treasury:read`

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `invoiceId` | string | Yes | Invoice identifier. |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |
| `sort` | string | No | Sort order: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: date, amount, createdAt, updatedAt. Defaults to "-date". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with. |
| `includeTotal` | boolean | No | Set it to true to include `pagination.total`, the number of results that match the filters across all pages. Off by default. = `false` |

## Request examples

*List the payments of an invoice*

**cURL**

```bash
curl https://app.filmo.io/api/v1/invoices/invo_8f2a1c/payments \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/invoices/invo_8f2a1c/payments', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/invoices/invo_8f2a1c/payments",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `PaymentDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Payment identifier. |
| `data.direction` | string | in when money comes in (a collection) and out when it goes out (a payment). |
| `data.amount` | string | Payment amount as a decimal string, in the indicated currency. |
| `data.currency` | string | Payment currency, as an ISO 4217 code. |
| `data.date` | string<date-time> | Payment date in ISO 8601 UTC. |
| `data.type` | string | normal, or deposit when it is an advance payment. |
| `data.treasuryAccountId` | string | Treasury account the payment goes through. |
| `data.contactId` | string | Customer or supplier of the payment; null if not declared. |
| `data.reference` | string | External reference of the payment; null if it has none. |
| `data.linkedDocuments` | object[] | Documents the payment is assigned to; empty if it is not linked to any. |
| `data.linkedDocuments.type` | string | Kind of the linked document. `invoice`, `creditNote`, `supplierInvoice`, `quote`, `proforma`, `salesReceipt`, `simpleCreditNote`, `purchaseOrder` |
| `data.linkedDocuments.id` | string | Identifier of the linked document. |
| `data.linkedDocuments.amount` | string | Amount of this payment assigned to the document, as a decimal string. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "id": "payment_9f3a2b",
      "direction": "Example direction",
      "amount": "120.00",
      "currency": "EUR",
      "date": "2026-09-01T08:00:00.000Z",
      "type": "Example type",
      "treasuryAccountId": "treasury_account_9f3a2b",
      "contactId": "contact_9f3a2b",
      "reference": "2026-0001",
      "linkedDocuments": [
        {
          "type": "invoice",
          "id": "linked_document_9f3a2b",
          "amount": "120.00"
        }
      ],
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/invoices/list-the-payments-of-an-invoice  
Last updated: 2026-10-25