Skip to content

Prepare HQ settlement ledger lines

POST
/reservation-financial-lifecycles/{reservationBookingId}/hq-settlement-preparations
curl --request POST \
--url https://example.com/reservation-financial-lifecycles/example/hq-settlement-preparations \
--header 'Content-Type: application/json' \
--data '{ "serviceCalendarImpactPlanId": null, "serviceCalendarImpactPolicyFingerprint": null, "serviceCalendarImpactFactIds": [], "serviceOccurrenceLedgerKey": null, "serviceOccurrenceLedgerRevisionNumber": null, "finalizedChargeSnapshotId": null, "serviceBalanceCloseoutEventId": null, "additionalServiceSelectionRevisionKey": null, "additionalServiceSelectionRevisionNumber": null, "lines": [ { "ledgerBucket": "caregiver_payout", "lineCode": "example", "lineTypeCode": "example", "policyVersionLabel": "example", "payerPartyCode": "example", "payeePartyCode": "example", "amountKrw": 1, "recognizedOn": "2026-04-15", "sourceReferenceCode": null, "calculationBasis": { "additionalProperty": "example" } } ] }'
reservationBookingId
required
string
>= 1 characters
Media typeapplication/json
PrepareReservationFinancialLedgerLines
object
serviceCalendarImpactPlanId
string | null
>= 1 characters
serviceCalendarImpactPolicyFingerprint
string | null
>= 1 characters
serviceCalendarImpactFactIds
Array<string>
default:
serviceOccurrenceLedgerKey
string | null
>= 1 characters
serviceOccurrenceLedgerRevisionNumber
integer | null
>= 1
finalizedChargeSnapshotId
string | null
>= 1 characters
serviceBalanceCloseoutEventId
string | null
>= 1 characters
additionalServiceSelectionRevisionKey
string | null
>= 1 characters
additionalServiceSelectionRevisionNumber
integer | null
>= 1
lines
required
Array<object>
>= 1 items
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
key
additional properties

Reservation financial lifecycle after HQ settlement preparation

Media typeapplication/json
ReservationFinancialLifecycle
object
reservationBookingId
required
string
>= 1 characters
financialStage
required
string
Allowed values: reservation_booked charge_finalized service_delivered caregiver_payout_ready branch_settlement_ready hq_settlement_ready settled
motherVisiblePayableKrw
required
integer
caregiverPayoutKrw
required
integer
branchSettlementKrw
required
integer
hqSettlementKrw
required
integer
careDeliverySessionCode
required
string | null
>= 1 characters
deliveredDayCount
required
integer | null
>= 1
ledgerLineCount
required
integer
key
additional properties

Reservation financial lifecycle not found

Reservation financial lifecycle is not in branch-settlement-ready stage

Reservation financial lifecycle command handler is unavailable