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

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

# LoanSegment

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    LoanType:
      type: string
      enum:
        - PREFERRED
        - NONPREFERREDSTANDARDLOAN
        - INDEXLOAN
    LoanInterestType:
      type: string
      enum:
        - FIXED
        - INDEXED
        - VARIABLE
        - ADJUSTABLE
    LoanSegment:
      type: object
      properties:
        segmentId:
          type: string
          description: A unique identifier assigned to each loan segment within the
            policy, representing a distinct loan transaction
          example: Loan1
        loanType:
          $ref: "#/components/schemas/LoanType"
        loanInterestType:
          $ref: "#/components/schemas/LoanInterestType"
        loanInterestDue:
          type: number
          format: double
          description: Calculated loan interest amount for a policy Owner to Pay before
            Anniversary
          example: 1000
        loanPrincipal:
          type: number
          format: double
          description: The original amount borrowed against the policy, excluding interest
          example: 1500
        loanBalance:
          type: number
          format: double
          description: The outstanding amount of the loan, including accrued interest if
            applicable
          example: 1500.72
        percentageOfAccountValue:
          type: number
          format: double
          description: Percentage of Account Value refers to a value that is calculated as
            a percentage of the total account value of an insurance or annuity
            contract. It is often used to determine allocations, fees, benefits,
            or charges that are based on how much money is currently held in the
            policy's account value.
          example: 1500.72
        loanCollateralAmount:
          type: number
          format: double
          description: This amount represents the total portion of the policy’s account
            value that is used as collateral when a loan is taken against the
            policy. It is calculated as follows:Loan Collateral Amount = Loan
            Principal + Loan Collateral Accrued Interest When a policyholder
            takes a loan, this amount reflects the loaned portion of the account
            value that is set aside as collateral. Interest is applied to this
            collateralized amount at a specific rate as per the policy terms
          example: 1500.72
        preInvestmentSegmentAmount:
          type: number
          format: double
          description: TBD
          example: 0
        loanInterestRate:
          type: number
          format: double
          description: The interest rate charged on the loan balance, which may be fixed
            or variable based on policy terms
          example: 4.5
        loanCreditRate:
          type: number
          format: double
          description: The interest rate charged to any collateralized portion of the
            policy’s cash value
          example: 4
        loanAccruedInterest:
          type: number
          format: double
          description: The interest accumulated on the outstanding loan balance that has
            not yet been paid
          example: 0.72
        loanCollateralAccruedInterest:
          type: number
          format: double
          description: The interest accumulated on the collateral portion of account value.
          example: 0.16
        yearToDateLoanTaken:
          type: number
          format: double
          description: The amount of loans taken against the policy in the current policy
            year
          example: 1500
        generalLedgerFundCode:
          type: string
          description: The accounting code used in the insurer’s general ledger system to
            track loan fund
          example: V2201
        startDate:
          type: string
          format: date
          description: The date when the loan segment becomes active and enforceable
            within the policy
          example: 2023-01-01
        endDate:
          type: string
          format: date
          description: The date when the loan segment is fully repaid, closed, or no
            longer applicable
          example: 2023-01-01
```