removeOvertime

The removeOvertime API is used to remove overtime entries for an employee in a pay period.

When to use:

• When correcting overtime mistakes before payroll submission

Notes:

• Pay period must be in an editable state (see the PayrollProcessing guide)
• overtimeType can be used to remove specific overtimes for a user
• Automatically updates earnings calculations after removal

POST /payroll#removeOvertime

removeOvertime

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#removeOvertime' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "removeOvertime",
  "companyId": "F59AE5EA-BE39-4120-A11E-DA2610D866CA",
  "payPeriodId": "382005A7-7B3E-4787-9B2B-2A3BE1767D7B",
  "userId": "A34C2BA9-900D-46B8-A297-644F82D68E29",
  "overtimeType": "Comp off OT"
}
'

200

{
  "overtimeRemoval": {
    "status": "Success",
    "message": "Comp off OT have been removed successfully."
  }
}

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

userId · string · required

overtimeType · string

Response

200

application/json

overtimeRemoval · object · required

Show child attributes