Description
Match a bank line to an order.
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
BanklineKey |
integer |
0 |
123 |
Match order to this bank line ID |
| 2 |
OrderNr |
integer |
0 |
123 |
Order which will be matched. Use either OrderNr or OrderNrExternal parameter |
| 3 |
OrderNrExternal |
string |
0 |
abcdefg |
Order which will be matched. Use either OrderNr or OrderNrExternal parameter |
| 4 |
MaxMatchDelta |
number |
0 |
9.99 |
Maximum allowed delta between order total and bank line amount |
| 5 |
AutoReleaseOrder |
boolean |
0 |
0 or 1 |
Automatically release order from HOLD after the bank match is created |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiCreateBanklineMatch>
<dem:BanklineKey>123</dem:BanklineKey>
<dem:OrderNr>123</dem:OrderNr>
<dem:OrderNrExternal>abcdefg</dem:OrderNrExternal>
<dem:MaxMatchDelta>9.99</dem:MaxMatchDelta>
<dem:AutoReleaseOrder>0 or 1</dem:AutoReleaseOrder>
</dem:pixiCreateBanklineMatch>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: Bank match status
| # |
Name |
Type |
Description |
| 1 |
Status |
string |
Bank match status |
| 2 |
Message |
string |
Bank match error message |
| 3 |
BankLineKey |
integer |
Bank line ID |
| 4 |
BankAmount |
number |
Bank line amount |
| 5 |
UsedAmount |
number |
Bank line used amount |
Additional Notes
Using **MaxMatchDelta** parameter:
- When the value for **MaxMatchDelta** parameter is defined, the API call checks if the difference between bank line amount and order total is **smaller or equal** the value provided for parameter MaxMatchDelta.
- Only when this is true, a new bank line match will be added.
Using **AutoReleaseOrder** parameter:
- When **AutoReleaseOrder** parameter is set to **1** the API call will **release** the order **from status hold** automatically after a successful bank line match will be added and the amount paid by the customer equals the amount of the order total.
- If the difference of the order total and amount paid by the customer is not 0 or smaller than defined with parameter MaxMatchDelta. The bank match will not be created and order will not be released.