Skip to main content
POST
Create payroll run

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

Payroll period start date

payrollEndDate
string<date-time>
required

Payroll period end date

payrollFiatCurrency
string
required

Fiat currency code for the payroll

tokenTypeID
string<uuid>
required

Token type identifier

payrollEntity
string
required

Payroll entity identifier

payrollName
string | null

Optional payroll name

payrollPayDate
string<date-time> | null

Scheduled payroll pay date

Response

Successful response

payroll
object | null
required