Reports
getPayPeriodDetails
- 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
getPayPeriodDetails
In this report the pay period details are fetched based on PayPeriodId
GET
/
reports#getPayPeriodDetails
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
getPayPeriodDetails · string
*
method
Required
string
Add Example Value
payPeriodId
string
*
payPeriodId
Required
string
Body
application/json
method
string
default: getPayPeriodDetailsrequiredpayPeriodId
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.payPeriodType
object
payPeriod.payPeriodType.payPeriodType
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.employee
object
requiredpayPeriod.payrollLineItems.employee.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.payrollLineItemAdditionalCompensationVertexCompensationIdentifier
object
requiredpayPeriod.payrollLineItems.additionalCompensations.payrollLineItemAdditionalCompensationVertexCompensationIdentifier.compensationDescription
string
requiredpayPeriod.payrollLineItems.additionalCompensations.amount
integer
required