Finalises the specified pay run. A pay run can only be finalised if there are no calculations in progress.



Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

The request body takes a complete FinalisePayRunOptions resource, containing the following writable properties:

    "datePaid": "date-time",
    "exportJournals": "boolean",
    "lodgeFinalPayRun": "boolean",
    "lodgePayRun": "boolean",
    "lodgePayRunInTestMode": "boolean",
    "payRunId": "int32",
    "publishPaySlips": "string",
    "publishPaySlipsDateTime": "date-time",
    "relodgeHmrcLateSubmissionReason": "string",
    "relodgeSelectedEmployeesOnly": "boolean",
    "submitToPensionSync": "boolean",
    "suppressNotifications": "boolean"


Name Type Description
datePaid date-time Nullable
exportJournals boolean Boolean
lodgeFinalPayRun boolean Boolean
lodgePayRun boolean Boolean
lodgePayRunInTestMode boolean Boolean
payRunId int32 Int32
publishPaySlips string PublishPaySlipsPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
publishPaySlipsDateTime date-time Nullable
relodgeHmrcLateSubmissionReason string Nullable

Possible values are:

  • A
  • B
  • C
  • D
  • E
  • F
  • G
  • H
relodgeSelectedEmployeesOnly boolean Boolean
submitToPensionSync boolean Boolean
suppressNotifications boolean Boolean


The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK