importDifferentialPayrollData

curl --request POST \
  --url https://sandbox.rollfi.xyz/payroll/importDifferentialPayrollData \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "importDifferentialPayrollData",
  "companyId": "68D29B82-86FA-4B51-B16E-01346BD3F43B",
  "payPeriodId": "2412217E-E92A-46D5-A359-DF715FBF28CD",
  "payrollData": [
    {
      "userId": "CE934E2C-00A5-46A1-B925-CBD97BF07AF8",
      "firstName": "Emmanuel",
      "lastName": "Golden",
      "paymentMethod": "Direct Deposit",
      "basePay": [
        {
          "payHours": 8.75,
          "payRate": 0,
          "payCode": "BASE_PAY",
          "multiplier": 1,
          "amount": 0
        },
        {
          "payHours": 0.75,
          "payRate": 20,
          "payCode": "1151",
          "multiplier": 1,
          "amount": 15
        }
      ],
      "additionalCompensations": [
        {
          "amount": 310,
          "description": "Van Pool & Transit Passes"
        }
      ],
      "deductions": [
        {
          "description": "Qualified Parking Sup",
          "amount": 120
        }
      ],
      "reimbursements": [
        {
          "reimbursementType": "GYM",
          "amount": 120
        }
      ],
      "miscellaneousStateTaxes": [
        {
          "stateCode": "WA",
          "taxName": "Washington L&I",
          "taxDetails": [
            {
              "riskClassName": "Shop - Intra State Trucking",
              "noOfHours": 6
            }
          ]
        }
      ]
    }
  ]
}
'

{
  "importDifferntiaPayrollData": {
    "status": "Ready",
    "message": "Imported Differential Payroll Data Successfully"
  }
}

Payroll

importDifferentialPayrollData

The importDifferentialPayrollData API adds regular differential payroll data for processing.

What it does:

Adds payroll data with differential pay rates for employees
Allows varying pay rate using a payCode for employees who operate in different roles with different pay scales

Notes:

To allow miscellaneousStateTaxes to be imported to payroll, please refer to the addEmployeeMiscellaneousStateTax API
An employee’s available miscellaneousStateTax items can be retrieved using ‘getEmployeeMiscellaneousStateTaxforPayroll`

Specifying Payment Method:

PaymentMethod can be specified for each employee in the request.
Defauls to the method in the user’s wage details.
Employees can only be set to Direct Deposit if the employee has a connected bank account
Employees will be switched only for the pay period you are currently importing for. Subsequent pay periods will default back to the user wage

POST

payroll

importDifferentialPayrollData

curl --request POST \
  --url https://sandbox.rollfi.xyz/payroll/importDifferentialPayrollData \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "importDifferentialPayrollData",
  "companyId": "68D29B82-86FA-4B51-B16E-01346BD3F43B",
  "payPeriodId": "2412217E-E92A-46D5-A359-DF715FBF28CD",
  "payrollData": [
    {
      "userId": "CE934E2C-00A5-46A1-B925-CBD97BF07AF8",
      "firstName": "Emmanuel",
      "lastName": "Golden",
      "paymentMethod": "Direct Deposit",
      "basePay": [
        {
          "payHours": 8.75,
          "payRate": 0,
          "payCode": "BASE_PAY",
          "multiplier": 1,
          "amount": 0
        },
        {
          "payHours": 0.75,
          "payRate": 20,
          "payCode": "1151",
          "multiplier": 1,
          "amount": 15
        }
      ],
      "additionalCompensations": [
        {
          "amount": 310,
          "description": "Van Pool & Transit Passes"
        }
      ],
      "deductions": [
        {
          "description": "Qualified Parking Sup",
          "amount": 120
        }
      ],
      "reimbursements": [
        {
          "reimbursementType": "GYM",
          "amount": 120
        }
      ],
      "miscellaneousStateTaxes": [
        {
          "stateCode": "WA",
          "taxName": "Washington L&I",
          "taxDetails": [
            {
              "riskClassName": "Shop - Intra State Trucking",
              "noOfHours": 6
            }
          ]
        }
      ]
    }
  ]
}
'

{
  "importDifferntiaPayrollData": {
    "status": "Ready",
    "message": "Imported Differential Payroll Data 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

payrollData

object[]

required

Show child attributes

Response

importDifferntiaPayrollData

object

required

Show child attributes

addPaySchedule importRegularPayrollData