Search
K
Policy

Rules

object
variablestring
entityTypestring
debitAccountstring
creditAccountstring
ledgerTypestring
Example

AccountingEntryRules

object
idstring

The ID of the rule

Example:65a867a326d49513ae85c2d3

timestampstring

The timestamp of the rule

Example:2023-01-01T12:00:00.000Z

productTypestring

Allowed values:WHOLELIFEUNIVERSALLIFEVARIABLEUNIVERSALLIFEVARIABLEWHOLELIFEINDEXEDUNIVERSALLIFEFIXEDANNUITYFIXEDINDEXEDANNUITYTERMTERMWITHCASHVALUE

transactionTypestring

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

rulesarray[object]

The rules for the entry

Show Child Parameters
carrierIdstring

The Carrier ID is a unique identifier assigned to an insurance company (carrier) that issues and underwrites a policy. It helps track, manage, and differentiate insurance providers within industry databases, regulatory systems, and digital platforms

Example:SB

carrierSetIdstring

The carrier set ID

Example:SBCOC

planCodestring

The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration

Example:SBFIXUL1

qualificationTypestring

Qualification type of original policy being exchanged

Allowed values:INDIVIDUALRETIREMENTACCOUNTREGULARINDIVIDUALRETIREMENTACCOUNTSPOUSALINDIVIDUALRETIREMENTACCOUNTROLLOVERROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALINDIVIDUALRETIREMENTACCOUNTCUSTODIALROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNTQUALIFIEDNONQUALIFIEDSIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNTINHERITEDINDIVIDUALRETIREMENTACCOUNTINHERITEDROTHINDIVIDUALRETIREMENTACCOUNTNONQUALIFIEDSTRETCHINDIVIDUALRETIREMENTACCOUNTSIMPLEQ403BQ401KQ401AQ457BPENSIONPLANCONVERTEDINDIVIDUALRETIREMENTACCOUNTROTH403BCUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSIONKEOGH10CORPORATEPENSIONGROUPTAXSHELTEREDANNUITYPROFITSHARINGTARGETBENEFITCORPORATEDEFERREDCOMPENSATION404EDUCATIONALINDIVIDUALRETIREMENTACCOUNTQN457BCONVERTEDSPOUSALCUSTODIALUNIFORMGIFTSORTRANSFERSTOMINORACT

versioninteger(int32)

The version

Example:1

Example

AccountEntryRuleRequestFields

object
productTypestring

Allowed values:WHOLELIFEUNIVERSALLIFEVARIABLEUNIVERSALLIFEVARIABLEWHOLELIFEINDEXEDUNIVERSALLIFEFIXEDANNUITYFIXEDINDEXEDANNUITYTERMTERMWITHCASHVALUE

transactionTypestring

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

rulesarray[object]
Show Child Parameters
Example

Disbursement

object
idstring

Disbursement ID refers to the unique identifier assigned to a specific disbursement transaction within an insurance or annuity system. It is used to track, reference, and audit the payout or withdrawal of funds related to a policy, such as benefit payments, loans, withdrawals, or refunds

Example:65a867a326d49513ae85c2d3

correlationIdstring

The unique ID to track each transaction request across all systems

Example:657b717b7dcf554abf9ef067

sourcestring

Source System refers to the originating system or platform from which a financial transaction, policy event, or accounting entry is generated and passed into the general ledger or accounting engine. It identifies where the data came from, helping to track, validate, and audit entries across integrated insurance systems

Example:ZHA

carrierIdstring

Carrier Code is a unique identifier assigned to each insurance carrier (insurance company) within a system, typically used to distinguish between multiple carriers in a multi-carrier environment. It is essential for chart of account setup, policy administration, and reporting across insurance platforms

Example:SB

planCodestring

The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration

Example:SBFIXUL1

setIdstring

Carrier SET ID refers to a system-specific grouping identifier that represents a set of data, configuration, or financial parameters uniquely tied to a particular carrier within the chart of accounts and policy administration system

Example:SBCOC

businessUnitstring

AP Business Unit (Accounts Payable Business Unit) refers to the organizational entity or department responsible for processing and recording disbursements in the general ledger. It represents the source entity within the enterprise`s financial structure that issues payments, such as claims, withdrawals, policy loans, or refunds

Example:11001

invoiceDatestring(date)

Invoice Date refers to the date on which an invoice or payment request is issued or recorded for a disbursement transaction. In the context of insurance and annuity disbursements, this could relate to payments for claims, commissions, policy loans, refunds, or services provided (e.g., third-party administrator fees or vendor invoices)

Example:2024-01-18

invoiceIdstring

Invoice ID is a unique identifier assigned to a disbursement-related invoice, used for tracking, reconciliation, and audit purposes across financial and operational systems in insurance and annuity environments

Example:AK10000015

contractNumberstring

The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime

Example:AK10000015

transactionTypestring

Transaction Type refers to the specific kind of financial activity or event that occurs within a life insurance or annuity policy, and is used to trigger predefined accounting entry rules. It defines what the transaction represents (e.g., premium payment, claim payout, fee deduction), and determines how it should be recorded in the general ledger

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

parentTransactionTypestring

Parent Transaction Type refers to the original or primary business event that triggers or causes a related disbursement transaction (the “child” transaction). In insurance and annuity systems, it identifies the source action or condition that results in money being disbursed—such as a claim approval, policy loan request, withdrawal, or refund

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

transactionIdstring

Transaction ID is a unique identifier assigned to each financial or policy-related transaction within an insurance or annuity system. It serves as a reference key to track, audit, and link the transaction across systems—such as policy administration, billing, claims, and general ledger

Example:13

arNumberstring

AR Number stands for Accounts Receivable Number and refers to the unique identifier assigned to a receivable transaction that reflects money owed to the insurance company. In some insurance systems, it may also be used to track receivable offsets against disbursements, such as refunds, recoveries, or adjustments

Example:Party_PI_1

paymentMethodstring

The type of payment method such as DTCC,EFT or credit card

Example:EFT

netPaymentAmountnumber(double)

The actual dollar amount disbursed to the payee

Example:5

payeeGrossAmountnumber

TBD

Example:20

distributionInternalRevenueServiceCodestring

The IRS tax reporting code associated to the distribution code

Example:LD

distributionCodestring

Allowed values:DEFAULTPREMATUREDISTRIBUTIONEXCEPTIONAPPLIESDISABILITYDEATHDEATHEXCLUSIONDEATHROLLOVEREXCHANGE1035NORMALDISTRIBUTIONCOSTOFCURRENTLIFEINSURANCEPROTECTIONQUALIFIEDROLLOVERROTHDISTRIBUTIONNOEXCEPTIONQUALIFIEDLOANDISTRIBUTIONPREMATURELOANDISTRIBUTIONQUALIFIEDROTHINDIVIDUALRETIREMENTARRANGEMENTDISTRIBUTIONROTHINDIVIDUALRETIREMENTACCOUNTSDISTRIBUTIONEXCEPTIONAPPLIESEXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSTAXABLEIN2009NONTAXABLEEVENTGROSSPAIDTOATTORNEYOTHERINCOMENONEMPLOYEECOMPENSATIONPREMATUREEXCEPTIONROYALTIESDEATHTRANSFER4HPROHIBITEDTRANSACTIONTENYEARTAXOPTIONTRUSTEETOTRUSTEETRANSFERQUALIFIEDDOMESTICRELATIONSORDERLIKETOLIKENO1099DISTRIBUTIONSUNDEREMPLOYEEPLANSCOMPLIANCERESOLUTIONSYSTEMCHARITABLEGIFTLOANSASDISTRIBUTIONSQUALIFIEDPLANLOANOFFSETRECHARACTERIZEDINDIVIDUALRETIREMENTARRANGEMENTCURRENTYEAREXCESSCONTRIBUTION1YEARPRIORTAXRECHARACTERIZEDINDIVIDUALRETIREMENTACCOUNTSPREVIOUSYEAREARLYDISTRIBUTIONFROMSAVINGSINCENTIVEMATCHPLANFOREMPLOYEESDIRECTTRANSFEREXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSANDOREARNINGSTAXABLEIN2024EXCESSCONTRIBUTIONS2YEARPRIORTAXDIRECTROLLOVERQUALPLANTAXSHELTEREDANNUITYSEPARATIONFROMSERVICEINDIVIDUALRETIREMENTARRANGEMENTTOROTHINDIVIDUALRETIREMENTARRANGEMENTQUALIFIEDDOMESTICRELATIONSORDERROLLOVERTOINDIVIDUALRETIREMENTARRANGEMENT2GQUALIFIEDDOMESTICRELATIONSORDERPAYMENTTOSPOUSEFIRSTTIMEHOMEBUYERINDIVIDUALRETIREMENTARRANGEMENTONLYEDUCATIONEXPENSEMEDICALEXPENSEFEEADMINFEEASSETFEECONTRIBUTIONFEELUMPSUMDEATHFEELUMPSUMDISABILITYFEELUMPSUMPURCHASEDANNUITYFEELUMPSUMOTHERFEENEWRETIREEWITHPERPAYMENTFEEEXISTINGRETIREMENTINFORCEFEECONTRACTFEEEXISTINGRETIREMENTINCREASEFEETHIRDPARTYLUMPSUMDEATHLUMPSUMDISABILITYLUMPSUMPURCHASEDANNUITYLUMPSUMOTHERFEEINTERNATIONALPROGRAMSGROUPEXPENSEFROMFUNDRELEASERESERVEHEALTHDEDUCTIONFEEMARKETVALUEFEEANNUITYADMINISTRATIONSECTION1035EXCHANGEPARTIALQUALIFIEDDOMESTICRELATIONSORDERNORMALDISTRIBUTIONQUALIFIEDDOMESTICRELATIONSORDERSECTION1035FEELONGTERMCAREINSURANCEDESIGNATEDROTHACCOUNTDISTRIBUTIONREPORTABLEDEATHBENEFITSUNDERSECTION6050YDISTRIBUTIONOFTRADITIONALINDIVIDUALRETIREMENTARRANGEMENTASSETSNOTHAVINGAREADILYAVAILABLEFAIRMARKETVALUEDIVIDENDSDISTRIBUTEDFROMANEMPLOYEESTOCKOWNERSHIPPLANSUNDERSECTION404K

costBasisChangeAmountnumber(double)

The Cost Basis Change Amount refers to the difference between the old and new cost basis of a life insurance policy or annuity. It reflects adjustments due to premium payments, withdrawals, policy loans, 1035 exchanges, or other financial transactions that impact the total cost basis

Example:161.81698

ownerNamestring

Name of the owner

Example:KAREN Anne BATES

annuitantNamestring

Name of the annuitant

Example:KAREN Anne BATES

payeeNamestring

Name of the payee

Example:Karen Anne Bates

payeeAddressobject
Show Child Parameters
bankDetailobject
Show Child Parameters
forBenefitOfOrForFurtherCreditstring

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

timestampstring(date-time)

TBD

Example:2024-01-25T17:51:17.312Z

originalTransactionIdstring

The unique identifier of the reversed transaction. When a transaction is reversed, this field holds the ID of the original transaction that was reversed. We capture this to ensure proper tracking and auditing of financial adjustments within the system

Example:1

Example

AccountingEntries

object
idstring

The ID of the entry

Example:65a867a326d49513ae85c2d3

timestampstring

The timestamp of the entry

Example:2024-01-17T23:49:55.090Z

carrierIdstring

The Carrier ID is a unique identifier assigned to an insurance company (carrier) that issues and underwrites a policy. It helps track, manage, and differentiate insurance providers within industry databases, regulatory systems, and digital platforms

Example:SB

planCodestring

The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration

Example:SBFIXUL1

policyNumberstring

The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime

Example:AU0000001

qualificationTypestring

The Qualification Type in life insurance and annuities refers to the tax law provision or regulatory classification that governs a policy or contract, indicating whether it falls under a tax-advantaged retirement plan (IRA, 401(k), 403(b)) or a non-qualified account

Allowed values:INDIVIDUALRETIREMENTACCOUNTREGULARINDIVIDUALRETIREMENTACCOUNTSPOUSALINDIVIDUALRETIREMENTACCOUNTROLLOVERROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALINDIVIDUALRETIREMENTACCOUNTCUSTODIALROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNTQUALIFIEDNONQUALIFIEDSIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNTINHERITEDINDIVIDUALRETIREMENTACCOUNTINHERITEDROTHINDIVIDUALRETIREMENTACCOUNTNONQUALIFIEDSTRETCHINDIVIDUALRETIREMENTACCOUNTSIMPLEQ403BQ401KQ401AQ457BPENSIONPLANCONVERTEDINDIVIDUALRETIREMENTACCOUNTROTH403BCUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSIONKEOGH10CORPORATEPENSIONGROUPTAXSHELTEREDANNUITYPROFITSHARINGTARGETBENEFITCORPORATEDEFERREDCOMPENSATION404EDUCATIONALINDIVIDUALRETIREMENTACCOUNTQN457BCONVERTEDSPOUSALCUSTODIALUNIFORMGIFTSORTRANSFERSTOMINORACT

accountEntryTypestring

Account Entry Type refers to the categorization of a financial entry within an accounting system that indicates the nature or purpose of the entry being recorded. It helps define what the transaction represents and how it should be processed or interpreted in the general ledger

Example:DEBIT

accountNumberstring

Account Number refers to a unique numeric or alphanumeric identifier assigned to a general ledger account within the chart of accounts for an insurance carrier. It is used to classify and record financial transactions such as premiums, claims, commissions, reserves, or administrative expenses

Example:299032

accountPeriodnumber(int32)

Accounting Period refers to the specific span of time during which financial transactions are recorded, summarized, and reported in the accounting system. It is used to group entries within a defined time frame for financial reporting, reconciliation, and audit purposes.

Example:1

ledgerTypestring

Ledger Type refers to the classification of the general ledger (GL) in which a financial transaction is recorded, based on the purpose, scope, or basis of accounting. It determines where and how transactions are captured, reported, and reconciled within an insurance company’s financial systems

Example:ACTUAL

ledgerGroupstring

Ledger Group refers to a collection of related general ledger (GL) accounts grouped together under a common identifier for financial reporting, accounting rule application, and system processing. In insurance and annuity systems, it helps organize and manage posting logic, financial segmentation, and parallel accounting structures (e.g., statutory, GAAP, tax).

Example:ACTUAL

sourceSystemstring

Source System refers to the originating system or platform from which a financial transaction, policy event, or accounting entry is generated and passed into the general ledger or accounting engine. It identifies where the data came from, helping to track, validate, and audit entries across integrated insurance systems

Example:ZAH

statestring

In the context of accounting entries or insurance policy administration, State refers to the U.S. state or jurisdiction associated with a policy, transaction, or party. This field is critical for determining regulatory, tax, and reporting requirements, as insurance is regulated at the state level in the U.S.

Example:TX

currencystring

Currency refers to the monetary unit in which a financial transaction, policy value, or accounting entry is denominated. In insurance and annuity accounting systems, the Currency field specifies the legal tender used for recording and reporting transactions such as premiums, claims, fees, commissions, and investments

Example:USD

amountnumber

Amount refers to the numerical value of a financial transaction recorded in an accounting entry. In insurance and annuity systems, it represents the monetary value applied to a specific debit or credit line within a journal entry, and is typically expressed in the designated currency of the transaction

Example:80

generalLedgerPlanCodestring

GL Product Code refers to a unique identifier used to classify financial transactions in the general ledger (GL) based on the insurance or annuity product type. It links each accounting entry to a specific product line, allowing for accurate reporting, reconciliation, and financial analysis at the product level

Example:V2201

fundIdstring

Fund ID refers to a unique identifier assigned to a specific investment fund or account within an insurance or annuity product structure. It is used to track, allocate, and report financial activity related to investment-linked products, such as variable annuities, variable universal life (VUL), or separate account products

Example:FundAccount1

distributionChannelstring

Distribution Channel refers to the method or pathway through which insurance and annuity products are marketed, sold, and delivered to customers. In the context of accounting entry rules and policy administration, it helps identify how the business was acquired and may influence commission structures, financial reporting, and accounting treatments

Example:D

accountingMethodstring

Accounting Method refers to the approach or set of rules used to recognize, record, and report financial transactions in the accounting system. In the context of insurance and annuity accounting entry rules, it determines when and how revenues, expenses, assets, and liabilities are recorded, and is essential for ensuring regulatory compliance and financial accuracy

Example:C

transactionDatestring

Transaction Date refers to the actual date on which a financial or business event occurred that results in an accounting entry. In insurance and annuity systems, this is the date the transaction (e.g., premium payment, claim payout, commission, fee, or reserve adjustment) was executed or became effective, and it serves as a key reference point for financial reporting and auditing

Example:2024-01-17

transactionIdstring

Transaction ID is a unique identifier assigned to each financial or policy-related transaction within an insurance or annuity system. It serves as a reference key to track, audit, and link the transaction across systems—such as policy administration, billing, claims, and general ledger

Example:15

transactionTypestring

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

unitstring

Unit refers to the standardized measure used to represent a quantity of insurance coverage, investment participation, or transactional value within an insurance, annuity, or accounting system. It is typically used to calculate coverage amounts, charges, benefits, or allocations based on a per-unit basis

Example:110

Example