EHR · Claims EDI
Remittances
Electronic remittance advice (835): the payment, the claims it pays, the adjustments and the patient's share, posted to the claims, and whether it all balances.
/api/ehr/era-remittancesPublished as /api/v1/era-remittancesOverview
| Package | EHR |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold EHR › Remittances on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | ehr.era_remittances · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
9 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ehr/era-remittancesList remittances
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"era_no": "ERA-000001",
"edi_file_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_name": "Example",
"payer_ref": "text",
"payee_npi": "text",
"trace_no": "TRA-000001",
"handling_code": "HAN-000001",
"payment_method": "text",
"payment_amount": "1250.00",
"payment_date": "2026-10-30",
"claims_count": 10,
"claims_paid": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ehr/era-remittances?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/era-remittances/{id}Read one era remittances
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"era_no": "ERA-000001",
"edi_file_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_name": "Example",
"payer_ref": "text",
"payee_npi": "text",
"trace_no": "TRA-000001",
"handling_code": "HAN-000001",
"payment_method": "text",
"payment_amount": "1250.00",
"payment_date": "2026-10-30",
"claims_count": 10,
"claims_paid": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ehr/era-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/era-remittancesPost remittances
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/era-remittances" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/era-remittances/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/era-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/ehr/era-remittances/{id}Put remittances
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/ehr/era-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ehr/era-remittances/{id}Delete remittances
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ehr/era-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/era-remittances/sandbox-fetchSandbox fetch
Request body
The keys this action reads (* = required; "one of" lists the only values):
claimIds, plbResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/era-remittances/sandbox-fetch" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"claimIds":"value","plb":"value"}'POST/api/ehr/era-remittances/{id}/postPost
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/era-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/era-remittances/{id}/reconciliationReconciliation
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ehr/era-remittances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reconciliation" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a era remittances, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
era_no | text | read only | Era no |
edi_file_id | uuid | read only | Edi file id |
payer_name | text | read only | Payer name |
payer_ref | text | read only | Payer ref |
payee_npi | text | read only | Payee npi |
trace_no | text | read only | Trace no |
handling_code | text | read only | Handling code |
payment_method | text | read only | Payment method |
payment_amount | numeric | read only | Payment amount |
payment_date | date | read only | Payment date |
claims_count | integer | read only | Claims count |
claims_paid | numeric | read only | Claims paid |
provider_adjustments | numeric | read only | Provider adjustments |
plb | jsonb | read only | Plb |
posted_amount | numeric | read only | Posted amount |
unmatched_amount | numeric | read only | Unmatched amount |
balanced | boolean | read only | Balanced |
status | text | read only | Status |
posted_at | timestamp with time zone | read only | Posted at |
posted_by | uuid | read only | Posted by |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold EHR › Remittances for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.