--- title: "AdhocSystematicProgram" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/AdhocSystematicProgram" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # AdhocSystematicProgram ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://qa.api.zinnia.io components: schemas: PaymentForm: type: string enum: - DTCC - CREDITCARD - ACH - CHECK - WIRE - EXCHANGE - PREMIUMLOAN ArrangementType: type: string enum: - PAYMENT - WITHDRAWAL - LOANREPAYMENT - REQUIREDMINIMUMDISTRIBUTION - PAYOUT - RIDERCLAIMWITHDRAWAL AmountType: type: string enum: - AMOUNT - PERCENTAGE - MAX - FREEWITHDRAWALAMOUNT - WITHDRAWALUNTILBASIS - EARNINGSONLY - PRORATA - PERCENT - MODIFIEDEARNINGSONLY - SUNINCOMEMAXIMIZERONLYLBRMAXIMUM - SUNINCOMEMAXIMIZERNETONETIMEACCESS - NONSUNINCOMEMAXIMIZERLBRSWDMAXIMUM - SUNINCOMEMAXIMIZERGROSSONETIMEACCESS - YEARTODATEFIXEDEARNINGS - EARNINGSLIQUIDITYFIRST - EARNINGSLIQUIDITYLAST - GUARANTEEDWITHDRAWALBENEFIT - FIXEDMODIFIEDEARNINGS - ACCUMULATEDEARNINGS - LIFEEXPECTANCY - DEFAULT Frequency: type: string enum: - DAILY - EVERYTWOWEEKS - MONTHLY - SEMIANNUAL - QUARTERLY - ANNUAL - SINGLEPAYMENT DistributionCode: type: string enum: - DEFAULT - PREMATUREDISTRIBUTION - EXCEPTIONAPPLIES - DISABILITY - DEATH - DEATHEXCLUSION - DEATHROLLOVER - EXCHANGE1035 - NORMALDISTRIBUTION - COSTOFCURRENTLIFEINSURANCEPROTECTION - QUALIFIEDROLLOVER - ROTHDISTRIBUTIONNOEXCEPTION - QUALIFIEDLOANDISTRIBUTION - PREMATURELOANDISTRIBUTION - QUALIFIEDROTHINDIVIDUALRETIREMENTARRANGEMENTDISTRIBUTION - ROTHINDIVIDUALRETIREMENTACCOUNTSDISTRIBUTIONEXCEPTIONAPPLIES - EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSTAXABLEIN2009 - NONTAXABLEEVENT - GROSSPAIDTOATTORNEY - OTHERINCOME - NONEMPLOYEECOMPENSATION - PREMATUREEXCEPTION - ROYALTIES - DEATHTRANSFER4H - PROHIBITEDTRANSACTION - TENYEARTAXOPTION - TRUSTEETOTRUSTEETRANSFER - QUALIFIEDDOMESTICRELATIONSORDERLIKETOLIKENO1099 - DISTRIBUTIONSUNDEREMPLOYEEPLANSCOMPLIANCERESOLUTIONSYSTEM - CHARITABLEGIFT - LOANSASDISTRIBUTIONS - QUALIFIEDPLANLOANOFFSET - RECHARACTERIZEDINDIVIDUALRETIREMENTARRANGEMENTCURRENTYEAR - EXCESSCONTRIBUTION1YEARPRIORTAX - RECHARACTERIZEDINDIVIDUALRETIREMENTACCOUNTSPREVIOUSYEAR - EARLYDISTRIBUTIONFROMSAVINGSINCENTIVEMATCHPLANFOREMPLOYEES - DIRECTTRANSFER - EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSANDOREARNINGSTAXABLEIN2024 - EXCESSCONTRIBUTIONS2YEARPRIORTAX - DIRECTROLLOVERQUALPLANTAXSHELTEREDANNUITY - SEPARATIONFROMSERVICE - INDIVIDUALRETIREMENTARRANGEMENTTOROTHINDIVIDUALRETIREMENTARRANGEMENT - QUALIFIEDDOMESTICRELATIONSORDERROLLOVERTOINDIVIDUALRETIREMENTARRANGEMENT2G - QUALIFIEDDOMESTICRELATIONSORDERPAYMENTTOSPOUSE - FIRSTTIMEHOMEBUYERINDIVIDUALRETIREMENTARRANGEMENTONLY - EDUCATIONEXPENSE - MEDICALEXPENSE - FEEADMIN - FEEASSET - FEECONTRIBUTION - FEELUMPSUMDEATH - FEELUMPSUMDISABILITY - FEELUMPSUMPURCHASEDANNUITY - FEELUMPSUMOTHER - FEENEWRETIREEWITHPERPAYMENT - FEEEXISTINGRETIREMENTINFORCE - FEECONTRACT - FEEEXISTINGRETIREMENTINCREASE - FEETHIRDPARTY - LUMPSUMDEATH - LUMPSUMDISABILITY - LUMPSUMPURCHASEDANNUITY - LUMPSUMOTHER - FEEINTERNATIONALPROGRAMSGROUPEXPENSE - FROMFUND - RELEASERESERVE - HEALTHDEDUCTION - FEEMARKETVALUE - FEEANNUITYADMINISTRATION - SECTION1035EXCHANGEPARTIAL - QUALIFIEDDOMESTICRELATIONSORDERNORMALDISTRIBUTION - QUALIFIEDDOMESTICRELATIONSORDERSECTION1035 - FEELONGTERMCAREINSURANCE - DESIGNATEDROTHACCOUNTDISTRIBUTION - REPORTABLEDEATHBENEFITSUNDERSECTION6050Y - DISTRIBUTIONOFTRADITIONALINDIVIDUALRETIREMENTARRANGEMENTASSETSNOTHAVINGAREADILYAVAILABLEFAIRMARKETVALUE - DIVIDENDSDISTRIBUTEDFROMANEMPLOYEESTOCKOWNERSHIPPLANSUNDERSECTION404K - DIRECTROLLOVEROFADESIGNATEDROTHACCOUNT - DEATHQUALIFIEDCHARITABLEDISTRIBUTION - NORMALQUALIFIEDCHARITABLEDISTRIBUTION BaseAdhocParty: type: object properties: partyId: type: string example: Party_PI_1 description: Impacted Party in the event of financial transaction bankId: type: string example: Bank_1 description: Comes in Acord 103 AdhocDisbursementParty: type: object properties: partyRole: $ref: "#/components/schemas/PartyRole" partyId: type: string description: unique identifier linking the party to the policy example: Party_PI_1 paymentForm: $ref: "#/components/schemas/PaymentForm" allocationPercentage: type: number description: The percentage of the total disbursement allocated to the payee example: 100 format: double bankId: type: string description: A unique identifier for the financial institution handling the transaction example: Bank_1 addressId: type: string description: A unique identifier for the address associated with the payee or policyholder example: "1" forBenefitOfOrForFurtherCredit: type: string description: FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out) example: John Doe forBenefitOfOrForFurtherCreditIndicator: type: boolean example: true description: Indicates whether the outgoing funds are being requested for the benefit of or for further credit to another person or organization. AdhocFundAllocation: type: object properties: allocationOption: $ref: "#/components/schemas/AllocationOption" amountType: $ref: "#/components/schemas/AmountType" AdhocFundDistributions: type: object properties: fundId: type: string description: A unique identifier assigned to a specific fund account within the investment structure fundName: type: string description: The official business name of the specific fund account within the investment structure totalFundValue: type: number description: The total value of the specific fund account within the investment structure.The total fund value of the a specific fund, considering any earnings, withdrawals, or adjustments due to transaction requestedAmount: type: number description: The specific amount or percentage requested for withdrawal, transfer, or reallocation from the selected fund.This amount will be utilized when allocation option is selected as specified funds distributionAmountType: $ref: "#/components/schemas/DistributionAmountType" fundDistributionSegments: type: array items: $ref: "#/components/schemas/AdhocFundDistributionSegment" Charge: type: object properties: chargeType: $ref: "#/components/schemas/TransactionChargeType" chargeWaiverIndicator: $ref: "#/components/schemas/ChargeWaiverIndicator" chargeWaiverReason: type: string description: The reason why a charge was waived (e.g., Promotional Waiver, Policy Exception) example: "100" partyId: type: string description: The partyId to which the charge is applied. example: Party_PI_1 Suppression: type: object properties: suppressionType: $ref: "#/components/schemas/SuppressionType" suppressionReason: type: string description: Specifies the specific reason or justification for applying the suppression. It explains why the suppression was applied. PartyRole: type: string enum: - OWNER - PRIMARYBENEFICIARY - CONTINGENTBENEFICIARY - INSURED - PAYOR - PAYEE - AGENT - PRIMARYWRITINGAGENT - PRIMARYSERVICINGAGENT - ADDITIONALSERVICINGAGENT - ADDITIONALWRITINGAGENT - THIRDPARTYDESIGNEE - JOINTOWNER - COVERAGEINSURED - ASSIGNEE - ANNUITANT - EXCHANGECOMPANY - JOINTANNUITANT - GRANTOR - TRUSTEE - POWEROFATTORNEY - AUTHORIZEDSIGNATORY - OTHERINTERESTEDPARTY - CONTINGENTOWNER - THIRDPARTYADMINISTRATOR - CARRIER - SUCCESSORTRUSTEE - COVERAGEJOINTINSURED AllocationOption: type: string enum: - PRORATA - DOLLAR - SPECIFYPERCENTAGE - SPECIFIEDFUNDS - SPECIFIEDSEGMENTS - DEFAULT - PECKINGORDER - EARNINGSONLY - SPECIFICFUNDPERCENTAGE - FIXEDONLY - VARIABLEONLY - CURRENTHOLDINGS DistributionAmountType: type: string enum: - PERCENTAGE - AMOUNT - UNIT AdhocFundDistributionSegment: type: object properties: segmentId: type: string description: A unique identifier assigned to a particular segment for a specific fund account within the investment structure currentAmount: type: number requestedAmount: type: number TransactionChargeType: type: string enum: - COSTOFINSURANCE - EXPENSECHARGE - UNITEXPENSECHARGE - RIDERCHARGE - SURRENDERCHARGE - WITHDRAWALCHARGE - PAYMENTCHARGE - COVERAGECHARGE - COVERAGECREDIT - PREMIUMTAX - MARKETVALUEADJUSTMENT - BONUSRECAPTURE - EQUITYINDEXADJUSTMENT - PRODUCTLIMITS - DEATHBENEFITINTEREST - FUTURECHARGESFORTRANSACTION - REDEMPTIONFEE - MAILCHARGE - FUNDFEE - INEFFECT - ALL - OVERNIGHTMAIL - WIRE ChargeWaiverIndicator: type: string enum: - Yes - No SuppressionType: type: string description: Specifies the category or type of suppression being applied to a transaction. It indicates what kind of suppression is in effect. enum: - CORRESPONDENCE - TAX - DISBURSEMENT - COMMISSION AdhocSystematicProgram: type: object properties: paymentForm: $ref: "#/components/schemas/PaymentForm" arrangementType: $ref: "#/components/schemas/ArrangementType" amountType: $ref: "#/components/schemas/AmountType" amount: type: number example: 5.132 description: Requested amount value format: double frequency: $ref: "#/components/schemas/Frequency" startDate: format: date type: string example: 2020-01-01 description: Date (with pattern "yyyy-mm-dd") endDate: format: date type: string example: 2023-01-01 description: Date (with pattern "yyyy-mm-dd") previousProgramDate: format: date type: string example: 2018-01-01 description: Date (with pattern "yyyy-mm-dd") nextProgramDate: format: date type: string example: 2023-01-01 description: Date (with pattern "yyyy-mm-dd") distributionCode: $ref: "#/components/schemas/DistributionCode" party: $ref: "#/components/schemas/BaseAdhocParty" parties: type: array items: $ref: "#/components/schemas/AdhocDisbursementParty" externalArrangementId: type: string description: The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program segmentId: type: string description: A unique identifier assigned to a specific loan segment example: Segment1 accountNumber: type: string description: The unique identifier representing the policy or account associated with the transaction for DTCC money movement. example: "123456789" participantId: type: string description: The DTCC Participant ID (also known as DTCC Number or Participant Number) assigned by DTCC to financial institutions. example: DTCC12345 fundAllocation: $ref: "#/components/schemas/AdhocFundAllocation" fundDistributions: type: array items: $ref: "#/components/schemas/AdhocFundDistributions" charges: type: array items: $ref: "#/components/schemas/Charge" suppression: type: array items: $ref: "#/components/schemas/Suppression" ```