addUsersToRegularPayPeriod

The addUsersToRegularPayPeriod API is used to add employees to an existing regular pay period in the rollfi system

Notes:

• This API can be used when an employee was removed and needs re-adding to a pay period
• Only works with ‘Regular’ pay period types, not supplemental pay periods

POST /payroll#addUsersToRegularPayPeriod

addUsersToRegularPayPeriod

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#addUsersToRegularPayPeriod' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addUsersToRegularPayPeriod",
  "companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
  "payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C",
  "payrollLineItems": [
    {
      "userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
      "paymentMethod": "Check"
    }
  ]
}
'

200

1

{
  "payrollLineItems": [
    {
      "userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
      "status": "Ready",
      "message": "The PayrollLineItem for Brendon Mcln 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

companyId · string · required

payPeriodId · string · required

payrollLineItems · object[] · required

Show child attributes

Response

200

application/json

payrollLineItems · object[] · required

Show child attributes