removeDeductions

The removeDeductions API is used to remove deduction entries for an employee in a pay period.

When to use:

• When correcting deduction mistakes before payroll submission
• When removing specific deduction types (401k, health insurance, etc.)

Notes:

• Pay period must be in an editable state (see the ‘Payroll Processing` guide)
• deductionDescription can be included to remove specific deductions for a user
• Automatically updates earnings calculations after removal

POST /payroll#removeDeductions

removeDeductions

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#removeDeductions' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "removeDeductions",
  "companyId": "3A08507F-E78B-4ABF-98D8-87D382E7CE14",
  "payPeriodId": "43CCBBDF-8CF3-472E-874D-888E7911BB1F",
  "userId": "5F45CFBA-4AED-41AF-B334-E02D23BA17AE",
  "deductionDescription": "125DC Reg"
}
'

200

1

{
  "removeDeductionOnly": {
    "status": "Success",
    "message": "125DC Reg deduction has 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

deductionDescription · string

Response

200

application/json

removeDeductionOnly · object · required

Show child attributes