---
title: "FormProgram"
url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/FormProgram"
---

> Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md

# FormProgram

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Case Management API
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io/
    description: Dev Environment
  - url: https://qa.api.zinnia.io/
    description: QA Environment
  - url: https://uat.api.zinnia.io/
    description: UAT Environment
  - url: https://api.zinnia.io/
    description: PROD Environment
components:
  schemas:
    FormProgram:
      type: object
      properties:
        clientCode:
          type: string
          example: CarrierName_2
        contractNumber:
          type: string
          example: "5450009139"
        withdrawType:
          type: object
          properties:
            text:
              type: string
              example: NET
              enum:
                - GROSS
                - NET
        amountQualifierType:
          type: string
          example: NET
          enum:
            - GROSS
            - NET
        program:
          type: object
          properties:
            text:
              type: string
              example: Withdrawal
              enum:
                - Withdrawal
                - Systematic Withdrawal
        programType:
          type: object
          properties:
            text:
              type: string
              example: Full Surrender
              enum:
                - impossible
                - Full
                - Partial
                - Total Free Amt
                - GMWB
                - RMD
                - SSW
                - Full Surrender
                - Withdrawal
                - TotalFreeAmt
                - GrossWithdrawal
                - NetWithdrawal
                - LAP
        programSubType:
          type: object
          properties:
            text:
              type: string
              example: Dollar
              enum:
                - Default
                - Specific
                - Dollar
                - Percentage
                - Earning Only
                - Prorata
                - MaxFree
                - Maximum Free
                - Renewal_GuaranteeWD
                - Pre Tax,After Tax
                - FixDollar
                - AnnualFree
                - Total Free Withdrawal
                - PercentofAcctValue
                - InterestEarningDividendsGains
                - Pecking Order
                - FixPeriod
                - GMWB
                - IRC72TorQ
                - Dollar Liquidity Last
                - Auto
                - Percent Liquidity First
                - Dollar Liquidity First
                - Percent Liquidity Last
                - Prorata New Money
        programFrequency:
          type: string
          example: Default
          enum:
            - Default
            - Annually
            - BiMonthly
            - Monthly
            - QUARTERLY
            - SemiAnnually
        rollover:
          type: string
          example: PayMe
          enum:
            - PayMe
            - Partial
            - Entire
            - None
        rmd:
          type: string
          example: CustomerProvideAmt
          enum:
            - CustomerProvideAmt
            - IRCJointLifeNonRecalc
            - IRCJointLifeAgeRecalc
            - IRCSingleLifeNonRecalc
        programAmount:
          type: object
          properties:
            text:
              type: string
              example: "100"
            amountType:
              type: string
              example: DOLLAR
              enum:
                - DOLLAR
                - PERCENT
        partialAmount:
          type: object
          properties:
            text:
              type: string
              example: ""
            amountType:
              type: string
              example: DOLLAR
              enum:
                - DOLLAR
                - PERCENT
        partialPercent:
          type: object
          properties:
            text:
              type: string
              example: ""
            amountType:
              type: string
              example: PERCENT
              enum:
                - DOLLAR
                - PERCENT
        partialGrossAmount:
          type: object
          properties:
            text:
              type: string
              example: ""
            amountType:
              type: string
              example: DOLLAR
              enum:
                - DOLLAR
                - PERCENT
        partialNetAmount:
          type: object
          properties:
            text:
              type: string
              example: ""
            amountType:
              type: string
              example: DOLLAR
              enum:
                - DOLLAR
                - PERCENT
        processRequestType:
          type: string
          example: IMMED
          enum:
            - IMMED
            - NOCDSC
            - AS_OF_DATE
        isValidAsOfDate:
          type: boolean
          example: true
        accountCloseReason:
          type: object
          properties:
            text:
              type: string
              example: SURRENDER
              enum:
                - SURRENDER
                - CONTRACT_ATTACH
                - CONTRACT_LOST
        programSubTypeOptions:
          type: string
          example: ""
        asOfDate:
          type: object
          properties:
            text:
              type: string
              example: ""
```