Skip to main content
GET
List remittances
/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. Each remittance says in era_available whether it has an 835. Fetch the 835 itself with Fetch a remittance’s 835.

Query parameters

string
required
The ID of the entity whose remittances to list. You can find entity IDs using the List entities endpoint.
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.
string
Return only remittances with a remittance date on or after this date (YYYY-MM-DD).
string
Return only remittances with a remittance date on or before this date (YYYY-MM-DD).
string
Return only remittances whose payer name contains this text.
integer
default:"10"
Maximum number of remittances to return per page. Maximum is 100.
string
Pagination cursor for retrieving the next page of results. Returned as cursor in the response. See pagination for details.

Response

object[]
The list of remittance objects.
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.
Every listed id resolves on Get a remittance. Only remittances with era_available set to true have an 835 to fetch.
boolean
Whether more remittances exist beyond this page. Use the cursor field to retrieve the next page.
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 for details.