CancelPurchaseOrder
- James Overell
Marks a specified order as cancelled. Will error if the order has been filled or paid.
This web service calls underlying SQL stored procedure – SynergyOneFinance.dbo.spxuPurchaseOrderCancel.
InputObject (XML)
Element |
SQL Data Type |
Mandatory |
Description |
VendorTokenGUID |
GUID |
Yes |
Specific GUID that Synergetic will give the third party app to validate them upon every web service request. |
VersionNumber |
Decimal(4,2) |
Yes |
To cater for extending the web service and return the version specific format. Default 2.5. |
ConfigFileName |
Varchar(max) |
No |
Optional - if missing or blank then the authentication details into DB are found in WebServiceSynergetic.XML in the website folder. |
OrderNumber |
Integer |
Yes |
Purchase order number to mark as cancelled. |
Sample Input
<InputXML>
<VendorTokenGUID>3FC2ABA9-8F37-4CC9-934C-6ABCCA9F44B7</VendorTokenGUID>
<VersionNumber>2.5</VersionNumber>
<ConfigFileName></ConfigFileName>
<OrderNumber>10345</OrderNumber>
</InputXML>
OutputObject (XML)
Element |
SQL Data Type |
Description |
ReturnValue |
Integer |
0 = Success, Non Zero indicates an error. |
Message |
Varchar(max) |
Will only contain an error message if there is a problem creating the order. For example if the Creditor ID is unknown to Synergetic. Default to blank. |
<PurchaseOrder OrderNumber="7" Message="Order cancelled successfully." />