•Use Cases / Data Management Configuration
•Use Case 1: Refunding to Fixed Payment Methods
•Use Case 2 - Refund to Original Payment Methods
•Use Case 3: Refunding to Gifts
•Use Case 4: Refunding to Miscellaneous Items
•Use Case 5: Refunding to Stored Value Items
•Use Case 6: Splitting the Refund Between Fixed Payment Methods & Sellable Items
•Use Case 7: Splitting Refund the refund Between Original Payment Methods & Sellable Items
Summary
Script Name |
Remove Admissions and Refund Payments |
Minimum Supported Version |
7.39.0 |
Source Type |
Single Source |
Script Definitions |
Remove Admissions and Refund Payments |
Overview
The Remove Admissions and Refund Payments allows you to remove admissions (and their associated charges) from a set of orders and deal with the resulting balances.
Configuration Prerequisites
The script runs using the default role for the sched user. This role should have access to any events, payment methods, gifts, miscellaneous items or stored value items being used by the script.
If fields referenced in the script do not have 'Writable' set to Yes, the script will still run successfully but those fields will not be updated. For more information, refer to Configuring Marketing Data Fields.
The script accepts a BI or CSV source file containing the order numbers to be updated. If using a BI, set the ‘Extract Template’ to Business Intelligence CSV Report Extract.
We recommend testing the script on a small number of orders before processing a large batch.
Source File Format
The script accepts a BI or CSV source file containing the order numbers (the column header should be Order Number) to be updated. If using a BI, set the ‘Extract Template’ to Business Intelligence CSV Report Extract.
We recommend testing the script on a small number of orders before processing a large batch.
Use Cases / Data Management Configuration
Balances can be handled by:
•Use Case 1: Refunding the full balance to a fixed payment method (account credit, gift card), regardless of the original payment method.
•Use Case 2: Refunding the full balance to the original payment method.
•Use Case 3: Adding a gift for the full amount.
•Use Case 4: Adding a miscellaneous item for the full amount.
•Use Case 5: Adding a stored value item for the full amount.
•Use Case 6: Splitting the refund between a fixed payment method (Use Case 1) and a gift (Use Case 3), miscellaneous item (Use Case 4) or stored value item (Use Case 5).
•Use Case 7: Splitting the refund between a the original payment method (Use Case 2) and a gift (Use Case 3), miscellaneous item (Use Case 4) or stored value item (Use Case 5).
Use Case 1: Refunding to Fixed Payment Methods
If you want to refund the full balances to fixed payment methods, regardless of the original payment methods:
•Events: Select the event(s) that will be removed from the orders.
•Payment Method: Select the payment method you want to use for the refunds.
•Cancel Reason: Enter a reason why the admissions are being cancelled/removed from the order.
•Leave the remaining fields blank.
Selecting a payment method which requires an account number, like Visa or Paypal, will cause the script to fail. We recommend using Account as the ‘Refund Payment Method’.
Use Case 2 - Refund to Original Payment Methods
If you want to refund the full balances to the original payment methods:
•Events: Select the event(s) that will be removed from the orders.
•Payment Method: Leave this blank.
•Cancel Reason: Enter a reason why the admissions are being cancelled/removed from the order.
•Leave the remaining fields blank.
Use Case 3: Refunding to Gifts
If you want to add the full balances to gifts:
•Events: Select the event(s) that will be removed from the orders.
•Payment Method: Leave this blank.
•Cancel Reason: Enter a reason why the admissions are being cancelled/removed from the order.
•Select a gift.
•Hold Back Rate: Enter to 100%.
•Leave the remaining fields blank.
|
Use a gift with only one valid appeal and one valid fund. |
Use Case 4: Refunding to Miscellaneous Items
If you want to add the full balances to miscellaneous items:
•Events: Select the event(s) that will be removed from the orders.
•Payment Method: Leave this blank.
•Cancel Reason: Enter a reason why the admissions are being cancelled/removed from the order.
•Miscellaneous Item: Select the miscellaneous item that you want to use for the refund.
•Hold Back Rate: Enter to 100%.
•Leave the remaining fields blank.
Use Case 5: Refunding to Stored Value Items
If you want to add the full balances to stored value items:
•Events: Select the event(s) that will be removed from the orders.
•Payment Method: Leave this blank.
•Cancel Reason: Enter a reason why the admissions are being cancelled/removed from the order.
•Stored Value Item: Select a stored value item that you want to use for the refund.
•Hold Back Rate: Enter to 100%.
•Leave the remaining fields blank.
|
You cannot use a Fixed 'Type' of stored value item. |
Use Case 6: Splitting the Refund Between Fixed Payment Methods & Sellable Items
If you want to combine a partial refund to a fixed payment method with adding an item:
•Events: Select the event(s) that will be removed from the orders.
•Payment Method: Select the payment method that you want to use to refund the payments.
•Cancel Reason: Enter a reason why the admissions are being cancelled/removed from the order.
•Gift / Miscellaneous Item / Stored Value Item: Select the 'Gift', 'Miscellaneous Item' or 'Stored Value Item' that you want to use for the refund.
Only select one type of sellable item.
•Hold Back Rate: Set the flat rate or percentage that will be refunded to the 'Gift', 'Miscellaneous Item' or 'Stored Value Item'.
To set a percentage, add the % symbol.
Any remaining balance will be refunded to the selected payment method.
If a flat rate exceeds the value on an order, the full amount will be applied to the selected 'Gift', 'Miscellaneous Item' or 'Stored Value Item'.
|
You cannot use a Fixed 'Type' of stored value item.
Use a gift with only one valid appeal and one valid fund. |
The selected ‘Refund Payment Method’ will need to be enabled for the gift, miscellaneous item or stored value item that is being added to the order.
Use Case 7: Splitting Refund the refund Between Original Payment Methods & Sellable Items
If you want to combine a partial refund to the original payment method with adding an item:
•Events: Select the event(s) that will be removed from the orders.
•Payment Method: Leave this blank.
•Cancel Reason: Enter a reason why the admissions are being cancelled/removed from the order.
•Gift / Miscellaneous Item / Stored Value Item: Select the 'Gift', 'Miscellaneous Item' or 'Stored Value Item' that you want to use for the refund.
Only select one type of sellable item.
•Hold Back Rate: Set the flat rate or percentage that will be refunded to the 'Gift', 'Miscellaneous Item' or 'Stored Value Item'.
To set a percentage, add the % symbol.
Any remaining balance will be refunded to the selected payment method.
If a flat rate exceeds the value on an order, the full amount will be applied to the selected 'Gift', 'Miscellaneous Item' or 'Stored Value Item'.
|
You cannot use a Fixed 'Type' of stored value item.
Use a gift with only one valid appeal and one valid fund. |
Notes & Limitations
•If refunding to the original payment methods:
•Orders that have multiple credit card payments will fail to update because multiple gateway-dependent payments cannot be processed in a single update.
The order will need to be updated manually.
•Overpaid orders will be fully refunded to the original payment method (not just the portion for the selected event(s)
•The script will successfully add a miscellaneous item even if it is off-sale to the role.
This is a bug and will be fixed in a future iteration.
•The 'Hold Back Field'
•There is no input validation.
Only numeric values and the % symbol should be used for the ‘Hold Back Rate’ field.
•Is not localized.
You will need to use a period as a decimal separator even if your locale uses a comma.
