EHR · Revenue Cycle
Claims
Built, scrubbed, submitted and adjudicated. What the patient owes becomes a receivable in Accounting.
/api/ehr/claimsPublished as /api/v1/claimsOverview
| 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 › Claims 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.claims · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ehr/claimsList claims
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",
"claim_no": "CLA-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"claim_type": "text",
"service_from": "2026-10-30",
"service_to": "2026-10-30",
"billed_amount": "1250.00",
"allowed_amount": "1250.00",
"paid_amount": "1250.00",
"patient_responsibility": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ehr/claims?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/claims/{id}Read one claims
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",
"claim_no": "CLA-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"claim_type": "text",
"service_from": "2026-10-30",
"service_to": "2026-10-30",
"billed_amount": "1250.00",
"allowed_amount": "1250.00",
"paid_amount": "1250.00",
"patient_responsibility": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ehr/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/claimsCreate a claims
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
patient_id | uuid | Yes | Patient id |
encounter_id | uuid | No | Encounter id |
payer_id | uuid | No | Payer id |
policy_id | uuid | No | Policy id |
claim_type | text | No | Claim type |
service_from | date | No | Service from |
service_to | date | No | Service to |
status | text | No | Status |
denial_code | text | No | Denial code |
denial_reason | text | No | Denial reason |
bill_type | text | No | Bill type |
place_of_service | text | No | Place of service |
frequency_code | text | No | Frequency code |
billing_site_id | uuid | No | Billing site id |
rendering_provider_id | uuid | No | Rendering provider id |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"claim_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"claim_no": "CLA-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"claim_type": "text",
"service_from": "2026-10-30",
"service_to": "2026-10-30",
"billed_amount": "1250.00",
"allowed_amount": "1250.00",
"paid_amount": "1250.00",
"patient_responsibility": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/claims" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","encounter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","payer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","policy_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","claim_type":"text"}'PUT/api/ehr/claims/{id}Change a claims
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
patient_id | uuid | Yes | Patient id |
encounter_id | uuid | No | Encounter id |
payer_id | uuid | No | Payer id |
policy_id | uuid | No | Policy id |
claim_type | text | No | Claim type |
service_from | date | No | Service from |
service_to | date | No | Service to |
status | text | No | Status |
denial_code | text | No | Denial code |
denial_reason | text | No | Denial reason |
bill_type | text | No | Bill type |
place_of_service | text | No | Place of service |
frequency_code | text | No | Frequency code |
billing_site_id | uuid | No | Billing site id |
rendering_provider_id | uuid | No | Rendering provider id |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"claim_no": "CLA-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"claim_type": "text",
"service_from": "2026-10-30",
"service_to": "2026-10-30",
"billed_amount": "1250.00",
"allowed_amount": "1250.00",
"paid_amount": "1250.00",
"patient_responsibility": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ehr/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","encounter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/ehr/claims/{id}Delete a claims
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ehr/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/claims/{id}/submitSubmit
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):
channelResponse
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/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"channel":"value"}'POST/api/ehr/claims/{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/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/ehr/claims/{parentId}/paymentsPayments
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ehr/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payments" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/claims/{parentId}/paymentsPayments
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payments" \
-H "Authorization: Bearer $TOKEN"PUT/api/ehr/claims/{parentId}/payments/{lineId}Payments
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ehr/claims/{parentId}/payments/{lineId}Payments
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/claims/buildBuild
Request body
The keys this action reads (* = required; "one of" lists the only values):
patientId*, patient_id, encounterId, chargeIds, payerIdResponse
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/claims/build" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patientId":"value","patient_id":"value","encounterId":"value","chargeIds":"value","payerId":"value"}'POST/api/ehr/claims/{id}/post-paymentPost payment
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):
paidAmount, allowedAmount, adjustmentAmount, patientResponsibility, denialCode, denialReason, method, referenceResponse
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/claims/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post-payment" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"paidAmount":"value","allowedAmount":"value","adjustmentAmount":"value","patientResponsibility":"value","denialCode":"value","denialReason":"value"}'Data model
Every field of a claims, 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 |
claim_no | text | read only | Claim no |
patient_id | uuid | read, write | Patient id |
encounter_id | uuid | read, write | Encounter id |
payer_id | uuid | read, write | Payer id |
policy_id | uuid | read, write | Policy id |
claim_type | text | read, write | Claim type |
service_from | date | read, write | Service from |
service_to | date | read, write | Service to |
billed_amount | numeric | read only | Billed amount |
allowed_amount | numeric | read only | Allowed amount |
paid_amount | numeric | read only | Paid amount |
patient_responsibility | numeric | read only | Patient responsibility |
adjustment_amount | numeric | read only | Adjustment amount |
status | text | read, write | Status |
submitted_at | timestamp with time zone | read only | Submitted at |
adjudicated_at | timestamp with time zone | read only | Adjudicated at |
denial_code | text | read, write | Denial code |
denial_reason | text | read, write | Denial reason |
ar_invoice_id | uuid | read only | Ar invoice id |
scrub_errors | _text | read only | Scrub errors |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
bill_type | text | read, write | Bill type |
place_of_service | text | read, write | Place of service |
frequency_code | text | read, write | Frequency code |
billing_site_id | uuid | read, write | Billing site id |
rendering_provider_id | uuid | read, write | Rendering provider id |
edi_status | text | read only | Edi status |
edi_status_detail | text | read only | Edi status detail |
last_edi_file_id | uuid | read only | Last edi file id |
payer_claim_no | text | read only | Payer claim no |
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 › Claims 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.