Overview
How to use the requisition API for exporting requisitions
Use the requisition API to receive requisitions from Proactis and process budget approval.
cXML
Proactis requisition API uses the cXML message standard for the requisition message. 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.
Automatically push requisitions 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).
Apart from the communication settings the requisition export requires additional configuration to be done by a Proactis consultant. Contact your Proactis consultant before enabling the communication settings.
Requisitions will be send using a POST request with just the cXML requisition, no attachments will be added. Upon receiving the requisition 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.
Execute a budget check
The requisition message serves as the basis of the external budget check. The Proactis API will send your application a requisition message with all the details on header and line level. Your application will return a positive cXML response upon receiving the requisition message. The requisition screen in Proactis will show the Requisition Status Sent for budget check.
At a later stage, when your application has determined whether budget is available for this requisition, your application needs to call the budget check endpoint. Whenever budget is sufficient the requisition process will be restarted. The would ultimately result in the order being created and sent to the supplier and/or to your application.
If budget is not available for (part of) the requisition, the entire requisition will be closed and a comment will be added.
As this integration requires the requisition export, using the budget check requires additional configuration to be done by a Proactis consultant. Contact your Proactis consultant before enabling the communication settings.