---
title: "Scenario Results for IUL"
url: "https://developers.zinnia.com/apis/illustration-3-0-8/versions/b96a49c1-73c5-46d3-8968-fe603081d524/schemas/Scenario-IUL"
---

> Full API specification: https://developers.zinnia.com/apis/illustration-3-0-8/versions/b96a49c1-73c5-46d3-8968-fe603081d524.md

# Scenario Results for IUL

Outputs for Indexed Universal Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Illustration Generation
  version: 3.5.3
servers:
  - url: https://dev.api.zinnia.io
    description: Development
components:
  schemas:
    Scenario-Base:
      title: Base Scenario Results
      description: Fundamental outputs that apply across all products. This object
        represents a single scenario (e.g. Assumed, Guaranteed, etc)
      type: object
      properties:
        annualTimeSeriesData:
          description: Collection of values that vary annually - each item represents all
            the values for a single year
          type: array
          items:
            $ref: "#/components/schemas/Single-Year-Values-Base"
        annualPolicyManagementFee:
          type: number
          format: double
          description: Annual policy management fee
          example: 60
        annualPremiumAmount:
          type: number
          format: double
          description: Annual premium amount
          example: 397.2
        baseCoverageEndYear:
          type: number
          format: integer
          description: Base coverage end year
          example: 86
        costIndex:
          type: object
          properties:
            netPaymentCostIndexYear10:
              type: number
              format: double
              description: Net payment cost index year 10
              example: 1.59
            netPaymentCostIndexYear20:
              type: number
              format: double
              description: Net payment cost index year 20
              example: 1.59
            surrenderCostIndexYear10:
              type: number
              format: double
              description: Surrender cost index year 20
              example: 1.59
            surrenderCostIndexYear20:
              type: number
              format: double
              description: Surrender cost index year 20
              example: 1.59
        coverages:
          type: object
          description: These values represent the initial or constant state of coverages
          properties:
            base:
              $ref: "#/components/schemas/Output-Coverage-Values"
        initial:
          type: object
          properties:
            totalFaceAmount:
              type: number
              format: double
              description: Total Face Amount
              example: 22500.05
            totalPremium:
              type: number
              format: double
              description: Premium
              example: 33.1
            accountValue:
              type: number
              format: double
              example: 0.104742
            totalModalPremium:
              type: number
              format: double
              example: 100.2
            totalPolicyFee:
              type: number
              format: double
              example: 600
            totalModalPolicyFee:
              type: number
              format: double
              example: 500
        interestRate:
          type: number
          format: double
          description: Interest rate
          example: 5.1
        issueAge:
          type: number
          format: integer
          description: Issue age
          example: 35
        lapse:
          type: object
          properties:
            age:
              type: number
              format: integer
              description: Lapse age
              example: 122
            year:
              type: number
              format: integer
              description: Lapse year
              example: 87
            month:
              type: number
              format: integer
              description: Lapse month
              example: 12
        loan:
          type: object
          properties:
            chargeRate:
              type: number
              format: double
              description: Charge rate
              example: 4.5
            chargeRateArrears:
              type: number
              format: double
              description: Charge rate arrears
              example: 4.5
            creditRate:
              type: number
              format: double
              description: Credit rate
              example: 4.3
            takenIndicator:
              type: number
              format: integer
              description: Taken indicator
              example: 0
        maturityYear:
          type: number
          format: integer
          description: Maturity year
          example: 86
        payToAge:
          type: number
          format: integer
          description: Pay to age
          example: 121
        payment:
          type: object
          properties:
            mode:
              type: number
              format: integer
              description: Payment mode
              example: 12
            term:
              type: number
              format: integer
              description: Payment term
              example: 86
        policyStartYear:
          type: number
          format: integer
          description: Policy start year
          example: 1
        premium:
          type: object
          properties:
            amount:
              type: number
              format: double
              description: Premium amount
              example: 33.1
            duration:
              type: number
              format: integer
              description: Premium duration
              example: 86
            durationAge:
              type: number
              format: integer
              description: Premium duration age
              example: 121
        scenarioEndAge:
          type: number
          format: integer
          description: Scenario end age
          example: 122
        totalFirstPaymentAmount:
          type: number
          format: double
          description: Total first payment amount
          example: 33.1
        netSurrenderValue:
          type: object
          properties:
            age65:
              type: number
              format: double
              example: 1.385921
            finalAge:
              type: number
              format: double
              example: 1.385921
        premiumFinalAge:
          type: number
          format: double
          example: 110.04
    IUL-Shared-Scenario-Properties:
      title: IUL Shared Scenario Properties
      description: Scenario properties shared between IUL and HIT products
      type: object
      properties:
        annualTimeSeriesData:
          type: array
          items:
            $ref: "#/components/schemas/Single-Year-Values-IUL"
        acceleratedBenefitRider:
          type: object
          properties:
            band1MonthlyFee:
              type: number
              format: double
              description: Band 1 monthly fee
              example: 250
            maximumAmount:
              type: number
              format: double
              description: Maximum amount
              example: 500000
            maximumPercent:
              type: number
              format: double
              description: Maximum percent
              example: 50
        annualCumulativeGuidelineLevelPremium:
          type: number
          format: double
          description: Annual cumulative guideline level premium
          example: 0
        annualDistributionAmount:
          type: number
          format: integer
          description: Annual distribution amount
          example: 0
        baseCoverageEndYear:
          type: number
          format: integer
          example: 21
        bonus:
          type: object
          properties:
            annualMaximum:
              type: number
              format: double
              description: Annual maximum
              example: 100
            maximum:
              type: number
              format: double
              description: Maximum
              example: 300
            percent:
              type: number
              format: double
              description: Percent
              example: 10
        capAccountParameters:
          type: object
          properties:
            bestRate25Years:
              type: number
              format: double
              description: Best rate 25 years
              example: 7.18
            maximumRate:
              type: number
              format: double
              description: Maximum rate
              example: 5.82
            rate:
              type: number
              format: double
              description: Rate
              example: 9
            rateLast10Years:
              type: number
              format: double
              description: Rate last 10 years
              example: 6.22
            rateLast20Years:
              type: number
              format: double
              description: Rate last 20 years
              example: 6.1
            worstRate25Years:
              type: number
              format: double
              description: Worst rate 25 years
              example: 4.05
        coverages:
          properties:
            acceleratedDeathBenefitForTerminalIllness:
              $ref: "#/components/schemas/Output-Coverage-Values"
            acceleratedDeathBenefitForChronicIllness:
              $ref: "#/components/schemas/Output-Coverage-Values"
            acceleratedDeathBenefitForCriticalIllness:
              $ref: "#/components/schemas/Output-Coverage-Values"
            accidentalDeathBenefit:
              $ref: "#/components/schemas/Output-Coverage-Values"
            charitableGiving:
              $ref: "#/components/schemas/Output-Coverage-Values"
            childrensTerm:
              $ref: "#/components/schemas/Output-Coverage-Values"
            guaranteedInsurabilityBenefit:
              $ref: "#/components/schemas/Output-Coverage-Values"
            overloanProtection:
              $ref: "#/components/schemas/Output-Coverage-Values"
            ownerWaiverOfDeduction:
              $ref: "#/components/schemas/Output-Coverage-Values"
            waiverOfDeduction:
              $ref: "#/components/schemas/Output-Coverage-Values"
        current:
          type: object
          properties:
            interestRate:
              type: number
              format: double
              example: 5
              description: Interest rate
            premiumLoad:
              type: number
              format: double
              example: 4
              description: Premium load
        currentInterestRate:
          type: number
          format: double
          example: 3
        deathBenefit:
          type: object
          properties:
            age65:
              type: number
              format: double
              example: 100000
            finalAge:
              type: number
              format: double
              example: 100000
        distribution:
          type: object
          properties:
            endAge:
              type: number
              format: integer
              example: 0
              description: End age
            startAge:
              type: number
              format: integer
              example: 0
              description: Start age
        fixed:
          type: object
          properties:
            accountRate:
              type: number
              format: double
              example: 5
              description: Account rate
            costPeriod:
              type: object
              properties:
                coveragePayment:
                  type: number
                  format: double
                  example: 9.17
                  description: Coverage payment
                savings:
                  type: number
                  format: double
                  example: 0
                  description: Savings
                totalPayment:
                  type: number
                  format: double
                  example: 9.17
                  description: Total payment
        fixedAccountRate:
          type: number
          format: double
          example: 1
        initial:
          type: object
          properties:
            guidelineLevelPremium:
              type: number
              format: double
              example: 0
              description: Guideline level premium
            minimumPremiumAmount:
              example: 0
              format: double
              type: number
              description: Minimum premium amount
            modifiedEndowmentPremium:
              example: 4274.62
              format: double
              type: number
              description: Modified endowment premium
            targetPremiumAmount:
              example: 1234.5
              format: double
              type: number
              description: Target premium amount
        insuranceAge:
          type: object
          properties:
            atLastDeathBenefitOptionChange:
              type: number
              format: integer
              example: 56
              description: Insurance age at last death benefit option change
            atLastFaceChange:
              type: number
              format: integer
              example: 35
              description: Insurance age at last face change
        lapseAge:
          type: number
          format: integer
          example: 56
        lapseYear:
          type: number
          format: integer
          example: 21
        match:
          type: object
          properties:
            maximumPercent:
              type: number
              format: double
              example: 5
              description: Max percent
            maximumPremiumAmount:
              type: number
              format: double
              example: 5000
              description: Maximum premium amount
            maximumYear:
              type: number
              format: integer
              example: 0
              description: Maximum year
            percent:
              type: number
              format: double
              example: 2.5
              description: Percent
            printColumnMessageFlag:
              type: number
              format: integer
              example: 1
              description: Print column message flag
            transferAmount:
              type: number
              format: double
              example: 5
              description: Transfer amount
            vestingPrintColumnMessageFlag:
              type: number
              format: integer
              example: 1
              description: Vesting print column message flag
            vestingYears:
              type: number
              format: integer
              example: 0
              description: Vesting years
            years:
              type: number
              format: integer
              example: 0
              description: Years
        minimumNoLapseGuaranteeTestYears:
          type: number
          format: integer
          example: 0
          description: Minimum no lapse guarantee test years
        modifiedEndowmentContract:
          type: object
          properties:
            adjustmentIndicator:
              type: number
              format: integer
              example: 0
              description: Adjustment indicator
            conversionYear:
              type: number
              format: integer
              example: 0
              description: Conversion year
        overloan:
          type: object
          properties:
            minimumAge:
              type: number
              format: integer
              example: 75
              description: Minimum age
            minimumLoanPercent:
              type: number
              format: double
              example: 95
              description: Minimum loan percent
            minimumYear:
              type: number
              format: integer
              example: 15
              description: Minimum year
        participantAccountParameters:
          type: object
          properties:
            bestRate25Years:
              type: number
              format: double
              example: 8.68
              description: Best rate 25 years
            maximumRate:
              type: number
              format: double
              example: 6.54
              description: Maximum rate
            rate:
              type: number
              format: double
              example: 55.25
              description: Rate
            rateLast10Years:
              type: number
              format: double
              example: 8.3
              description: Rate last 10 years
            rateLast20Years:
              type: number
              format: double
              example: 6.98
              description: Rate last 20 years
            worstRate25Years:
              type: number
              format: double
              example: 4.22
              description: Worst rate 25 years
        parRate:
          type: number
          format: double
          example: 5
        policyYearOfLastDeathBenefitOptionChange:
          type: number
          format: integer
          example: 21
          description: Policy year of last death benefit option change
        policyYearOfLastFaceChange:
          type: number
          format: integer
          example: 0
          description: Policy year of last face change
        premiumAge65:
          type: number
          format: double
          example: 1522.2
        savings:
          type: object
          properties:
            maximumAmount:
              type: number
              format: double
              example: 100
            minimumPayment:
              type: number
              format: integer
              example: 100
            percent:
              type: number
              format: double
              example: 10
            years:
              type: number
              format: integer
              example: 3
        secondLoan:
          type: object
          properties:
            chargeRateArrears:
              type: number
              format: double
              example: 4.5
            creditRate:
              type: number
              format: double
              example: 4.5
        terminal:
          type: object
          properties:
            amount:
              type: number
              format: double
              example: 500000
            percent:
              type: number
              format: double
              example: 50
        thirdLoan:
          type: object
          properties:
            chargeRateArrears:
              type: number
              format: double
              example: 4.5
            creditRate:
              type: number
              format: double
              example: 4.5
        totalPremiumDueToFaceAmount:
          type: number
          format: double
          example: 33.1
        withdrawalTakenIndicator:
          type: number
          format: integer
          example: 0
        yearAge65:
          type: number
          format: integer
          example: 31
        zeroPremiumIndicator:
          type: number
          format: integer
          example: 0
    Single-Year-Values-Base:
      title: Single-Year Values
      description: A single-year slice of data that varies annually - these values
        apply to any scenario and any product
      type: object
      allOf:
        - $ref: "#/components/schemas/PropertyCollection-Loan"
      properties:
        year:
          type: number
          format: integer
        accountValue:
          type: number
          format: double
          example: 0.104742
        coverages:
          type: object
          description: Coverage-specific values which are annually variable. See under
            "initial" for values that are constant year-to-year
          properties:
            base:
              $ref: "#/components/schemas/Output-Coverage-Values"
        cumulativePremiumAmount:
          type: number
          format: double
          example: 397.2
        deathBenefitAmount:
          type: number
          format: double
          example: 250000.104742
        faceAmount:
          type: number
          format: double
          example: 250000
        insuranceAgeAtBeginningOfYear:
          type: number
          format: integer
          example: 35
        insuranceAgeAtEndOfYear:
          type: number
          format: integer
          example: 36
        perUnitCharge:
          type: number
          format: double
          example: 201.21
        policyValue:
          type: number
          format: double
          example: 0.104742
        premiumAmount:
          type: number
          format: double
          example: 397.2
        policyBasis:
          type: number
          format: double
          example: 110.04
        policyGain:
          type: number
          format: double
          example: 0
        surrenderValue:
          type: number
          format: double
          example: 0.102552
    Output-Coverage-Values:
      title: Output Coverage Values
      description: Result values relevant to a specific coverage
      type: object
      properties:
        policyFee:
          type: number
          format: double
          description: Annual policy fee
          example: 150.2
        modalPolicyFee:
          type: number
          format: double
          description: Modal policy fee
          example: 0
        premium:
          type: number
          format: double
          description: Annual premium
          example: 0
        modalPremium:
          type: number
          format: double
          description: Modal premium
          example: 0
        tablePremium:
          type: number
          format: double
          description: Annual table premium
          example: 0
        modalTablePremium:
          type: number
          format: double
          description: Modal table premium
          example: 0
        flatExtraPremium:
          description: Flat Extra premium
          type: number
          format: double
          example: 5
        modalFlatExtraPremium:
          type: number
          format: double
          description: Modal flat extra premium
          example: 0
        faceAmount:
          type: number
          format: double
          description: Coverage face amount
          example: 2500
        isIncludedInQuote:
          type: boolean
          example: true
          description: indicates that this coverage was actually used in producing the quote
    Single-Year-Values-IUL:
      title: Single-Year values for IUL
      description: A single-year slice of data that varies annually - these values are
        specific to IUL products
      allOf:
        - $ref: "#/components/schemas/Single-Year-Values-Base"
        - $ref: "#/components/schemas/PropertyCollection-Withdrawal"
      properties:
        accumulatedPremiumAmountAtInterest:
          type: number
          format: double
          example: 115.542
        bonus:
          type: number
          format: double
          example: 0
        costOfInsurance:
          type: number
          format: double
          example: 45.576
        coverages:
          properties:
            acceleratedDeathBenefitForTerminalIllness:
              $ref: "#/components/schemas/Output-Coverage-Values"
            acceleratedDeathBenefitForChronicIllness:
              $ref: "#/components/schemas/Output-Coverage-Values"
            acceleratedDeathBenefitForCriticalIllness:
              $ref: "#/components/schemas/Output-Coverage-Values"
            accidentalDeathBenefit:
              $ref: "#/components/schemas/Output-Coverage-Values"
            charitableGiving:
              $ref: "#/components/schemas/Output-Coverage-Values"
            childrensTerm:
              $ref: "#/components/schemas/Output-Coverage-Values"
            guaranteedInsurabilityBenefit:
              $ref: "#/components/schemas/Output-Coverage-Values"
            overloanProtection:
              $ref: "#/components/schemas/Output-Coverage-Values"
            ownerWaiverOfDeduction:
              $ref: "#/components/schemas/Output-Coverage-Values"
            waiverOfDeduction:
              $ref: "#/components/schemas/Output-Coverage-Values"
        coverageCredit:
          type: number
          format: double
          example: 1.1
        deathBenefitAmountDueToCorridor:
          type: number
          format: double
          example: 0
        effectiveInterestRate:
          type: number
          format: double
          example: 5
        expenseCharge:
          type: number
          format: double
          example: 60
        forcedWithdrawalDueToGuidelinesAmount:
          type: number
          format: double
          example: 0
        guidelineLevelPremiumAmount:
          type: number
          format: double
          example: 0
        guidelineMaximumPremiumAmount:
          type: number
          format: double
          example: 0
        guidelineSinglePremiumAmount:
          type: number
          format: double
          example: 0
        historical:
          type: object
          properties:
            SP500:
              type: number
              format: double
              example: 3.001023
            SP500CapRate:
              type: number
              format: double
              example: 3.001023
            SP500ParticipationRate:
              type: number
              format: double
              example: 1.7
            Year:
              type: number
              format: double
              example: 2005
        interestRate:
          type: number
          format: double
          example: 5
        interestCreditedAmount:
          type: number
          format: double
          example: 0.001678
        minimumPremiumAmount:
          type: number
          format: double
          example: 0
        modifiedEndowmentContractIndicator:
          type: number
          format: double
          example: 0
        netAmountAtRisk:
          type: number
          format: double
          example: 99991.138173
        policyNetOutlayAmountForExpenseSummary:
          type: number
          format: double
          example: 110.04
        premiumCharge:
          type: number
          format: double
          example: 4.4016
        premiumOutlayKey:
          type: number
          format: double
          example: 1
        protectionCost:
          type: number
          format: double
          example: 105.576
        riderCharges:
          type: number
          format: double
          example: 0
        sevenPayPremiumAmount:
          type: number
          format: double
          example: 4274.62
        surrenderChargeAmount:
          type: number
          format: double
          example: 0
        taxDueAmount:
          type: number
          format: double
          example: 0
        taxableAmount:
          type: number
          format: double
          example: 0
        totalDistributionAmount:
          type: number
          format: double
          example: 0
        cvatFactors:
          type: number
          format: double
          example: 3.526381
        insuranceAge:
          type: object
          properties:
            atBeginningOfYear:
              type: number
              format: double
              example: 18
            atEndOfYear:
              type: number
              format: double
              example: 19
        internalRateOfReturn:
          type: object
          properties:
            deathBenefit:
              type: number
              format: double
              example: 0
            surrender:
              type: number
              format: double
              example: 0
        match:
          type: object
          properties:
            cumulativeVestedPremiumAmount:
              type: number
              format: double
              example: 0
            premiumAmount:
              type: number
              format: double
              example: 0
            unvestedAccountValue:
              type: number
              format: double
              example: 0
            vestedPremiumAmount:
              type: number
              format: double
              example: 0
    PropertyCollection-Loan:
      title: Loan Property Collection
      description: Reusable collection of loan-related properties
      type: object
      properties:
        loan:
          type: object
          properties:
            amount:
              type: number
              format: double
              description: Loan amount
              example: 0
            interestCreditedAmount:
              type: number
              format: double
              description: Loan interest credited amount
              example: 0
            interestDueAmount:
              type: number
              format: double
              description: Loan interest due amount
              example: 0
            payoffAmount:
              type: number
              format: double
              description: Loan payoff amount
              example: 0
            maximumLoanAmount:
              type: number
              format: double
              description: Maximum loan amount
              example: 0
        netAccountValue:
          type: number
          format: double
          example: 0.104742
        netDeathBenefitAmount:
          type: number
          format: double
          example: 250000.104742
        netSurrenderValue:
          type: number
          format: double
          example: 0.104742
        policyNetOutlayAmount:
          type: number
          format: double
          example: 397.2
        premiumOutlayAmount:
          type: number
          format: double
          example: 397.2
    PropertyCollection-Withdrawal:
      title: Withdrawal Property Collection
      description: Reusable collection of withdrawal-related properties
      type: object
      properties:
        cumulativeWithdrawalAmount:
          type: number
          format: double
          description: Cumulative withdrawal amount
          example: 0
        maximumWithdrawalAmount:
          type: number
          format: double
          description: Maximum withdrawal amount
          example: 0
        withdrawalAmount:
          type: number
          format: double
          description: Withdrawal amount
          example: 0
    Scenario-IUL:
      title: Scenario Results for IUL
      description: Outputs for Indexed Universal Life product across all scenarios.
        This object represents a single scenario (e.g. Assumed, Guaranteed, etc)
      type: object
      allOf:
        - $ref: "#/components/schemas/Scenario-Base"
        - $ref: "#/components/schemas/IUL-Shared-Scenario-Properties"
```