Skip to main content
POST
Create Payrun

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json
pay_calendar_id
string
required
pay_group_id
string
required
run_type
enum<string>
required

MAIN is the period's regular run, paid on the pay calendar's pay date. SUPPLEMENTARY is an extra run in the same period, paid on payment_date.

Available options:
MAIN,
SUPPLEMENTARY
external_ref
string | null
payment_date
string<date> | null

SUPPLEMENTARY only, and required for it: the date the run pays. Not before today, Monday to Friday, in the tax period (tax month, or tax week for a weekly pay group) of the pay calendar's pay date and, for a pay group whose pension pay reference period is the pay period (METHOD_A), in the pay period containing that date, not the date of another run of the pay calendar and pay group nor the calendar's deposit date (the day the main run's money reaches the bank), and not before the payment date of a run of the pay group already approved, in any of its calendars. A MAIN run pays on the calendar's pay date.

Response

Successful Response

contractual_payday
string<date>
required

The pay calendar's pay date: the day the period's pay is due.

external_ref
string | null
required
id
string
required
pay_calendar_id
string
required
pay_group_id
string
required
payment_date
string<date>
required

The day the run's BACS payment reaches employees' accounts: a SUPPLEMENTARY run's own date, the pay calendar's deposit date for a MAIN run (which moves off contractual_payday when that is not a banking day).

payroll_status_id
string
required
reported_payment_date
string<date>
required

The payment date the run reports to HMRC on the FPS: contractual_payday for a MAIN run, payment_date for a SUPPLEMENTARY run.

run_type
enum<string>
required

Kind of pay run: the period's main run, or a supplementary run in the same period

Available options:
MAIN,
SUPPLEMENTARY
status
enum<string>
required

Payrun status

Available options:
DRAFT,
PROCESSING,
APPROVED,
PAID,
CANCELLED