--- title: "TransactionAmount" url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/TransactionAmount" --- > Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md # TransactionAmount ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: Policy Service version: 0.0.21 servers: - url: https://qa.api.zinnia.io components: schemas: 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 - NUMBEROFUNITS 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 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 ```