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
GetPayPeriodDetails
GET
/
reports#getPayPeriodDetails
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayPeriodDetails' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPayPeriodDetails",
"payPeriodId": "7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53"
}'
{
"summary": "Success",
"value": {
"payPeriod": [
{
"payPeriodId": "EFAB1DAB-5646-4DF5-8EA2-C4D42C37811E",
"payPeriod": "11/16/2023 - 11/30/2023",
"deadLineToRunPayroll": "2023-11-28",
"total": 2910,
"employeeTaxSum": 574.18,
"employerTaxSum": 493.73,
"isProcessed": true,
"payDate": "2023-11-30",
"payEndDate": "2023-11-30",
"payBeginDate": "2023-11-16",
"workerType": {
"workerType": "W2"
},
"payPeriodType": {
"payPeriodType": "Regular"
},
"payrollLineItems": [
{
"userId": "50070F09-2923-499A-850B-F12ED4C2FD69",
"baseTotal": 960,
"numberOfLeaveDays": 0,
"lop": 0,
"retroAmount": 0,
"grossTotal": 940,
"netTotal": 810.01,
"employee": {
"employee": "Ron Wood"
},
"employeeTax": {
"employeeTax": 129.99
},
"deductions": [
{
"vertexDeductionIdentifier": {
"deductionDescription": "Qualified Parking Sup"
},
"amount": 120
}
],
"payDetails": [
{
"payPercentage": 0,
"amount": 0,
"employeePayAccount": {
"accountName": "savings ... 1111"
}
},
{
"payPercentage": 100,
"amount": 810.01,
"employeePayAccount": {
"accountName": null
}
}
],
"overTimes": [],
"additionalCompensations": [
{
"payrollLineItemAdditionalCompensationVertexCompensationIdentifier": {
"compensationDescription": "Cash"
},
"amount": 100
}
]
},
{
"userId": "9E3CBA77-9035-471F-AA1E-F77A13AFE5C2",
"baseTotal": 2000,
"numberOfLeaveDays": 0,
"lop": 0,
"retroAmount": 0,
"grossTotal": 1970,
"netTotal": 1540.26,
"employee": {
"employee": "Mark sazav Steve"
},
"employeeTax": {
"employeeTax": 429.74
},
"deductions": [
{
"vertexDeductionIdentifier": {
"deductionDescription": "Qualified Parking Sup"
},
"amount": 150
}
],
"payDetails": [
{
"payPercentage": 100,
"amount": 1540.26,
"employeePayAccount": {
"accountName": "checking ... 0000"
}
}
],
"overTimes": [],
"additionalCompensations": [
{
"payrollLineItemAdditionalCompensationVertexCompensationIdentifier": {
"compensationDescription": "Cash"
},
"amount": 120
}
]
}
]
}
]
}
}
Body
application/json
Example:
["getPayPeriodDetails"]
Response
200 - application/json
payPeriod.payrollLineItems.additionalCompensations.payrollLineItemAdditionalCompensationVertexCompensationIdentifier
object
requiredpayPeriod.payrollLineItems.additionalCompensations.payrollLineItemAdditionalCompensationVertexCompensationIdentifier.compensationDescription
string
requiredcurl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayPeriodDetails' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPayPeriodDetails",
"payPeriodId": "7BF6D637-9E8C-4AF6-A8B0-A24F36CA2F53"
}'
{
"summary": "Success",
"value": {
"payPeriod": [
{
"payPeriodId": "EFAB1DAB-5646-4DF5-8EA2-C4D42C37811E",
"payPeriod": "11/16/2023 - 11/30/2023",
"deadLineToRunPayroll": "2023-11-28",
"total": 2910,
"employeeTaxSum": 574.18,
"employerTaxSum": 493.73,
"isProcessed": true,
"payDate": "2023-11-30",
"payEndDate": "2023-11-30",
"payBeginDate": "2023-11-16",
"workerType": {
"workerType": "W2"
},
"payPeriodType": {
"payPeriodType": "Regular"
},
"payrollLineItems": [
{
"userId": "50070F09-2923-499A-850B-F12ED4C2FD69",
"baseTotal": 960,
"numberOfLeaveDays": 0,
"lop": 0,
"retroAmount": 0,
"grossTotal": 940,
"netTotal": 810.01,
"employee": {
"employee": "Ron Wood"
},
"employeeTax": {
"employeeTax": 129.99
},
"deductions": [
{
"vertexDeductionIdentifier": {
"deductionDescription": "Qualified Parking Sup"
},
"amount": 120
}
],
"payDetails": [
{
"payPercentage": 0,
"amount": 0,
"employeePayAccount": {
"accountName": "savings ... 1111"
}
},
{
"payPercentage": 100,
"amount": 810.01,
"employeePayAccount": {
"accountName": null
}
}
],
"overTimes": [],
"additionalCompensations": [
{
"payrollLineItemAdditionalCompensationVertexCompensationIdentifier": {
"compensationDescription": "Cash"
},
"amount": 100
}
]
},
{
"userId": "9E3CBA77-9035-471F-AA1E-F77A13AFE5C2",
"baseTotal": 2000,
"numberOfLeaveDays": 0,
"lop": 0,
"retroAmount": 0,
"grossTotal": 1970,
"netTotal": 1540.26,
"employee": {
"employee": "Mark sazav Steve"
},
"employeeTax": {
"employeeTax": 429.74
},
"deductions": [
{
"vertexDeductionIdentifier": {
"deductionDescription": "Qualified Parking Sup"
},
"amount": 150
}
],
"payDetails": [
{
"payPercentage": 100,
"amount": 1540.26,
"employeePayAccount": {
"accountName": "checking ... 0000"
}
}
],
"overTimes": [],
"additionalCompensations": [
{
"payrollLineItemAdditionalCompensationVertexCompensationIdentifier": {
"compensationDescription": "Cash"
},
"amount": 120
}
]
}
]
}
]
}
}