paycheckheaderdetails

API resource to retrieve employee paycheck and paycheck header level details for:

• Total Earnings

• Total Deductions

• Total Taxes

• Net Pay

• Gross Pay

• Total Employer Paid Benefits

• Total After Tax deductions

• Total Before Tax deductions

• Leave Balances

• Direct Deposit in Paycheck

• Garnishment details in Paycheck

Method: GET

Path: /paycheckheaderdetails/{fromDate}/{toDate}

This end point retrieves the paycheck details between the provided From Date and To Date.

Request Parameters	Description
fromDate	From date.
toDate	To date.

Response Parameters	Response Result Type	Description
emplId	Success	Employee ID.
checkDate	Success	Paycheck date.
paycheckNumber	Success	Paycheck number.
paybeginDate	Success	Pay period begin date.
payendDate	Success	Pay period end date.
companyID	Success	Company ID.
payGroup	Success	Employee pay group.
OffCycle	Success	Off cycle (paycheck)
pageNum	Success	Paycheck page number.
lineNum	Success	Paycheck line number.
netPay	Success	Paycheck net pay.
earningsDetails	Success	Paycheck earnings details.
deductionDetails	Success	Paycheck deduction details.
taxDetails	Success	Paycheck tax details.
pdfURL	Success	PDF URL. URL to download PDF version of a paycheck.
piaURL	Success	PIA URL. URL to PeopleSoft Self-service Paycheck page, where user can retrieve paycheck details.
titleValue	Success	Title value (paycheck date details).
headerValue	Success	Header value (paycheck details for gross wages, taxes, deductions, and so forth).

Method: GET

Path: /paycheckheaderdetails/{fromDate}/{toDate}/{paycheckSection}

This end point retrieves the employee payslip header details based on the payslip section name provided. The end point also filters the details based on the count provided.

Request Parameters	Description
fromDate	From date.
paycheckSection	Paycheck section filter.
toDate	To date.

Response Parameters	Response Result Type	Description
emplId	Success	Employee ID.
checkDate	Success	Paycheck date.
paycheckNumber	Success	Paycheck number.
paybeginDate	Success	Pay period begin date.
payendDate	Success	Pay period end date.
companyID	Success	Company ID.
payGroup	Success	Employee pay group.
OffCycle	Success	Off cycle (paycheck)
pageNum	Success	Paycheck page number.
lineNum	Success	Paycheck line number.
netPay	Success	Paycheck net pay.
earningsDetails	Success	Paycheck earnings details.
deductionDetails	Success	Paycheck deduction details.
taxDetails	Success	Paycheck tax details.
pdfURL	Success	PDF URL. URL to download PDF version of a paycheck.
piaURL	Success	PIA URL. URL to PeopleSoft Self-service Paycheck page, where user can retrieve paycheck details.
titleValue	Success	Title value (paycheck date details).
headerValue	Success	Header value (paycheck details for gross wages, taxes, deductions, and so forth).

Method: GET

Path: /paycheckheaderdetails/{fromDate}/{toDate}/{paycheckSection}/{categoryID}

This end point retrieves specific earnings or deductions details from employee paycheck based on category.

Request Parameters	Description
categoryID	Paycheck category ID.
fromDate	From date.
paycheckSection	Paycheck section filter.
toDate	To date.

Response Parameters	Response Result Type	Description
emplId	Success	Employee ID.
checkDate	Success	Paycheck date.
paycheckNumber	Success	Paycheck number.
paybeginDate	Success	Pay period begin date.
payendDate	Success	Pay period end date.
companyID	Success	Company ID.
payGroup	Success	Employee pay group.
OffCycle	Success	Off cycle (paycheck)
pageNum	Success	Paycheck page number.
lineNum	Success	Paycheck line number.
netPay	Success	Paycheck net pay.
earningsDetails	Success	Paycheck earnings details.
deductionDetails	Success	Paycheck deduction details.
taxDetails	Success	Paycheck tax details.
pdfURL	Success	PDF URL. URL to download PDF version of a paycheck.
piaURL	Success	PIA URL. URL to PeopleSoft Self-service Paycheck page, where user can retrieve paycheck details.
titleValue	Success	Title value (paycheck date details).
headerValue	Success	Header value (paycheck details for gross wages, taxes, deductions, and so forth).

Method: GET

Path:/paycheckheaderdetails/{fromDate}/{toDate}/{paycheckSection}/{categoryID}/{filterBy}/{countFilter}/{garnishType}/{searchText}

This end point retrieves details based on the filter values and count value provided.

Request Parameters	Description
categoryID	Paycheck category ID.
countFilter	Count filter
filterBy	Filter by criteria.
fromDate	From date.
garnishType	Wage garnishment type.
paycheckSection	Paycheck section filter.
searchText	Search text.
toDate	To date.

Response Parameters	Response Result Type	Description
emplId	Success	Employee ID.
checkDate	Success	Paycheck date.
paycheckNumber	Success	Paycheck number.
paybeginDate	Success	Pay period begin date.
payendDate	Success	Pay period end date.
companyID	Success	Company ID.
payGroup	Success	Employee pay group.
OffCycle	Success	Off cycle (paycheck)
pageNum	Success	Paycheck page number.
lineNum	Success	Paycheck line number.
netPay	Success	Paycheck net pay.
earningsDetails	Success	Paycheck earnings details.
deductionDetails	Success	Paycheck deduction details.
taxDetails	Success	Paycheck tax details.
pdfURL	Success	PDF URL. URL to download PDF version of a paycheck.
piaURL	Success	PIA URL. URL to PeopleSoft Self-service Paycheck page, where user can retrieve paycheck details.
titleValue	Success	Title value (paycheck date details).
headerValue	Success	Header value (paycheck details for gross wages, taxes, deductions, and so forth).