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

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

# WithdrawalValues

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    WithdrawalValues:
      type: object
      properties:
        totalWithdrawalAmount:
          type: number
          format: double
          description: The Total Withdrawal Amount refers to the cumulative amount of
            funds withdrawn from a life insurance policy or annuity by the
            policyholder. This includes all withdrawals made since the policy’s
            inception, whether taken as partial surrenders, cash value
            withdrawals, or systematic distributions
          example: 0
        freeWithdrawalAmount:
          type: number
          format: double
          description: The Free Withdrawal Amount refers to the maximum amount a
            policyholder can withdraw from their life insurance policy or
            annuity in a contract year without incurring a surrender charge.
            This limit is set by the insurer and is typically expressed as a
            percentage of the account value or premiums paid
          example: 0
        yearToDateFreeWithdrawalAmount:
          type: number
          format: double
          example: 0
          description: The YTD Free Amount (Year-To-Date Free Withdrawal Amount) refers to
            the total amount withdrawn so far in the current contract year that
            was within the free withdrawal limit, meaning it did not incur
            surrender charges. This tracks how much of the allowable free
            withdrawal limit has been used
        minimumWithdrawalAmount:
          type: number
          format: double
          description: The Minimum Withdrawal Amount refers to the smallest amount a
            policyholder can withdraw from their life insurance policy or
            annuity in a single transaction, as defined by the insurer. This
            ensures that withdrawals remain administratively efficient and align
            with policy rules
          example: 1
        maximumWithdrawalAmount:
          type: number
          format: double
          description: The Maximum Withdrawal Amount refers to the highest amount a
            policyholder can withdraw from their life insurance policy or
            annuity in a single transaction or within a policy year, as set by
            the insurer. This ensures that withdrawals do not deplete the
            policy’s cash value too quickly or violate contract terms
          example: 161.81698
        annualWithdrawalLimitNoCoverageDecrease:
          type: number
          format: double
          description: The Annual Withdrawal Limit for No Coverage Decrease refers to the
            maximum amount a policyholder can withdraw from their life insurance
            policy within a policy year without reducing the death benefit or
            coverage amount. This ensures that policyholders can access cash
            value while maintaining full coverage
          example: 322.678939
        maximumWithdrawalRequestDuringVestingPeriod:
          type: number
          format: int32
          description: The Max Withdrawal Request Allowed During Vesting Period refers to
            the highest number of withdrawal transactions permitted within the
            vesting period of a life insurance policy or annuity. This ensures
            policyholders follow contract rules while maintaining eligibility
            for vested benefits
          example: 1
        yearToDateNumberOfWithdrawal:
          type: number
          description: The YTD (Year-To-Date) Number of Withdrawals refers to the total
            count of withdrawal transactions made by the policyholder from the
            beginning of the policy year to the present date. This tracks how
            frequently funds have been withdrawn within the current policy year
          example: 1
          format: int32
        maximumWithdrawalRequestAfterVestingPeriod:
          type: number
          description: The Max Withdrawal Request Allowed After Vesting Period refers to
            the highest number of withdrawals a policyholder can make per year
            or over the life of the policy after the vesting period has ended.
            This ensures that policyholders can access their funds while still
            maintaining policy sustainability and compliance with contract terms
          example: 12
          format: int32
        totalYearToDateWithdrawalTaken:
          type: number
          description: The Total YTD (Year-To-Date) Withdrawal Taken refers to the total
            amount withdrawn by the policyholder from their life insurance
            policy or annuity within the current contract year. This tracks all
            withdrawals made so far from the beginning of the policy year up to
            the present date.
          example: 0
          format: double
        numberOfWithdrawal:
          type: number
          description: The Number of Withdrawals refers to the total count of withdrawal
            transactions made by the policyholder within a specified period,
            typically within the current policy year or calendar year. This
            tracks how frequently funds have been withdrawn from the policy
          example: 0
          format: int32
        withdrawalAllowedStartDate:
          type: string
          description: The Withdrawal Allowed Start Date refers to the calculated date
            from which the policyholder is permitted to make withdrawals from
            the policy’s cash value or annuity funds. This date is determined
            based on policy terms, surrender charge periods, and regulatory
            restrictions
          example: 2023-01-01
          format: date
        remainingFreeWithdrawalAmount:
          type: number
          format: double
          description: The remaining portion of the annual free withdrawal allowance that
            the policyholder can withdraw during the current contract year
            without incurring surrender charges or withdrawal penalties.
          example: 0
      required:
        - yearToDateFreeWithdrawalAmount
```