POST api/feepayments/pay

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SchoolId	integer	None.
PupilId	integer	None.
AcademicYear	integer	None.
Term	integer	None.
AccountId	integer	None.
ParentName	string	None.
PupilFullName	string	None.
Phone	string	None.
Network	string	None.
Amount	decimal number	None.
GrossAmount	decimal number	None.
DiscountAmount	decimal number	None.
Splits	Collection of FeePaymentSplitItem	None.
Discounts	Collection of FeePaymentDiscountItem	None.
Reference	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SchoolId": 1,
  "PupilId": 2,
  "AcademicYear": 3,
  "Term": 1,
  "AccountId": 1,
  "ParentName": "sample string 4",
  "PupilFullName": "sample string 5",
  "Phone": "sample string 6",
  "Network": "sample string 7",
  "Amount": 8.0,
  "GrossAmount": 9.0,
  "DiscountAmount": 10.0,
  "Splits": [
    {
      "FeeAmountId": 1,
      "AssignmentId": 1,
      "AmountApplied": 1.0,
      "AcademicYear": 1
    },
    {
      "FeeAmountId": 1,
      "AssignmentId": 1,
      "AmountApplied": 1.0,
      "AcademicYear": 1
    }
  ],
  "Discounts": [
    {
      "DiscountId": 1,
      "DiscountedAmount": 2.0
    },
    {
      "DiscountId": 1,
      "DiscountedAmount": 2.0
    }
  ],
  "Reference": "sample string 11"
}

application/xml, text/xml

Sample:

<FeePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/zamprepapi.Models.Fees">
  <AcademicYear>3</AcademicYear>
  <AccountId>1</AccountId>
  <Amount>8</Amount>
  <DiscountAmount>10</DiscountAmount>
  <Discounts>
    <FeePaymentDiscountItem>
      <DiscountId>1</DiscountId>
      <DiscountedAmount>2</DiscountedAmount>
    </FeePaymentDiscountItem>
    <FeePaymentDiscountItem>
      <DiscountId>1</DiscountId>
      <DiscountedAmount>2</DiscountedAmount>
    </FeePaymentDiscountItem>
  </Discounts>
  <GrossAmount>9</GrossAmount>
  <Network>sample string 7</Network>
  <ParentName>sample string 4</ParentName>
  <Phone>sample string 6</Phone>
  <PupilFullName>sample string 5</PupilFullName>
  <PupilId>2</PupilId>
  <Reference>sample string 11</Reference>
  <SchoolId>1</SchoolId>
  <Splits>
    <FeePaymentSplitItem>
      <AcademicYear>1</AcademicYear>
      <AmountApplied>1</AmountApplied>
      <AssignmentId>1</AssignmentId>
      <FeeAmountId>1</FeeAmountId>
    </FeePaymentSplitItem>
    <FeePaymentSplitItem>
      <AcademicYear>1</AcademicYear>
      <AmountApplied>1</AmountApplied>
      <AssignmentId>1</AssignmentId>
      <FeeAmountId>1</FeeAmountId>
    </FeePaymentSplitItem>
  </Splits>
  <Term>1</Term>
</FeePaymentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.