# Retrieve a loan schedule

Returns the schedule of the loan specified in the request URL. The loan schedule includes the full details of a loan, such as loan balance, fees, penalities, interests, and all past, present, and future installments of the loan.

Endpoint: GET /v1/loans/{loan_id}/repayment_schedule
Version: 1.0

## Path parameters:

  - `loan_id` (string, required)
    The ID of the loan for which the schedule should be retrieved.

## Response 200 fields (application/json):

  - `loan_balances` (object)
    An overview of the entire loan details, including principal, interests, penalities, and fees as of the current date.

  - `loan_balances.principal` (object, required)
    An object containing information about the loan principal, including current balance, paid and due amounts.

  - `loan_balances.principal.balance` (any, required)
    The total principal amount currently owed on the loan. Balance refers to only overdue and future payments.

  - `loan_balances.principal.due` (any, required)
    The principal amount currently due on the loan.

  - `loan_balances.principal.paid` (any, required)
    The total principal amount paid on the loan as of the current date.

  - `loan_balances.penalty` (object, required)
    An object containing information about the loan applicable penalities, including current balance, paid and due amounts.

  - `loan_balances.penalty.balance` (any, required)
    The total penalities currently owed on the loan. Balance refers to only overdue and future payments.

  - `loan_balances.penalty.due` (any, required)
    The penalty amount currently due on the loan.

  - `loan_balances.penalty.paid` (any, required)
    The total amount of penalities paid on the loan as of the current date.

  - `loan_balances.interest` (object, required)
    An object containing information about the loan interest, including balance, paid and due amounts. Accrued interest isn't reflected in this field, only applied interest is considered.

  - `loan_balances.interest.balance` (any, required)
    The total balance of applied interest expected throughout the loan lifecycle. Balance refers to only overdue and future payments.

  - `loan_balances.interest.due` (any, required)
    The amount of interest currently due on the loan.

  - `loan_balances.interest.paid` (any, required)
    The total amount of interest paid on the loan as of the current date.

  - `loan_balances.interest_from_arrears` (object, required)
    An object containing information about interest from arrears, including balance, paid and due amounts. Only applicable if additional interests in case of arrear is to be applied on the loan.

  - `loan_balances.interest_from_arrears.balance` (any, required)
    The total interest from arrears currently owed on the loan. Balance refers to only overdue and future payments.

  - `loan_balances.interest_from_arrears.due` (any, required)
    The amount of interest from arrears currently due on the loan.

  - `loan_balances.interest_from_arrears.paid` (any, required)
    The amount of interest from arrears paid on the loan as of the current date.

  - `loan_balances.fees` (object, required)
    An object containing information about the loan fees, including balance, paid and due amounts.

  - `loan_balances.fees.balance` (any, required)
    The total balance of applicable fees expected throughout the loan lifecycle. Balance refers to only overdue and future payments.

  - `loan_balances.fees.due` (any, required)
    The amount of fees currently due on the loan.

  - `loan_balances.fees.paid` (any, required)
    The total amount of fees paid on the loan as of the current date.

  - `loan_balances.total` (object, required)
    An object containing information about all the sum of all relevant amounts payable in relation to the loan, including principal, interests, penalities, and fees.

  - `loan_balances.total.balance` (any, required)
    The total amount currently owed on the loan, including principal, penalty, interest, and fees, and excluding accrued interest. Balance refers to only overdue and future payments.

  - `loan_balances.total.due` (any, required)
    The installment amount currently due on the loan that the customer must pay in general or to resolve a dunning case. This amount includes the currently due principal, interest, fees, and/or penalities.

  - `loan_balances.total.paid` (any, required)
    The total amount paid on the loan as of the current date, including principal, interest, fees, and penalities.

  - `loan_balances.total.current_repayment_amount` (any, required)
    The current loan repayment amount, including loan total balance and any accrued interest the customer must pay now to settle the loan in full. This amount is subject to changes daily as interest accrues.

  - `loan_balances.total.loan_expenses` (any, required)
    An object representing the total loan expenses (e.g., costs, fees, penalities incurred during a loan lifecycle). This amount is subject to changes during the loan lifecycle to include fees or penalities that might be charged on the loan. At the loan origination, it's the sum of total principal and total interest.

  - `installments` (array)
    An array of objects containing information about all the loan installments (past, present, and future).

  - `installments.number` (string, required)
    The installment number.
    Example: "5"

  - `installments.due_date` (string, required)
    The due date of the installment.
    Example: "2022-06-23"

  - `installments.state` (string, required)
    The status of an installment.
    Enum: "PENDING", "LATE", "PAID", "PARTIALLY_PAID", "GRACE"

  - `installments.is_payment_holiday` (boolean, required)
    A field to indicate whether a pause has been implemented on the loan installments or not.

  - `installments.total` (object, required)
    An object containing information about an installment, including expected, due, and paid amounts.

  - `installments.total.expected` (any, required)
    The total expected installment amount, including principal, interest, fees, and/or penalities.

  - `installments.total.due` (any, required)
    The total installment amount currently due on the loan, including principal, interest, fees, and/or penalities.

  - `installments.total.paid` (any, required)
    The total installment amount already paid, including principal, interest, fees, and/or penalities.

  - `installments.principal` (object, required)
    An object containing information about the principal amount payable as part of an installment.

  - `installments.principal.expected` (any, required)
    The expected principal amount to be paid as part of an installment.

  - `installments.principal.due` (any, required)
    The principal amount currently due as part of an installment.

  - `installments.principal.paid` (any, required)
    The principal amount that has been paid as part of an installment.

  - `installments.penalty` (object, required)
    An object containing information about the penalty amount payable as part of an installment.

  - `installments.penalty.expected` (any, required)
    The expected penalty amount to be paid as part of an installment.

  - `installments.penalty.due` (any, required)
    The penalty amount currently due as part of an installment.

  - `installments.penalty.paid` (any, required)
    The penalty amount that has been paid as part of an installment.

  - `installments.interest` (object, required)
    An object containing information about the interest amount payable as part of an installment.

  - `installments.interest.expected` (any, required)
    The expected interest amount to be paid as part of an installment.

  - `installments.interest.due` (any, required)
    The interest amount currently due as part of an installment.

  - `installments.interest.paid` (any, required)
    The interest amount that has been paid as part of an installment.

  - `installments.fee` (object, required)
    The total amount of the fees payable on an installment. For a breakdown of the details of the fee, check the  field.

  - `installments.fee.expected` (any, required)
    The total fee amount that's expected to be paid as part of an installment.

  - `installments.fee.due` (any, required)
    The total fee amount currently due as part of an installment.

  - `installments.fee.paid` (any, required)
    The total fee amount that has been paid as part of an installment.

  - `installments.fee_details` (array, required)
    An array of objects containing the breakdown of the fees type, applicable taxes, amounts, descriptions, etc.

  - `installments.fee_details.name` (string, required)
    The name of the applied fee. Could be SDDR costs or dunning fees.

  - `installments.fee_details.amount` (object, required)
    An object containing information about the fee amount, including reduced, expected, due, and paid amounts.

  - `installments.fee_details.amount.reduced` (any, required)
    The fee amount that has been reduced as part of an installment.

  - `installments.fee_details.amount.expected` (any, required)
    The fee amount that's expected to be paid as part of an installment.

  - `installments.fee_details.amount.due` (any, required)
    The fee amount currently due as part of an installment.

  - `installments.fee_details.amount.paid` (any, required)
    The fee amount that has been paid as part of an installment.

  - `installments.fee_details.tax` (object, required)
    An object containing information about the tax applicable to the fee.

  - `installments.fee_details.tax.reduced` (any, required)
    The fee tax amount that has been reduced as part of an installment.

  - `installments.fee_details.tax.expected` (any, required)
    The fee tax amount that's expected to be paid as part of an installment.

  - `installments.fee_details.tax.due` (any, required)
    The fee tax amount currently due as part of an installment.

  - `installments.fee_details.tax.paid` (any, required)
    The fee tax amount that has been paid as part of an installment.

## Response 404 fields (application/json):

  - `title` (string)
    Example: "Model Not Found"

  - `status` (string)
    Example: "404"

  - `id` (string)
    Example: "a95f2aaf-4e0c-4d49-8021-8a16a884ed86"

  - `detail` (string)
    Example: "Couldn't find 'Account' for id 'DE24112233445566'."

  - `code` (string)
    Example: "model_not_found"

## Response 409 fields (application/json):

  - `title` (string)
    Example: "Record Not Unique"

  - `status` (string)
    Example: "409"

  - `id` (string)
    Example: "a95f2aaf-4e0c-4d49-8021-8a16a884ed86"

  - `detail` (string)
    Example: "Could not save `terms_and_conditions_event`."

  - `code` (string)
    Example: "record_not_unique"