Student Lifecycle · Money
Overdue Student Bills
Every bill past its due date with money still open: how late, whether the student and finance were warned, its late fee and its hold. The late fee comes from the Fee Schedule (a fee of type Late), the hold from Alert Rules — neither is charged or placed unless the school has set one.
/api/slcm/overdue-billsPublished as /api/v1/overdue-billsDownload specification (OpenAPI 3.1) Screen: Overdue Student Bills
Overview
| Package | Student Lifecycle |
|---|---|
| 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 Student Lifecycle › Overdue Student Bills 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 | slcm.student_bills · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/overdue-billsList overdue student bills
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",
"bill_no": "BIL-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bill_date": "2026-10-30",
"due_date": "2026-10-30",
"gross_charges": "1250.00",
"aid_applied": "1250.00",
"net_due": "1250.00",
"currency": "USD",
"status": "draft",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/overdue-bills?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/overdue-bills/{id}Read one overdue bills
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",
"bill_no": "BIL-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bill_date": "2026-10-30",
"due_date": "2026-10-30",
"gross_charges": "1250.00",
"aid_applied": "1250.00",
"net_due": "1250.00",
"currency": "USD",
"status": "draft",
"ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/overdue-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/overdue-bills/applyApply
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/slcm/overdue-bills/apply" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/overdue-bills/{id}/applyApply
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/slcm/overdue-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/apply" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/overdue-billsPost overdue student bills
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/slcm/overdue-bills" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/overdue-bills/{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/slcm/overdue-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/slcm/overdue-bills/{id}Put overdue student bills
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/slcm/overdue-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/overdue-bills/{id}Delete overdue student bills
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/slcm/overdue-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a overdue bills, 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 |
bill_no | text | read only | Bill no |
student_id | uuid | read only | Student id |
term_id | uuid | read only | Term id |
bill_date | date | read only | Bill date |
due_date | date | read only | Due date |
gross_charges | numeric | read only | Gross charges |
aid_applied | numeric | read only | Aid applied |
net_due | numeric | read only | Net due |
currency | text | read only | Currency |
status | text | read only | Status |
ar_invoice_id | uuid | read only | Ar invoice id |
cost_center_id | uuid | read only | Cost center id |
notes | text | read only | Notes |
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 |
amount_settled | numeric | read only | Amount settled |
late_fee_for | uuid | read only | Late fee for |
late_fee_id | uuid | read only | Late fee id |
amount_paid | numeric | read only | Amount paid |
amount_credited | numeric | read only | Amount credited |
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 Student Lifecycle › Overdue Student Bills 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.