cancelPayrollSubmission

The cancelPayrollSubmission API is used to cancel a previously submitted payroll and return it to an editable state.

When to use:

• When there are last minute changes to a payroll that has already been submitted
• When a payroll has been submitted but needs to be moved to another day

Notes:

• payPeriodStatus becomes Cancelled after using this API
• Edits can be made before 12:00 PM EST (noon) on the deadlineToRunPayroll to ensure payroll is still disbursed on time
• If edits are made after this time the payroll will be delayed. For more information see out Payroll Processing guide.

POST /payroll#cancelPayrollSubmission

cancelPayrollSubmission

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#cancelPayrollSubmission' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "cancelPayrollSubmission",
  "companyId": "3A08507F-E78B-4ABF-98D8-87D382E7CE14",
  "payPeriodId": "3C068DE4-038F-4874-B99B-4AFD7CB39351"
}
'

200

{
  "payPeriod": {
    "payPeriodId": "DEE97E29-BF4A-40D1-9324-11D70BE38582",
    "message": "Payroll submission has been cancelled successfully. You can now make changes and resubmit before the deadline."
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

companyId · string · required

payPeriodId · string · required

Response

200

application/json

payPeriod · object · required

Show child attributes