Finalise Payrun

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

Request

POST ../api/v1/client/payrun/{payrunId}/finalize

Path parameters

Parameter name	Value	Description	Additional
payrunId	int32		Required

Request body

The request body takes the following writable properties:

{
    "datePaid": "date-time",
    "exportJournals": "boolean",
    "exportJournalsDateTime": "date-time",
    "exportJournalsPreference": "string",
    "finaliseAsAdmin": "boolean",
    "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"
}