TRANXACT.AI Help

Student Lifecycle · Money

Fee Schedule

What is charged, on what basis, and to which general ledger account.

Type REST6 operationsBase path /api/slcm/fee-schedulePublished as /api/v1/fee-schedule

Download specification (OpenAPI 3.1) Screen: Fee Schedule

Overview

PackageStudent Lifecycle
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 Student Lifecycle › Fee Schedule 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.
Tableslcm.fee_schedule · 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

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

GET/api/slcm/fee-scheduleList fee schedule

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",
      "code": "COD-000001",
      "name": "Example",
      "fee_type": "text",
      "basis": "per_credit",
      "amount": "1250.00",
      "currency": "USD",
      "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "residency": "in_state",
      "level": "text",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "effective_from": "2026-10-30",
      "effective_to": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fee_type": "text",
  "basis": "per_credit",
  "amount": "1250.00",
  "currency": "USD",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "residency": "in_state",
  "level": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30"
}

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

Sample request

curl "https://demo.tranxact.ai/api/slcm/fee-schedule/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/fee-scheduleCreate a fee schedule

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesFee code
nametextYesName
fee_typetextNoType
basistextNoCharged
Allowed: per_credit per_term per_course flat per_year pct_of_overdue
amountnumericNoAmount
currencytextNoCurrency
program_iduuidNoProgram (blank for all)
residencytextNoResidency (blank for all)
Allowed: in_state out_of_state international
leveltextNoLevel (blank for all)
gl_account_iduuidNoRevenue account
cost_center_iduuidNoCost center
effective_fromdateNoEffective from
effective_todateNoEffective to
is_activebooleanNoActive
late_after_daysintegerNoLate fee: charged after (days overdue) — For a fee of type Late: charged once on a bill this many days past due. Charged flat, or with Charged = pct_of_overdue as that percentage of what is overdue.

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "fee_type": "text",
  "basis": "per_credit",
  "amount": "1250.00",
  "currency": "USD"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fee_type": "text",
  "basis": "per_credit",
  "amount": "1250.00",
  "currency": "USD",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "residency": "in_state",
  "level": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/slcm/fee-schedule" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","fee_type":"text","basis":"per_credit","amount":"1250.00","currency":"USD"}'
PUT/api/slcm/fee-schedule/{id}Change a fee schedule

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
codetextYesFee code
nametextYesName
fee_typetextNoType
basistextNoCharged
Allowed: per_credit per_term per_course flat per_year pct_of_overdue
amountnumericNoAmount
currencytextNoCurrency
program_iduuidNoProgram (blank for all)
residencytextNoResidency (blank for all)
Allowed: in_state out_of_state international
leveltextNoLevel (blank for all)
gl_account_iduuidNoRevenue account
cost_center_iduuidNoCost center
effective_fromdateNoEffective from
effective_todateNoEffective to
is_activebooleanNoActive
late_after_daysintegerNoLate fee: charged after (days overdue) — For a fee of type Late: charged once on a bill this many days past due. Charged flat, or with Charged = pct_of_overdue as that percentage of what is overdue.

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "fee_type": "text",
  "basis": "per_credit",
  "amount": "1250.00",
  "currency": "USD",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "residency": "in_state",
  "level": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/slcm/fee-schedule/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/slcm/fee-schedule/{id}Delete a fee schedule

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

Data model

Every field of a fee schedule, 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
codetextread, writeFee code
nametextread, writeName
fee_typetextread, writeType
basistextread, writeCharged
Allowed: per_credit per_term per_course flat per_year pct_of_overdue
amountnumericread, writeAmount
currencytextread, writeCurrency
program_iduuidread, writeProgram (blank for all)
residencytextread, writeResidency (blank for all)
Allowed: in_state out_of_state international
leveltextread, writeLevel (blank for all)
gl_account_iduuidread, writeRevenue account
cost_center_iduuidread, writeCost center
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
late_after_daysintegerread, writeLate fee: charged after (days overdue) — For a fee of type Late: charged once on a bill this many days past due. Charged flat, or with Charged = pct_of_overdue as that percentage of what is overdue.
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 Student Lifecycle › Fee Schedule 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.