Skip to main content
POST
Batch Record 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
settlements
object[]
required
scheduleType
enum<string>
required
Available options:
VESTING,
LOCKUP,
WARRANT_LOCKUP

Response

Settlements recorded

success
boolean
Example:

true