---
title: "LoanValues"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/LoanValues"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# LoanValues

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    LoanInterestMethod:
      type: string
      enum:
        - ADVANCE
        - ARREARS
    LoanRepaymentType:
      type: string
      enum:
        - INTERESTFIRST
        - PRINCIPALFIRST
    LoanValues:
      type: object
      properties:
        totalLoanBalance:
          type: number
          format: double
          description: The Total Loan Balance refers to the outstanding loan amount on a
            life insurance policy, including the principal, accrued interest,
            and any unpaid loan charges. This balance reflects the total amount
            the policyholder owes the insurance company when a policy loan is
            taken against the cash value.
          example: 1000
        totalLoanPrincipal:
          type: number
          format: double
          description: The Total Loan Principal refers to the original amount borrowed by
            the policyholder against the cash value of a life insurance policy,
            excluding any accrued interest or unpaid loan charges. It represents
            the base loan amount before interest accumulation
          example: 100
        loanPayoffAmount:
          type: number
          format: double
          description: The Loan Payoff Amount refers to the total amount required to fully
            repay a policy loan, including the outstanding loan balance, accrued
            loan interest, and any adjustments for unearned interest. This value
            is calculated daily and fluctuates based on the loan’s interest
            accrual
          example: 100
        maximumLoanAmount:
          type: number
          format: double
          description: The Maximum Loan Amount refers to the highest amount a policyholder
            can borrow against their life insurance policy’s cash value. This
            limit is determined by the policy’s cash value, outstanding loans,
            and insurer-specific rules
          example: 161.81698
        minimumLoanAmount:
          type: number
          format: double
          description: The Minimum Loan Amount refers to the smallest amount a
            policyholder can borrow against their life insurance policy’s cash
            value, as defined by the insurer. This limit ensures that
            administrative costs and processing fees are justified for each loan
            transaction
          example: 100
        totalLoanAccruedInterest:
          type: number
          format: double
          description: The Total Loan Accrued Interest refers to the amount of interest
            that has accumulated on a policy loan so far within the current
            year. This interest is added to the outstanding loan balance if it
            is not paid separately by the policyholder
          example: 100
        lastLoanInterestDueDate:
          type: string
          format: date
          description: The Last Loan Interest Due Date refers to the last policy
            anniversary date when loan interest was due on an outstanding policy
            loan. Since loan interest on life insurance policies is typically
            charged annually, this date always corresponds to the most recent
            policy anniversary date
          example: 2023-01-01
        totalNumberOfLoan:
          type: number
          format: int32
          description: The Total Number of Loans refers to the total count of policy loans
            taken by the policyholder throughout the life of the insurance
            policy. It tracks each separate loan transaction, regardless of
            whether previous loans were repaid or still outstanding
          example: 10
        loanInterestMethod:
          $ref: "#/components/schemas/LoanInterestMethod"
        totalYearToDateLoanTaken:
          type: number
          format: double
          description: The Total YTD (Year-To-Date) Loan Taken refers to the total amount
            of policy loans taken by the policyholder within the current
            calendar or policy year. It tracks all loan transactions processed
            within the year, excluding prior years` loan activity
          example: 1000
        loanRepaymentType:
          $ref: "#/components/schemas/LoanRepaymentType"
        minimumLoanRepayment:
          type: number
          format: double
          description: The Minimum Loan Repayment refers to the smallest amount a
            policyholder is required to repay on a policy loan, as specified by
            the insurance company. This ensures that the loan balance is managed
            and prevents excessive interest accrual, which could lead to policy
            lapse
          example: 100
        amountExcessToLoanPayoff:
          type: number
          format: double
          description: The Amount Excess to Loan Payoff refers to the amount by which the
            available value exceeds what is required to fully pay off the
            outstanding policy loan.
          example: 50
```