Policy Transactions
PolicyCoverageChangesIdentifierDocument
objectBusiness identifier associated with the case, using Zinnia’s existing {identifier, value} convention
identifierstringrequired
Type/name of the business identifier (e.g. zlCaseId, policyNumber; extensible)
Example:zlCaseId
valuestringrequired
Value of the identifier
Example:CA0001296422
Example
OnetimeRmdRequest
objectcaseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)
Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
externalIdentifiersobject
Show Child Parameters
transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
Example
ThirdPartyDeleteRequest
objecteffectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]required
Signature details for the agent change
Show Child Parameters
partyobjectrequired
Show Child Parameters
Example
AgentChangeDto
objectfromAORstring
From AOR
Example:744760
toAORstring
To AOR
Example:744760
fromAgentIdstring
From agent id
Example:744760
toAgentIdstring
To agent id
Example:744760
policyIdstring
Policy number
Example:FNWL0020303021
caseIdstring
Case id
Example:CA0004789
partyRolestring
Party role
Example:PRIMARYWRITINGAGENT
signaturesarray[object]
Signature details for the agent change
Show Child Parameters
partyUpdatesarray[object]
Party updates list
Show Child Parameters
Example
AnnuitantChangeRequest
objecteffectiveDatestring(date)
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]
Signature details for the agent change
Show Child Parameters
partyUpdatesarray[object]
Party updates list
Show Child Parameters
Example