Reports
getPayPeriod
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
getPayPeriod
GET
/
reports#getPayPeriod
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayPeriod' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPayPeriod",
"companyId": "28fcb32e-29fe-4269-8aa3-011e7276ef5e",
"workerType": "W2"
}'
{
"payPeriodId": "5D001432-D5E4-4EF3-80E1-BB4388ADC43B",
"payPeriod": "11/01/2023 - 11/30/2023",
"payBeginDate": "2023-11-01",
"payEndDate": "2023-11-30",
"payDate": "2023-11-30",
"deadLineToRunPayroll": "2023-11-28"
}
Body
application/json
Response
200 - application/json
The response is of type object
.
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getPayPeriod' \
--header 'Content-Type: application/json' \
--data '{
"method": "getPayPeriod",
"companyId": "28fcb32e-29fe-4269-8aa3-011e7276ef5e",
"workerType": "W2"
}'
{
"payPeriodId": "5D001432-D5E4-4EF3-80E1-BB4388ADC43B",
"payPeriod": "11/01/2023 - 11/30/2023",
"payBeginDate": "2023-11-01",
"payEndDate": "2023-11-30",
"payDate": "2023-11-30",
"deadLineToRunPayroll": "2023-11-28"
}