Show contract fees info

GET

https://app.schoolset.io/app/api/v1/services/contract/fees/:id

GET

/app/api/v1/services/contract/fees/:id

1 curl https://app.schoolset.io/app/api/v1/services/contract/fees/id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Contract fee details retrieved successfully.",
4   "data": {
5     "id": 1024,
6     "type": "Tuition Fee",
7     "contract_fees_type_id": 5,
8     "due_date": "2024-09-01",
9     "of_installments": 3,
10     "grace_period": 7,
11     "discount": 150,
12     "amount": 1500,
13     "final_amount": 1350,
14     "total_paid": 450,
15     "total_upcoming": 900,
16     "student": {
17       "id": 789,
18       "first_name": "Emily",
19       "last_name": "Johnson",
20       "grade": "10",
21       "email": "emily.johnson@example.com"
22     },
23     "contract_fees_period": {
24       "start_date": "2024-01-01",
25       "end_date": "2024-12-31",
26       "period_name": "2024 Academic Year"
27     },
28     "fees_plan": [
29       {
30         "installment_number": 1,
31         "due_date": "2024-09-01",
32         "amount": 450,
33         "status": "paid"
34       },
35       {
36         "installment_number": 2,
37         "due_date": "2024-10-01",
38         "amount": 450,
39         "status": "upcoming"
40       },
41       {
42         "installment_number": 3,
43         "due_date": "2024-11-01",
44         "amount": 450,
45         "status": "upcoming"
46       }
47     ],
48     "responsible_id": 321,
49     "responsible_type": "Parent",
50     "responsible_note": "Payment plan agreed upon with parent.",
51     "responsible": {
52       "id": 321,
53       "name": "Michael Johnson"
54     },
55     "payments": [
56       {
57         "id": 5001,
58         "payment_date": "2024-09-05",
59         "amount_payment": 450,
60         "payment_status_id": 2,
61         "allocated_amount": 450
62       }
63     ]
64   }
65 }

Returns contract fee information for the selected context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/services/contract/fees/{id}.

statusstring

messagestring

dataobject