getPayRun

The getPayRun API retrieves payroll line item information for a specific pay period.

What it does:

• Returns payroll line items including user ID, total hours, wages and taxes
• Provides at-a-glance payroll data for all employees within a specific pay period
• Provides cash requirements after all withholdings, deductions, taxes and credits for each employee to be paid successfully

GET /reports#getPayRun

getPayRun

cURL

curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPayRun' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getPayRun",
  "payPeriodId": "1701499A-1F6A-4D96-9A45-2021A19777E6"
}
'

200

{
  "payrollLineItems": [
    {
      "userId": "50070F09-2923-499A-850B-F12ED4C2FD69",
      "totalHours": 40,
      "wages": 960,
      "taxes": 129.99,
      "cash requirements": 960
    },
    {
      "userId": "9E3CBA77-9035-471F-AA1E-F77A13AFE5C2",
      "totalHours": 40,
      "wages": 2000,
      "taxes": 429.74,
      "cash requirements": 2000
    }
  ]
}

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

Example:

"getPayRun"

payPeriodId · string<uuid> · required

Response

200

application/json

payrollLineItems · object[] · required

Show child attributes