removeAdditionalCompensations

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

{
  "removeAdditionalCompensationOnly": {
    "status": "Success",
    "message": "Bonus additional compensation has been removed successfully."
  }
}

Payroll

removeAdditionalCompensations

The removeAdditionalCompensations API is used to remove additional compensation entries for an employee in a pay period.

When to use:

When correcting additional compensation mistakes before payroll submission
When removing specific compensation types (bonuses, commissions, etc.)

Notes:

Pay period must be in an editable state (see the ‘Payroll Processing` guide)
All additionalCompensations are removed if compensationDescription is not included in the request
Automatically updates earnings calculations after removal

POST

payroll#removeAdditionalCompensations

removeAdditionalCompensations

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

{
  "removeAdditionalCompensationOnly": {
    "status": "Success",
    "message": "Bonus additional compensation 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

compensationDescription

string

Response

removeAdditionalCompensationOnly

object

required

Show child attributes

removeDeductions removeReimbursements