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

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

# WithdrawalTaskData

## 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:
    FormRequest:
      type: object
      properties:
        formSource:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormSource"
        formData:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormData"
        formProgram:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormProgram"
        formParty:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormParty"
        formDistribution:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormDistribution"
        formDisbursement:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormDisbursement"
        formRestriction:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormRestriction"
        formTaxWithholding:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormTaxWithholding"
        formTpaAuthorization:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormTpaAuthorization"
        formFullSurrenderAck:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormFullSurrenderAck"
        formTaxIdCertificate:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormTaxIdCertificate"
        formSignature:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormSignature"
        formLoan:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormLoan"
        formSpecialInstruction:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormSpecialInstruction"
        formIrsData:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormIrsData"
    FormSource:
      type: object
      properties:
        businessKey:
          type: string
          example: 20230712-EM-786626
        channel:
          type: object
          properties:
            text:
              type: string
              example: EMAIL
              enum:
                - MAIL
                - FAX
                - MAVRO
                - EMAIL
                - EXL
                - UNIFIED_WEB
        cutOffTimeExpireInd:
          type: boolean
          example: true
        formsDBId:
          type: string
          example: abc121243
        receivedDate:
          type: string
          example: 2023-07-12
        receivedDateTime:
          type: string
          example: 2023-07-11T16:51:19-05:00
        sourceSysId:
          type: string
          example: ONBASE
        unstructuredFormInd:
          type: boolean
          example: true
    FormData:
      type: object
      properties:
        formExtName:
          type: string
          example: ANNUITY CONTRACT DIGITAL WD V1
        metaData:
          type: object
          oneOf:
            - $ref: "#/components/schemas/MetaData"
    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: ""
    FormParty:
      type: object
      properties:
        parties:
          type: array
          items:
            $ref: "#/components/schemas/Party"
    FormDistribution:
      type: object
      properties:
        moneyType:
          type: object
          properties:
            text:
              type: string
              example: Prorata
        distributionType:
          type: string
          example: ""
        oneYearRenewalGurantee:
          type: string
          example: ""
        funds:
          type: object
          oneOf:
            - $ref: "#/components/schemas/Fund"
    FormDisbursement:
      type: object
      properties:
        paymentMethod:
          type: object
          properties:
            text:
              type: string
              example: Check
        paymentMailType:
          type: object
          properties:
            text:
              type: string
              example: ""
        bank:
          type: object
          oneOf:
            - $ref: "#/components/schemas/Bank"
        paymentToBrokerageAccount:
          type: boolean
          example: true
        payeeType:
          type: string
          example: OWNER
    FormRestriction:
      type: object
      properties:
        restrictions:
          type: object
          properties:
            text:
              type: string
              example: ""
        hardship:
          type: object
          properties:
            text:
              type: string
              example: ""
        emergency:
          type: string
          example: ""
    FormTaxWithholding:
      type: object
      properties:
        taxWithholding:
          type: array
          items:
            $ref: "#/components/schemas/TaxWithholding"
    FormTpaAuthorization:
      type: object
      properties:
        isAuthorization:
          type: object
          properties:
            text:
              type: string
              example: ""
        isAgreementAttached:
          type: object
          properties:
            text:
              type: string
              example: No
        signOf:
          type: object
          properties:
            text:
              type: string
              example: ""
        signature:
          type: object
          oneOf:
            - $ref: "#/components/schemas/Sign"
    FormFullSurrenderAck:
      type: object
      properties:
        isFinancialProfessionAck:
          type: object
          properties:
            text:
              type: string
              example: ""
        signature:
          type: array
          items:
            $ref: "#/components/schemas/Sign"
    FormTaxIdCertificate:
      type: object
      properties:
        signatures:
          type: array
          items:
            $ref: "#/components/schemas/Sign"
    FormSignature:
      type: object
      properties:
        isSpousalConsentRequired:
          type: boolean
          example: true
        signatures:
          type: array
          items:
            $ref: "#/components/schemas/Sign"
    FormLoan:
      type: object
      properties:
        isLoanAck:
          type: object
          properties:
            text:
              type: string
              example: "false"
    FormSpecialInstruction:
      type: object
      properties:
        specialInstructionPresent:
          type: object
          properties:
            text:
              type: string
              example: ""
    FormIrsData:
      type: object
      properties:
        irsApplicable:
          type: boolean
          example: true
        irsSpecified:
          type: boolean
          example: true
        formParty:
          type: object
          oneOf:
            - $ref: "#/components/schemas/Party"
        irsTaxWithholding:
          type: array
          items:
            $ref: "#/components/schemas/TaxWithholding"
        irsSignature:
          type: boolean
          example: true
    MetaData:
      type: object
      properties:
        formId:
          type: integer
          example: 37825
        formNumber:
          type: string
          example: ""
        formType:
          type: string
          example: ANNUITY CONTRACT DIGITAL WD V1
    Party:
      type: object
      properties:
        partyRoleType:
          type: string
          example: OWNER
          enum:
            - OWNER
            - ANNUITANT
            - ROLLOVER_PAYEE
            - PAYEE
            - JOINT_OWNER
        firstName:
          type: string
          example: JAMES
        middleName:
          type: string
          example: C
        lastName:
          type: string
          example: FORD
        fullName:
          type: string
          example: JAMES C FORD
        suffix:
          type: string
          example: "1"
        dob:
          type: string
          example: ""
        taxId:
          type: string
          example: "572621420"
        email:
          type: string
          example: ""
        employer:
          type: string
          example: ""
        maritalStatus:
          type: object
          properties:
            text:
              type: string
              example: Single
              enum:
                - Single
                - Married
                - Widowed
        addresses:
          type: array
          items:
            $ref: "#/components/schemas/Address"
        phones:
          type: array
          items:
            $ref: "#/components/schemas/Phone"
    Fund:
      type: object
      properties:
        amount:
          type: object
          properties:
            text:
              type: string
              example: "122"
            amountType:
              type: string
              example: DOLLAR
              enum:
                - DOLLAR
                - PERCENT
        fundCode:
          type: string
          example: 056HJ0A
        fundName:
          type: string
          example: Fixed
    Bank:
      type: object
      properties:
        accountNumber:
          type: string
          example: ""
        accountType:
          type: object
          properties:
            text:
              type: string
              example: Checking
        bankContactPerson:
          type: string
          example: ""
        bankFurtherCreditAccount:
          type: string
          example: ""
        bankFurtherCreditName:
          type: string
          example: DEFAULT
        bankInfoCompleteInd:
          type: string
          example: ""
        bankLocation:
          type: string
          example: ""
        bankName:
          type: string
          example: ""
        bankPhone:
          type: string
          example: ""
        nameOnBankAccount:
          type: string
          example: ""
        routingNumber:
          type: string
          example: ""
    TaxWithholding:
      type: object
      properties:
        place:
          type: object
          properties:
            text:
              type: string
              example: Federal
        type:
          type: object
          properties:
            text:
              type: string
              example: No Tax Withholding
        amount:
          type: object
          properties:
            text:
              type: string
              example: "0"
            amountType:
              type: string
              example: DOLLAR
              enum:
                - DOLLAR
                - PERCENT
        filingStatus:
          type: object
          properties:
            text:
              type: string
              example: ""
        exemption:
          type: object
          properties:
            text:
              type: string
              example: ""
    Sign:
      type: object
      properties:
        isSigned:
          type: boolean
          example: true
        signDate:
          type: object
          properties:
            text:
              type: string
              example: 2023-05-25
        signExtension:
          type: object
        signName:
          type: string
          example: ""
        signOtherTitle:
          type: string
          example: ""
        signTitle:
          type: object
          properties:
            text:
              type: string
              example: ""
        signTitles:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
                example: ""
        signType:
          type: object
          properties:
            text:
              type: string
              example: OWNER
              enum:
                - OWNER
                - JOINT_OWNER
                - SPOUSE,NOTARY
        spousalConsent:
          type: object
          properties:
            text:
              type: string
              example: ""
    Address:
      type: object
      properties:
        addressLine1:
          type: string
          example: 560 calle de la sierra
        addressLine2:
          type: string
          example: ""
        addressLine3:
          type: string
          example: ""
        addressLine4:
          type: string
          example: ""
        addressType:
          type: string
          example: Default
          enum:
            - Default
            - Mailing
            - SADD
            - HADD
            - BADD
        city:
          type: string
          example: el cajon
        country:
          type: string
          example: ""
        state:
          type: string
          example: CA
        zip:
          type: string
          example: 92019-1241
        zipPlusFour:
          type: string
          example: ""
    Phone:
      type: object
      properties:
        phoneCountry:
          type: string
          example: US
        phoneNumber:
          type: string
          example: "6192001466"
        phoneTypeDesc:
          type: string
          example: Default
        phoneType:
          properties:
            text:
              type: string
              example: Owner_Phone_Day
              enum:
                - Owner_Phone_Day
                - Owner_Phone_Home
    WithdrawalTaskData:
      type: object
      properties:
        documentNumber:
          type: string
          example: 20230405-M-350385
        source:
          type: string
          example: DigitalPortal
        contractNum:
          type: string
          example: "571016565"
        userId:
          type: string
          example: abc121243
        onbaseCaseId:
          type: string
          example: "9280926"
        clientCode:
          type: string
          example: CarrierName_2
        incomingFaxNumber:
          type: string
          example: ""
        sysMailFromAddress:
          type: string
          example: ""
        agentEmailAddress:
          type: string
          example: ""
        taskType:
          type: string
          example: WithdrawalTask
        formRequest:
          type: object
          oneOf:
            - $ref: "#/components/schemas/FormRequest"
```