removeUsersFromRegularPayPeriod

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

{
  "payrollLineItems": [
    {
      "userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
      "status": "Removed",
      "message": "The PayrollLineItem for Brendon Mcln has been removed successfully."
    }
  ]
}

Payroll

removeUsersFromRegularPayPeriod

The removeUsersFromRegularPayPeriod API is used to remove employees from a regular pay period due to many different circumstances

When to use:

When there are employee terminations mid-pay period that need to be reflected in payroll
When payroll corrections are needed to fix accidental additions before payroll processing

Notes:

Cannot remove all employees - at least one must remain in the pay period
In the event that all employees need to be removed from a payroll use the skipPayPeriod API

POST

payroll#removeUsersFromRegularPayPeriod

removeUsersFromRegularPayPeriod

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

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

payrollLineItems

object[]

required

Show child attributes

addUsersToRegularPayPeriod removeOvertime