API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- GETGetBusinessUserInfo
- GETGetUserTask
- GETGetUsersByCompanyName
- GETGetCompanies
- GETGetPaidEmployeesCountBasedOnDateRange
- GETGetPayPeriodDetails
- GETGetPayPeriod
- GETGetCompanyInfo
- GETGetCompanyLocationInfo
- GETGetActiveUsers
- GETGetTerminatedUsers
- GETGetDeactivatedUsers
- GETGetPayrollHistoryBasedOnPayPeriod
- GETGetPayrollHistoryBasedOnDateRange
- GETGetPayRun
- GETGetPaySchedule
- GETGetPayStub
- GETGetTransactionBasedOnReference
- GETGetTransactions
- GETGetTransactionsBasedOnName
- GETGetBusinessUserDetails
- GETGetStateW4FormFeilds
- GETGetPayrollJournalReport
- GETGetUser
- GETGetPayBeginDates
- GETGetStateRegistration
- GETGetIndividualPayrollHistory
- GET
- Webhooks
Reports
GetPayrollHistoryBasedOnPayPeriod
GET
/
reports#getPayrollHistoryBasedOnPayPeriod
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayrollHistoryBasedOnPayPeriod' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPayrollHistoryBasedOnPayPeriod",
"payPeriodId": "7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53"
}'
{
"summary": "Success",
"value": {
"payPeriod": [
{
"payPeriodId": "7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53",
"payPeriod": "07/15/2023 - 07/28/2023",
"deadLineToRunPayroll": "2023-07-25",
"total": 110.59,
"employeeTaxSum": 6.57,
"employerTaxSum": 6.7,
"isProcessed": true,
"payDate": "2023-07-27",
"payEndDate": "2023-07-28",
"payBeginDate": "2023-07-15",
"workerType": "W2",
"payrollLineItems": [
{
"payrollLineItemId": "4920E23B-6B83-46CF-81D6-9806E653CE79",
"baseTotal": 87.52,
"numberOfLeaveDays": 10,
"lop": 6.42,
"retroAmount": 22,
"grossTotal": 87.52,
"netTotal": 41.55,
"employee": "Clenz Martin",
"employeeTax": 4.6,
"payrollLineItemDeductions": [],
"payDetails": [
{
"payPercentage": 100,
"amount": 41.55,
"employeePayAccount": "default"
}
],
"payrollLineItemOverTimes": [],
"payrollLineItemAdditionalCompensations": []
},
{
"payrollLineItemId": "39BFE40D-AFC6-4EF5-83A3-FE7F4D990B34",
"baseTotal": 23.07,
"numberOfLeaveDays": null,
"lop": null,
"retroAmount": 0,
"grossTotal": 23.07,
"netTotal": 21.1,
"employee": "Jordan Mathews",
"employeeTax": 1.97,
"payrollLineItemDeductions": [],
"payDetails": [
{
"payPercentage": 100,
"amount": 21.1,
"employeePayAccount": "default"
}
],
"payrollLineItemOverTimes": [],
"payrollLineItemAdditionalCompensations": []
}
]
}
]
}
}
Body
application/json
Example:
["getPayrollHistoryBasedOnPayPeriod"]
Response
200 - application/json
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayrollHistoryBasedOnPayPeriod' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPayrollHistoryBasedOnPayPeriod",
"payPeriodId": "7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53"
}'
{
"summary": "Success",
"value": {
"payPeriod": [
{
"payPeriodId": "7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53",
"payPeriod": "07/15/2023 - 07/28/2023",
"deadLineToRunPayroll": "2023-07-25",
"total": 110.59,
"employeeTaxSum": 6.57,
"employerTaxSum": 6.7,
"isProcessed": true,
"payDate": "2023-07-27",
"payEndDate": "2023-07-28",
"payBeginDate": "2023-07-15",
"workerType": "W2",
"payrollLineItems": [
{
"payrollLineItemId": "4920E23B-6B83-46CF-81D6-9806E653CE79",
"baseTotal": 87.52,
"numberOfLeaveDays": 10,
"lop": 6.42,
"retroAmount": 22,
"grossTotal": 87.52,
"netTotal": 41.55,
"employee": "Clenz Martin",
"employeeTax": 4.6,
"payrollLineItemDeductions": [],
"payDetails": [
{
"payPercentage": 100,
"amount": 41.55,
"employeePayAccount": "default"
}
],
"payrollLineItemOverTimes": [],
"payrollLineItemAdditionalCompensations": []
},
{
"payrollLineItemId": "39BFE40D-AFC6-4EF5-83A3-FE7F4D990B34",
"baseTotal": 23.07,
"numberOfLeaveDays": null,
"lop": null,
"retroAmount": 0,
"grossTotal": 23.07,
"netTotal": 21.1,
"employee": "Jordan Mathews",
"employeeTax": 1.97,
"payrollLineItemDeductions": [],
"payDetails": [
{
"payPercentage": 100,
"amount": 21.1,
"employeePayAccount": "default"
}
],
"payrollLineItemOverTimes": [],
"payrollLineItemAdditionalCompensations": []
}
]
}
]
}
}