Skip to main content
GET
Can Submit Settlement

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

Query Parameters

taxReferenceID
string<uuid>
required

Response

Settlement eligibility

allowed
boolean
Example:

true

reason
string | null