Rollfi home page

Reports

getPayrollHistoryBasedOnDateRange

Company Onboarding
User Onboarding
Admin Portal
User Portal
Payroll
benefits
Reports

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

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

required

companyId

string

required

startDate

string

required

Maximum length: 10

endDate

string

required

Maximum length: 10

Response

200 - application/json

payPeriod

object[]

required

payPeriod.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

required

payPeriod.payrollLineItems

object[]

payPeriod.payrollLineItems.userId

string

required

payPeriod.payrollLineItems.baseTotal

integer

required

payPeriod.payrollLineItems.numberOfLeaveDays

integer

required

payPeriod.payrollLineItems.lop

integer

required

payPeriod.payrollLineItems.retroAmount

integer

required

payPeriod.payrollLineItems.grossTotal

integer

required

payPeriod.payrollLineItems.netTotal

number

required

payPeriod.payrollLineItems.userName

object

required

payPeriod.payrollLineItems.userName.employee

string

required

payPeriod.payrollLineItems.employeeTax

object

required

payPeriod.payrollLineItems.employeeTax.employeeTax

number

required

payPeriod.payrollLineItems.Deductions

object[]

required

payPeriod.payrollLineItems.Deductions.vertexDeductionIdentifier

object

required

payPeriod.payrollLineItems.Deductions.vertexDeductionIdentifier.deductionDescription

string

required

payPeriod.payrollLineItems.Deductions.amount

integer

required

payPeriod.payrollLineItems.payDetails

object[]

required

payPeriod.payrollLineItems.payDetails.payPercentage

integer

required

payPeriod.payrollLineItems.payDetails.amount

integer

required

payPeriod.payrollLineItems.payDetails.employeePayAccount

object

required

payPeriod.payrollLineItems.payDetails.employeePayAccount.accountName

string | null

required

payPeriod.payrollLineItems.OverTimes

string[]

required

payPeriod.payrollLineItems.AdditionalCompensations

object[]

required

payPeriod.payrollLineItems.AdditionalCompensations.payrollLineItemAdditionalCompensation_VertexCompensationIdentifier

object

required

payPeriod.payrollLineItems.AdditionalCompensations.payrollLineItemAdditionalCompensation_VertexCompensationIdentifier.compensationDescription

string

required

payPeriod.payrollLineItems.AdditionalCompensations.amount

integer

required

getPayrollHistoryBasedOnPayPeriod getPayRun

twitter linkedin