Student Financial Summary

Financial summary for a student for an academic interval.

JSON Example 

1{
2  "academicIntervalId": "ACADEMIC_INTERVAL_ID",
3  "academicIntervalName": "example",
4  "activeRestrictionCount": 0,
5  "hasActivity": true,
6  "nextPaymentDueDate": "2026-11-01",
7  "primaryCurrency": "USD",
8  "summariesByCurrency": [
9    {
10      "appliedPaymentAmount": 0.0,
11      "balanceDueAmount": 0.0,
12      "creditAdjustmentAmount": 0.0,
13      "creditBalanceAmount": 0.0,
14      "currencyIsoCode": "USD",
15      "refundBalanceAmount": 0.0,
16      "totalChargeAmount": 0.0
17    }
18  ]
19}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
academicIntervalIdStringThe ID of the academic interval that the summary covers.Big, 68.068.0
academicIntervalNameStringThe name of the academic interval that the summary covers.Big, 68.068.0
activeRestrictionCountIntegerThe number of active financial restrictions (holds) on the student’s account. Currently returns 0 because of a known issue, which will be fixed in an upcoming patch.Big, 68.068.0
hasActivityBooleanIndicates whether the student has any financial activity for the selected academic interval.Big, 68.068.0
nextPaymentDueDateStringThe earliest upcoming payment due date across the student’s unpaid invoices.Big, 68.068.0
primaryCurrencyStringThe org’s default/corporate currency (ISO 4217).Big, 68.068.0
summariesByCurrencyStudent Financial Summary by Currency[]The financial summary amounts, grouped by currency.Big, 68.068.0