Skip to main content

Overview

How to use the receipt API to import and export receipts

Use the receipt API to control the flow of receipts from and to Proactis. Depending on your requirements we have several options available.

cXML​

Proactis receipt API uses the cXML message standard. We suggest you refer to the cXML User's Guide at cxml.org to learn more. Sample messages including annotation can be found on the sample messages page.

The definition of the exported cXML receipt can be found on the cXML export definition page.

Automatically push receipts to your application​

The option to push documents to a specified endpoint can be configured in the communication settings. Configuration needs to be done once for each environment (UAT and PROD).

Receipts will be send using a POST request. In case the receipt contains attachments these will be send in the same request as a multipart request. The receiving application will need to be able to receive this multipart requests and be able to extract the receipt and/or attachments.

Upon receiving the receipt Proactis API requires a response. This response can be either successful or unsuccessful and the contents will be visible in the widgets. The response needs to be a valid cXML message. When no or no valid response is received, the widgets will show an error.

More information on how to configure the communication settings can be read here.

Periodically retrieve receipts from Proactis​

Another option to get receipts is to have your application retrieve the receipts. To retrieve receipts Proactis API offers two endpoints, one for fetching a list of results based on filters or pagination and another for retrieving individual receipts.

Receipts which are retrieved from the Proactis API will not contain attachments.

More information on the process can be read here. Or check information on filtering or pagination.

Import receipts into Proactis​

Receipts created in a different application and required for other processes in Proactis (for example invoice matching) can be imported using the Proactis API. Individual receipts can be send to Proactis using a POST request containing a cXML version of the receipt. Each receipt requires at least one product line item. The API will respond with a cXML response, further processing and its status will be visible in the widgets.

More information on the process can be read here.

Contents