addRecurringPayItem

curl --request POST \
  --url https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addRecurringPayItem",
  "companyId": "336CB829-543B-451D-AAA2-18A1B03454F2",
  "userId": "C8E5F6AB-4CB5-406C-B756-208B742F4281",
  "payItem": "Garnishments",
  "type": "CN RPP",
  "amountPerPayperiod": 450
}
'

{
  "Status": "Success",
  "Message": "Recurring pay item added successfully."
}

Admin Portal

addRecurringPayItem

The addRecurringPayItem API is used to add a recurring item that will appear on an employee’s payroll.

What it does:

Adds an employee-specific recurring pay item
Used to add recurring deductions, additional compensations, and reimbursements without having to add them to pay periods

Notes:

Either allocatedPercentage or amountPerPayperiod is required
Recurring items will be added to open pay periods until they are removed with removeRecurringPayItem
type is restricted to the list of deductions and additional compensations available with getDeductionDescription and getAdditionalCompensationDescription
type allows free-string entry for reimbursements
Only one recurring item per type can be added

PayItem options	Restrictions
Deduction	`getDeductionDescription`
AdditionalCompensation	`getAdditionalCompensationDescription`
Reimbursement	No restriction. Free entry

POST

adminPortal

addRecurringPayItem

curl --request POST \
  --url https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addRecurringPayItem",
  "companyId": "336CB829-543B-451D-AAA2-18A1B03454F2",
  "userId": "C8E5F6AB-4CB5-406C-B756-208B742F4281",
  "payItem": "Garnishments",
  "type": "CN RPP",
  "amountPerPayperiod": 450
}
'

{
  "Status": "Success",
  "Message": "Recurring pay item added 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

userId

string

required

payItem

enum<string>

required

Available options:

Deduction,

AdditionalCompensation,

Reimbursement

type

string

required

amountPerPayperiod

number

allocatedPercentage

number

Response

status

string

required

message

string

required

downloadDocument updateRecurringPayItem