A fee is a charge that is applied to a person.
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 | number | 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 | 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 | The payment schedule for the fee. |
comment | string | A comment about the fee. |
description | string | A description of the fee. |
creation_date | Date | The creation date of the fee. |
date_charged | Date | The date the fee was charged. |
date_due | Date | The due date of the fee. |
priority | number | The priority of the fee. |
category | string | 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"]
}