addUsersToSupplementalPayPeriod

The addUsersToSupplementalPayPeriod API is used to add employees to a supplemental pay period for bonuses, commissions, or adjustments.

When to use:

• When issuing bonuses, commissions, or one-time payments
• When processing termination payouts outside regular payroll

Note:

• To create a supplemental pay period use the addSupplementalPayPeriod API

POST /payroll#addUsersToSupplementalPayPeriod

addUsersToSupplementalPayPeriod

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#addUsersToSupplementalPayPeriod' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addUsersToSupplementalPayPeriod",
  "companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
  "payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
  "payrollLineItems": [
    {
      "userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
      "amount": 1000,
      "paymentMethod": "Check"
    },
    {
      "userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
      "amount": 1500,
      "paymentMethod": "Direct Deposit"
    }
  ]
}
'

200

1

{
  "payrollLineItems": [
    {
      "userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
      "status": "Ready",
      "message": "The PayrollLineItem for Const Jonas has been saved successfully."
    },
    {
      "userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
      "status": "Ready",
      "message": "The PayrollLineItem for Celina Gos 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