Understanding REST API Endpoints for PeopleSoft Payment Inquiry (esfetchpaymentinquiry)
This topic lists the REST resources and methods for the Payment Inquiry API (esfetchpaymentinquiry). Use this API to retrieve invoice details based on payment inquiry.The Payment Inquiry REST API can be used for the eSettlements skill.
This table lists the delivered API resource used with the Payment Inquiry API.
|
API Resource |
Description |
|---|---|
|
API resource to retrieve invoice details based on payment inquiry. |
API resource to retrieve invoice details based on payment inquiry.
Method: POST
Path: /esfetchpaymentinquiry
|
Request Parameters |
Description |
|---|---|
|
iEndDate |
End Date |
|
iPaymentDate |
Payment Date |
|
iStartDate |
Start Date |
|
Response Parameters |
Response Result Type |
Description |
|---|---|---|
|
oGrossAmount |
Success |
Invoice gross amount. |
|
oInvDate |
Success |
Invoice date. |
|
oInvPymntType |
Success |
Invoice payment type. |
|
oInvoiceID |
Success |
Invoice ID. |
|
oOutRowNumber |
Success |
Row number for the retrieved invoice. For example, if the API retrieves 10 invoices, the value for the first row is '1 of 10.' |
|
oPymntStatus |
Success |
Invoice payment status. |
|
oTxnCurrencyCD |
Success |
Taxation currency code. |