Understanding REST API Endpoints for PeopleSoft

PeopleSoft delivers Representational State Transfer (REST) Application Programming Interfaces (APIs) to support your integration of PeopleSoft Skills with new or existing applications or business flows.

An API is a set of definitions and protocols that define how applications or devices can connect to and communicate with each other. It enables an application or service to access a resource within another application or service.

A REST API is an API that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services.

REST APIs use a:

  • GET request to retrieve a record.

  • POST request to create one.

  • PUT request to update a record.

  • DELETE request to delete one.

This topic provides an overview of PeopleSoft delivered APIs and discuses these concepts:

Note: There are security implications when you use PeopleSoft resources from outside the system. To know more about the security implications, refer to the "Setting Applications Services Security" topic in the PeopleTools Integration Broker documentation. Also, refer to the "Understanding OAuth2.0" topic in the PeopleTools Security Administration documentation.

This table lists the delivered REST API common to PeopleSoft applications:

REST API

Functional Area

Link to Product Documentation

Chatbot Integration Framework Utility Services (utilities)

Chatbot Integration Framework

Understanding REST API Endpoints for PeopleSoft Chatbot Integration Framework Utility Services (utilities)

This table lists the delivered REST APIs for PeopleSoft HCM:

REST API

Functional Area

Link to Product Documentation

Absence Management Application Services (absence)

Absence Management

Understanding REST API Endpoints for PeopleSoft Absence Management Application Services (absence)

Employee Directory (employeedirectory)

Employee Directory

Understanding REST API Endpoints for PeopleSoft Employee Directory (employeedirectory)

Payroll for North America Services (payrollbankingyearendforms)

Payroll for North America

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

Generate Careers URL (hrsutilities)

Recruiting

Understanding REST API Endpoints for PeopleSoft Generate Careers URL (hrsutilities)

Applicant Activity (hrsapplicantcgactivity)

Recruiting

Understanding REST API Endpoints for PeopleSoft Applicant Activity (hrsapplicantcgactivity)

Job Search Services (hrsjobs)

Recruiting

Understanding REST API Endpoints for PeopleSoft Job Search Services (hrsjobs)

HR Common Utility Services (hcmcommonutilities)

Not applicable.

Understanding REST API Endpoints for PeopleSoft HR Common Utility Services (hcmcommonutilities)

PeopleSoft FSCM delivers the following REST APIs:

REST API

Functional Area

Link to Product Documentation

Get Requisition for Item (eprogetrequisitionforitem)

eProcurement

Understanding REST API Endpoints for PeopleSoft Get Requisition for Item (eprogetrequisitionforitem)

Get Requester List (eprogetrequesterlist)

eProcurement

Understanding REST API Endpoints for PeopleSoft Get Requester List (eprogetrequesterlist)

Get Requester Name (eprogetrequestername)

eProcurement

Understanding REST API Endpoints for PeopleSoft Get Requester Name (eprogetrequestername)

Get Requisition Status (eprogetrequisitionstatus and eprogetrequisitionstatusexternal)

eProcurement

Understanding REST API Endpoints for PeopleSoft Get Requisition Status

Fetch Disputed Invoices (esfetchdispinvoice)

eSettlements

Understanding REST API Endpoints for PeopleSoft Fetch Disputed Invoices (esfetchdispinvoice)

Fetch Invoice Inquiry (esfetchinvoiceinquiry)

eSettlements

Understanding REST API Endpoints for PeopleSoft Fetch Invoice Inquiry (esfetchinvoiceinquiry)

Payment Inquiry (esfetchpaymentinquiry)

eSettlements

Understanding REST API Endpoints for PeopleSoft Payment Inquiry (esfetchpaymentinquiry)

Get First Name (esgetname)

eSettlements

Understanding REST API Endpoints for PeopleSoft Get First Name (esgetname)

Invoice and Payment Inquiry (esinvpyminqlink)

eSettlements

Understanding REST API Endpoints for PeopleSoft Invoice and Payment Inquiry (esinvpyminqlink)

Fetch Invoice Status (esinvoicestatus)

eSettlements

Understanding REST API Endpoints for PeopleSoft Fetch Invoice Status (esinvoicestatus)

Payment Difference (espymntdiff)

eSettlements

Understanding REST API Endpoints for PeopleSoft Payment Difference (espymntdiff)

Fetch Payment Status (espaymentstatus)

eSettlements

Understanding REST API Endpoints for PeopleSoft Fetch Payment Status (espaymentstatus)

Fetch Denied Line (exdenydetails)

Expenses

Understanding REST API Endpoints for PeopleSoft Fetch Denied Line

Expense Type Location Validation (exexptypelocedit)

Expenses

Understanding REST API Endpoints for PeopleSoft Expense Type Location Validation (exexptypelocedit)

Fetch by Creation Date (exfetchbycreationdate)

Expenses

Understanding REST API Endpoints for PeopleSoft Fetch by Creation Date

Fetch By Sheet Name (exfetchbysheetname)

Expenses

Understanding REST API Endpoints for PeopleSoft Fetch By Sheet Name

Fetch by Status (exfetchbystatus)

Expenses

Understanding REST API Endpoints for PeopleSoft Fetch by Status

Fetch Last Five Transactions (exfetchlast5)

Expenses

Understanding REST API Endpoints for PeopleSoft Fetch Last Five Transactions

Date Validation (exfromtodatevalidation)

Expenses

Understanding REST API Endpoints for PeopleSoft Date Validation (exfromtodatevalidation)

Get Requester Name (exgetname)

Expenses

Understanding REST API Endpoints for PeopleSoft Get Requester Name (exgetname)

Get Transaction Details (exgettransdetails)

Expenses

Understanding REST API Endpoints for PeopleSoft Get Transaction Details

Create Wallet Entry (exinsertmywallet)

Expenses

Understanding REST API Endpoints for PeopleSoft Create Wallet Entry (exinsertmywallet)

Send Notification (exsendnotification)

Expenses

Understanding REST API Endpoints for PeopleSoft Send Notification (exsendnotification)

Date Format Validation (exvalidatedateformat)

Expenses

Understanding REST API Endpoints for PeopleSoft Date Format Validation (exvalidatedateformat)

Wallet Location Validation (exwalletvalidateloc)

Expenses

Understanding REST API Endpoints for PeopleSoft Wallet Location Validation (exwalletvalidateloc)

Supplier Comprehensive Portal Service (scp)

Supplier Secure Collaboration

Supplier Secure General

Supplier Secure Invoice and Payment

Supplier Public

Sourcing

Understanding REST API Endpoints for PeopleSoft Supplier Comprehensive Portal Service (scp)