Skip to main content
POST
Run Payroll

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Include-Execution-History
boolean
default:false

Path Parameters

organization_id
required

Body

application/json

Input parameters

payroll_group
PayrollRequestBase · object[]
required
pay_group_id
required
pay_calendar_id
required
external_ref
string | null

External reference for payroll run

Response

Successful Response

task_id
string
required
status
enum<string>
required

Payrun status

Available options:
draft,
processing,
approved,
paid
payroll_status_id
string
required