Skip to main content

Import definition

Explore the comprehensive definition of budget response

Budget responses can be send in XML or JSON depending on what you application supports. The message itself is simple and only has to elements: budgetAvailable and comment. The comment element is mandatory whenever the budgetAvailable element has a false value.

Budget is available​

When budget is available for the requisition a positive budget message needs to be returned to the Proactis API. The endpoint URL will include the Proactis requisition number, for example /requisitions/v1/{domainId}/budgetcheck/{requisitionNumber}

The contents of the message requires just one value to specify budget is available for the entire requisition.

<?xml version="1.0" encoding="UTF-8"?>
<BudgetRequest>
   <budgetAvailable>true</budgetAvailable>
</BudgetRequest>

Budget is not available​

When budget is not available for (part of) the requisition a negative budget message needs to be returned to the Proactis API. The endpoint URL will include the Proactis requisition number, for example /requisitions/v1/{domainId}/budgetcheck/{requisitionNumber}

Apart from the budgetAvailable element this message requires the comment element.

<?xml version="1.0" encoding="UTF-8"?>
<BudgetRequest>
   <budgetAvailable>false</budgetAvailable>
   <comment>No budget available for cost center 100040</comment>
</BudgetRequest>

Upon processing the budget message, the status of the requisition will change to Budget not approved.

And the comment will be added to the Approval & Comment details screen.

Contents