For Developers

List Fees

GET https://ed.link/api/v2/graph/fees

Retrieve a list of all Fees.

Request Parameters

This query allows for standard paging parameters.

ParameterLocationTypeDescription
$firstquerynumber

Returns the first n elements from the list.

$lastquerynumber

Returns the last n elements from the list.

$beforequeryuuid

Returns the elements in the list that come before the specified item.

$afterqueryuuid

Returns the elements in the list that come after the specified item.

It is best practice to use either $first or $last in conjunction with the $next value returned by the API to paginate through results.

Sample Request

axios.get('https://ed.link/api/v2/graph/fees', {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "e02c6d44-62a8-4481-91c6-e7bb0b8b30cc",
            "created_date": "2021-07-13T17:45:27.570Z",
            "updated_date": "2021-07-13T17:45:27.570Z",
            "properties": {},
            "amount": 50.99,
            "balance": 20.99,
            "currency": "CAD",
            "amount_charged": 50.99,
            "amount_paid": 30.0,
            "original_amount": 50.99,
            "adjustment_amount": 0.0,
            "prorated": false,
            "payment_schedule": "One-time",
            "comment": "Fee for lab materials",
            "description": "Lab Materials Fee",
            "creation_date": "2021-08-01T00:00:00.000Z",
            "date_charged": "2021-08-15T00:00:00.000Z",
            "date_due": "2021-09-15T00:00:00.000Z",
            "priority": 1,
            "category": "Course Supplies",
            "type": "other",
            "flags": [],
            "identifiers": [
                {
                    "type": "sis_id",
                    "value": "FEE12345"
                }
            ],
            "school_ids": ["c880375f-54ec-431e-bf29-5f62002f6a93"],
            "department_ids": [],
            "subject_ids": ["3ff7179c-7c47-42a5-becf-bd45a67166b1"],
            "course_ids": ["3c631bdf-d64b-4638-a6c6-cc8b6d2f1aee"],
            "session_ids": [],
            "person_ids": ["fdc68e46-597d-4a81-bbed-6ed3cde63ee0"]
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}