For Developers
Fees Overview
A fee is a charge that is applied to a person. Typically they are used to track financial obligations that are not tuition. They can be associated with relevant schools, departments, subjects, courses, sessions, and people.
For example, schools may assign fees for course-related costs such as lab materials, art supplies, or technology usage. They might also charge for participation in programs and activities like athletics, band, or clubs. They also may track administrative costs like registration, parking permits, or replacement ID cards as fees.
Not every system will have fees, but for those that do, the model below provides a standardized way to access and manage this data.
Properties
Property | Type | Description |
---|---|---|
id | string | The UUID for the fee. $filter operators: equals in not in |
created_date | Date | When the fee was first seen by Edlink. |
updated_date | Date | When the fee was last changed in Edlink. $filter operators: equals gt lt gte lte |
properties | object | Non-standard properties that may be of interest to the developer. |
amount | number | The total amount of the fee. |
balance | number | The current balance of the fee. |
currency | string , null | The currency used for the fee. |
amount_charged | number | The amount charged for the fee. |
amount_paid | number | The amount already paid for the fee. |
original_amount | number , null | The original amount of the fee. |
adjustment_amount | number | The adjustment amount for the fee. |
prorated | boolean | Indicates whether the fee is prorated. |
payment_schedule | string , null | The payment schedule for the fee. |
comment | string , null | A comment about the fee. |
description | string , null | A description of the fee. |
creation_date | Date , null | The creation date of the fee. |
charged_date | Date , null | The date the fee was charged. |
date_due | Date , null | The due date of the fee. |
priority | number | The priority of the fee. |
category | string , null | The category of the fee. |
type | FeeType | The type of the fee. |
flags | FeeFlag[] | The flags for the fee. All, some, or none of the possible flags may be included. |
identifiers | Identifier[] | Additional IDs associated with the object. |
school_ids | string[] | An array of UUIDs of the associated Schools. |
department_ids | string[] | An array of UUIDs of the associated Departments. |
subject_ids | string[] | An array of UUIDs of the associated Subjects. |
course_ids | string[] | An array of UUIDs of the associated Courses. |
session_ids | string[] | An array of UUIDs of the associated Sessions. |
person_ids | string[] | An array of UUIDs of the associated People. |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-13T17:45:27.570Z",
"updated_date": "2021-07-13T17:45:27.570Z",
"properties": {},
"amount": 50.99,
"balance": 20.75,
"currency": "USD",
"amount_charged": 50.99,
"amount_paid": 30.24,
"original_amount": 70.5,
"adjustment_amount": 19.51,
"prorated": true,
"payment_schedule": "Monthly",
"comment": "This fee is for the Fall semester.",
"description": "Tuition fee for the Fall semester",
"creation_date": "2021-07-13T17:45:27.570Z",
"date_charged": "2021-08-01T00:00:00.000Z",
"date_due": "2021-09-01T00:00:00.000Z",
"priority": 1,
"category": "Arbitrary Category",
"type": "tuition",
"flags": ["adjustment"],
"school_ids": [],
"department_ids": ["11111111-1111-1111-1111-111111111111"],
"subject_ids": ["22222222-2222-2222-2222-222222222222"],
"course_ids": ["33333333-3333-3333-3333-333333333333"],
"session_ids": [],
"person_ids": ["44444444-4444-4444-4444-444444444444"]
}
{
"comment": null,
"description": null,
"amount": 2,
"balance": 2,
"currency": null,
"amount_charged": 2,
"amount_paid": 0,
"original_amount": null,
"adjustment_amount": 0,
"prorated": null,
"payment_schedule": null,
"creation_date": null,
"charged_date": null,
"due_date": null,
"priority": 1,
"category": null,
"created_date": "2025-08-12T04:17:18.149Z",
"updated_date": "2025-08-12T15:45:13.446Z",
"properties": {},
"identifiers": [
{
"type": "sis_id",
"value": "10599"
},
{
"type": "powerschool_id",
"value": "10599"
},
{
"type": "powerschool_dc_id",
"value": "10599"
}
],
"rule_ids": [],
"id": "a51ffa3f-89dd-4e6d-8cb3-1d63486485ea",
"type": "other",
"flags": [],
"school_ids": ["a3303522-8747-456e-8dda-a4079dc32409"],
"department_ids": [],
"subject_ids": [],
"course_ids": [],
"session_ids": [],
"person_ids": ["4c098c19-7c3f-4213-a57f-269c99b574d6"]
}
Supported Providers
Provider | Support |
---|---|
aeries | ✅ |
powerschool | ✅ |