Skip to main content
POST
Create token payroll

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
payPeriodStart
string<date-time>
required

Payroll period start date

payPeriodEnd
string<date-time>
required

Payroll period end date

payDate
string<date-time>
required

Payroll pay date

fiatCurrency
string
required

Fiat currency code

payrollEntityId
string
required

Payroll entity identifier

externalPayrollID
string | null

External payroll identifier

type
string | null

Payroll type

state
enum<string> | null

Payroll lifecycle state.

Available options:
DRAFT,
CALCULATING,
APPROVED,
FUNDING,
COMPLETED,
FAILED

Response

Successful response

tokenPayroll
object
required