Search
K
Policy Transactions

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

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

ActiveRestrictTransactionDocument

object

Document reference in the submit request (common BPM document fields)

documentIdstring
documentDatestring
documentTypestring
documentTypeDescriptionstring
displayNamestring
policyNumberstring
planCodestring
caseIdstring
Example

ActiveRestrictTransactionRequest

object

Request body for active restrict (POST /bpm/v1/policies/{planCode}/{policyNumber}/Restrict).
Extends the common transaction case request fields with restriction operations.

planCodestring
correlationIdstring
partyIdstring
policyNumberstring
businessKeystring
transactionNamestring
deleteRequestboolean
requestTypestring
submitInfoobject

Submission metadata for active restrict requests

Show Child Parameters
receivedDatestring
carrierIdstring
restrictionarray[object]

Single restriction operation in the submit payload

Show Child Parameters
effectiveDatestring
caseIdstring
documentsarray[object]

Document reference in the submit request (common BPM document fields)

Show Child Parameters
policyFeatureDataobject
Example