Skip to content

Start reservation financial lifecycle workflow

POST
/reservation-financial-lifecycle-workflow-starts
curl --request POST \
--url https://example.com/reservation-financial-lifecycle-workflow-starts \
--header 'Content-Type: application/json' \
--data '{ "financialLifecycleWorkflowRequestId": "example", "reservationBookingId": "example", "serviceDelivery": { "careDeliverySessionCode": "example", "caregiverId": "example", "serviceStartedOn": "2026-04-15", "serviceEndedOn": "2026-04-15", "deliveredDayCount": 1 }, "caregiverPayoutLines": [], "branchSettlementLines": [], "hqSettlementLines": [], "completeSettlement": false }'
Media typeapplication/json
Any of:
ReservationFinancialLifecycleWorkflowStart
object
financialLifecycleWorkflowRequestId
string
>= 1 characters
reservationBookingId
string
>= 1 characters
serviceDelivery
required
object
careDeliverySessionCode
required
string
>= 1 characters
caregiverId
required
string
>= 1 characters
serviceStartedOn
required
string format: date
serviceEndedOn
required
string format: date
deliveredDayCount
required
integer
>= 1
key
additional properties
caregiverPayoutLines
Array<object>
default:
object
ledgerBucket
required
string
Allowed values: caregiver_payout branch_settlement hq_settlement award_payout
lineCode
required
string
>= 1 characters
lineTypeCode
required
string
>= 1 characters
policyVersionLabel
required
string
>= 1 characters
payerPartyCode
required
string
>= 1 characters
payeePartyCode
required
string
>= 1 characters
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
>= 1 characters
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
branchSettlementLines
Array<object>
default:
object
ledgerBucket
required
string
Allowed values: caregiver_payout branch_settlement hq_settlement award_payout
lineCode
required
string
>= 1 characters
lineTypeCode
required
string
>= 1 characters
policyVersionLabel
required
string
>= 1 characters
payerPartyCode
required
string
>= 1 characters
payeePartyCode
required
string
>= 1 characters
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
>= 1 characters
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
hqSettlementLines
Array<object>
default:
object
ledgerBucket
required
string
Allowed values: caregiver_payout branch_settlement hq_settlement award_payout
lineCode
required
string
>= 1 characters
lineTypeCode
required
string
>= 1 characters
policyVersionLabel
required
string
>= 1 characters
payerPartyCode
required
string
>= 1 characters
payeePartyCode
required
string
>= 1 characters
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
>= 1 characters
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
completeSettlement
boolean
key
additional properties

Reservation financial lifecycle workflow accepted

Media typeapplication/json
ReservationFinancialLifecycleWorkflowStartResponse
object
financialLifecycleWorkflowRequestId
required
string
>= 1 characters
reservationBookingId
required
string
>= 1 characters
workflowName
required
string
Allowed value: ReservationFinancialLifecycleWorkflow
workflowKey
required
string
>= 1 characters
workflowEngine
required
string
Allowed value: restate
invocationId
required
string
>= 1 characters
workflowStatus
required
string
>= 1 characters
key
additional properties

Workflow payload is not valid for financial lifecycle orchestration

Reservation financial lifecycle workflow runtime is unavailable