GET api/v{version}/RecurringPayment/{districtId}/GetRecurringPaymentDetails
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
districtId | integer |
Required |
|
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
RecurringPaymentModelName | Description | Type | Additional information |
---|---|---|---|
IsScheduled | boolean |
None. |
|
WalletId | integer |
None. |
|
WalletName | string |
None. |
|
AutoPaymentType | string |
None. |
|
NextPaymentDate | date |
None. |
|
LowBalanceThreshold | decimal number |
None. |
|
NumberOfPayments | integer |
None. |
|
RecurringStudentItems | Collection of RecurringStudentItem |
None. |
|
FeesBreakdown | Collection of FeesBreakdown |
None. |
|
Total | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsScheduled": true, "WalletId": 2, "WalletName": "sample string 3", "AutoPaymentType": "sample string 4", "NextPaymentDate": "2024-12-03T18:30:46.6504462-05:00", "LowBalanceThreshold": 6.0, "NumberOfPayments": 7, "RecurringStudentItems": [ { "StudentId": 1, "StudentName": "sample string 2", "Amount": 3.0, "StudentImage": "sample string 4" }, { "StudentId": 1, "StudentName": "sample string 2", "Amount": 3.0, "StudentImage": "sample string 4" } ], "FeesBreakdown": [ { "DistrictFee": 1.0, "IsLunchFee": true, "ParentFee": 3.0, "Title": "sample string 4" }, { "DistrictFee": 1.0, "IsLunchFee": true, "ParentFee": 3.0, "Title": "sample string 4" } ], "Total": 8.0 }
application/xml, text/xml
Sample:
<RecurringPaymentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models"> <AutoPaymentType>sample string 4</AutoPaymentType> <FeesBreakdown> <FeesBreakdown> <DistrictFee>1</DistrictFee> <IsLunchFee>true</IsLunchFee> <ParentFee>3</ParentFee> <Title>sample string 4</Title> </FeesBreakdown> <FeesBreakdown> <DistrictFee>1</DistrictFee> <IsLunchFee>true</IsLunchFee> <ParentFee>3</ParentFee> <Title>sample string 4</Title> </FeesBreakdown> </FeesBreakdown> <IsScheduled>true</IsScheduled> <LowBalanceThreshold>6</LowBalanceThreshold> <NextPaymentDate>2024-12-03T18:30:46.6504462-05:00</NextPaymentDate> <NumberOfPayments>7</NumberOfPayments> <RecurringStudentItems> <RecurringStudentItem> <Amount>3</Amount> <StudentId>1</StudentId> <StudentImage>sample string 4</StudentImage> <StudentName>sample string 2</StudentName> </RecurringStudentItem> <RecurringStudentItem> <Amount>3</Amount> <StudentId>1</StudentId> <StudentImage>sample string 4</StudentImage> <StudentName>sample string 2</StudentName> </RecurringStudentItem> </RecurringStudentItems> <Total>8</Total> <WalletId>2</WalletId> <WalletName>sample string 3</WalletName> </RecurringPaymentModel>