TRANXACT.AI Help

EHR · Revenue Cycle

Claims

Built, scrubbed, submitted and adjudicated. What the patient owes becomes a receivable in Accounting.

Type REST13 operationsBase path /api/ehr/claimsPublished as /api/v1/claims

Download specification (OpenAPI 3.1) Screen: Claims

Overview

PackageEHR
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableehr.claims · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
patient_iduuidYesPatient id
encounter_iduuidNoEncounter id
payer_iduuidNoPayer id
policy_iduuidNoPolicy id
claim_typetextNoClaim type
service_fromdateNoService from
service_todateNoService to
statustextNoStatus
denial_codetextNoDenial code
denial_reasontextNoDenial reason
bill_typetextNoBill type
place_of_servicetextNoPlace of service
frequency_codetextNoFrequency code
billing_site_iduuidNoBilling site id
rendering_provider_iduuidNoRendering 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
patient_iduuidYesPatient id
encounter_iduuidNoEncounter id
payer_iduuidNoPayer id
policy_iduuidNoPolicy id
claim_typetextNoClaim type
service_fromdateNoService from
service_todateNoService to
statustextNoStatus
denial_codetextNoDenial code
denial_reasontextNoDenial reason
bill_typetextNoBill type
place_of_servicetextNoPlace of service
frequency_codetextNoFrequency code
billing_site_iduuidNoBilling site id
rendering_provider_iduuidNoRendering 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

channel

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/submit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"channel":"value"}'
POST/api/ehr/claims/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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, payerId

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/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

NameTypeDescription
idstring (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, reference

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
claim_notextread onlyClaim no
patient_iduuidread, writePatient id
encounter_iduuidread, writeEncounter id
payer_iduuidread, writePayer id
policy_iduuidread, writePolicy id
claim_typetextread, writeClaim type
service_fromdateread, writeService from
service_todateread, writeService to
billed_amountnumericread onlyBilled amount
allowed_amountnumericread onlyAllowed amount
paid_amountnumericread onlyPaid amount
patient_responsibilitynumericread onlyPatient responsibility
adjustment_amountnumericread onlyAdjustment amount
statustextread, writeStatus
submitted_attimestamp with time zoneread onlySubmitted at
adjudicated_attimestamp with time zoneread onlyAdjudicated at
denial_codetextread, writeDenial code
denial_reasontextread, writeDenial reason
ar_invoice_iduuidread onlyAr invoice id
scrub_errors_textread onlyScrub errors
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
bill_typetextread, writeBill type
place_of_servicetextread, writePlace of service
frequency_codetextread, writeFrequency code
billing_site_iduuidread, writeBilling site id
rendering_provider_iduuidread, writeRendering provider id
edi_statustextread onlyEdi status
edi_status_detailtextread onlyEdi status detail
last_edi_file_iduuidread onlyLast edi file id
payer_claim_notextread onlyPayer claim no

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold EHR › Claims for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.