addSupplementalPayPeriodWithLineItems

The addSupplementalPayPeriodWithLineItems API is used to fully import a supplemental payPeriod to the rollfi system

Notes:

• This API is used when all the data for a supplemental payPeriod, including individual pay items, is readily available
• If you do not have access to the lineItem data at the time of import use addSupplementalPayPeriod and addSupplementalPayrollLineItem to achieve the same results

POST /payroll#addSupplementalPayPeriodWithLineItems

addSupplementalPayPeriodWithLineItems

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#addSupplementalPayPeriodWithLineItems' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addSupplementalPayPeriodWithLineItems",
  "payPeriod": {
    "companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
    "payPeriodType": "Off-Cycle",
    "workerType": "W2",
    "payBeginDate": "2024-01-15",
    "payEndDate": "2024-01-15",
    "payDate": "2025-10-15",
    "payrollLineItem": [
      {
        "userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
        "amount": 500,
        "paymentMethod": "Direct Deposit"
      },
      {
        "userId": "3D971CE4-3DA9-4031-AB0E-D0E1A364444B",
        "amount": 300
      }
    ]
  }
}
'

200

1

{
  "payPeriod": {
    "payPeriodId": "80B0DE7E-BB68-4EDE-B418-36FC21B90914",
    "status": "Ready",
    "message": "Supplemental PayPeriod for Payroll MonthlyBiweekly 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

payPeriod · object · required

Show child attributes

Response

200

application/json

payPeriod · object · required

Show child attributes