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

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

# SpecialProgramDetails

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    ApiRequestHeaderValue:
      type: object
      properties:
        externalId:
          type: string
        externalUserId:
          type: string
        externalSystemId:
          type: string
        externalUserCompHrchyId:
          type: string
        muleCorrelationId:
          type: string
        timestamp:
          format: date-time
          type: string
        apiRequestUUID:
          type: string
        apiName:
          type: string
        externalTransactionName:
          type: string
        clientCode:
          type: string
        externalUserIdValid:
          type: string
      required:
        - externalId
        - externalUserId
        - externalSystemId
        - externalUserCompHrchyId
        - muleCorrelationId
        - timestamp
        - apiRequestUUID
        - apiName
        - externalTransactionName
        - clientCode
        - externalUserIdValid
    PolicyCommonRequestValue:
      type: object
      properties:
        contractNumber:
          type: string
        companyId:
          type: number
        companyHierarchyId:
          type: number
        planCode:
          type: string
        policyNumber:
          type: number
        cvgId:
          type: number
      required:
        - contractNumber
        - companyId
        - companyHierarchyId
        - planCode
        - policyNumber
        - cvgId
    StatusValue:
      type: object
      properties:
        statusCode:
          type: string
        statusMessage:
          type: string
        errors:
          type: array
          items:
            type: string
      required:
        - statusCode
        - statusMessage
        - errors
    AllocationDetailItem:
      type: object
      properties:
        dbAmount:
          type: number
        dbFixedPct:
          type: number
        dbNonLifePayoutExclAmt:
          type: number
        dbPctGMWBPayment:
          type: number
        dbPriorMRDAmt:
          type: number
        policyNumber:
          type: number
        cvgId:
          type: number
        typeOfAlloc:
          type: number
        startDate:
          format: date-time
          type: string
        termDate:
          format: date-time
          type: string
        mode:
          type: string
        nextDate:
          format: date-time
          type: string
        lastTxnDate:
          format: date-time
          type: string
        termBy:
          type: string
        modePeriods:
          type: number
        amountType:
          type: number
        distributionCode:
          type: string
        allocationId:
          type: number
        firstPayYear:
          type: string
        firstPayYearDate:
          format: date-time
          type: string
        calcType:
          type: number
        count:
          type: number
        duration:
          type: number
        dcaSweep:
          type: number
        earningsRefreshDate:
          format: date-time
          type: string
        loanId:
          type: number
        grossDisbInd:
          type: number
        programCounter:
          type: number
        moneySrcId:
          type: number
        firstNextDate:
          format: date-time
          type: string
        waive:
          type: number
        waiveMVA:
          type: number
        waiveBonusRecap:
          type: number
        refundOnly:
          type: number
        treatAsNonTaxable:
          type: boolean
        waiveLimits:
          type: number
        evaluateGMWBAmt:
          type: number
        advisorConsultation:
          type: number
        featureChange:
          type: number
        taxExclType:
          type: number
        firstSSWBasis:
          type: number
        priorMRDAmtType:
          type: number
        batch:
          type: number
      required:
        - dbAmount
        - dbFixedPct
        - dbNonLifePayoutExclAmt
        - dbPctGMWBPayment
        - dbPriorMRDAmt
        - policyNumber
        - cvgId
        - typeOfAlloc
        - startDate
        - termDate
        - mode
        - nextDate
        - lastTxnDate
        - termBy
        - modePeriods
        - amountType
        - distributionCode
        - allocationId
        - firstPayYear
        - firstPayYearDate
        - calcType
        - count
        - duration
        - dcaSweep
        - earningsRefreshDate
        - loanId
        - grossDisbInd
        - programCounter
        - moneySrcId
        - firstNextDate
        - waive
        - waiveMVA
        - waiveBonusRecap
        - refundOnly
        - treatAsNonTaxable
        - waiveLimits
        - evaluateGMWBAmt
        - advisorConsultation
        - featureChange
        - taxExclType
        - firstSSWBasis
        - priorMRDAmtType
        - batch
    SpecialProgramDetails:
      type: object
      properties:
        apiRequestHeader:
          $ref: "#/components/schemas/ApiRequestHeaderValue"
        policyCommonRequest:
          $ref: "#/components/schemas/PolicyCommonRequestValue"
        status:
          $ref: "#/components/schemas/StatusValue"
        allocationDetails:
          type: array
          items:
            $ref: "#/components/schemas/AllocationDetailItem"
      required:
        - apiRequestHeader
        - policyCommonRequest
        - status
        - allocationDetails
```