GET api/Student/PaymentDues?invtype={invtype}&cid={cid}&cattempt={cattempt}&duedate={duedate}

Get student payment due list

Request Information

URI Parameters

Name	Description	Type	Additional information
invtype	Invoice type (Tuition fee, miscellaneous fee, etc)	string	None.
cid	Unique course code that student enrolled and is studying. Use this field to do filter by course.	string	None.
cattempt	Attempt of student course enrolled and studied. Expecting whole positive number (1, 2, 3,...)	string	None.
duedate	Date format (e.g. dd/mm/yyyy) to check against due date You can specify exact date matching by duedate=1/1/2016. Or specify a range of date to bring all student payment due date under the date range (duedate=1/1/2016-28/2/2016). Or specify a from date onward against student payment due date (duedate=1/1/2016-). Or specify a last date against student payment due date (duedate=-28/2/2016).	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of StdPaymentInvoiceModels

Name	Description	Type	Additional information
InvoiceType	Invoice type (Tuition fee, miscellaneous fee, etc)	string	Required
InvoiceNumber	Invoice number	string	Required
StudentId	Unique RTO student identifier	string	Required
CourseId	Unique course code that student enrolled and is studying. Use this field to do filter by course.	string	Required
CourseAttempt	Attempt of student course enrolled and studied	integer	Required
DueDate	Payment due date	date	Required Data type: Date
Fees	Amount fee/charge shown in the invoice	decimal number	Required Data type: Currency
AmountPaid	Amount that was already paid	decimal number	Required Data type: Currency
AmountRefunded	Amount that has been refunded	decimal number	Required Data type: Currency
BalanceDue	The outstanding balance to pay	decimal number	Required Data type: Currency
CurrencyCode	Display currency code	string	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "InvoiceType": "sample string 1",
    "InvoiceNumber": "sample string 2",
    "StudentId": "sample string 3",
    "CourseId": "sample string 4",
    "CourseAttempt": 5,
    "DueDate": "2025-04-27T00:14:50.938519+10:00",
    "Fees": 7.0,
    "AmountPaid": 8.0,
    "AmountRefunded": 9.0,
    "BalanceDue": 10.0,
    "CurrencyCode": "sample string 11"
  },
  {
    "InvoiceType": "sample string 1",
    "InvoiceNumber": "sample string 2",
    "StudentId": "sample string 3",
    "CourseId": "sample string 4",
    "CourseAttempt": 5,
    "DueDate": "2025-04-27T00:14:50.938519+10:00",
    "Fees": 7.0,
    "AmountPaid": 8.0,
    "AmountRefunded": 9.0,
    "BalanceDue": 10.0,
    "CurrencyCode": "sample string 11"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStdPaymentInvoiceModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileApp_WebAPI.Models.Students">
  <StdPaymentInvoiceModels>
    <AmountPaid>8</AmountPaid>
    <AmountRefunded>9</AmountRefunded>
    <BalanceDue>10</BalanceDue>
    <CourseAttempt>5</CourseAttempt>
    <CourseId>sample string 4</CourseId>
    <CurrencyCode>sample string 11</CurrencyCode>
    <DueDate>2025-04-27T00:14:50.938519+10:00</DueDate>
    <Fees>7</Fees>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceType>sample string 1</InvoiceType>
    <StudentId>sample string 3</StudentId>
  </StdPaymentInvoiceModels>
  <StdPaymentInvoiceModels>
    <AmountPaid>8</AmountPaid>
    <AmountRefunded>9</AmountRefunded>
    <BalanceDue>10</BalanceDue>
    <CourseAttempt>5</CourseAttempt>
    <CourseId>sample string 4</CourseId>
    <CurrencyCode>sample string 11</CurrencyCode>
    <DueDate>2025-04-27T00:14:50.938519+10:00</DueDate>
    <Fees>7</Fees>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceType>sample string 1</InvoiceType>
    <StudentId>sample string 3</StudentId>
  </StdPaymentInvoiceModels>
</ArrayOfStdPaymentInvoiceModels>