importRegularPayrollData

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#importRegularPayrollData' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "importRegularPayrollLData",
  "companyId": "3FD08599-7CBB-44C5-9243-CAD72BE36BDF",
  "payPeriodId": "EDD9F5D2-BED4-4337-A80C-4DDD33EDFF91",
  "payrollData": [
    {
      "userId": "4DF5A79A-3735-4588-95A6-B80D15CB5A5E",
      "basicPay": {
        "payHours": 173
      },
      "unPaidLeave": {
        "noOfHours": 10
      },
      "retro": {
        "amount": 4,
        "description": "JK"
      },
      "overTime": [
        {
          "type": "Comp off OT",
          "noOfHours": 10,
          "multiplier": 1
        }
      ],
      "additionalCompensation": [
        {
          "description": "Stock Options",
          "amount": 500
        },
        {
          "description": "Van Pool & Transit Passes",
          "amount": 500
        }
      ],
      "deductions": [
        {
          "description": "403B CU 15 year Reg",
          "amount": 10
        },
        {
          "description": "125DC Reg",
          "amount": 5000
        }
      ],
      "reimbursements": [
        {
          "reimbursementType": "GYM",
          "amount": 120
        }
      ],
      "timeOffs": [
        {
          "leaveType": "Paid",
          "policyType": "Sick Leave",
          "hours": 20
        },
        {
          "leaveType": "Paid",
          "policyType": "Vacation",
          "hours": 10
        },
        {
          "leaveType": "Unpaid",
          "hours": 5
        }
      ],
      "miscellaneousStateTaxes": [
        {
          "stateCode": "WA",
          "taxName": "Washington L&I",
          "taxDetails": [
            {
              "riskClassName": "Electrician",
              "noOfHours": 5
            }
          ]
        }
      ]
    }
  ]
}
'

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

Payroll

importRegularPayrollData

The importRegularPayrollData API imports regular payroll data for processing.

What it does:

Handles standard payroll data import for companies with consistent pay structures
Links users to their regular compensation package, deductions, additional compensation, and reimbursements
Processes regular payroll information for multiple employees at once
Used to import regular payroll data without differential pay rates on a user-by-user basis

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`

POST

payroll#importRegularPayrollData

importRegularPayrollData

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#importRegularPayrollData' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "importRegularPayrollLData",
  "companyId": "3FD08599-7CBB-44C5-9243-CAD72BE36BDF",
  "payPeriodId": "EDD9F5D2-BED4-4337-A80C-4DDD33EDFF91",
  "payrollData": [
    {
      "userId": "4DF5A79A-3735-4588-95A6-B80D15CB5A5E",
      "basicPay": {
        "payHours": 173
      },
      "unPaidLeave": {
        "noOfHours": 10
      },
      "retro": {
        "amount": 4,
        "description": "JK"
      },
      "overTime": [
        {
          "type": "Comp off OT",
          "noOfHours": 10,
          "multiplier": 1
        }
      ],
      "additionalCompensation": [
        {
          "description": "Stock Options",
          "amount": 500
        },
        {
          "description": "Van Pool & Transit Passes",
          "amount": 500
        }
      ],
      "deductions": [
        {
          "description": "403B CU 15 year Reg",
          "amount": 10
        },
        {
          "description": "125DC Reg",
          "amount": 5000
        }
      ],
      "reimbursements": [
        {
          "reimbursementType": "GYM",
          "amount": 120
        }
      ],
      "timeOffs": [
        {
          "leaveType": "Paid",
          "policyType": "Sick Leave",
          "hours": 20
        },
        {
          "leaveType": "Paid",
          "policyType": "Vacation",
          "hours": 10
        },
        {
          "leaveType": "Unpaid",
          "hours": 5
        }
      ],
      "miscellaneousStateTaxes": [
        {
          "stateCode": "WA",
          "taxName": "Washington L&I",
          "taxDetails": [
            {
              "riskClassName": "Electrician",
              "noOfHours": 5
            }
          ]
        }
      ]
    }
  ]
}
'

{
  "importRegularPayrollLData": {
    "status": "Ready",
    "message": "Imported 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

importRegularPayrollLData

object

required

Show child attributes

importRegularDifferentialPayrollData deactivatePaySchedule

Documentation Index

Authorizations

Body

Response