Finalise Pay Run

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

Request

POST http:///api/v2/business/{businessId}/payrun/{payRunId}/finalise

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",
    "exportJournalsDateTime": "date-time",
    "exportJournalsPreference": "string",
    "finaliseAsAdmin": "boolean",
    "fpsDate": "date-time",
    "fromPayRunAutomation": "boolean",
    "lodgeFinalPayRun": "boolean",
    "lodgePayRun": "boolean",
    "lodgePayRunDateTime": "date-time",
    "lodgePayRunInTestMode": "boolean",
    "lodgePayRunPreference": "string",
    "payRunId": "int32",
    "publishPaySlips": "string",
    "publishPaySlipsDateTime": "date-time",
    "publishPaySlipsPreference": "string",
    "relodgeHmrcLateSubmissionReason": "string",
    "relodgeSelectedEmployeesOnly": "boolean",
    "reportPacksToRun": [
        "int32"
    ],
    "runReportPacksDateTime": "date-time",
    "runReportPacksPreference": "string",
    "saveChangesToDefaultSettings": "boolean",
    "submitToPensionSync": "boolean",
    "submitToPensionSyncDateTime": "date-time",
    "submitToPensionSyncPreference": "string",
    "superPaymentPreference": "boolean",
    "suppressNotifications": "boolean"
}

Properties

Name Type Description
datePaid date-time Nullable
exportJournals boolean Boolean
exportJournalsDateTime date-time Nullable
exportJournalsPreference string Nullable

Possible values are:

  • Manual
  • Immediate
  • Scheduled
finaliseAsAdmin boolean Boolean
fpsDate date-time Nullable
fromPayRunAutomation boolean Boolean
lodgeFinalPayRun boolean Boolean
lodgePayRun boolean Boolean
lodgePayRunDateTime date-time Nullable
lodgePayRunInTestMode boolean Boolean
lodgePayRunPreference string Nullable

Possible values are:

  • Manual
  • Immediate
  • Scheduled
payRunId int32 Int32
publishPaySlips string PublishPaySlipsPreference

Possible values are:

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

Possible values are:

  • Manual
  • Immediate
  • Scheduled
relodgeHmrcLateSubmissionReason string Nullable

Possible values are:

  • A
  • B
  • C
  • D
  • E
  • F
  • G
  • H
relodgeSelectedEmployeesOnly boolean Boolean
reportPacksToRun[] array of int32
runReportPacksDateTime date-time Nullable
runReportPacksPreference string Nullable

Possible values are:

  • Manual
  • Immediate
  • Scheduled
saveChangesToDefaultSettings boolean Boolean
submitToPensionSync boolean Boolean
submitToPensionSyncDateTime date-time Nullable
submitToPensionSyncPreference string Nullable

Possible values are:

  • Manual
  • Immediate
  • Scheduled
superPaymentPreference boolean Boolean
suppressNotifications boolean Boolean

Response

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

Status code Description Resource
200 OK

OK

 PayRunFinaliseResult