• Register

Request Extraction Remittance

This section documents the APIs used to manage the Remittance process across Spirit, GenAI, Matchwin, and ServiceNow. The table below provides a brief description of each RemittanceManagement API.

API Description
Remittance Extraction Request This API submits a remittance case to GenAI and requests the extraction of the relevant remittance data.
Retrieve Document This API retrieves a document attachment associated with a remittance case.
Post Remittance Data to Spirit This API sends the remittance data extracted by GenAI to Spirit.
Post Remittance Data to Matchwin This API sends the remittance data processed by GenAI to Matchwin.
Post Remittance RPA Data to Matchwin This API sends remittance data generated by the RPA process to Matchwin.
Retrieve Remittance Report Data from ServiceNow This API retrieves remittance report data from ServiceNow.

If these APIs meet your requirements, please register your application as described here and subscribe it to the pln_remittanceManagement_qas plan under the pkg_remittanceManagement package, as shown below.

 

 

Response

All APIs return a standard response structure.

Field Type Description
status string Outcome of the request. Possible values are Success and Error.
message string Confirmation message in case of success, or error details in case of failure.

Success response example

{
  "status": "Success",
  "message": "Request processed successfully."
}

Error response example

{
  "status": "Error",
  "message": "The requested resource was not found."
}

Docs Navigation