Reports
getPayrollHistoryBasedOnDateRange
- Documentation
- API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Reports
- GETgetBusinessUserInfo
- GETgetUserTask
- GETgetPaidEmployeesCountBasedOnDateRange
- GETgetPayPeriodDetails
- GETgetPayPeriod
- GETgetCompanyInfo
- GETgetCompanyLocationInfo
- GETgetActiveUsers
- GETgetTerminatedUsers
- GETgetDeactivatedUsers
- GETgetPayrollHistoryBasedOnPayPeriod
- GETgetPayrollHistoryBasedOnDateRange
- GETgetPayRun
- GETgetPaySchedule
- GETgetPayStub
- GETgetTransactionBasedOnReference
- GETgetTransactions
- GETgetTransactionsBasedOnName
- GETgetBusinessUserDetails
- GETgetIndividualPayrollHistory
- GET
API Reference
Reports
getPayrollHistoryBasedOnDateRange
In this Report we will be able to get payperiod details and payperiodlineitem details of the company based on the Pay Begin Date and Pay End Date
GET
/
reports#getPayrollHistoryBasedOnDateRange
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
username
string
username
string
password
string
password
string
object
method
getPayrollHistoryBasedOnDateRange · string
*
method
Required
string
Add Example Value
companyId
string
*
companyId
Required
string
startDate
string
*
startDate
Required
string
endDate
string
*
endDate
Required
string
Body
application/json
method
string
default: getPayrollHistoryBasedOnDateRangerequiredcompanyId
string
requiredstartDate
string
requiredendDate
string
requiredResponse
200 - application/json
payPeriod
object[]
requiredpayPeriod.payPeriodId
string
payPeriod.payPeriod
string
payPeriod.deadLineToRunPayroll
string
payPeriod.total
integer
payPeriod.employeeTaxSum
number
payPeriod.employerTaxSum
number
payPeriod.isProcessed
boolean
payPeriod.payDate
string
payPeriod.payEndDate
string
payPeriod.payBeginDate
string
payPeriod.workerType
object
payPeriod.workerType.workerType
string
requiredpayPeriod.payrollLineItems
object[]
payPeriod.payrollLineItems.userId
string
requiredpayPeriod.payrollLineItems.baseTotal
integer
requiredpayPeriod.payrollLineItems.numberOfLeaveDays
integer
requiredpayPeriod.payrollLineItems.lop
integer
requiredpayPeriod.payrollLineItems.retroAmount
integer
requiredpayPeriod.payrollLineItems.grossTotal
integer
requiredpayPeriod.payrollLineItems.netTotal
number
requiredpayPeriod.payrollLineItems.userName
object
requiredpayPeriod.payrollLineItems.userName.employee
string
requiredpayPeriod.payrollLineItems.employeeTax
object
requiredpayPeriod.payrollLineItems.employeeTax.employeeTax
number
requiredpayPeriod.payrollLineItems.Deductions
object[]
requiredpayPeriod.payrollLineItems.Deductions.vertexDeductionIdentifier
object
requiredpayPeriod.payrollLineItems.Deductions.vertexDeductionIdentifier.deductionDescription
string
requiredpayPeriod.payrollLineItems.Deductions.amount
integer
requiredpayPeriod.payrollLineItems.payDetails
object[]
requiredpayPeriod.payrollLineItems.payDetails.payPercentage
integer
requiredpayPeriod.payrollLineItems.payDetails.amount
integer
requiredpayPeriod.payrollLineItems.payDetails.employeePayAccount
object
requiredpayPeriod.payrollLineItems.payDetails.employeePayAccount.accountName
string | null
requiredpayPeriod.payrollLineItems.OverTimes
string[]
requiredpayPeriod.payrollLineItems.AdditionalCompensations
object[]
requiredpayPeriod.payrollLineItems.AdditionalCompensations.payrollLineItemAdditionalCompensation_VertexCompensationIdentifier
object
requiredpayPeriod.payrollLineItems.AdditionalCompensations.payrollLineItemAdditionalCompensation_VertexCompensationIdentifier.compensationDescription
string
requiredpayPeriod.payrollLineItems.AdditionalCompensations.amount
integer
required