PUT api/v1/finance_PrePaymentTransaction/{prePaymentTransactionId}/prePaymentTransactionId

Request Information

URI Parameters

Name	Description	Type	Additional information
prePaymentTransactionId		integer	Required

Body Parameters

Finance_PrePaymentTransactionVM

Name	Type	Additional information
prePaymentTransactionId	integer	None.
referenceNumber	string	None.
chartOfAccountId	integer	None.
transactionTypeId	integer	None.
amount	decimal number	None.
vat	decimal number	None.
transactionDate	date	None.
studentId	integer	None.
studentReferenceNumber	string	None.
paymentStatusId	integer	None.
academicSessionId	integer	None.
description	string	None.
tenantId	integer	None.
dateCreated	date	None.
isApproved	boolean	None.
currencyId	integer	None.
createdBy	integer	None.
paymentTypeName	string	None.
academicSessionName	string	None.
isEvidenceUploaded	boolean	None.
evidenceUploaded	string	None.
paymentStatusName	string	None.
isConfirmed	boolean	None.
paymentEvidenceId	integer	None.
total	decimal number	None.
fileLink	string	None.
paymentTypeId	integer	None.
isFeeWaiverApply	boolean	None.
discountedAmount	decimal number	None.
linkedId	string	None.
chartOfAccountName	Object	None.
paymentType	string	None.
currencyName	string	None.
isApprovedName	string	None.
feeItems	Collection of FeeItems	None.
bank	Collection of Finance_BankVM	None.
totalFee	decimal number	None.
documentId	integer	None.
depositorName	string	None.
schoolName	string	None.
programmeName	string	None.
fees	Collection of Finance_FeeStructureVM	None.

Request Formats

application/json, text/json

Sample:

{
  "prePaymentTransactionId": 1,
  "referenceNumber": "sample string 2",
  "chartOfAccountId": 1,
  "transactionTypeId": 1,
  "amount": 3.0,
  "vat": 4.0,
  "transactionDate": "2025-11-03T12:08:03.8445674-08:00",
  "studentId": 1,
  "studentReferenceNumber": "sample string 5",
  "paymentStatusId": 1,
  "academicSessionId": 1,
  "description": "sample string 6",
  "tenantId": 1,
  "dateCreated": "2025-11-03T12:08:03.8455672-08:00",
  "isApproved": true,
  "currencyId": 1,
  "createdBy": 7,
  "paymentTypeName": "sample string 8",
  "academicSessionName": "sample string 9",
  "isEvidenceUploaded": true,
  "evidenceUploaded": "sample string 10",
  "paymentStatusName": "sample string 11",
  "isConfirmed": true,
  "paymentEvidenceId": 1,
  "total": 12.0,
  "fileLink": "sample string 13",
  "paymentTypeId": 1,
  "isFeeWaiverApply": true,
  "discountedAmount": 15.0,
  "linkedId": "sample string 16",
  "chartOfAccountName": {},
  "paymentType": "sample string 18",
  "currencyName": "sample string 19",
  "isApprovedName": "sample string 20",
  "feeItems": [
    {
      "feeItem": "sample string 1",
      "vat": 2.0,
      "amount": 3.0,
      "bank": "sample string 4",
      "accountNumber": "sample string 5",
      "accountName": "sample string 6"
    },
    {
      "feeItem": "sample string 1",
      "vat": 2.0,
      "amount": 3.0,
      "bank": "sample string 4",
      "accountNumber": "sample string 5",
      "accountName": "sample string 6"
    }
  ],
  "bank": [
    {
      "financeBankId": 1,
      "bankName": "sample string 2",
      "accountName": "sample string 3",
      "accountNumber": "sample string 4",
      "branchName": "sample string 5",
      "currencyTypeId": 1,
      "branchAddress": "sample string 6",
      "description": "sample string 7",
      "creditFor": "sample string 8",
      "dateCreated": "2025-11-03T12:08:03.8465668-08:00",
      "tenantId": 1,
      "isActive": true,
      "createdBy": 9,
      "currencyTypeName": "sample string 10"
    },
    {
      "financeBankId": 1,
      "bankName": "sample string 2",
      "accountName": "sample string 3",
      "accountNumber": "sample string 4",
      "branchName": "sample string 5",
      "currencyTypeId": 1,
      "branchAddress": "sample string 6",
      "description": "sample string 7",
      "creditFor": "sample string 8",
      "dateCreated": "2025-11-03T12:08:03.8465668-08:00",
      "tenantId": 1,
      "isActive": true,
      "createdBy": 9,
      "currencyTypeName": "sample string 10"
    }
  ],
  "totalFee": 21.0,
  "documentId": 1,
  "depositorName": "sample string 22",
  "schoolName": "sample string 23",
  "programmeName": "sample string 24",
  "fees": [
    {
      "financeFeeStructureId": 1,
      "academicDegreeTypeId": 1,
      "academicFacultyId": 1,
      "academicFacultyIds": [
        1,
        2
      ],
      "academicDepartmentIds": [
        1,
        2
      ],
      "academicDepartmentId": 1,
      "academicDegreeProgrammeId": 1,
      "academicDegreeProgrammeIds": [
        1,
        2
      ],
      "academicLevelIds": [
        1,
        2
      ],
      "academicLevelId": 1,
      "amount": 2.0,
      "financeFeeCategoryId": 1,
      "academicSessionId": 1,
      "isVatApply": true,
      "dateCreated": "2025-11-03T12:08:03.8475737-08:00",
      "isActive": true,
      "tenantId": 1,
      "financeFeeItemId": 1,
      "academicDegreeTypeName": "sample string 3",
      "academicFacultyName": "sample string 4",
      "academicDepartmentName": "sample string 5",
      "academicDegreeProgrammeName": "sample string 6",
      "academicLevelName": "sample string 7",
      "academicSessionName": "sample string 8",
      "financeFeeItemName": "sample string 9",
      "vat": 10.0,
      "vatAmount": 0.2,
      "total": 2.2,
      "admissionTypeId": 1,
      "academicSemesterId": 1,
      "academicSemesterName": "sample string 11",
      "admissionTypeName": "sample string 12",
      "intakeName": "sample string 13",
      "postgraduateTypeId": 1,
      "chartOfAccountId": 1
    },
    {
      "financeFeeStructureId": 1,
      "academicDegreeTypeId": 1,
      "academicFacultyId": 1,
      "academicFacultyIds": [
        1,
        2
      ],
      "academicDepartmentIds": [
        1,
        2
      ],
      "academicDepartmentId": 1,
      "academicDegreeProgrammeId": 1,
      "academicDegreeProgrammeIds": [
        1,
        2
      ],
      "academicLevelIds": [
        1,
        2
      ],
      "academicLevelId": 1,
      "amount": 2.0,
      "financeFeeCategoryId": 1,
      "academicSessionId": 1,
      "isVatApply": true,
      "dateCreated": "2025-11-03T12:08:03.8475737-08:00",
      "isActive": true,
      "tenantId": 1,
      "financeFeeItemId": 1,
      "academicDegreeTypeName": "sample string 3",
      "academicFacultyName": "sample string 4",
      "academicDepartmentName": "sample string 5",
      "academicDegreeProgrammeName": "sample string 6",
      "academicLevelName": "sample string 7",
      "academicSessionName": "sample string 8",
      "financeFeeItemName": "sample string 9",
      "vat": 10.0,
      "vatAmount": 0.2,
      "total": 2.2,
      "admissionTypeId": 1,
      "academicSemesterId": 1,
      "academicSemesterName": "sample string 11",
      "admissionTypeName": "sample string 12",
      "intakeName": "sample string 13",
      "postgraduateTypeId": 1,
      "chartOfAccountId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<Finance_PrePaymentTransactionVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Data.TransferObject.ViewModel">
  <academicSessionId>1</academicSessionId>
  <academicSessionName>sample string 9</academicSessionName>
  <amount>3</amount>
  <bank>
    <Finance_BankVM>
      <accountName>sample string 3</accountName>
      <accountNumber>sample string 4</accountNumber>
      <bankName>sample string 2</bankName>
      <branchAddress>sample string 6</branchAddress>
      <branchName>sample string 5</branchName>
      <createdBy>9</createdBy>
      <creditFor>sample string 8</creditFor>
      <currencyTypeId>1</currencyTypeId>
      <currencyTypeName>sample string 10</currencyTypeName>
      <dateCreated>2025-11-03T12:08:03.8465668-08:00</dateCreated>
      <description>sample string 7</description>
      <financeBankId>1</financeBankId>
      <isActive>true</isActive>
      <tenantId>1</tenantId>
    </Finance_BankVM>
    <Finance_BankVM>
      <accountName>sample string 3</accountName>
      <accountNumber>sample string 4</accountNumber>
      <bankName>sample string 2</bankName>
      <branchAddress>sample string 6</branchAddress>
      <branchName>sample string 5</branchName>
      <createdBy>9</createdBy>
      <creditFor>sample string 8</creditFor>
      <currencyTypeId>1</currencyTypeId>
      <currencyTypeName>sample string 10</currencyTypeName>
      <dateCreated>2025-11-03T12:08:03.8465668-08:00</dateCreated>
      <description>sample string 7</description>
      <financeBankId>1</financeBankId>
      <isActive>true</isActive>
      <tenantId>1</tenantId>
    </Finance_BankVM>
  </bank>
  <chartOfAccountId>1</chartOfAccountId>
  <chartOfAccountName />
  <createdBy>7</createdBy>
  <currencyId>1</currencyId>
  <currencyName>sample string 19</currencyName>
  <dateCreated>2025-11-03T12:08:03.8455672-08:00</dateCreated>
  <depositorName>sample string 22</depositorName>
  <description>sample string 6</description>
  <discountedAmount>15</discountedAmount>
  <documentId>1</documentId>
  <evidenceUploaded>sample string 10</evidenceUploaded>
  <feeItems>
    <FeeItems>
      <accountName>sample string 6</accountName>
      <accountNumber>sample string 5</accountNumber>
      <amount>3</amount>
      <bank>sample string 4</bank>
      <feeItem>sample string 1</feeItem>
      <vat>2</vat>
    </FeeItems>
    <FeeItems>
      <accountName>sample string 6</accountName>
      <accountNumber>sample string 5</accountNumber>
      <amount>3</amount>
      <bank>sample string 4</bank>
      <feeItem>sample string 1</feeItem>
      <vat>2</vat>
    </FeeItems>
  </feeItems>
  <fees>
    <Finance_FeeStructureVM>
      <academicDegreeProgrammeId>1</academicDegreeProgrammeId>
      <academicDegreeProgrammeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicDegreeProgrammeIds>
      <academicDegreeProgrammeName>sample string 6</academicDegreeProgrammeName>
      <academicDegreeTypeId>1</academicDegreeTypeId>
      <academicDegreeTypeName>sample string 3</academicDegreeTypeName>
      <academicDepartmentId>1</academicDepartmentId>
      <academicDepartmentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicDepartmentIds>
      <academicDepartmentName>sample string 5</academicDepartmentName>
      <academicFacultyId>1</academicFacultyId>
      <academicFacultyIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicFacultyIds>
      <academicFacultyName>sample string 4</academicFacultyName>
      <academicLevelId>1</academicLevelId>
      <academicLevelIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicLevelIds>
      <academicLevelName>sample string 7</academicLevelName>
      <academicSemesterId>1</academicSemesterId>
      <academicSemesterName>sample string 11</academicSemesterName>
      <academicSessionId>1</academicSessionId>
      <academicSessionName>sample string 8</academicSessionName>
      <admissionTypeId>1</admissionTypeId>
      <admissionTypeName>sample string 12</admissionTypeName>
      <amount>2</amount>
      <chartOfAccountId>1</chartOfAccountId>
      <dateCreated>2025-11-03T12:08:03.8475737-08:00</dateCreated>
      <financeFeeCategoryId>1</financeFeeCategoryId>
      <financeFeeItemId>1</financeFeeItemId>
      <financeFeeItemName>sample string 9</financeFeeItemName>
      <financeFeeStructureId>1</financeFeeStructureId>
      <intakeName>sample string 13</intakeName>
      <isActive>true</isActive>
      <isVatApply>true</isVatApply>
      <postgraduateTypeId>1</postgraduateTypeId>
      <tenantId>1</tenantId>
      <vat>10</vat>
    </Finance_FeeStructureVM>
    <Finance_FeeStructureVM>
      <academicDegreeProgrammeId>1</academicDegreeProgrammeId>
      <academicDegreeProgrammeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicDegreeProgrammeIds>
      <academicDegreeProgrammeName>sample string 6</academicDegreeProgrammeName>
      <academicDegreeTypeId>1</academicDegreeTypeId>
      <academicDegreeTypeName>sample string 3</academicDegreeTypeName>
      <academicDepartmentId>1</academicDepartmentId>
      <academicDepartmentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicDepartmentIds>
      <academicDepartmentName>sample string 5</academicDepartmentName>
      <academicFacultyId>1</academicFacultyId>
      <academicFacultyIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicFacultyIds>
      <academicFacultyName>sample string 4</academicFacultyName>
      <academicLevelId>1</academicLevelId>
      <academicLevelIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </academicLevelIds>
      <academicLevelName>sample string 7</academicLevelName>
      <academicSemesterId>1</academicSemesterId>
      <academicSemesterName>sample string 11</academicSemesterName>
      <academicSessionId>1</academicSessionId>
      <academicSessionName>sample string 8</academicSessionName>
      <admissionTypeId>1</admissionTypeId>
      <admissionTypeName>sample string 12</admissionTypeName>
      <amount>2</amount>
      <chartOfAccountId>1</chartOfAccountId>
      <dateCreated>2025-11-03T12:08:03.8475737-08:00</dateCreated>
      <financeFeeCategoryId>1</financeFeeCategoryId>
      <financeFeeItemId>1</financeFeeItemId>
      <financeFeeItemName>sample string 9</financeFeeItemName>
      <financeFeeStructureId>1</financeFeeStructureId>
      <intakeName>sample string 13</intakeName>
      <isActive>true</isActive>
      <isVatApply>true</isVatApply>
      <postgraduateTypeId>1</postgraduateTypeId>
      <tenantId>1</tenantId>
      <vat>10</vat>
    </Finance_FeeStructureVM>
  </fees>
  <fileLink>sample string 13</fileLink>
  <isApproved>true</isApproved>
  <isApprovedName>sample string 20</isApprovedName>
  <isConfirmed>true</isConfirmed>
  <isEvidenceUploaded>true</isEvidenceUploaded>
  <isFeeWaiverApply>true</isFeeWaiverApply>
  <linkedId>sample string 16</linkedId>
  <paymentEvidenceId>1</paymentEvidenceId>
  <paymentStatusId>1</paymentStatusId>
  <paymentStatusName>sample string 11</paymentStatusName>
  <paymentType>sample string 18</paymentType>
  <paymentTypeId>1</paymentTypeId>
  <paymentTypeName>sample string 8</paymentTypeName>
  <prePaymentTransactionId>1</prePaymentTransactionId>
  <programmeName>sample string 24</programmeName>
  <referenceNumber>sample string 2</referenceNumber>
  <schoolName>sample string 23</schoolName>
  <studentId>1</studentId>
  <studentReferenceNumber>sample string 5</studentReferenceNumber>
  <tenantId>1</tenantId>
  <total>12</total>
  <totalFee>21</totalFee>
  <transactionDate>2025-11-03T12:08:03.8445674-08:00</transactionDate>
  <transactionTypeId>1</transactionTypeId>
  <vat>4</vat>
</Finance_PrePaymentTransactionVM>

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.