Case Management
CaseCancellationRequest
objectsourcestringrequired
Identifies the calling source/system
Example:Zinnia.SupportTool
cancellationReasonKeystringrequired
Key used to derive the configured caseResult and caseResultDetail from the reference store
Example:INVALID_CASE
carrierstringrequired
Must match the target case’s own carrier
Example:CarrierName_1
processstringrequired
Must match the target case’s own process
Example:Withdrawal
processSubTypestringrequired
Must match the target case’s own processSubType
Example:FullWithdrawal
jiraIdstringrequired
Jira/request reference for governance and traceability
Example:ZLCM-9014
approvedBystringrequired
Must be on the configured case-cancellation approver list
Example:jane.doe@zinnia.com
effectiveCancellationDatestring(date-time)required
ISO 8601 business-effective date; must fall strictly between the case’s creation date and the current time
Example:2026-06-29T10:15:30Z
supportingDocumentIdsarray[string]
EDS document IDs associated with the case
Example:DOC00001234
Example
CaseCancellationResponse
objectcancellationRequestIdstring
Generated id of the persisted case termination audit record
Example:CT0000114641
caseIdstring
Example:CA0000360227
cancellationStatusstring
Outcome recorded for this cancellation request
Example:CANCELLED
caseStatusstring
Outcome recorded for this cancellation request
Example:CANCELLED
messagestring
Human-readable note about the outcome
Example:Case CA0000360227 is already CANCELED and is not eligible for this request
Example
CaseCompletionRequest
objectsourcestringrequired
Identifies the calling source/system
Example:Zinnia.SupportTool
completionReasonKeystringrequired
Key used to derive the configured caseResult and caseResultDetail from the reference store
Example:POLICY_ISSUED
carrierstringrequired
Must match the target case’s own carrier
Example:CarrierName_1
processstringrequired
Must match the target case’s own process
Example:Withdrawal
processSubTypestringrequired
Must match the target case’s own processSubType
Example:FullWithdrawal
jiraIdstringrequired
Jira/request reference for governance and traceability
Example:ZLCM-9014
approvedBystringrequired
Must be on the configured case-completion approver list
Example:jane.doe@zinnia.com
effectiveCompletionDatestring(date-time)required
ISO 8601 business-effective date; must fall strictly between the case’s creation date and the current time
Example:2026-06-29T10:15:30Z
supportingDocumentIdsarray[string]
EDS document IDs associated with the case
Example:DOC00001234
Example
CaseCompletionResponse
objectcompletionRequestIdstring
Generated id of the persisted case termination audit record
Example:CT0000114641
caseIdstring
Example:CA0000360227
completionStatusstring
Outcome recorded for this completion request
Example:COMPLETED
caseStatusstring
Outcome recorded for this completion request
Example:COMPLETED
messagestring
Human-readable note about the outcome
Example:Case CA0000360227 is already COMPLETED and is not eligible for this request
Example
RenewalTaskData
objectdocumentNumberstring
Example:20230405-M-350385
sourcestring
Example:SupportTool
contractNumstring
Example:571016565
userIdstring
Example:abc121243
onbaseCaseIdstring
Example:9280926
productNamestring
Example:CarrierName_1MUTUAL STABLE VOYAGE
clientCodestring
Example:CarrierName_1
taskTypestring
Example:RenewalTransfer
subsequentGuaranteePeriodstring
Example:3Year
goodOrderDatestring(date-time)
renewalRequestSignDatestring(date-time)
ownerInformationarray[object]
Show Child Parameters
documentReceivedDatestring(date-time)
Example