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

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

# IUL Shared Properties

Properties shared between IUL and HIT products

## 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:
    Conversion:
      title: Conversion
      description: Specifies what type of conversion is occurring
      type: object
      properties:
        conversionType:
          type: string
          description: Type of conversion
          example: STANDARD
          enum:
            - NONE
            - STANDARD
            - PREMIUM_CREDIT
        isSourceMEC:
          type: boolean
          description: Conversion MEC indicator - Indicates the source policy being
            converted was already in MEC status
          example: true
        conversionCredit:
          type: number
          format: double
          description: Amount to be credited to new policy on conversion
          example: 5000
      required:
        - conversionType
        - isSourceMEC
    Distributions:
      title: Distributions
      description: Distributions
      type: object
      required:
        - frequency
        - sequence
      properties:
        frequency:
          $ref: "#/components/schemas/Frequency"
        sequence:
          description: Sequence
          type: array
          items:
            type: object
            title: Sequence
            description: Distribution sequence
            properties:
              amountType:
                type: string
                description: Amount type
                example: AMOUNT
                enum:
                  - NONE
                  - AMOUNT
                  - PERCENTANGE
                  - MAX
                  - FREE_WITHDRAWAL_AMOUNT
                  - WITHDRAWA_LUNTIL_BASIS
                  - EARNINGS_ONLY
                  - PRORATA
                  - MODIFIED_EARNINGS_ONLY
              requestedAmount:
                type: number
                format: double
                description: Requested amount
                example: 10000
              funding:
                type: string
                description: Funding
                example: LOAN
                enum:
                  - LOAN
                  - WITHDRAWAL
                  - SWITCH_AT_BASIS
              from:
                $ref: "#/components/schemas/Distribution-Sequence-FromThrough"
              through:
                $ref: "#/components/schemas/Distribution-Sequence-FromThrough"
        loanInterestOption:
          description: Specifies how loan interest is processed; BORROW indicates that the
            interest is added into the loan amount, CASH indicates that the loan
            is paid and does not accumulate.
          type: string
          example: BORROW
          enum:
            - BORROW
            - CASH
    Exchange:
      title: Exchange
      description: 1035 Exchange - exchanging another policy for this one
      type: object
      required:
        - amount
        - basis
        - isModifiedEndowmentContract
      properties:
        amount:
          type: number
          format: double
          description: The value of the exchanged policy
          example: 5000
        basis:
          type: number
          format: double
          description: How much can be exchanged without incurring additional taxes
          example: 5000
        isModifiedEndowmentContract:
          type: boolean
          description: Whether the policy being exchanged for this one is a MEC
          example: true
        carryoverLoan:
          type: number
          format: double
          description: How much loan is being carried in as part of this exchange
          example: 5000
    Frequency:
      type: string
      description: Frequency
      example: DAILY
      enum:
        - DAILY
        - EVERYTWOWEEKS
        - MONTHLY
        - SEMIANNUAL
        - QUARTERLY
        - ANNUAL
        - SINGLEPAYMENT
    Distribution-Sequence-FromThrough:
      title: From/Through Entry in a Distribution Sequence
      type: object
      description: From/Through
      properties:
        offset:
          type: number
          format: integer
          description: Offset
          example: 1
        basis:
          type: string
          description: Basis
          example: AGE
          enum:
            - AGE
            - DURATION
            - RETIREMENT
    IUL-Shared-Properties:
      title: IUL Shared Properties
      description: Properties shared between IUL and HIT products
      type: object
      properties:
        conversion:
          $ref: "#/components/schemas/Conversion"
        lumpSumDeposits:
          description: Additional one-time payments that take place at specified points in
            time
          type: array
          items:
            type: object
            required:
              - amount
            properties:
              amount:
                description: lump sum deposit amount
                type: number
                format: double
                example: 100000
              duration:
                description: contract year of the lump sum deposit. If not specified, '1' (first
                  year) is assumed.
                type: number
                format: integer
                example: 65
              month:
                description: lump sum deposit month. If not specified, '1' (January) is assumed.
                type: number
                format: integer
                example: 12
        fundAllocations:
          description: Fund allocations
          type: array
          items:
            type: object
            properties:
              allocationPercent:
                type: number
                format: integer
                description: Allocation percent
                example: 50
              fundId:
                type: string
                description: Fund id
                example: SPX
              illustratedRate:
                description: Assumed rate of return to use for illustrative purposes
                type: number
                format: double
                example: 0.3
            required:
              - allocationPercent
              - fundId
        distributions:
          $ref: "#/components/schemas/Distributions"
        exchanges:
          type: object
          properties:
            internal:
              $ref: "#/components/schemas/Exchange"
            external:
              $ref: "#/components/schemas/Exchange"
      required:
        - fundAllocations
```