TRANXACT.AI Help

EHR · Patient Billing

Statement Runs

One billing cycle: a statement for every patient with a balance after insurance, aged and dunned, with the ones that should not go held or suppressed and the reason recorded.

Type REST8 operationsBase path /api/ehr/statement-runsPublished as /api/v1/statement-runs

Download specification (OpenAPI 3.1) Screen: Statement Runs

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 › Statement Runs 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.statement_runs · 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

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ehr/statement-runsList statement runs

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",
      "run_no": "RUN-000001",
      "cycle_label": "text",
      "statement_date": "2026-10-30",
      "due_days": 10,
      "min_balance": "1250.00",
      "payment_url_template": "https://example.com",
      "remit_to": "text",
      "status": "draft",
      "statements": 10,
      "held": 10,
      "suppressed": 10,
      "total_due": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ehr/statement-runs?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/statement-runs/{id}Read one statement runs

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",
  "run_no": "RUN-000001",
  "cycle_label": "text",
  "statement_date": "2026-10-30",
  "due_days": 10,
  "min_balance": "1250.00",
  "payment_url_template": "https://example.com",
  "remit_to": "text",
  "status": "draft",
  "statements": 10,
  "held": 10,
  "suppressed": 10,
  "total_due": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ehr/statement-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/statement-runsCreate a statement runs

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
cycle_labeltextNoCycle — For example October 2026.
statement_datedateNoStatement date — Within a year of today.
due_daysintegerNoDays to pay
min_balancenumericNoDo not send under — A balance below this is suppressed.
payment_url_templatetextNoPayment page address — Use {statement_no} and {amount}. Leave empty if patients cannot pay online.
remit_totextNoPay by mail to

Sample body

{
  "cycle_label": "text",
  "statement_date": "2026-10-30",
  "due_days": 10,
  "min_balance": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_no": "RUN-000001",
  "cycle_label": "text",
  "statement_date": "2026-10-30",
  "due_days": 10,
  "min_balance": "1250.00",
  "payment_url_template": "https://example.com",
  "remit_to": "text",
  "status": "draft",
  "statements": 10,
  "held": 10,
  "suppressed": 10,
  "total_due": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/statement-runs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cycle_label":"text","statement_date":"2026-10-30","due_days":10,"min_balance":"1250.00"}'
PUT/api/ehr/statement-runs/{id}Change a statement runs

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
cycle_labeltextNoCycle — For example October 2026.
statement_datedateNoStatement date — Within a year of today.
due_daysintegerNoDays to pay
min_balancenumericNoDo not send under — A balance below this is suppressed.
payment_url_templatetextNoPayment page address — Use {statement_no} and {amount}. Leave empty if patients cannot pay online.
remit_totextNoPay by mail to

Sample body

{
  "cycle_label": "text",
  "statement_date": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_no": "RUN-000001",
  "cycle_label": "text",
  "statement_date": "2026-10-30",
  "due_days": 10,
  "min_balance": "1250.00",
  "payment_url_template": "https://example.com",
  "remit_to": "text",
  "status": "draft",
  "statements": 10,
  "held": 10,
  "suppressed": 10,
  "total_due": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ehr/statement-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cycle_label":"text","statement_date":"2026-10-30"}'
DELETE/api/ehr/statement-runs/{id}Delete a statement runs

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/statement-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/statement-runs/{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/statement-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/ehr/statement-runs/{id}/generateGenerate

Path parameters

NameTypeDescription
idstring (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/statement-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/generate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/statement-runs/{id}/sendSend

Path parameters

NameTypeDescription
idstring (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/statement-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a statement runs, 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
run_notextread onlyRun no
cycle_labeltextread, writeCycle — For example October 2026.
statement_datedateread, writeStatement date — Within a year of today.
due_daysintegerread, writeDays to pay
min_balancenumericread, writeDo not send under — A balance below this is suppressed.
payment_url_templatetextread, writePayment page address — Use {statement_no} and {amount}. Leave empty if patients cannot pay online.
remit_totextread, writePay by mail to
statustextread onlyStatus
statementsintegerread onlyStatements
heldintegerread onlyHeld
suppressedintegerread onlySuppressed
total_duenumericread onlyTotal due
generated_attimestamp with time zoneread onlyGenerated at
sent_attimestamp with time zoneread onlySent at
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Statement Runs 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.