Response key and document retrieval in ELR

This section describes how your integration should retrieve, store, and use document status information and document outputs.

To implement this functionality, use the following endpoints:

Outbound documents (flow = out)

For documents with status Complete, your integration must:

Store all events[].responseKey and responseValue values (from GetDocumentStatus).
Download all available media types, except UBL (unless required).
Save the downloaded files at the document level in the ERP or business system.

For documents with status Error, your integration must:

For documents with status Complete, your integration must:

Download all available media types.
Save the downloaded files at the document level in the ERP or business system.
Use the UBL media type to create an AP document in the ERP or business application (in draft status).

Note

Inbound documents may not be available for some mandates.

Your integration must allow users to:

You can also support webhook integration to receive real-time updates and reduce the need for polling.

Display this information even when the document status is Complete to support troubleshooting, auditing, and downstream processing.

Your application must allow users to:

Don’t restrict users to a single file format. Always expose all formats returned by ELR.

Users must be able to:

For example, users may: