addSupplementalPayPeriod

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#addSupplementalPayPeriod' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addSupplementalPayPeriod",
  "payPeriod": {
    "companyId": "3c62037a-2bac-4910-839d-5c803f0d4f0a",
    "payPeriodType": "Missing",
    "workerType": "W2",
    "payBeginDate": "2023-11-12",
    "payEndDate": "2023-12-10",
    "payDate": "2023-12-10"
  }
}
'

{
  "payPeriod": {
    "payPeriodId": "91384C53-089C-42E9-8CB0-59978AF46DEA",
    "status": "New",
    "message": "Supplemental PayPeriod for Prism Ltd has been saved successfully."
  }
}

Payroll

addSupplementalPayPeriod

The addSupplementalPayPeriod API creates a supplemental pay period for processing additional payroll outside of the regular pay schedules.

What it does:

Creates a special pay period for supplemental payroll processing (bonuses, commissions, off-cycle payments)
Sets up pay period dates and worker type for the supplemental payroll

Notes:

Requires pay period dates (payBeginDate, payEndDate, payDate)
Returns a payPeriodId for use with supplemental payroll line items

POST

payroll#addSupplementalPayPeriod

addSupplementalPayPeriod

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#addSupplementalPayPeriod' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addSupplementalPayPeriod",
  "payPeriod": {
    "companyId": "3c62037a-2bac-4910-839d-5c803f0d4f0a",
    "payPeriodType": "Missing",
    "workerType": "W2",
    "payBeginDate": "2023-11-12",
    "payEndDate": "2023-12-10",
    "payDate": "2023-12-10"
  }
}
'

{
  "payPeriod": {
    "payPeriodId": "91384C53-089C-42E9-8CB0-59978AF46DEA",
    "status": "New",
    "message": "Supplemental PayPeriod for Prism Ltd has been saved 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

Example:

"addSupplementalPayPeriod"

payPeriod

object

required

Show child attributes

Response

payPeriod

object

required

Show child attributes

deactivatePaySchedule initiatePayroll