Skip to content
Sanmopia Modernization

Get branch settlement reconciliation export dataset

Switch to Zen Mode
GET
/branch-settlement-reconciliation-exports/{branchProfileId}
curl --request GET \
  --url 'https://example.com/branch-settlement-reconciliation-exports/example?exportFormat=csv' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Query Parameters

Section titled “Query Parameters”
exportFormat
string
default: csv
Allowed values: csv xlsx json

Responses

Section titled “Responses”

200

Section titled “200”

Export-ready branch settlement reconciliation dataset

Media typeapplication/json
BranchSettlementReconciliationExport
object
branchProfileId
required
string
>= 1 characters
exportFormat
required
string
Allowed values: csv xlsx json
exportCode
required
string
>= 1 characters
artifactBucket
required
Allowed value: business-report-exports
settlementDataRoomReadiness
required
SettlementDataRoomReadinessProjection
object
collectionCode
required
string
>= 1 characters
collection
required
string
Allowed values: external_counterparty_settlement branch_to_headquarters_settlement headquarters_settlement inter_office_settlement
readinessStatus
required
string
Allowed values: ready empty needs_repair
settlementPeriodStart
required
string | null format: date
>= 1 characters
settlementPeriodEnd
required
string | null format: date
>= 1 characters
branchProfileId
required
string | null
>= 1 characters
externalRecipientCode
required
string | null
>= 1 characters
sourceDatasetRevision
required
integer
>= 1
projectionRevision
required
integer
>= 1
expectedRevision
required
integer
>= 1
rowCount
required
integer
sourceEvidenceKeys
required
Array<string>
blockingFacts
required
Array<string>
updatedAt
required
string format: date-time
key
additional properties
columns
required
Array<object>
>= 1 items
object
columnKey
required
string
>= 1 characters
label
required
string
>= 1 characters
valueKind
required
string
Allowed values: date money text
displayOrder
required
integer
key
additional properties
rows
required
Array<object>
object
rowKey
required
string
>= 1 characters
label
required
string
>= 1 characters
values
required
Array<object>
object
columnKey
required
string
>= 1 characters
value
required
string
key
additional properties
key
additional properties
totalRow
required
object
rowKey
required
string
>= 1 characters
label
required
string
>= 1 characters
values
required
Array<object>
object
columnKey
required
string
>= 1 characters
value
required
string
key
additional properties
key
additional properties
key
additional properties

400

Section titled “400”

Export format or request is invalid

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot export branch settlement reconciliation

503

Section titled “503”

Branch settlement operator dashboard reader is unavailable