Skip to main content
POST
Cancel Payrun

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
payrun_id
string
required

Body

application/json
drop_standing_pay_for
string[]

Exactly the employees whose salary and statutory pay for the period the run holds, or the cancel is refused; omit (or leave empty) when it holds nobody's. Naming them moves that pay out of this run, which does not pay it: the next run of the period that calculates them pays it (the MAIN run while it is a draft, otherwise the first supplementary run that calculates them). Drop it only to pay it in a later period: the response lists in unpaid_standing_pay_for those whose pay no run will now pay. To pay it in this period, move them to another draft run first.

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
unpaid_standing_pay_for
string[]

Those named in drop_standing_pay_for whose salary and statutory pay for the period no run will now pay: once the MAIN run is approved, all of them except those holding pay items in another draft run of the period, which pays it when calculated again; while it is a draft, those it does not cover (in positive pay, employees holding no pay items in it). Pay it in a later period, for instance as a back-pay item. Not listed, in net change: an employee who started in the period, has no payment for it approved and no pay items in another run of it. The next period's MAIN run pays the period for them unasked, so back pay would pay it twice. Empty when nobody was named or the MAIN run pays every named employee.