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

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

# Distributions

Distributions

## 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:
    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
    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
```