Skip to main content
GET
Get Settlement Status

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 status

hasTransaction
boolean
Example:

true

status
string
Example:

"COMPLETED"

canSubmit
boolean
Example:

false

canRetry
boolean
Example:

false