Student Lifecycle · Money
Aid Awards
What was offered, accepted and disbursed. Accepted aid reduces the next bill.
/api/slcm/aid-awardsPublished as /api/v1/aid-awardsOverview
| 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 › Aid Awards 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.aid_awards · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/aid-awardsList aid awards
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",
"award_no": "AWA-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"aid_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"academic_year": "text",
"amount_offered": "1250.00",
"amount_accepted": "1250.00",
"amount_disbursed": "1250.00",
"status": "draft",
"offered_at": "2026-10-30",
"responded_at": "2026-10-30",
"disbursed_at": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/aid-awards?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/aid-awards/{id}Read one aid awards
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",
"award_no": "AWA-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"aid_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"academic_year": "text",
"amount_offered": "1250.00",
"amount_accepted": "1250.00",
"amount_disbursed": "1250.00",
"status": "draft",
"offered_at": "2026-10-30",
"responded_at": "2026-10-30",
"disbursed_at": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/aid-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/aid-awardsCreate a aid awards
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
student_id | uuid | Yes | Student |
aid_program_id | uuid | Yes | Aid program |
term_id | uuid | No | Term |
academic_year | text | No | Academic year |
amount_offered | numeric | No | Amount offered |
amount_accepted | numeric | No | Amount accepted |
status | text | No | Status |
conditions | text | No | Conditions |
cost_center_id | uuid | No | Cost center |
Sample body
{
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"aid_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"academic_year": "text",
"amount_offered": "1250.00",
"amount_accepted": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_no": "AWA-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"aid_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"academic_year": "text",
"amount_offered": "1250.00",
"amount_accepted": "1250.00",
"amount_disbursed": "1250.00",
"status": "draft",
"offered_at": "2026-10-30",
"responded_at": "2026-10-30",
"disbursed_at": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/aid-awards" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","aid_program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","term_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","academic_year":"text","amount_offered":"1250.00","amount_accepted":"1250.00"}'PUT/api/slcm/aid-awards/{id}Change a aid awards
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 |
|---|---|---|---|
student_id | uuid | Yes | Student |
aid_program_id | uuid | Yes | Aid program |
term_id | uuid | No | Term |
academic_year | text | No | Academic year |
amount_offered | numeric | No | Amount offered |
amount_accepted | numeric | No | Amount accepted |
status | text | No | Status |
conditions | text | No | Conditions |
cost_center_id | uuid | No | Cost center |
Sample body
{
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"aid_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_no": "AWA-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"aid_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"academic_year": "text",
"amount_offered": "1250.00",
"amount_accepted": "1250.00",
"amount_disbursed": "1250.00",
"status": "draft",
"offered_at": "2026-10-30",
"responded_at": "2026-10-30",
"disbursed_at": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/aid-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","aid_program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/slcm/aid-awards/{id}Delete a aid awards
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/slcm/aid-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/aid-awards/{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/aid-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/slcm/aid-awards/{id}/respondRespond
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):
accept, amountResponse
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/aid-awards/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/respond" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"accept":"value","amount":"value"}'Data model
Every field of a aid awards, 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 |
award_no | text | read only | Award no |
student_id | uuid | read, write | Student |
aid_program_id | uuid | read, write | Aid program |
term_id | uuid | read, write | Term |
academic_year | text | read, write | Academic year |
amount_offered | numeric | read, write | Amount offered |
amount_accepted | numeric | read, write | Amount accepted |
amount_disbursed | numeric | read only | Amount disbursed |
status | text | read, write | Status |
offered_at | date | read only | Offered at |
responded_at | date | read only | Responded at |
disbursed_at | date | read only | Disbursed at |
conditions | text | read, write | Conditions |
cost_center_id | uuid | read, write | Cost center |
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 |
application_id | uuid | read only | Application id |
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 › Aid Awards 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.