Skip to content
Sanmopia Modernization

Get branch settlement operator board

Switch to Zen Mode
GET
/branch-settlement-operator-boards/{branchSettlementId}
curl --request GET \
  --url https://example.com/branch-settlement-operator-boards/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
branchSettlementId
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Operator-safe branch settlement board

Media typeapplication/json
BranchSettlementOperatorBoard
object
branchSettlementId
required
string
>= 1 characters
branchProfileId
required
string
>= 1 characters
settlementStatus
required
string
Allowed values: awaiting_branch_deposit awaiting_confirmation settled reconciliation arrears
settlementPeriodStart
required
string format: date
settlementPeriodEnd
required
string format: date
grossAmountKrw
required
integer
storedNetBalanceKrw
required
integer
membershipDueKrw
required
integer
deliveryFeeKrw
required
integer
caregiverCompensationKrw
required
integer
voucherServiceCommissionKrw
required
integer
giftCouponCommissionKrw
required
integer
cancelledGiftCouponCommissionKrw
required
integer
promotionalCouponCostKrw
required
integer
branchAdjustmentKrw
required
integer
branchReceivableTotalKrw
required
integer
branchPayableTotalKrw
required
integer
calculatedNetBalanceKrw
required
integer
reconciliationDeltaKrw
required
integer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
lineItems
required
Array<object>
object
kind
required
string
Allowed values: membership_due delivery_fee caregiver_compensation voucher_service_commission gift_coupon_commission cancelled_gift_coupon_commission promotional_coupon_cost inter_office_branch_share inter_office_service_fee branch_adjustment
direction
required
string
Allowed values: receivable_from_branch payable_to_branch
amountKrw
required
integer
policyVersionLabel
required
string
>= 1 characters
lineOrder
required
integer
sourceReferenceKey
required
string | null
>= 1 characters
memo
required
string | null
key
additional properties
key
additional properties

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot view branch settlement operator board

404

Section titled “404”

Branch settlement operator board not found

503

Section titled “503”

Branch settlement operator board reader is unavailable