Search
K
Policy Transactions

SystematicProgramUpdateRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

authorizationManualboolean

Indicates manual authorization handling may apply for this submission

contactMFAobject

Contact channels for multi-factor authentication on systematic program transactions

Show Child Parameters
agentobject

Named participant (e.g. servicing agent or policy holder context on the request)

Show Child Parameters
policyHolderobject

Named participant (e.g. servicing agent or policy holder context on the request)

Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
featureTransactionProductobject

Product-level transaction classification accompanying the systematic program request

Show Child Parameters
submittedDatestring(date-time)

When the transaction was submitted (ISO-8601)

Example:2026-02-27T11:55:17Z

currencystring

ISO 4217 currency code

Example:USD

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

Example

SystematicProgramQuoteRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

arrangementIdstring

The unique ID for the systematic programs available in the policy

Example:arr_1

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

Example

SystematicProgramSubmitRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

authorizationManualboolean

Indicates manual authorization handling may apply for this submission

contactMFAobject

Contact channels for multi-factor authentication on systematic program transactions

Show Child Parameters
agentobject

Named participant (e.g. servicing agent or policy holder context on the request)

Show Child Parameters
policyHolderobject

Named participant (e.g. servicing agent or policy holder context on the request)

Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
featureTransactionProductobject

Product-level transaction classification accompanying the systematic program request

Show Child Parameters
submittedDatestring(date-time)

When the transaction was submitted (ISO-8601)

Example:2026-02-27T11:55:17Z

currencystring

ISO 4217 currency code

Example:USD

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

externalArrangementIdstring

Arrangement ID from external system

Example:B45678

Example

ActiveRestrictSubmitInfo

object

Submission metadata for active restrict requests

submittedBystring
sourcestring
submittedByPartyIdstring
Example

ActiveRestrictRestrictionItem

object

Single restriction operation in the submit payload

restrictionTypestring
actionstring
restrictionSubTypestring
Example