Understanding REST API Endpoints for PeopleSoft Fetch Invoice Inquiry (esfetchinvoiceinquiry)
This topic lists the REST resources and methods for the Fetch Invoice Inquiry API (esfetchinvoiceinquiry). Use this API to retrieve invoice details.The Fetch Invoice Inquiry REST API can be used for the eSettlements skill.
This table lists the delivered API resource used with the Fetch Invoice Inquiry API.
|
API Resource |
Description |
|---|---|
|
API resource to retrieve invoice details. |
API resource to retrieve invoice details.
Method: POST
Path: /esfetchinvoiceinquiry
|
Request Parameters |
Description |
|---|---|
|
iCurrency |
Invoice currency. |
|
iEndDate |
End date. |
|
iInvStatus |
Invoice status. |
|
iInvoiceAmount |
Invoice amount. |
|
iInvoiceDate |
Invoice 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. |