Skip to content
Sanmopia Modernization

Get settlement statement

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

Settlement statement with remittance snapshot and transition audit

Media typeapplication/json
SettlementStatement
object
statementId
required
string
>= 1 characters
statementCode
required
string
>= 1 characters
statementKind
required
string
Allowed values: head_office_to_branch danbee_to_branch inter_office_service_handoff
branchProfileId
required
string
>= 1 characters
settlementPeriodStart
required
string format: date
settlementPeriodEnd
required
string format: date
status
required
string
Allowed values: awaiting_branch_deposit awaiting_confirmation settled reconciliation arrears
revision
required
integer
>= 1
remittanceAccountSnapshot
required
object
remittanceAccountSnapshotId
required
string
>= 1 characters
bankName
required
string
>= 1 characters
accountHolder
required
string
>= 1 characters
accountNumberDisplay
required
string
>= 1 characters
capturedAt
required
string format: date-time
sourceReferenceKey
required
string | null
>= 1 characters
key
additional properties
requestedByActorProfileId
required
string
>= 1 characters
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
messageToBranch
required
string | null
>= 1 characters
headOfficePrivateMemo
required
string | null
>= 1 characters
transitionAudits
required
Array<object>
object
auditId
required
string
>= 1 characters
commandKind
required
string
Allowed values: request_deposit add_manual_settlement_row acknowledge_branch_deposit approve_headquarters_settlement request_arrears_deposit
actorKind
required
string
Allowed values: headquarters_administrator branch_manager system_workflow
actorProfileId
required
string
>= 1 characters
idempotencyKey
required
string
>= 1 characters
expectedRevision
required
integer
committedRevision
required
integer
>= 1
beforeStatus
required
string
Allowed values: awaiting_branch_deposit awaiting_confirmation settled reconciliation arrears
afterStatus
required
string
Allowed values: awaiting_branch_deposit awaiting_confirmation settled reconciliation arrears
recordedAt
required
string format: date-time
reason
required
string | null
>= 1 characters
resultMessage
required
string | null
>= 1 characters
metadata
required
object
key
additional properties
key
additional properties
lineAcknowledgements
required
Array<object>
object
lineAcknowledgementId
required
string
>= 1 characters
settlementLineKey
required
string
>= 1 characters
settlementLineKind
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
acknowledgedByActorProfileId
required
string
>= 1 characters
acknowledgedAt
required
string format: date-time
sourceEvidenceKey
string | null
>= 1 characters
acknowledgementNote
required
string | null
>= 1 characters
key
additional properties
manualRows
required
Array<object>
object
manualRowId
required
string
>= 1 characters
settlementLineKey
required
string
>= 1 characters
settlementLineKind
required
Allowed value: branch_adjustment
description
required
string
>= 1 characters
quantity
required
integer
>= 1
unitAmountKrw
required
integer
totalAmountKrw
required
integer
addedByActorProfileId
required
string
>= 1 characters
addedAt
required
string format: date-time
sourceReferenceKey
required
string | null
>= 1 characters
memo
required
string | null
>= 1 characters
key
additional properties
key
additional properties

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot view settlement statement

404

Section titled “404”

Settlement statement not found

503

Section titled “503”

Settlement statement reader is unavailable