API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- GETgetActiveUsers
- GETgetAdditionalCompensationDescription
- GETgetBusinessUserInfo
- GETgetBusinessUserDetails
- GETgetCompanies
- GETgetCompanyInfo
- GETgetCompanyLocationInfo
- GETgetDeactivatedUsers
- GETgetDeductionDescription
- GETgetIndividualPayrollHistory
- GETgetOverTimeTypes
- GETgetProcessedPayperiodsDetails
- GETgetPaidEmployeesCountBasedOnDateRange
- GETgetPayPeriodDetails
- GETgetPayPeriod
- GETgetPayrollHistoryBasedOnPayPeriod
- GETgetPayrollHistoryBasedOnDateRange
- GETgetPayRun
- GETgetPaySchedule
- GETgetPayStub
- GETgetPayBeginDates
- GETgetPayrollJournalReport
- GETgetStateW4FormFeilds
- GETgetStateRegistration
- GETgetTerminatedUsers
- GETgetTransactionBasedOnReference
- GETgetTransactions
- GETgetTransactionsBasedOnName
- GETgetUserTask
- GETgetUsersByCompanyName
- GETgetUnProcessedPayPeriod
- GETgetUsers
- GETgetUser
- GET
- Webhooks
Reports
getPaySchedule
GET
/
reports#getPaySchedule
getPaySchedule
Copy
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPaySchedule' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPaySchedule",
"companyId": "28fcb32e-29fe-4269-8aa3-011e7276ef5e"
}'
Copy
{
"paySchedule": [
{
"payBeginDate": "2023-11-16",
"payDate": "2023-11-30",
"payEndDate": "2023-11-30",
"deadlineToRunPayroll": "2023-11-28",
"workerType": {
"workerType": "W2"
},
"compensationFrequency": {
"compensationFrequency": "SemiMonthly"
}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
Response
200 - application/json
The response is of type object
.
getPaySchedule
Copy
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPaySchedule' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPaySchedule",
"companyId": "28fcb32e-29fe-4269-8aa3-011e7276ef5e"
}'
Copy
{
"paySchedule": [
{
"payBeginDate": "2023-11-16",
"payDate": "2023-11-30",
"payEndDate": "2023-11-30",
"deadlineToRunPayroll": "2023-11-28",
"workerType": {
"workerType": "W2"
},
"compensationFrequency": {
"compensationFrequency": "SemiMonthly"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.