View Loan Schedule

To retrieve a loan repayment schedule, send a GET request to the endpoint below, along with the loan accountNumber in the request query. GET /api/LoanAccount/v1/viewloanschedule

The response will contain the loan repayment schedule information, including details such as loan amounts, due dates, and outstanding loan fees. This feature provides convenient access to loan repayment schedules, thereby facilitating effective management of loan-related data.

Headers

Name	Value
Content-Type*	application/json
Authorization*	Bearer <token>
Request-Reference	{unique-reference}

Query Parameter

Name	Data Type (length)	Description
accountNumber	string	The unique number identifying the loan account

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/LoanAccount/v1/Search?AccountNumber=1000002992&CustomerID=001&AccountName=Test&ProductCode=001&AccountOfficerCode=002&AccountStatus=Active&HasDisbursed=Yes&StartDate=2022-01-01&EndDate=2022-03-09&PageNumber=1&PageSize=10&SortColumn=DateCreated&Direction=asc' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''

Respose: 200

{
  "status": true,
  "message": "string",
  "data": {
    "data": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "accountNumber": "string",
        "name": "string",
        "accountStatus": "string",
        "customerID": "string",
        "linkedNumber": "string",
        "accountOfficerCode": "string",
        "productCode": "string",
        "lendingModel": "string",
        "economicSector": "string",
        "guarantorID1": "string",
        "guarantor1": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "customerID": "string",
          "name": "string",
          "phoneNumber": "string"
        },
        "guarantorID2": "string",
        "guarantor2": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "customerID": "string",
          "name": "string",
          "phoneNumber": "string"
        },
        "penaltyGracePeriod": 0,
        "loanAmount": 0,
        "dateCreated": "2023-01-29T15:05:30.196Z",
        "dateLastModified": "2023-01-29T15:05:30.196Z",
        "approvedDate": "2023-01-29T15:05:30.196Z",
        "interestCommencementDate": "2023-01-29T15:05:30.196Z",
        "tenure": 0,
        "startDate": "2023-01-29T15:05:30.196Z",
        "maturityDate": "2023-01-29T15:05:30.196Z",
        "installmentAmount": 0,
        "hasCollateralPledge": true,
        "collateralType": "string",
        "collateralValuation": 0,
        "collateralDescription": "string",
        "principalRepaymentType": "string",
        "principalFrequency": "string",
        "principalToBeRepaidEvery": 0,
        "principalInstallment": 0,
        "applicableInterestCode": "string",
        "interestName": "string",
        "useProductInterestRate": true,
        "applicableInterestRate": 0,
        "defaultingInterestRate": 0,
        "interestRepaymentType": "string",
        "interestFrequency": "string",
        "interestToBeRepaidEvery": 0,
        "interestInstallment": 0,
        "interestAccrualMode": "string",
        "interestFreePrincipalAmount": 0,
        "securityDeposit": 0,
        "applyLoanFees": true,
        "productName": "string",
        "accountOfficerName": "string",
        "branchName": "string",
        "ledgerBalance": 0,
        "unpaidPrincipal": 0,
        "outstandingLoanPrincipal": 0,
        "outstandingLoanInterest": 0,
        "outstandingLoanFee": 0,
        "hasDisbursed": true,
        "hasOutstandingLoan": true,
        "dateCreatedFinancial": "2023-01-29T15:05:30.196Z",
        "firstInstallmentDate": "2023-01-29T15:05:30.196Z",
        "closureDate": "2023-01-29T15:05:30.196Z",
        "enableRepaymentTracker": true,
        "repaymentTrackerInDays": 0,
        "loanFees": [
          {
            "loanFeeCode": "string"
          }
        ],
        "paymentSchedules": [
          {
            "loanAccountNumber": "string",
            "linkedNumber": "string",
            "principal": 0,
            "interest": 0,
            "fee": 0,
            "totalRepayment": 0,
            "paymentDate": "string",
            "paymentDate_Date": "2023-01-29T15:05:30.196Z",
            "hasProcessed": true,
            "paymentStatus": "string"
          }
        ]
      }
    ],
    "recordCount": 0
  }
}