GET api/Student/Payments?sessionId={sessionId}&studentId={studentId}&RegNumber={RegNumber}&sessionName={sessionName}

Get Student Payment breakdown

Request Information

Parameters

Name	Description	Additional information
sessionId	Optional, returns payment for all sessions when missing and sessionName is not provided	Define this parameter in the request URI.
studentId	Optional, returns payment for student having the token sent when missing and regNumber is not provider	Define this parameter in the request URI.
RegNumber	Optional, returns payment for student having the token sent when missing and studentId is not provider	Define this parameter in the request URI.
sessionName	Optional, returns payment for all session when missing and sessionId is not provided	Define this parameter in the request URI.

Response Information

Student Payment

Response body formats

application/json, text/json

Sample:

{
  "SessionId": 1,
  "StudentId": 2,
  "IsActiveSession": true,
  "SessionName": "sample string 4",
  "RegNumber": "sample string 5",
  "Name": "sample string 6",
  "AmountPaid": 7.0,
  "PaymentItems": [
    {
      "Amount": 1.0,
      "AmountPaid": 2.0,
      "AmountDue": 3.0,
      "Source": "sample string 4",
      "Remark": "sample string 5",
      "IsOptional": true,
      "IsCompulsory": true,
      "Name": "sample string 8",
      "Description": "sample string 9",
      "Code": "sample string 10",
      "SessionId": 11,
      "SessionName": "sample string 12",
      "StudentId": 13
    },
    {
      "Amount": 1.0,
      "AmountPaid": 2.0,
      "AmountDue": 3.0,
      "Source": "sample string 4",
      "Remark": "sample string 5",
      "IsOptional": true,
      "IsCompulsory": true,
      "Name": "sample string 8",
      "Description": "sample string 9",
      "Code": "sample string 10",
      "SessionId": 11,
      "SessionName": "sample string 12",
      "StudentId": 13
    },
    {
      "Amount": 1.0,
      "AmountPaid": 2.0,
      "AmountDue": 3.0,
      "Source": "sample string 4",
      "Remark": "sample string 5",
      "IsOptional": true,
      "IsCompulsory": true,
      "Name": "sample string 8",
      "Description": "sample string 9",
      "Code": "sample string 10",
      "SessionId": 11,
      "SessionName": "sample string 12",
      "StudentId": 13
    }
  ],
  "Installments": [
    {
      "Amount": 1.0,
      "DueDate": "2025-05-30T05:50:49.4488208+00:00",
      "SessionPaymentTemplateId": 3,
      "Name": "sample string 4",
      "SessionId": 5,
      "StudentId": 6,
      "SessionName": "sample string 7"
    },
    {
      "Amount": 1.0,
      "DueDate": "2025-05-30T05:50:49.4488208+00:00",
      "SessionPaymentTemplateId": 3,
      "Name": "sample string 4",
      "SessionId": 5,
      "StudentId": 6,
      "SessionName": "sample string 7"
    },
    {
      "Amount": 1.0,
      "DueDate": "2025-05-30T05:50:49.4488208+00:00",
      "SessionPaymentTemplateId": 3,
      "Name": "sample string 4",
      "SessionId": 5,
      "StudentId": 6,
      "SessionName": "sample string 7"
    }
  ],
  "PaymentSummary": [
    {
      "PaymentType": "sample string 1",
      "NumberOfItems": "sample string 2",
      "Amount": "sample string 3",
      "AmountPaid": "sample string 4",
      "AmountOutstanding": "sample string 5",
      "SessionId": 6,
      "StudentId": 7,
      "SessionName": "sample string 8"
    },
    {
      "PaymentType": "sample string 1",
      "NumberOfItems": "sample string 2",
      "Amount": "sample string 3",
      "AmountPaid": "sample string 4",
      "AmountOutstanding": "sample string 5",
      "SessionId": 6,
      "StudentId": 7,
      "SessionName": "sample string 8"
    },
    {
      "PaymentType": "sample string 1",
      "NumberOfItems": "sample string 2",
      "Amount": "sample string 3",
      "AmountPaid": "sample string 4",
      "AmountOutstanding": "sample string 5",
      "SessionId": 6,
      "StudentId": 7,
      "SessionName": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<AllPaymentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eduportal.API.Models">
  <AmountPaid>7</AmountPaid>
  <Installments>
    <InstallmentModel>
      <Amount>1</Amount>
      <DueDate>2025-05-30T05:50:49.4488208+00:00</DueDate>
      <Name>sample string 4</Name>
      <SessionId>5</SessionId>
      <SessionName>sample string 7</SessionName>
      <SessionPaymentTemplateId>3</SessionPaymentTemplateId>
      <StudentId>6</StudentId>
    </InstallmentModel>
    <InstallmentModel>
      <Amount>1</Amount>
      <DueDate>2025-05-30T05:50:49.4488208+00:00</DueDate>
      <Name>sample string 4</Name>
      <SessionId>5</SessionId>
      <SessionName>sample string 7</SessionName>
      <SessionPaymentTemplateId>3</SessionPaymentTemplateId>
      <StudentId>6</StudentId>
    </InstallmentModel>
    <InstallmentModel>
      <Amount>1</Amount>
      <DueDate>2025-05-30T05:50:49.4488208+00:00</DueDate>
      <Name>sample string 4</Name>
      <SessionId>5</SessionId>
      <SessionName>sample string 7</SessionName>
      <SessionPaymentTemplateId>3</SessionPaymentTemplateId>
      <StudentId>6</StudentId>
    </InstallmentModel>
  </Installments>
  <IsActiveSession>true</IsActiveSession>
  <Name>sample string 6</Name>
  <PaymentItems>
    <PaidItemModel>
      <Amount>1</Amount>
      <AmountDue>3</AmountDue>
      <AmountPaid>2</AmountPaid>
      <Code>sample string 10</Code>
      <Description>sample string 9</Description>
      <IsCompulsory>true</IsCompulsory>
      <IsOptional>true</IsOptional>
      <Name>sample string 8</Name>
      <Remark>sample string 5</Remark>
      <SessionId>11</SessionId>
      <SessionName>sample string 12</SessionName>
      <Source>sample string 4</Source>
      <StudentId>13</StudentId>
    </PaidItemModel>
    <PaidItemModel>
      <Amount>1</Amount>
      <AmountDue>3</AmountDue>
      <AmountPaid>2</AmountPaid>
      <Code>sample string 10</Code>
      <Description>sample string 9</Description>
      <IsCompulsory>true</IsCompulsory>
      <IsOptional>true</IsOptional>
      <Name>sample string 8</Name>
      <Remark>sample string 5</Remark>
      <SessionId>11</SessionId>
      <SessionName>sample string 12</SessionName>
      <Source>sample string 4</Source>
      <StudentId>13</StudentId>
    </PaidItemModel>
    <PaidItemModel>
      <Amount>1</Amount>
      <AmountDue>3</AmountDue>
      <AmountPaid>2</AmountPaid>
      <Code>sample string 10</Code>
      <Description>sample string 9</Description>
      <IsCompulsory>true</IsCompulsory>
      <IsOptional>true</IsOptional>
      <Name>sample string 8</Name>
      <Remark>sample string 5</Remark>
      <SessionId>11</SessionId>
      <SessionName>sample string 12</SessionName>
      <Source>sample string 4</Source>
      <StudentId>13</StudentId>
    </PaidItemModel>
  </PaymentItems>
  <PaymentSummary>
    <PaidItemSummaryModel>
      <Amount>sample string 3</Amount>
      <AmountOutstanding>sample string 5</AmountOutstanding>
      <AmountPaid>sample string 4</AmountPaid>
      <NumberOfItems>sample string 2</NumberOfItems>
      <PaymentType>sample string 1</PaymentType>
      <SessionId>6</SessionId>
      <SessionName>sample string 8</SessionName>
      <StudentId>7</StudentId>
    </PaidItemSummaryModel>
    <PaidItemSummaryModel>
      <Amount>sample string 3</Amount>
      <AmountOutstanding>sample string 5</AmountOutstanding>
      <AmountPaid>sample string 4</AmountPaid>
      <NumberOfItems>sample string 2</NumberOfItems>
      <PaymentType>sample string 1</PaymentType>
      <SessionId>6</SessionId>
      <SessionName>sample string 8</SessionName>
      <StudentId>7</StudentId>
    </PaidItemSummaryModel>
    <PaidItemSummaryModel>
      <Amount>sample string 3</Amount>
      <AmountOutstanding>sample string 5</AmountOutstanding>
      <AmountPaid>sample string 4</AmountPaid>
      <NumberOfItems>sample string 2</NumberOfItems>
      <PaymentType>sample string 1</PaymentType>
      <SessionId>6</SessionId>
      <SessionName>sample string 8</SessionName>
      <StudentId>7</StudentId>
    </PaidItemSummaryModel>
  </PaymentSummary>
  <RegNumber>sample string 5</RegNumber>
  <SessionId>1</SessionId>
  <SessionName>sample string 4</SessionName>
  <StudentId>2</StudentId>
</AllPaymentsModel>