> ## Documentation Index
> Fetch the complete documentation index at: https://getlemma.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List remittances

> Retrieve an entity's remittances and whether an 835 is available for each.

> [!NOTE]
>
> /v1 remittance IDs (`canonical_payment_…`) are different from /v0 IDs (`remittance_…`) and are
> not interchangeable. Use /v1 IDs only with /v1 endpoints.

Returns a paginated list of an entity's remittances, ordered by most recently
updated first. A remittance Lemma read from a scanned EOB appears once its
extraction has been reviewed and accepted. Results are
[paginated](https://getlemma.com/docs/api-reference/pagination.md).

Each remittance says in `era_available` whether it has an 835. Fetch the 835
itself with [Fetch a remittance's 835](https://getlemma.com/docs/api-reference/get-remittance-era-v1.md).

## Query parameters

**entity\_id** `string` *required*

The ID of the entity whose remittances to list. You can find entity IDs using
the [List entities](https://getlemma.com/docs/api-reference/list-entities.md) endpoint.

**updated\_since** `string`

Return only remittances whose payment details (payer, amount, trace number or
dates) changed at or after this timestamp (ISO 8601). Changes to a
remittance's claims, its deposit match (`reconciled`) or its 835 do not count,
so fetch a remittance again to see those. A change can appear a few minutes
after the time it is stamped with, so start each poll about 10 minutes before
the largest `updated_at` you have seen; a remittance you already hold may
come back, so update it in place.

**received\_on\_or\_after** `string`

Return only remittances with a remittance date on or after this date
(YYYY-MM-DD).

**received\_on\_or\_before** `string`

Return only remittances with a remittance date on or before this date
(YYYY-MM-DD).

**payer** `string`

Return only remittances whose payer name contains this text.

**limit** `integer` (default: 10)

Maximum number of remittances to return per page. Maximum is 100.

**cursor** `string`

Pagination cursor for retrieving the next page of results. Returned as
`cursor` in the response. See [pagination](https://getlemma.com/docs/api-reference/pagination.md) for
details.

## Response

**data** `object[]`

The list of remittance objects.

**Remittance object**

**id** `string`

Identifies the remittance. If Lemma later combines two copies of the same
payment, this ID keeps working and returns the combined remittance, whose
`id` is then the new one.

**entity\_id** `string`

The ID of the entity the remittance belongs to.

**payer\_name** `string | null`

Payer name as it appears on the remittance.

**payment** `object`

Payment-level details for the remittance.

**payment**

**amount** `integer | null`

Total paid amount, in cents.

**trace\_number** `string | null`

Check or EFT trace number.

**remittance\_date** `string | null`

Date of the payment, as a calendar date (YYYY-MM-DD).

**reconciled** `boolean`

`true` when the remittance reconciles. Lemma either matched it to the bank
deposit that paid it or a teammate settled it manually. \$0 remittances,
which have no deposit to match, also return `true`. `false` only while a
paid remittance is still awaiting a deposit match. Use `payment.amount` to
tell a \$0 settlement (amount 0) apart from one matched to real money
(amount > 0).

**era\_available** `boolean`

`true` when [Fetch a remittance's 835](https://getlemma.com/docs/api-reference/get-remittance-era-v1.md)
returns an 835 for this remittance. Lemma generates an 835 for remittances
it read from an EOB; a remittance that reached Lemma already as an 835, for
example from a clearinghouse, has none to fetch.

> [!NOTE]
>
> **`reconciled` is `true` for \$0 remittances.** They have no deposit to match, so
> there is nothing to reconcile and they report `true` even though no money moved.
> Check `payment.amount` to separate a \$0 settlement from one matched to real money.

> [!NOTE]
>
> Every listed `id` resolves on [Get a remittance](https://getlemma.com/docs/api-reference/get-remittance-v1.md). Only
> remittances with `era_available` set to `true` have an 835 to fetch.

**has\_next** `boolean`

Whether more remittances exist beyond this page. Use the `cursor` field to
retrieve the next page.

**cursor** `string | null`

Cursor to retrieve the next page of results. Null if this is the last page.
Pass this value as the `cursor` query parameter in a subsequent request. See
[pagination](https://getlemma.com/docs/api-reference/pagination.md) for details.

```json 200 theme={null}
{
  "data": [
    {
      "id": "canonical_payment_DrE8uykrS8bg",
      "entity_id": "entity_k7mXp2vR9nTfBw4s",
      "payer_name": "Cigna",
      "payment": { "amount": 172800, "trace_number": "012321930571284" },
      "remittance_date": "2026-03-20",
      "reconciled": true
    },
    {
      "id": "canonical_payment_Qw3Zmn7Ht2Lp",
      "entity_id": "entity_k7mXp2vR9nTfBw4s",
      "payer_name": "United Health",
      "payment": { "amount": 45200, "trace_number": null },
      "remittance_date": "2026-03-18",
      "reconciled": false
    },
    {
      "id": "canonical_payment_Lp9Vh2Kt7Zmn",
      "entity_id": "entity_k7mXp2vR9nTfBw4s",
      "payer_name": "Aetna",
      "payment": { "amount": 0, "trace_number": null },
      "remittance_date": "2026-03-17",
      "reconciled": true
    }
  ],
  "has_next": false,
  "cursor": null
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.