Skip to main content
POST
Compute pending settlements

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Body

application/json
payrollID
string<uuid>
required

Token payroll identifier

Response

Successful response

success
boolean
required

Whether pending settlements were computed successfully

message
string
required

Computation summary message

pendingSettlements
object[]
required

Computed settlement records

totalSettlements
integer
required

Number of settlement records

totalFiatAmount
number
required

Total fiat amount across settlements