Understanding REST API Endpoints for PeopleSoft Payroll for North America Services (payrollbankingyearendforms)

This table lists the delivered API resources used with the PeopleSoft Payroll for North America Services API.

API Resource	Description
paycheckheaderdetails	API resource to retrieve employee paycheck and paycheck header level details.
paycheckemployerpaidbenefits	API resource to retrieve employer paid benefits to an employee for a given paycheck.
paycheckgarnishment	API resource to retrieve employee garnishments for a given paycheck number and pay end date.
yearendforms	API resource to retrieve year end forms (report details) of the employee from a given date.
bankingdetails	API resource to retrieve employee direct deposit details.
garnishmentdetails	API resource to retrieve active garnishment details for an employee.
employeepayfrequency	API resource to retrieve employee payment frequency details.
paycheckearnings	API resource to retrieve employee payment frequency details.
paychecktaxes	API resource to retrieve employee tax details for a given paycheck.
paycheckaftertaxdeductions	API resource to retrieve after tax deductions for an employee for a given paycheck.
paycheckbeforetaxdeductions	API resource to retrieve employee before tax deductions for an employee for a given paycheck.

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

API resource to retrieve employer paid benefits to an employee for a given paycheck.

Method: GET

Path: /paycheckemployerpaidbenefits/{paycheckNum}/{endDate}

This end point retrieves employer paid benefits for an employee for a given paycheck number and pay end date.

Request Parameters	Description
endDate	End date.
paycheckNum	Paycheck number.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (paycheck details for gross wages, taxes, deductions, and so forth).
sectnDetails	Success	Section details (paycheck benefits details, such as 401(k) and so forth).

API resource to retrieve employee garnishments for a given paycheck number and pay end date.

Method: GET

Path: /paycheckgarnishment/{paycheckNum}/{endDate}

Request Parameters	Description
endDate	End date.
paycheckNum	Paycheck number.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (paycheck details for gross wages, taxes, deductions, and so forth).
accntDetails	Success	Account details (garnishment details for the paycheck).

API resource to retrieve year end form details for an employee.

Method: GET

Path:/yearendforms/{fromDate}

This end point retrieves year end report details for the employee, for a given date.

Request Parameters	Description
fromDate	From date.

Response Parameters	Response Result Type	Description
taxformidOut	Success	Tax form ID out. Description of the year end tax form (for example, W-2).
titleValue	Success	Title value (year end form details, such as company and date).
headerValue	Success	Header value (year end form details, such as tax form issue date, description, and so forth).
urlDetails	Success	URL details. URL to download PDF version of year end forms.
buttonDescr	Success	Button description (button label in Digital Assistant).
consentForm	Success	Consent form flag.

Method: GET

Path: /yearendforms/{fromDate}/{taxformID}

This end point retrieves employee year end forms for the given date and for a particular tax form ID.

Request Parameters	Description
fromDate	From date.
taxformID	Tax form ID

Response Parameters	Response Result Type	Description
taxformidOut	Success	Tax form ID out. Description of the year end tax form (for example, W-2).
titleValue	Success	Title value (year end form details, such as company and date).
headerValue	Success	Header value (year end form details, such as tax form issue date, description, and so forth).
urlDetails	Success	URL details. URL to download PDF version of year end forms.
buttonDescr	Success	Button description (button label in Digital Assistant).
consentForm	Success	Consent form flag.

Method: GET

Path: /yearendforms/{fromDate}/{taxformID}/{formAvailability}

This end point retrieves year end availability date for a given tax form ID and for a given date.

Request Parameters	Description
formAvailability	Tax form availability.
fromDate	From date.
taxformID	Tax form ID.

Response Parameters	Response Result Type	Description
taxformidOut	Success	Tax form ID out. Description of the year end tax form (for example, W-2).
titleValue	Success	Title value (year end form details, such as company and date).
headerValue	Success	Header value (year end form details, such as tax form issue date, description, and so forth).
urlDetails	Success	URL details. URL to download PDF version of year end forms.
buttonDescr	Success	Button description (button label in Digital Assistant).
consentForm	Success	Consent form flag.

Method: GET

Path: /yearendforms/{fromDate}/{taxformID}/ConsentCheck/{consentAvailability}

This end point retrieves consent availability for year end forms for the employee for the given date and tax form ID.

Request Parameters	Description
consentAvailability	Consent form availability.
fromDate	From date.
taxformID	Tax form ID.

Response Parameters	Response Result Type	Description
taxformidOut	Success	Tax form ID out. Description of the year end tax form (for example, W-2).
titleValue	Success	Title value (year end form details, such as company and date).
headerValue	Success	Header value (year end form details, such as tax form issue date, description, and so forth).
urlDetails	Success	URL details. URL to download PDF version of year end forms.
buttonDescr	Success	Button description (button label in Digital Assistant).
consentForm	Success	Consent form flag.

Method: GET

Path: /yearendforms/{fromDate}/{taxformID}/{formAvailability}/{consentAvailability}/{countFilter}/{searchText}

This end point retrieves year end forms details or consent details or availability date details for a given date and taxform id or based on forms count.

Request Parameters	Description
consentAvailability	Consent form availability.
countFilter	Count filter.
formAvailability	Form availability.
fromDate	From date.
searchText	Search text.
taxformID	Tax form ID.

Response Parameters	Response Result Type	Description
taxformidOut	Success	Tax form ID out. Description of the year end tax form (for example, W-2).
titleValue	Success	Title value (year end form details, such as company and date).
headerValue	Success	Header value (year end form details, such as tax form issue date, description, and so forth).
urlDetails	Success	URL details. URL to download PDF version of year end forms.
buttonDescr	Success	Button description (button label in Digital Assistant).
consentForm	Success	Consent form flag.

API resource to retrieve employee direct deposit details.

Method: GET

Path:/bankingdetails/{txnType}

This end point retrieves direct deposits available for an employee.

Request Parameters	Description
txnType	Banking Transaction type.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (bank account header details).
accntDetails	Success	Account details (bank account details for the user).
piaURL	Success	PIA URL. URL to view direct deposit details.

Response Parameters

Response Result Type

Description

headerValue

Success

Header value (bank account header details).

accntDetails

Success

Account details (bank account details for the user).

piaURL

Success

PIA URL.

URL to view direct deposit details.

Method: GET

Path: /bankingdetails/{txnType}/{depositType}

This end point retrieves direct deposit details for an employee based on the deposit type and action type provided.

Request Parameters	Description
depositType	Banking deposit type.
txnType	Banking Transaction type.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (bank account header details).
accntDetails	Success	Account details (bank account details for the user).
piaURL	Success	PIA URL. URL to view direct deposit details.

Response Parameters

Response Result Type

Description

headerValue

Success

Header value (bank account header details).

accntDetails

Success

Account details (bank account details for the user).

piaURL

Success

PIA URL.

URL to view direct deposit details.

Method: GET

Path: /bankingdetails/{txnType}/{depositType}/{actionType}/{searchText}

This end point retrieves direct deposit details based on the deposit type and action type provided.

Request Parameters	Description
actionType	Banking action type.
depositType	Banking deposit type.
searchText	Search text.
txnType	Banking Transaction type.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (bank account header details).
accntDetails	Success	Account details (bank account details for the user).
piaURL	Success	PIA URL. URL to view direct deposit details.

Response Parameters

Response Result Type

Description

headerValue

Success

Header value (bank account header details).

accntDetails

Success

Account details (bank account details for the user).

piaURL

Success

PIA URL.

URL to view direct deposit details.

API resource to retrieve active garnishment details for an employee.

Method: GET

Path: /garnishmentdetails

Request Parameters	Description
None available.	N/A

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (garnishment name).
accntDetails	Success	Account details for the garnishment.

API resource to retrieve employee payment frequency details.

Method: GET

Path: /employeepayfrequency/{payFrequency}/{frequencySchedule}

Request Parameters	Description
frequencySchedule.	Pay frequency schedule.
payFrequency	Pay frequency check.

Response Parameters	Response Result Type	Description
titleValue	Success	Title value (employee pay frequency).

API resource to retrieve employee earnings for a given paycheck.

Method: GET

Path: /paycheckearnings/{paycheckNum}/{endDate}

Request Parameters	Description
endDate	Pay period end date.
paycheckNum.	Paycheck number.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (paycheck generation details).
sectnDetails	Success	Section details (paycheck earnings details).

API resource to retrieve employee tax details for a given paycheck.

Method: GET

Path: /paychecktaxes/{paycheckNum}/{endDate}

Request Parameters	Description
endDate	Pay period end date.
paycheckNum	Paycheck number.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (paycheck generation details).
sectnDetails	Success	Section details (paycheck tax details).

API resource to retrieve employee after tax deductions for a given paycheck.

Method: GET

Path: /paycheckaftertaxdeductions/{paycheckNum}/{endDate}

Request Parameters	Description
endDate	Pay period end date.
paycheckNum	Paycheck number.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (paycheck generation details).
sectnDetails	Success	Section details (paycheck after tax deduction details).

API resource to retrieve employee before tax deductions for a given paycheck.

Method: GET

Path:/paycheckbeforetaxdeductions/{paycheckNum}/{endDate}

Request Parameters	Description
endDate	Pay period end date.
paycheckNum	Paycheck number.

Response Parameters	Response Result Type	Description
headerValue	Success	Header value (paycheck generation details).
sectnDetails	Success	Section details (paycheck before tax deduction details).

Understanding REST API Endpoints for PeopleSoft Payroll for North America Services (payrollbankingyearendforms)

API Resources Used With the PeopleSoft Payroll for North America Services API

paycheckheaderdetails

Method: GET

Method: GET

Method: GET

Method: GET

paycheckemployerpaidbenefits

Method: GET

paycheckgarnishment

Method: GET

yearendforms

Method: GET

Method: GET

Method: GET

Method: GET

Method: GET

bankingdetails

Method: GET

Method: GET

Method: GET

garnishmentdetails

Method: GET

employeepayfrequency

Method: GET

paycheckearnings

Method: GET

paychecktaxes

Method: GET

paycheckaftertaxdeductions

Method: GET

paycheckbeforetaxdeductions

Method: GET