Reports
getPayPeriodDetails
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
- GETGetStateW4Information
- GETgetPayrollJournalReport
- GETgetUser
- GETgetIndividualPayrollHistory
- GET
- Webhooks
Reports
getPayPeriodDetails
In this report the pay period details are fetched based on PayPeriodId
GET
/
reports#getPayPeriodDetails
Response
200 - application/json
payPeriod.payrollLineItems.additionalCompensations.payrollLineItemAdditionalCompensationVertexCompensationIdentifier
object
payPeriod.payrollLineItems.additionalCompensations.payrollLineItemAdditionalCompensationVertexCompensationIdentifier.compensationDescription
string