Finalise a PayRun

Post

/employers/{employerId}/payrun/{taxYear}/{payPeriod}/{periodNumber}/finalise

Deprecated This endpoint is deprecated and will eventually be removed

This endpoint is now deprecated and will be removed in Jan 2022.
You should instead use the Update method and set the State to Finalised.

Returns True if the resulting FPS has been automatically submitted due to the Employers RTISubmissionSettings, otherwise returns false.
You can suppress the emailing of payslips to employees by adding a key named dontEmailEmployeePayslips with a value of true to the body. See the related guides for more information.

Store values

Parameters

employerId string

payPeriod string

periodNumber integer

taxYear string

body
sample value
Content Type object

ordinal integer

(optional)

Try it

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`boolean`	application/json