POST InvoicesAPI/RemoveInvoice

Request Information

URI Parameters

None.

Body Parameters

Invoices
NameDescriptionTypeAdditional information
InvoiceID

integer

None.

AmountDue

decimal number

None.

AmountDueOtherFees

decimal number

None.

AmountPaidOtherFees

decimal number

None.

AmountPaidScholarship

decimal number

None.

AmountPaidCreditMemo

decimal number

None.

CreditMemoID

integer

None.

AmountTuitionDepositApplied

decimal number

None.

AmountRemainingCreditMemo

decimal number

None.

ApplicationID

integer

None.

AssetReservationID

integer

None.

AmountPaid

decimal number

None.

TuitionDepositsTotalPaid

decimal number

None.

DiscountsApplied

string

None.

TheInvoiceDate

date

None.

TheInvoiceDateStr

string

None.

InvoiceType

string

None.

Department

string

None.

InvoiceDescription

string

None.

Notes

string

None.

OtherFeesDescription

string

None.

PeopleIDSchoolRep

integer

None.

PeopleIDStudent

integer

None.

PeoplePayerName

string

None.

PeopleSchoolRepName

string

None.

PeopleStudentName

string

None.

Programme

string

None.

pkSemesterID

integer

None.

SchoolYearBeginning

integer

None.

SemesterID

string

None.

SendTheMail

string

None.

IsPaySuccessful

boolean

None.

UserName

string

None.

TransID

string

None.

RefundTrnsactionID

string

None.

QMAFeeForTerm

string

None.

EmailMother

string

None.

EmailFather

string

None.

PhoneMother

string

None.

PhoneFather

string

None.

PhoneStudent

string

None.

FailureDescrption

string

None.

DBUnpaidInvoiceID

integer

None.

DatePaid

date

None.

ClassesForFeesList

Collection of LineItems

None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceID": 1,
  "AmountDue": 2.0,
  "AmountDueOtherFees": 3.0,
  "AmountPaidOtherFees": 4.0,
  "AmountPaidScholarship": 5.0,
  "AmountPaidCreditMemo": 6.0,
  "CreditMemoID": 7,
  "AmountTuitionDepositApplied": 8.0,
  "AmountRemainingCreditMemo": 9.0,
  "ApplicationID": 10,
  "AssetReservationID": 11,
  "AmountPaid": 12.0,
  "TuitionDepositsTotalPaid": 13.0,
  "DiscountsApplied": "sample string 14",
  "TheInvoiceDate": "2024-04-20T02:32:47.2756181+01:00",
  "TheInvoiceDateStr": "sample string 16",
  "InvoiceType": "sample string 17",
  "Department": "sample string 18",
  "InvoiceDescription": "sample string 19",
  "Notes": "sample string 20",
  "OtherFeesDescription": "sample string 21",
  "PeopleIDSchoolRep": 22,
  "PeopleIDStudent": 23,
  "PeoplePayerName": "sample string 24",
  "PeopleSchoolRepName": "sample string 25",
  "PeopleStudentName": "sample string 26",
  "Programme": "sample string 27",
  "pkSemesterID": 28,
  "SchoolYearBeginning": 29,
  "SemesterID": "sample string 30",
  "SendTheMail": "sample string 31",
  "IsPaySuccessful": true,
  "UserName": "sample string 33",
  "TransID": "sample string 34",
  "RefundTrnsactionID": "sample string 35",
  "QMAFeeForTerm": "sample string 36",
  "EmailMother": "sample string 37",
  "EmailFather": "sample string 38",
  "PhoneMother": "sample string 39",
  "PhoneFather": "sample string 40",
  "PhoneStudent": "sample string 41",
  "FailureDescrption": "sample string 42",
  "DBUnpaidInvoiceID": 1,
  "DatePaid": "2024-04-20T02:32:47.2756181+01:00",
  "ClassesForFeesList": [
    {
      "LineItemID": 1,
      "ItemTitle": "sample string 2",
      "InvoiceID": 3,
      "ItemDescription": "sample string 4",
      "ItemPrice": 5.0,
      "PKCourseSectionID": 6,
      "CourseSectionID": "sample string 7",
      "LineItemClassFeeTotal": 8.0
    },
    {
      "LineItemID": 1,
      "ItemTitle": "sample string 2",
      "InvoiceID": 3,
      "ItemDescription": "sample string 4",
      "ItemPrice": 5.0,
      "PKCourseSectionID": 6,
      "CourseSectionID": "sample string 7",
      "LineItemClassFeeTotal": 8.0
    }
  ]
}

application/xml, text/xml

Sample:
<Invoices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QMA2020.Models">
  <AmountDue>2</AmountDue>
  <AmountDueOtherFees>3</AmountDueOtherFees>
  <AmountPaid>12</AmountPaid>
  <AmountPaidCreditMemo>6</AmountPaidCreditMemo>
  <AmountPaidOtherFees>4</AmountPaidOtherFees>
  <AmountPaidScholarship>5</AmountPaidScholarship>
  <AmountRemainingCreditMemo>9</AmountRemainingCreditMemo>
  <AmountTuitionDepositApplied>8</AmountTuitionDepositApplied>
  <ApplicationID>10</ApplicationID>
  <AssetReservationID>11</AssetReservationID>
  <ClassesForFeesList>
    <LineItems>
      <CourseSectionID>sample string 7</CourseSectionID>
      <InvoiceID>3</InvoiceID>
      <ItemDescription>sample string 4</ItemDescription>
      <ItemPrice>5</ItemPrice>
      <ItemTitle>sample string 2</ItemTitle>
      <LineItemClassFeeTotal>8</LineItemClassFeeTotal>
      <LineItemID>1</LineItemID>
      <PKCourseSectionID>6</PKCourseSectionID>
    </LineItems>
    <LineItems>
      <CourseSectionID>sample string 7</CourseSectionID>
      <InvoiceID>3</InvoiceID>
      <ItemDescription>sample string 4</ItemDescription>
      <ItemPrice>5</ItemPrice>
      <ItemTitle>sample string 2</ItemTitle>
      <LineItemClassFeeTotal>8</LineItemClassFeeTotal>
      <LineItemID>1</LineItemID>
      <PKCourseSectionID>6</PKCourseSectionID>
    </LineItems>
  </ClassesForFeesList>
  <CreditMemoID>7</CreditMemoID>
  <DBUnpaidInvoiceID>1</DBUnpaidInvoiceID>
  <DatePaid>2024-04-20T02:32:47.2756181+01:00</DatePaid>
  <Department>sample string 18</Department>
  <DiscountsApplied>sample string 14</DiscountsApplied>
  <EmailFather>sample string 38</EmailFather>
  <EmailMother>sample string 37</EmailMother>
  <FailureDescrption>sample string 42</FailureDescrption>
  <InvoiceDescription>sample string 19</InvoiceDescription>
  <InvoiceID>1</InvoiceID>
  <InvoiceType>sample string 17</InvoiceType>
  <IsPaySuccessful>true</IsPaySuccessful>
  <Notes>sample string 20</Notes>
  <OtherFeesDescription>sample string 21</OtherFeesDescription>
  <PeopleIDSchoolRep>22</PeopleIDSchoolRep>
  <PeopleIDStudent>23</PeopleIDStudent>
  <PeoplePayerName>sample string 24</PeoplePayerName>
  <PeopleSchoolRepName>sample string 25</PeopleSchoolRepName>
  <PeopleStudentName>sample string 26</PeopleStudentName>
  <PhoneFather>sample string 40</PhoneFather>
  <PhoneMother>sample string 39</PhoneMother>
  <PhoneStudent>sample string 41</PhoneStudent>
  <Programme>sample string 27</Programme>
  <QMAFeeForTerm>sample string 36</QMAFeeForTerm>
  <RefundTrnsactionID>sample string 35</RefundTrnsactionID>
  <SchoolYearBeginning>29</SchoolYearBeginning>
  <SemesterID>sample string 30</SemesterID>
  <SendTheMail>sample string 31</SendTheMail>
  <TheInvoiceDate>2024-04-20T02:32:47.2756181+01:00</TheInvoiceDate>
  <TheInvoiceDateStr>sample string 16</TheInvoiceDateStr>
  <TransID>sample string 34</TransID>
  <TuitionDepositsTotalPaid>13</TuitionDepositsTotalPaid>
  <UserName>sample string 33</UserName>
  <pkSemesterID>28</pkSemesterID>
</Invoices>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>