Start reservation financial lifecycle workflow
POST
/reservation-financial-lifecycle-workflow-starts
const url = 'https://example.com/reservation-financial-lifecycle-workflow-starts';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"financialLifecycleWorkflowRequestId":"example","reservationBookingId":"example","serviceDelivery":{"careDeliverySessionCode":"example","caregiverId":"example","serviceStartedOn":"2026-04-15","serviceEndedOn":"2026-04-15","deliveredDayCount":1},"caregiverPayoutLines":[],"branchSettlementLines":[],"hqSettlementLines":[],"completeSettlement":false}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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 }'Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
Any of:
ReservationFinancialLifecycleWorkflowStart
object
financialLifecycleWorkflowRequestId
string
reservationBookingId
string
serviceDelivery
required
object
careDeliverySessionCode
required
string
caregiverId
required
string
serviceStartedOn
required
string format: date
serviceEndedOn
required
string format: date
deliveredDayCount
required
integer
key
additional properties
caregiverPayoutLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
branchSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
hqSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
completeSettlement
boolean
key
additional properties
ReservationFinancialLifecycleWorkflowStart
object
financialLifecycleWorkflowRequestId
required
string
reservationBookingId
required
string
serviceDelivery
object
careDeliverySessionCode
required
string
caregiverId
required
string
serviceStartedOn
required
string format: date
serviceEndedOn
required
string format: date
deliveredDayCount
required
integer
key
additional properties
caregiverPayoutLines
required
branchSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
hqSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
completeSettlement
boolean
key
additional properties
ReservationFinancialLifecycleWorkflowStart
object
financialLifecycleWorkflowRequestId
required
string
reservationBookingId
required
string
serviceDelivery
object
careDeliverySessionCode
required
string
caregiverId
required
string
serviceStartedOn
required
string format: date
serviceEndedOn
required
string format: date
deliveredDayCount
required
integer
key
additional properties
caregiverPayoutLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
branchSettlementLines
required
hqSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
completeSettlement
boolean
key
additional properties
ReservationFinancialLifecycleWorkflowStart
object
financialLifecycleWorkflowRequestId
required
string
reservationBookingId
required
string
serviceDelivery
object
careDeliverySessionCode
required
string
caregiverId
required
string
serviceStartedOn
required
string format: date
serviceEndedOn
required
string format: date
deliveredDayCount
required
integer
key
additional properties
caregiverPayoutLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
branchSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
hqSettlementLines
required
completeSettlement
boolean
key
additional properties
ReservationFinancialLifecycleWorkflowStart
object
financialLifecycleWorkflowRequestId
required
string
reservationBookingId
required
string
serviceDelivery
object
careDeliverySessionCode
required
string
caregiverId
required
string
serviceStartedOn
required
string format: date
serviceEndedOn
required
string format: date
deliveredDayCount
required
integer
key
additional properties
caregiverPayoutLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
branchSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
hqSettlementLines
Array<object>
object
ledgerBucket
required
string
lineCode
required
string
lineTypeCode
required
string
policyVersionLabel
required
string
payerPartyCode
required
string
payeePartyCode
required
string
amountKrw
required
integer
recognizedOn
required
string format: date
sourceReferenceCode
string | null
calculationBasis
required
object
key
additional properties
string | integer
key
additional properties
completeSettlement
key
additional properties
Responses
Section titled “Responses”Reservation financial lifecycle workflow accepted
Media typeapplication/json
ReservationFinancialLifecycleWorkflowStartResponse
object
financialLifecycleWorkflowRequestId
required
string
reservationBookingId
required
string
workflowName
required
string
workflowKey
required
string
workflowEngine
required
string
invocationId
required
string
workflowStatus
required
string
key
additional properties
Workflow payload is not valid for financial lifecycle orchestration
Reservation financial lifecycle workflow runtime is unavailable