--- title: "FinancialTransaction" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/FinancialTransaction" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # FinancialTransaction ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://qa.api.zinnia.io components: schemas: FinancialTransactionTransactionTypeEnum: type: string enum: - PartialWithdrawalOneTime - FullSurrender - NewLoan - OneTimePremium - SystematicProgramUpdate - LoanRepaymentOneTime - SystematicLoanRepaymentSetup TransactionAmount: type: object properties: requestedAmount: type: number format: double example: 100.41 description: "Depending on the transaction, it will be one of the following: The amount requested for premium allocation or processing. The requested amount for issuing a new loan against the policy. The amount requested to initiate a loan repayment transaction. The requested amount for a partial withdrawal from the policy’s cash value. The requested amount for making adjustments to the policy’s value.This transaction overrides the value and do not adjust. Request amount shared for this variable will be utilized to override existing policy variable. Example: Cost basis change using value adjustment transaction, Old cost basis: $200, Value Adjustment Request Amount: $120, New Cost basis: $120." amountType: $ref: "#/components/schemas/AmountType" disbursementType: $ref: "#/components/schemas/DisbursementType" disbursementPaymentForm: $ref: "#/components/schemas/DisbursementPaymentForm" distributionCode: $ref: "#/components/schemas/DistributionCode" loanType: $ref: "#/components/schemas/LoanType" loanInterestType: $ref: "#/components/schemas/LoanInterestType" accountNumber: type: string example: "123456789" description: The unique identifier representing the policy number associated with a transaction for DTCC money movement. participantId: type: string example: "123456789" description: The DTCC Participant ID (also known as a DTCC Number or Participant Number) is a unique identifier assigned by the Depository Trust & Clearing Corporation (DTCC) to financial institutions — such as broker-dealers, banks, or mutual funds — that participate in DTCC’s clearing and settlement systems. paymentAmount: type: number format: double description: "Depending on the transaction, it will be one of the following: The amount used for drafting requested premium amount. The amount used for drafting requested loan repayment amount" example: 100.31 appliedAmount: type: number format: double description: "Depending on the transaction, it will be one of the following: - The portion of the requested premium that was successfully applied to the account value of the policy. - The portion of the requested loan amount that was actually applied on the policy. - The portion of the requested loan repayment amount that was applied on the policy. - The portion of the requested withdrawal amount that was applied on the policy. - The total amount applied toward the full surrender of the policy. - The portion of a transaction applied amount that is summation of all fund level applied amounts impacted due to the transaction. - The updated face amount successfully applied to the policy. - The amount refunded as part of a free-look period cancellation (policy cancellation within the allowable period). - The policy’s value before an adjustment is applied." example: 100.29 freeAppliedAmount: type: number format: double description: The portion of a transaction applied amount(e.g., withdrawal) that was processed without incurring charges or penalties example: 100.18 calculatedAmount: type: number format: double description: The system-determined premium amount based on policy calculations, this will be set as premium applied amount plus any applicable charges example: 100.19 totalChargeAmount: type: number format: double description: The total amount of fees or charges applied to the transaction which is summation of individual charges example: 100.41 taxableAmount: type: number format: double description: The portion of a transaction applied amount that is considered taxable based on IRS regulations example: 100.23 deathClaimPayoutPreStateSpecificInterest: type: number format: double description: The claim payout amount before applying Supplemental Security Income (SSI) offsets or adjustments example: 1000.91 claimStatutoryInterestAmount: type: number format: double description: The statutory interest amount paid as part of a claim settlement. This is the SSI amount example: 1000.41 deathBenefitInterestCalculatedFromDate: $ref: "#/components/schemas/DeathBenefitInterestCalculatedFromDate" claimStatutoryInterestRate: type: number format: double description: The state specific interest rate applied to the statutory claim payout example: 1000.51 claimCode: $ref: "#/components/schemas/ClaimCode" distributionInternalRevenueServiceCode: type: string description: The IRS tax reporting code associated to the distribution code example: LD offageAmount: type: number description: The difference between requested amount and applied amount for premium transactions example: 100.81 format: double excessPremium: type: number description: In transaction context, Excess Premium is the amount of premium applied beyond allowable or intended limits under a policy, triggering compliance review, refund, or corrective action example: 100.91 format: double targetPremium: type: number description: Target Premium is the planned annual premium amount set at issue for flexible premium policies. It serves as a benchmark for funding, performance monitoring, and commission purposes, but does not represent a required payment example: 100.19 format: double netPaymentAmount: type: number description: The net amount actually received from the agent to be applied to the policy example: 48000.28 format: double retainedCommissionAmount: type: number description: The difference between the net amount actually received and gross amount applied to the policy. example: 2000.29 format: double premiumPortionAmount: type: number format: double example: 1000.51 description: The amount paid toward the premium when the policy has a loan balance. loanRepaymentPortionAmount: type: number format: double example: 1000.51 description: The amount paid toward the Loan Repayment when the policy has a loan balance. statutoryInterestCalculationFromDate: type: string format: date description: The effective date from which statutory interest should begin to be calculated for the transaction example: 2023-01-01 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 TransactionFundAllocation: type: object properties: allocationOption: $ref: "#/components/schemas/AllocationOption" FundDistribution: type: object properties: fundId: type: string description: A unique identifier assigned to a specific fund account within the investment structure example: FundAccount1 fundName: type: string description: The official business name of the specific fund account within the investment structure example: Fund1 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 format: double example: 100 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 format: double example: 100 fundDistributionSegments: type: array items: $ref: "#/components/schemas/FundDistributionSegment" FundActivity: type: object properties: fundId: type: string description: A unique identifier assigned to a specific fund account within the investment structure example: FundAccount1 fundName: type: string description: The official business name of the fund account as designated by the financial institution or insurance provider. This name identifies the specific fund within the investment structure example: Fund Account 1 fundAccountType: type: string enum: - FIXED - INDEXED - VARIABLE description: Represents the classification of a fund based on its investment strategy/flexiblity,and structure. It defines how the fund is structured and managed, such as whether it focuses on equities, fixed income, or other investment categories 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 format: double appliedAmount: type: number format: double description: The total amount or percentage applied for withdrawal, transfer, or reallocation from the selected fund example: 100 fundActivitySegments: type: array items: $ref: "#/components/schemas/FundActivitySegment" MatchActivity: type: object properties: currentAmount: type: number description: This is total value of bonus or match post transaction processing including interest. This value will be populated on transaction which impacts bonus calculations. For e.g. premium, match bonus vesting example: 100 segmentActivity: $ref: "#/components/schemas/SegmentActivity" LoanActivity: type: object properties: totalLoanBalance: type: number example: 100 description: The total outstanding loan amount, including both principal and accrued interest format: double totalLoanAccruedInterest: type: number description: The accumulated interest on the outstanding loan balance example: 100 format: double repaymentInterestAmount: type: number example: 100 format: double description: The amount of interest repaid as part of transaction. This gets calculated on events such as loan repayment, systematic loan repayment,etc loanSegments: type: array items: $ref: "#/components/schemas/LoanActivitySegment" TaxWithholdingInstructions: type: object properties: partyId: type: string description: A unique identifier linking the party to the policy example: Party_PI_1 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 description: Roles that are essential in structuring life insurance and annuity contracts to meet the financial goals of policyholders and beneficiaries taxWithholdingType: $ref: "#/components/schemas/TaxWithholdingType" taxRateToUse: $ref: "#/components/schemas/TaxRateToUse" filingStatus: $ref: "#/components/schemas/FilingStatus" dollar: type: number description: The amount portion of the taxable transaction amount to be withheld example: 10 format: double percentage: type: number description: The percentage of the taxable transaction amount to be withheld example: 50 format: double exemptions: type: number description: The number of exemptions claimed for tax withholding within a tax year example: 0 format: int32 taxJurisdiction: type: string description: The legal tax authority (state or federal) governing the withholding process example: USA_WY contribution: type: string enum: - NOTAPPLICABLE - EMPLOYEEVOLUNTARY - EMPLOYEEDISCRETIONARY description: Not applicable, Employee Voluntary and Employee Discretionary taxFormType: type: string enum: - T1035COSTBASIS - T1035LOANTRANSFER - T1035SURRENDER - T1035TAXADVANTAGE - T1099R - TAXDISCLOSUREFORMW4P - TAXDISCLOSUREFORMW8 - USW4TAXFORM - W9 - VOIDCHECK description: The Tax Form Type refers to the specific IRS or government form used as the basis for determining an individual’s or entity’s tax withholding status on financial products such as life insurance policies, annuities, or investment accounts w4p: $ref: "#/components/schemas/W4P" TaxWithheldAmount: type: object properties: partyRole: $ref: "#/components/schemas/PartyRole" partyId: type: string example: Party_PI_1 description: A unique identifier linking the party to the policy taxWithholdingType: $ref: "#/components/schemas/TaxWithholdingType" withheldAmount: type: number format: double example: 100 description: The actual dollar amount withheld for taxes withheldTaxableAmount: type: number format: double example: 100 description: The portion of the transaction amount eligible for taxation taxableFlag: type: boolean description: Indicates whether the transaction is taxable appliedTaxRate: type: number format: double example: 100 description: The actual tax rate used for withholding calculations Payor: type: object properties: id: type: string policyDetailsId: type: string ledgerDocId: type: string timestamp: format: date-time type: string policyNumber: type: string partyMasterId: type: string partyId: type: string idReferenceNo: type: string beneficiaryPercentage: type: number partyType: type: string url: $ref: "#/components/schemas/Url" firstName: type: string middleName: type: string lastName: type: string fullName: type: string prefix: type: string suffix: type: string gender: type: string dateOfBirth: type: string attainedAge: type: number birthCountry: type: string birthState: type: string dba: type: string abbrName: type: string orgCode: type: string entityType: type: string trustDate: type: string trustType: type: string prefCommunicationType: type: string formerName: $ref: "#/components/schemas/FormerName" identifications: type: array items: $ref: "#/components/schemas/Identification" addresses: type: array items: $ref: "#/components/schemas/Address" phones: type: array items: $ref: "#/components/schemas/Phone" emails: type: array items: $ref: "#/components/schemas/Email" bankDetails: type: array items: $ref: "#/components/schemas/BankDetails" dateOfDeath: type: string stateOfDeath: type: string disabled: type: boolean disabilityStartDate: type: string riskDetails: $ref: "#/components/schemas/RiskDetails" financialInstitutionPartyId: type: string percentage: type: number version: type: number required: - id - policyDetailsId - ledgerDocId - timestamp - policyNumber - partyMasterId - partyId - idReferenceNo - beneficiaryPercentage - partyType - url - firstName - middleName - lastName - fullName - prefix - suffix - gender - dateOfBirth - attainedAge - birthCountry - birthState - dba - abbrName - orgCode - entityType - trustDate - trustType - prefCommunicationType - formerName - identifications - addresses - phones - emails - bankDetails - dateOfDeath - stateOfDeath - disabled - disabilityStartDate - riskDetails - financialInstitutionPartyId - percentage - version PayeeOrBeneficiary: type: object properties: partyId: type: string description: A 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 example: Bank_1 description: A unique identifier for the financial institution handling the transaction required: - allocationPercentage FinancialTransactionRequestTypeEnum: type: string enum: - Quote - Actual CaseRequest: type: object properties: caseCorrelationId: type: string caseId: type: string caseStatus: type: string requestSource: type: string carrierId: type: string productId: type: string userId: type: string policyNumber: type: string required: - caseCorrelationId - caseId - caseStatus - requestSource - carrierId - productId - userId - policyNumber CaseResponse: type: object properties: caseErrorCode: type: string caseErrorDescription: type: string required: - caseErrorCode - caseErrorDescription Schedule: type: object properties: amountType: type: string amount: type: number nextProgramDate: type: string required: - amountType - amount - nextProgramDate RemovePayor: type: object properties: partyRole: type: string partyId: type: string required: - partyRole - partyId 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 DisbursementType: type: string enum: - GROSS - NET - NETNET DisbursementPaymentForm: type: string enum: - DTCC - EFT - ACH - CHECK - WIRE 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 LoanType: type: string enum: - PREFERRED - NONPREFERREDSTANDARDLOAN - INDEXLOAN LoanInterestType: type: string enum: - FIXED - INDEXED - VARIABLE - ADJUSTABLE DeathBenefitInterestCalculatedFromDate: type: string enum: - DATEOFDEATH - DATEOFDEATHREPORTED ClaimCode: type: string enum: - DEATH - RIDER 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 AllocationOption: type: string enum: - PRORATA - DOLLAR - SPECIFYPERCENTAGE - SPECIFIEDFUNDS - SPECIFIEDSEGMENTS - DEFAULT - PECKINGORDER - EARNINGSONLY - SPECIFICFUNDPERCENTAGE - FIXEDONLY - VARIABLEONLY - CURRENTHOLDINGS FundDistributionSegment: type: object properties: segmentId: type: string description: A unique identifier assigned to a particular segment for a specific fund account within the investment structure example: segment1 currentAmount: type: number description: The current value of the particular segment for a specific fund account within the investment structure. The current amount of the segment, considering any earnings, withdrawals, or adjustments due to transaction format: double example: 1000 requestedAmount: type: number format: double example: 100 description: The specific amount or percentage requested for withdrawal, transfer, or reallocation from the particular segment selected for a fund.This amount will be utilized when allocation option is selected as specified segments FundActivitySegment: type: object properties: segmentId: type: string description: A unique identifier assigned to a particular segment for a specific fund account within the investment structure example: segment1 currentAmount: type: number description: The current value of the particular segment for a specific fund account within the investment structure. The current amount of the segment, considering any earnings, withdrawals, or adjustments due to transaction format: double example: 100 segmentActivity: $ref: "#/components/schemas/SegmentActivity" SegmentActivity: type: object properties: segmentId: type: string description: A unique identifier assigned to a particular segment for a specific fund account within the investment structure example: segment1 appliedRate: type: number description: "For funds: The rate at which an activity (e.g., interest, withdrawal, allocation) is applied. For match: The percentage rate at which the match or bonus contribution current value grows. For loans: The interest rate applied to the loan balance to calculate accrued interest" format: double example: 100 appliedAmount: type: number description: "For funds: The specific amount or percentage applied for withdrawal, transfer, or reallocation from the particular segment selected for a fund. For match: This is transaction level amount which tracks changes to match current value. This gets calculated on events such as interest credit match, premium, match bonus vesting. For loans: This is transaction level amount which tracks changes to loan balance . This gets calculated on events such as interest loan,loan repayment, loan true up,new loan,etc." format: double example: 100 appliedInterest: type: number description: Applied Interest refers to the amount of loan interest that has been posted (charged) to the policy’s outstanding loan balance during a specific accounting period. This interest is based on the terms of the policy loan, such as the loan type (fixed or variable), rate, and method of interest format: double example: 100 LoanActivitySegment: type: object properties: segmentId: type: string description: A unique identifier assigned to a specific loan segment example: Segment1 loanBalance: type: number description: The outstanding loan amount, including both principal and accrued interest at segment level example: 100 format: double loanAccruedInterest: type: number description: The accumulated interest on the outstanding loan balance at segment level example: 100 format: double percentageOfAccountValue: type: number description: Percentage of Account Value refers to a value that is calculated as a percentage of the total account value of an insurance or annuity contract. It is often used to determine allocations, fees, benefits, or charges that are based on how much money is currently held in the policy's account value. example: 1500.72 format: double repaymentInterestAmount: type: number example: 100 format: double description: Loan Interest Repaid with current Repayment Transaction segmentActivity: $ref: "#/components/schemas/SegmentActivity" TaxWithholdingType: type: string enum: - FEDERAL - STATE - NRA - BACKUP TaxRateToUse: type: string enum: - NOWITHHOLDINGELECTED - USEVALUESENTERED - NOWITHHOLDINGALLOWED - USEDEFAULTTABLE - ADDITIONALWITHHOLDING - TAKEINPUTTEDVALUE FilingStatus: type: string enum: - SINGLE - DOMESTICPARTNERSHIP - DEFAULT - MARRIED - HEADOFHOUSEHOLD - WIDOWED - DIVORCED - MARRIEDFILINGSEPARATELY W4P: type: object properties: totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities: type: number format: double example: 12.12 description: "Below Amounts are for periodic Payments Only - Certain States Require these amounts to be entered " totalAmountOfClaimsAndOtherCredits: type: number format: double example: 213.73 description: "This indicates the total amount of tax claims and credits party is eligible for to reduce the tax liabilities " otherIncome: type: number format: double example: 144.53 description: "Not from Jobs or Pension/Annuities " otherDeduction: type: number format: double example: 42.83 description: If Standard Deduction is not used 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 Url: type: object properties: website: type: string description: Carrier or Third party administrator website example: https://zinnialive.com/ carrierLogin: type: string description: Carrier login example: https://zinnialive.com/ agentLogin: type: string description: Agent login example: https://zinnialive.com/ customerLogin: type: string description: Customer login example: https://wellabe.mypolicyview.com/ FormerName: type: object properties: firstName: type: string description: Former first name of the party/trustee example: Karen middleName: type: string description: Former middle name of the party/trustee example: Anne lastName: type: string description: Former last name of the party/trustee example: Bates prefix: $ref: "#/components/schemas/Prefix" suffix: type: string enum: - JR - SN - SR - I - II - III - IV - V - VI - VII description: The suffix of the party name fullName: type: string description: Former full name of the party/Former legal name of the Trust/Organization example: Karen Anne Bates abbreviatedName: type: string description: The former shortened/abbreviated version of the organization`s name that is unique to the organization example: TBD doingBusinessAs: type: string description: The former name the organization is commonly known as example: TBD Identification: type: object properties: identificationId: type: string description: A unique system-generated ID for tracking individual identifier records example: "1" startDate: type: string description: The date from which the party`s identifier is considered valid. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: The date after which the party`s identifier is no longer valid. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date identificationType: type: string enum: - PASSPORT - STATEPHOTOID - DRIVERLICENSENUMBER - SSN - TIN - EXTERNAL - EIN - NATIONALPRODUCERNUMBER - OTHER description: Specifies the kind of identifier provided for a party. It describes what type of document or number is being used to recognize or verify the party's identity nullable: true identificationKey: type: string example: 666-50-8548 description: A unique code (such as ECN, Life Party ID, or Series Code) used to uniquely identify and manage individuals, entities, or product groupings within life insurance and annuity systems identificationValue: type: string example: 666-50-8548 description: The unique number of the selected identification type nullable: true identificationDescription: type: string example: Employee Control Number description: A brief description of the identifier. issueState: type: string enum: - AA - AE - AL - AP - AK - AZ - AR - AS - CA - CO - CT - DC - DE - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MP - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UM - UT - VT - VA - VI - WA - WV - WI - WY nullable: true issueCountry: type: string enum: - US - CA - RU - EG - ZA - GR - NL - BE - FR - ES - HU - IT - RO - CH - AT - GB - DK - SE - NO - PL - DE - PE - MX - CU - AR - BR - CL - CO - VE - MY - AU - ID - PH - NZ - SG - TH - JP - VN - CN - TR - IN - PK - AF - LK - IR - MA - DZ - TN - LY - GM - SN - MR - ML - GN - BF - NE - TG - BJ - MU - LR - SL - GH - NG - CF - TD - CM - CV - ST - GQ - GA - BS - AO - BB - AX - SD - RW - ET - SO - DJ - KE - TZ - UG - BI - MZ - ZM - MG - RE - ZW - NA - MW - LS - BW - AG - KM - GW - CD - VG - SH - AW - FO - GL - KY - GI - PT - LU - IE - IS - AL - MT - CY - FI - BG - GG - LT - LV - EE - MD - AM - BY - AD - SM - UA - HR - SI - BA - MK - XK - CZ - SK - LI - BM - GD - FK - BZ - GT - SV - HN - NI - CR - PM - HT - PR - VI - GS - SX - BQ - GP - BO - GY - EC - GF - PY - MQ - SR - UY - AN - TC - BL - MF - MS - GU - AQ - BN - NR - PG - TO - SB - VU - FJ - WF - CK - NU - AS - KI - NC - TV - PF - MP - PW - MH - FM - SS - LC - DM - VC - DO - HK - MO - KH - LA - TT - KN - JM - BD - TW - MM - KR - KP - LB - JO - SY - IQ - KW - SA - OM - AE - IL - BH - QA - BT - NP - TJ - TM - AZ - GE - UZ - AI - PA - CI - ER - KZ - KG - CC - MN - BV - SC - IO - WS - TL - TF - YT - PN - SJ - TK - UM - EH - MV - CX - NF - CG - MC - VA - SZ - PS - JE - IM - RS - ME - HM - CW - CS - YE - YD - SU - YU - ZR nullable: true Address: type: object properties: startDate: type: string description: The start date of the party address. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 endDate: type: string description: The end date of the party address. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 addressType: $ref: "#/components/schemas/AddressType" addressLine1: type: string description: Address Line 1 of the party address example: 1112 Pickle Street addressLine2: type: string description: Address Line 2 of the party address example: South Jersey addressLine3: type: string description: Address Line 3 of the party address example: 1234 Post box city: type: string description: City of the party address example: Garden City state: $ref: "#/components/schemas/State" zipCode: type: string description: Zip code of the party address example: "67846" zipCodeExtension: type: string description: Unit of the party address example: "23" country: $ref: "#/components/schemas/Country" isPreferred: type: boolean description: TBD addressId: type: string description: The record Id stored internally in zahara for each address example: "1" preferredAddress: type: boolean description: TBD example: false Phone: type: object properties: startDate: type: string description: The start date of when the party can be reached via the phone.Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: The end date of when the party can be reached via the phone. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date phoneType: $ref: "#/components/schemas/PhoneType" countryCode: type: string description: Country Code of the phone example: "9" areaCode: type: string description: Area code of the phone example: "973" dialNumber: type: string description: Dial number of the phone example: "765789" extension: type: string description: Dial in Extension for phone example: "null" bestTime: type: string description: The best time to contact the party via phone example: "null" timezone: type: string description: Timezone for the entered phone details example: "null" isPreferred: type: boolean description: The Preferred Phone Indicator is a boolean flag or attribute assigned to each phone number associated with a party, used to identify which phone number should be used as the primary contact number for communication phoneId: type: string description: The record Id stored internally in zahara for each phone example: "1" Email: type: object properties: startDate: type: string description: The start date of when the party can be reached via email.Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date endDate: type: string description: The end date of when the party can be reached via email. Date (with pattern "yyyy-mm-dd") example: 2023-01-01 format: date emailType: $ref: "#/components/schemas/EmailType" emailAddress: type: string description: Email address of the party example: user@example.com isPreferred: type: boolean description: The Preferred Email Indicator is a boolean flag associated with each email address linked to a party, used to designate which email address should be treated as the primary contact for electronic communications emailId: type: string description: The record Id stored internally in zahara for each email example: "1" BankDetails: type: object properties: recordId: type: number appliesToPartyId: type: string financialInstitutionPartyId: type: string startDate: type: string endDate: type: string nameOnAccount: type: string accountStatus: type: string accountType: type: string accountNumber: type: string routingNumber: type: string ibaNumber: type: string branchName: type: string accountPurpose: type: string branchAddress: $ref: "#/components/schemas/Address" branchPhoneNumber: type: string required: - recordId - appliesToPartyId - financialInstitutionPartyId - startDate - endDate - nameOnAccount - accountStatus - accountType - accountNumber - routingNumber - ibaNumber - branchName - accountPurpose - branchAddress - branchPhoneNumber RiskDetails: type: object properties: existingLifeInsurance: type: boolean existingLifeInsuranceAmount: type: number replaceLifeInsurance: type: boolean pendingOrPlanToBuyAdditional: type: boolean isDependent: type: boolean employed: type: boolean employmentStatus: type: string occupation: type: string householdIncome: type: number required: - existingLifeInsurance - existingLifeInsuranceAmount - replaceLifeInsurance - pendingOrPlanToBuyAdditional - isDependent - employed - employmentStatus - occupation - householdIncome PaymentForm: type: string enum: - DTCC - CREDITCARD - ACH - CHECK - WIRE - EXCHANGE - PREMIUMLOAN Prefix: type: string enum: - MR - MS - MISS - MRS - DR AddressType: type: string enum: - RESIDENCE - BUSINESS - POBOX - SEASONAL - SECONDARY - MAILING State: type: string enum: - AA - AE - AL - AP - AK - AZ - AR - AS - CA - CO - CT - DC - DE - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MP - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UM - UT - VT - VA - VI - WA - WV - WI - WY Country: type: string enum: - US - CA - RU - EG - ZA - GR - NL - BE - FR - ES - HU - IT - RO - CH - AT - GB - DK - SE - NO - PL - DE - PE - MX - CU - AR - BR - CL - CO - VE - MY - AU - ID - PH - NZ - SG - TH - JP - VN - CN - TR - IN - PK - AF - LK - IR - MA - DZ - TN - LY - GM - SN - MR - ML - GN - BF - NE - TG - BJ - MU - LR - SL - GH - NG - CF - TD - CM - CV - ST - GQ - GA - BS - AO - BB - AX - SD - RW - ET - SO - DJ - KE - TZ - UG - BI - MZ - ZM - MG - RE - ZW - NA - MW - LS - BW - AG - KM - GW - CD - VG - SH - AW - FO - GL - KY - GI - PT - LU - IE - IS - AL - MT - CY - FI - BG - GG - LT - LV - EE - MD - AM - BY - AD - SM - UA - HR - SI - BA - MK - XK - CZ - SK - LI - BM - GD - FK - BZ - GT - SV - HN - NI - CR - PM - HT - PR - VI - GS - SX - BQ - GP - BO - GY - EC - GF - PY - MQ - SR - UY - AN - TC - BL - MF - MS - GU - AQ - BN - NR - PG - TO - SB - VU - FJ - WF - CK - NU - AS - KI - NC - TV - PF - MP - PW - MH - FM - SS - LC - DM - VC - DO - HK - MO - KH - LA - TT - KN - JM - BD - TW - MM - KR - KP - LB - JO - SY - IQ - KW - SA - OM - AE - IL - BH - QA - BT - NP - TJ - TM - AZ - GE - UZ - AI - PA - CI - ER - KZ - KG - CC - MN - BV - SC - IO - WS - TL - TF - YT - PN - SJ - TK - UM - EH - MV - CX - NF - CG - MC - VA - SZ - PS - JE - IM - RS - ME - HM - CW - CS - YE - YD - SU - YU - ZR PhoneType: type: string enum: - MOBILE - HOME - BUSINESS - CLAIMCENTER - CUSTOMERSERVICE - CORPORATEOFFICE - FAX - UNKNOWN - OTHER EmailType: type: string enum: - PERSONAL - BUSINESS - CUSTOMERSERVICE - OTHER FinancialTransaction: type: object properties: id: type: string policyDetailsId: type: string ledgerDocId: type: string timestamp: format: date-time type: string policyNumber: type: string transactionId: type: string externalTransactionId: type: string correlationId: type: string parentId: type: string transType: type: string transactionType: $ref: "#/components/schemas/FinancialTransactionTransactionTypeEnum" requestDate: type: string effectiveDate: type: string processDate: type: string status: type: string action: type: string outcome: type: boolean outcomeStatus: type: string outcomeCode: type: string outcomeCodeDescription: type: string transactionReason: type: string processNo: type: number transactionAmounts: $ref: "#/components/schemas/TransactionAmount" charges: type: array items: $ref: "#/components/schemas/Charge" fundAllocation: $ref: "#/components/schemas/TransactionFundAllocation" fundDistributions: type: array items: $ref: "#/components/schemas/FundDistribution" fundActivity: type: array items: $ref: "#/components/schemas/FundActivity" matchActivity: $ref: "#/components/schemas/MatchActivity" loanActivity: $ref: "#/components/schemas/LoanActivity" taxWithholdingInstructions: type: array items: $ref: "#/components/schemas/TaxWithholdingInstructions" taxWithheldAmounts: type: array items: $ref: "#/components/schemas/TaxWithheldAmount" payor: type: array items: $ref: "#/components/schemas/Payor" payeeOrBeneficiary: type: array items: $ref: "#/components/schemas/PayeeOrBeneficiary" lifecycleNo: type: number reverseInitiator: type: boolean default: false caseId: type: string partyId: type: string requestType: $ref: "#/components/schemas/FinancialTransactionRequestTypeEnum" caseRequest: $ref: "#/components/schemas/CaseRequest" caseResponse: $ref: "#/components/schemas/CaseResponse" programType: type: string systematicProgramId: type: string frequency: type: string startDate: type: string endDate: type: string schedule: $ref: "#/components/schemas/Schedule" removePayor: $ref: "#/components/schemas/RemovePayor" version: type: string required: - id - policyDetailsId - ledgerDocId - timestamp - policyNumber - transactionId - externalTransactionId - correlationId - parentId - transType - requestDate - effectiveDate - processDate - status - action - outcome - outcomeStatus - outcomeCode - outcomeCodeDescription - transactionReason - processNo - transactionAmounts - charges - fundAllocation - fundDistributions - fundActivity - matchActivity - loanActivity - taxWithholdingInstructions - taxWithheldAmounts - payor - payeeOrBeneficiary - lifecycleNo - caseId - partyId - caseRequest - caseResponse - programType - systematicProgramId - frequency - startDate - endDate - schedule - removePayor - version ```