Skip to main content
POST
Approve Payroll

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
payroll_status_id
string
required

Query Parameters

force_approve
boolean
default:false

Approve over the NMW refusal (payslips below the National Minimum or Living Wage). Needs the pay_runs:override permission and a force_approve_reason in the body.

pay_nobody
boolean
default:false

Positive pay only: approve a main run that would pay nobody, because none of its pay group members holds pay items in it. Without it such a run is refused (409 INVALID_TRANSITION, params.reason NO_EMPLOYEES). A net change main run pays its members' standing pay without pay items, so it never needs this. It does not lift the refusal for a supplementary run, and changes nothing for a run that pays somebody.

Body

application/json

The optional body of an approval.

force_approve_reason
string | null

Why the approval overrides the refusal: required with force_approve=true, refused without it. Recorded on the approval with the employees concerned. In the body, not the query string, so it stays out of URLs and access logs.

Maximum string length: 500

Response

Successful Response

external_ref
string | null
required
id
string
required
status
enum<string>
required

Payrun status

Available options:
DRAFT,
PROCESSING,
APPROVED,
PAID,
CANCELLED
status_id
string
required