Skip to main content

Generate Repayment Schedule for Loan

POST Generate Repayment Schedule

This is the Loan management API used for generating a Repayment Schedule for the loan.

URL: {{base_url}}/loan-management/v1/generateRepaymentSchedule

Request
Request Type: POST
Authorization: Bearer Token

Query Parameter
No Parameter
Request Body Required

{
  "principal_amount": 50000.0, // Replace with the actual principal amount
  "installment_amount": "", // (Optional) Replace with the actual installment amount
  "tenure": 3, // Replace with the actual tenure
  "interest_rate": 5.0, // Replace with the actual interest rate
  "repayment_start_date": "2023-09-01", // Replace with the actual date
  "interest_start_date": "2023-08-01", // Replace with the actual date
  "repayment_properties": {
    "property1": "value1",
    "property2": "value2"
    // Include additional properties and values as needed
  },
  "charges_data": [
    {
      "original_amount": 100.0, // Replace with the actual original amount
      "paid_amount": 50.0, // Replace with the actual paid amount
      "charge_id": "Charge ID 1",
      "charge_rate": 5.0, // Replace with the actual charge rate
      "tax_amount": 10.0, // Replace with the actual tax amount
      "status": "Charge Status 1",
      "receivable_payable": "Receivable/Payable 1",
      "is_tax_applicable": true,
      "pending_amount": 40.0, // Replace with the actual pending amount
      "waived_amount": 15.0, // Replace with the actual waived amount
      "source_id": "Source ID 1",
      "tax_type": "Tax Type 1",
      "amount_without_tax": 90.0, // Replace with the actual amount without tax
      "charge_label": "Charge Label 1",
      "due_date": "2023-10-01", // Replace with the actual due date
      "transaction_date": "2023-09-15" // Replace with the actual transaction date
    },
    {
      // Include properties for the second ChargesRequestDTO object here
    }
    // Include properties for additional ChargesRequestDTO objects as needed
  ],
  "loan_id": 12345, // Replace with the actual loan ID
  "scheme_code": "Scheme Code Value",
  "is_save_db": false,
  "loan_type": "Loan Type Value",
  "frequency": 12, // Replace with the actual frequency
  "disbursal_status": "Disbursal Status Value",
  "start_principle_recovery": true,
  "irr": 8.0, // Replace with the actual IRR value
  "disbursal_date": "2023-09-01", // Replace with the actual date
  "advance_installment": {
    "advance_installment_amount": 1000.0, // Replace with the actual advance installment amount
    "advance_installment_adjustment_time": "Adjustment Time Value",
    "number_of_advance_installment": 3, // Replace with the actual number
    "adjust_from_disbursement": true
  }
}

Response: 200
{
    "response": true,
    "data": [
        {
            "installment_number": "1",
            "due_date": "01/09/2023",
            "opening_balance": 50000.0,
            "installment_amount": 16806.0,
            "principal_component": 16594.0,
            "interest_component": 212.0,
            "effective_rate": 5.0,
            "day": "31",
            "status": null,
            "repayment_schedule_id": null,
            "interest_rate": null,
            "closing_balance": 33406.0,
            "installment_number_int": 1,
            "pending_amount": null,
            "pemi_flag": false,
            "principal_due": null,
            "month": 9,
            "year": 2023,
            "ratio": null,
            "installment_indicator": null,
            "irr": null,
            "tos": null,
            "principal_in_process": null,
            "interest_in_process": null,
            "delay_days": null,
            "advance_prepay_flag": false,
            "late_payment_charges_accrued": 0.0,
            "tds_amount": 0.0
        },
        {
            "installment_number": "2",
            "due_date": "01/10/2023",
            "opening_balance": 33406.0,
            "installment_amount": 16806.0,
            "principal_component": 16669.0,
            "interest_component": 137.0,
            "effective_rate": 5.0,
            "day": "61",
            "status": null,
            "repayment_schedule_id": null,
            "interest_rate": null,
            "closing_balance": 16737.0,
            "installment_number_int": 2,
            "pending_amount": null,
            "pemi_flag": false,
            "principal_due": null,
            "month": 10,
            "year": 2023,
            "ratio": null,
            "installment_indicator": null,
            "irr": null,
            "tos": null,
            "principal_in_process": null,
            "interest_in_process": null,
            "delay_days": null,
            "advance_prepay_flag": false,
            "late_payment_charges_accrued": 0.0,
            "tds_amount": 0.0
        },
        {
            "installment_number": "3",
            "due_date": "01/11/2023",
            "opening_balance": 16737.0,
            "installment_amount": 16808.0,
            "principal_component": 16737.0,
            "interest_component": 71.0,
            "effective_rate": 5.0,
            "day": "92",
            "status": null,
            "repayment_schedule_id": null,
            "interest_rate": null,
            "closing_balance": 0.0,
            "installment_number_int": 3,
            "pending_amount": null,
            "pemi_flag": false,
            "principal_due": null,
            "month": 11,
            "year": 2023,
            "ratio": null,
            "installment_indicator": null,
            "irr": null,
            "tos": null,
            "principal_in_process": null,
            "interest_in_process": null,
            "delay_days": null,
            "advance_prepay_flag": false,
            "late_payment_charges_accrued": 0.0,
            "tds_amount": 0.0
        }
    ],
    "error": null,
    "timestamp": "2023-09-13T07:49:05.865+00:00"
}