PAR POS™ v5.17 Release Notes
About This Release
PAR POS 5.0.17281 is a point release covering enhancements. This document summarizes what's new.
Register/POS Features
Optimized Digital-Order Refunds Through Aurus: Same-Day Card Credit and Prior-Day Tip
For app orders paid by card through Aurus, the refund process has been optimized. A Same-Day Refund Order credits the original card for the order total plus tip, and a Prior-Day Historical Refund refunds the order total plus tip. The confirm screen shows both the order total and the tip.
Setup: Set up a Historical Refund button and enable Available for Refund for the external Aurus tender.
More Information: Aurus Refunds
(BRNK-72610, PDOC-4433)
Concurrent Split Seat Access Across Multiple POS Terminals
This feature improves how seat locking works after an order has already been split by seat and allows several registers to work on the same table at once. If a large party has split their checks by seat, one cashier can close out seat 46.1 while another closes out seat 46.2. Before, opening one seat locked the whole table, so everyone had to wait at a single register.
Now, only the seat being worked on is locked. If you try to open a seat that's already in use, you'll see a message telling you which register has it. Splitting checks and taking payment work the same way they always have.
Setup: None. This feature is enabled automatically with the 5.17 upgrade.
(BRNK-67345, PDOC-4433)
Promotions: Auto-Add Qualifying Items to Order Now Supports Substitutions
Guests can now swap an item in an Auto-Add promotion for another eligible item, the same way they can swap items in a Combo. When a promotion has substitutions turned on, the cashier uses the new Automatically Add Qualifying Items to the Order function. It shows the items the guest can swap in, along with any extra charge, before anything is applied.
- If the new item costs more than the original, the guest pays only the difference.
- If it costs the same or less, the price stays the same. There is no credit or refund for choosing a cheaper item.
- The promotion's discount does not change.
Setup: Enable Automatically Add Qualifying Items to the Order (Only Quantity Qualifiers) on an Order Reduction promotion and configure its Substitution Groups.
More Information: How To Set Up Promotions with Enhanced 'Automatically Add Qualifying Items to Order' Setting
(BRNK-55697, PDOC-4433)
Discount Group Button Behavior for POS Layouts
A new Discount Group button behavior on POS layouts filters the discount selection window to a configured subset of active discounts. Previously, Discounts: Prompt User showed every active discount. Now, only active discounts in the group are shown. A discount does not have to be in a group, and can be in several.
Setup: Define a Discount Group, add a Discount Group button to the POS layout, then Save and Publish.
More Information: Discount Groups
(BRNK-70531, PDOC-4433)
Advanced Refunds 2.1
We have enhanced the Advanced Refunds feature to include an Open Refund option. A linked refund is created without picking an original item. The refund check is editable, so you can add or remove items, including Open Dollar items. Refunds still go only to tenders used on the original order, and the total of linked refunds can’t exceed the original. Example: a guest was overcharged $1.00, so you refund only $1.00.
Additional Updates to Advanced Refund:
- A full-order refund no longer shows the Tender screen. It refunds automatically to the original tenders, including split payments and orders paid with a gift card through a payment device.
- When the refund involves cash, the confirmation message lists the amount by tender.
- The Recall Order by the Name column now sorts, so #2 comes before #10.
- The Recall Order Item list always allows selecting multiple items, regardless of the Allow Multi Selection screen setting.
- Refund Item only offers quantities not already refunded. For combos, it counts whole combos refunded from their components.
- Any Enhanced Refund (Item, Order, or Open) is blocked on a still-open order, with a message.
Setup: Refund Mode will need to be changed to Open Refund
More Information: Open Refund
(BRNK-70661, PDOC-4433)
Promotions: Order Reduction Discounts Now Update as Items Change
A new Auto-Apply Once Added option lets an Order Reduction promotion keep its discount up to date after the cashier adds it to an order. Previously, items added afterward were not discounted unless the promotion was deleted and applied again. Removing any item also removed the whole promotion, even when the remaining items still qualified.
With the option on, the promotion is still added by the cashier. After that, the discount is recalculated as items are added or removed:
- Adding qualifying items increases the discount, up to the promotion's limits.
- Adding non-qualifying items does not change the discount.
- If the order no longer qualifies, the promotion stays on the order at $0.00. It applies again automatically when qualifying items are added back.
Setup: Enable Auto-Apply Once Added on an Order Reduction promotion. This option cannot be enabled at the same time as Automatically Apply. It is off by default, so existing promotions are not affected.
More Information: Auto-Apply Once Added
(BRNK-74837, PDOC-4433)
PAR Pay
Automated Configuration on Register Launch
When a location uses a PAR Pay Ingenico or Verifone device with the Aurus "EXE Solution", store staff or technicians had to hand-edit AurusEnterpriseSDK.exe.config. The right values depend on the device type and the connection type, TCP/IP or Serial/USB. Manual edits are error-prone and can break payments. We optimized this process so the register now writes the required settings from the saved device configuration.
What you'll notice
Fewer misconfigured card readers and fewer technician steps. Switching or setting up a pinpad is now simpler.
Setup: None. This feature is enabled automatically with the 5.17 upgrade.
(MH1-2258, PDOC-4433)
Can Save Time by Adding Donations Directly on the PAR Pay Device
This new feature enables guests to choose a donation amount on the payment terminal itself, instead of the cashier adding it manually. Businesses already run donation programs, such as $1, $2 or $3 options or rounding up the total. At the moment the cashier has to key the donation into the order before payment. That is slow and error-prone. With this feature, the donation entered on the device is added to the transaction in the POS automatically.
Setup: There are three ways to setup donations on the POS:
- Menu item. The donation is set up as a Non-Revenue menu item and linked to a Revenue Centre that has no tax. When applied, it is added to the balance due.
- Round-up charity. This uses the same Non-Revenue menu item, plus a Round Up Charity configured under Charities in SE. It is linked to a no-tax Revenue Centre. The round-up amount is added to the balance due.
- Charity. This is configured only as a Charity under Charities in Settings Editor.
For more information on how to use this feature click here:
(MH1-1524, PDOC-4433)
In-Store API
These changes let a handheld device, such as PAR Handheld, find an open order on the register and then change or pay for it. Before, handheld devices could only look up Quick Service orders (Line Busting and Drive-Thru). This release adds support for Table Service (Pay at Table).
Get Order API Enhanced for Table Pay
The in-store Get Order API (GET /register/v1/Order/getOrders) now supports the order lookups that handheld payment devices need. An open order can be found by table number, by the last 4 or more digits of the order ID, by order number, or by employee to return all of that employee's open orders. Closed orders are never returned.
The response contains the full order, including items, modifiers, sizes, quantities, discounts, applied loyalty, sent-to-kitchen status, partial payments, and totals calculated by the register. If a search doesn't match an open order, or a table number doesn't exist or has no open order, a validation error is returned. Existing Get Order API integrations are not affected.
Setup: None. This feature is enabled automatically with the 5.17 upgrade. Calls to the In-Store API require a valid In-Store API bearer token.
More Information: PAR POS In-Store APIs
(MH1-2270, PDOC-4433)
New Update Order API
A new in-store API lets a device change an existing open order. Changes are applied to the order on the register in real time. The supported operations are:
- Add an item (with modifiers, default quantity of 1)
- Update or modify an item
- Void an item
- Change an item's quantity
- Change an item's size
- Apply a discount (percentage, fixed, or open, at item level or order level)
- Apply loyalty (Generic and Punchh loyalty)
- Apply a payment, with or without a tip
The existing POS order and item validation rules apply to every operation. Items that have already been sent to the kitchen can't be voided or have their quantity reduced, and loyalty can be applied only if no loyalty is already applied to the order. After each successful change, the register recalculates the order totals and the API returns the full updated order.
Note: Combo items are not supported by the Update Order API in this release.
Setup: None. This feature is enabled automatically with the 5.17 upgrade. Calls to the In-Store API require a valid In-Store API bearer token. To apply loyalty or payments, the loyalty program and payment tenders must already be set up on the POS.
More Information: PAR POS In-Store APIs
(MH1-2250, PDOC-4433)
Punchh Integration Enhancements
Drive Thru Loyalty
A drive-thru guest can read a short code aloud and the cashier types it in. The guest is identified and receives their loyalty rewards without a card or app scan. This means faster service at the window, and loyalty-card lookups continue to work.
Setup: No additional setup required on the register side. Setup is required on the Punch side (see More Information, below)
More Information:
Generate Loyalty Short Code for Drive Thru
(PD-6142, PDOC-4433)
Offer Pass
Guests can redeem wallet-pass offers or rewards by showing a QR code, and cashiers scan it, with no app and no manual lookup. This speeds up checkout and increases redemption.
Setup: No additional setup required on the register side. There is setup required on the Punchh side (see More Information, below). This feature does require a Barcode scanner attached as a serial input device. HID is not supported at this time.
More Information:
Implement Apple Wallet Pass
Implement Google Wallet Pass
(PD-6405, PDOC-4433)
Configurable Punchh API URL for Reward Name Lookup
Some orders carry a temporary discount name for a Punchh loyalty reward. The system looks up the real reward name from Punchh and replaces the temporary one in your order data and reports.
Previously, this lookup always went to a single Punchh address. Customers on a different Punchh instance received a 401 error and kept the temporary name. The Punchh API address can now be set for each customer, so lookups reach the correct instance.
Setup: Reach out to your Customer Service Manager to get the process started.
(BNZ-1654, PDOC-4433)
Points Cost Shown on the Reward Selection Window
The reward selection window on the POS now shows how many points each Punchh reward deducts from the guest's loyalty points. For example: Free Small Shake (100 Points).
Setup: None. This feature is enabled automatically with the 5.17 upgrade.
More Information: Cost of Rewards Now Shows on Reward Selection Window
(PD-6452, PDOC-4433)
Deliverect Integration Enhancements
Disposition Payout Integration
The Deliverect integration now allows for same-day payout of driver mileage and credit card tips.
Setup: API, and a script button added to the menu is required for setup.
More Information: Deliverect Integration
(BNZ-1849, PDOC-4433)
Driver Pay Rate Attribution
Used when customers pay drivers a lower rate (Driver On Road, $6.50 for example) while they’re on the road. POS can’t switch jobs mid-shift, so on-road time is paid at the clocked-in rate. This epic reports on-road minutes to PAR so it can apply the right rate.
Setup: A Driver On Road job is required. Its name must contain On Road, and it must be assigned to each employee who takes delivery runs.
More Information: Deliverect Integration
(BNZ-1896, PDOC-4433)
Reporting (Admin Portal)
New Report Available on the Admin Portal: SAF Order Detail
A new report, SAF Order Detail, has been added under Reports → Accounting, with an API. It shows Store and Forward (SAF) card payments taken while a Verifone pinpad was offline. It helps finance and support reconcile offline payments and spot terminals in SAF mode. Data is kept for 3 months.
Setup: None. This feature is enabled automatically with the 5.17 upgrade.
(NUC-2513, PDOC-4433)
Separate Shifts by Business Date for 24 Hour Operation
A new feature has been added, Separate Shifts by Business Date. It allows shifts that cross End of Day to be split by Business Date for labor reporting, without interrupting the employee.
Setup: Enable Separate Shifts by Business Date under 24 Hour Operation in Options → System → General.
More Information: Separate Shifts by Business Date
(NUC-2421, PDOC-4433)
New Fields Added to Refund Detail Report
Refund Detail Report now has two new columns, Reason and Approver, plus localized headers and the integrator API. Refunds processed before the upgrade do not show these values.
Setup: None. This feature is enabled automatically with the 5.17 upgrade.
(NUC-2238, PDOC-4433)
Include Non-Revenue Items in Admin Portal Item Reports and Export Sales
Non-revenue items (charity, fundraising, pass-through) now appear consistently in the item reports. Non-revenue amounts are not treated as revenue in financial totals.
Reports updated: Item Group Comparison by Employee, Item Sales By Employee, and Export → Sales → Item Sales.
Setup: Items must be set up as Non-Revenue Items. Nothing else is required. This feature is enabled automatically with the 5.17 upgrade.
More Information: Non-Revenue Item
(NUC-2119, PDOC-4433)
Reporting Price Mode
Reporting Price Mode is a new item-level reporting setting. It can be set to Standard Price or Catalog Price. It allows reports to value an item at its listed price from Items in Settings Editor, instead of the discounted price the guest actually paid. It is not a separate price list, and it never changes what happens at the register. The default setting is Standard Price.
Example: A Kids Toy is listed as $3.00, and a Free Toy Friday discount applies a 100% discount to the toy. The guest pays $0 for the toy and the receipt shows $0 for the toy. If the Kids Toy has Catalog Price set, it will show $3.00 in the Product Mix report to assist with royalty and/or franchise extract purposes. Checkout, tax, tender and receipts are unchanged.
Setup: Set Reporting Price Mode on the item in Items (Settings Editor).
More Information: Set Reporting Price Mode
(NUC-1995, BNZ-1747, PDOC-4433)
Changeset Publishing and Settings Editor
This section covers improvements to how changesets are published and how Settings Editor performs. None of these changes require setup. They are enabled automatically with the 5.17 upgrade.
Optimization of Changeset Publisher
What was happening
Changeset publishing needed to be more reliable during busy periods.
What changed
Publishing a changeset from Settings Editor or Changeset Publisher now runs on a new back-end system. The way you publish does not change.
What you'll notice
- When you publish, the request is accepted right away and processed in the background. You can follow its progress through its status, which now shows
Submittedas soon as the publish is queued. - If a location briefly can't take the update, the system tries again on its own, up to 3 times, for that location only. Other locations are not held up.
- A publish that can't be processed is flagged as failed, so it doesn't sit there unnoticed.
(BRNK-67135, PDOC-4433)
Optimize How Large Changesets are Handled at End of Day (EOD)
What was happening
Publishing changesets to a large number of locations at End of Day was using a lot of memory and would intermittently crash.
What changed
We made three improvements: large changesets are now cached more efficiently, a few unnecessary validation steps were removed, and the collision check procedure is faster.
What you'll notice
Large multi-location customers should see EOD and scheduled changes publish reliably, without the service host running out of memory. Publishing should also be faster.
(BRNK-67196, PDOC-4433)
Searching with Large Location Sets or Too Many Pending Changesets Caused Admin Portal to Run Slowly
What was happening
When searching Changesets with large Location Sets or too many pending changesets, filtering ran slowly when the dropdown was selected.
What changed
We optimized the filtering process and how the results are cached, and shortened the time the caching process takes to run. These changes cause less load on the database.
What you'll notice
When searching with large location sets or many pending changesets, the system no longer runs slowly when you click the dropdown. When changesets are applied at EOD, Settings Editor opens faster as soon as the EOD process is complete on the registers.
(BRNK-64662, PDOC-4433)
Auto-naming of Changesets Made it Hard to Find the Changeset Later
What was happening
Settings Editor auto-named changesets with a date and time. Customers and support found it hard to locate a changeset afterward. The system also required users to click out of the Notes field in order for the OK button to enable.
What changed
We removed the default name, and a descriptive name is now required.
What you'll notice
Publishes are now easier to find, audit and troubleshoot. Users no longer have to click out of the Notes field in order for the OK button to enable.
(BRNK-64665, PDOC-4433)
Settings Editor Stalled When One Location Was Slow, or While Large Publishes Ran
What was happening
A single slow or timed-out location could degrade or block Settings Editor access for many or all other locations. Customers could not access Settings Editor during big publishes. Calls to the in-store service held a thread for up to 2 minutes. Once the thread pool was exhausted, every location queued behind it.
What changed
Those calls are now non-blocking, so a slow location no longer affects the others. The fix also makes many users opening the same location trigger one back-end load instead of many, and it removes a one-time startup load on the first request.
What you'll notice
Settings Editor stays available and responsive for other locations, even when one location is slow or a big publish is running.
(BRNK-67195, PDOC-4433)
One Stuck Changeset Package Could Lock a Location Out of Settings Editor
What was happening
If a location had a pending package that couldn't be applied, or whose result failed validation, loading that location's settings failed with a 500 error. The failure affected every screen that loads settings, including the changeset summary. The location stayed locked out until someone manually removed the package.
What changed
A failed package is now skipped and logged. Its errors are shown, any changes it made are undone, and the location loads with the remaining valid packages applied. A failed active changeset still fails the load, as before.
What you'll notice
A single bad package no longer blocks users from viewing or editing a location's settings.
(BRNK-67841, PDOC-4433)
Behind-the-Scenes Improvements
These improvements do not change how you work.
- Locations without registers (also called "headless" locations): Changesets published to these locations are now handled by the same newer publishing system used for other locations. Before, they were handled by an older component. Changesets published to the same location are applied one at a time so they can't overlap, an interrupted publish is picked back up automatically, and the settings the location is using are refreshed after each publish. You still publish from Settings Editor or Changeset Publisher. (BRNK-69787, PDOC-4433)
- Settings Editor and changeset reliability: A series of improvements to help Settings Editor and changeset publishing run faster, be more stable, and be more dependable day to day. You may see them run a little faster or hit fewer errors as these improvements roll out. (BRNK-64768, PDOC-4433)
Bug Fixes
Admin Portal and Changesets
| # | Problem | Resolution | Ticket |
|---|---|---|---|
| 1 | The service host became unresponsive after a Sales Clear. | Added a confirmation pop-up when performing a Sales Clear that shows the number of records to be cleared. | BRNK-66666 |
| 2 | Changeset-level search in the Admin Portal timed out with error -2. | Changed how changesets are stored so that the search no longer times out. | BRNK-69115 |
| 3 | The Settings Editor message "Register will not need a restart to apply these changes" (Hot Reload) was misleading when a large number of changesets were sent to a large number of locations during business hours. | The message was reworded to be more informative. It now warns users what an immediate publish during business hours can do, so they know the impact before publishing. | BBS-14006 |
| 4 | Several users were logged out of the Admin Portal and saw error messages while their session was idle. | Two changes were made to prevent this from occurring: A limit on how many updates are handled at once. Whenever a location's settings change, the Admin Portal server receives a settings-update notification so it can refresh its stored copy of that location's settings. The server now processes at most 10 of these notifications at a time. The limit was already built in, and it can now be adjusted without changing the code. Repeat notifications are combined. If several settings-update notifications arrive for the same location within 10 seconds, the server handles them as one. The first notification for a location is always handled right away, so normal day-to-day changes are not delayed. This combining can be turned off if needed. |
BRNK-72855 |
| 5 | In Settings Editor, the Void Reason on the Options → System → General screen did not keep its value after you left the screen. | Corrected so that saved settings now include the Void Reason. | BRNK-69228 |
| 6 | In Settings Editor, creating a Kitchen Display with Split View failed without any explanation or error message. | When the Input Type is Keypad and no Primary or Secondary Keypad is assigned, an error message now appears. | BRNK-59478 |
| 7 | A location name containing a tab character caused a failure in Changeset Publisher. | The system now checks location names and group names when a location or group is created or updated, and rejects hidden control characters such as tabs. | BRNK-66893 |
| 8 | When a changeset package got stuck or failed at one location, operators had little control. | A Cancel Location button in the Changeset Package dialog stops a single location without affecting the others. A Retry action, also in the dialog, resets the location to pending so it goes through the normal publish process again. It is no longer necessary to cancel and recreate the package. Packages now also show whether they are scheduled and their target business date. | BRNK-64664 |
| 9 | Headless locations were difficult to troubleshoot when data was missing. | Each headless publish now keeps its own metadata/version record. This provides a proper version history for headless locations, which helps with auditing and troubleshooting what changed and when. | BRNK-65646 |
| 10 | Publishing or scheduling a changeset package to a very large number of locations, from the Admin Portal or Settings Editor, failed with a raw error such as "Unterminated string. Expected delimiter…". Users could not see the warnings or tell whether the publish had gone through. | Each publish result now shows at most 50 warnings, and each warning is cut off at 1,000 characters. Any extra warnings are summarized in one line: "… and N more warning(s) not shown." Errors are not limited. | BRNK-74648 |
Register and Payments
| # | Problem | Resolution | Ticket |
|---|---|---|---|
| 11 | A customer's refund on one order showed as declined on the register, with the message "Refunds must be issued to a card from the original order." The card processor (Fiserv) had approved the refund each time. The cashier retried twice more, and each retry was approved too, so the order was refunded 3 times. | The system now compares the card's token (or masked number, expiration and card type) instead of the name only. | BBS-13902 |
| 12 | Gift card cashout returned the error "Giftcard Cashout Not Configured" on locations using an integrated Verifone device, even though the button and gift cards were set up correctly. | Gift card cashout is now supported on integrated Verifone devices. | BRNK-40957 |
| 13 | Parts of a combo could be moved or transferred separately from the rest of the combo, which could leave items mispriced or cause the register to crash. | Transfer Item, Move/Split Check, and Auto Split by Seat now keep combos together. Moving only part of a combo shows “Cannot split combo items.” Combos can still be moved as a whole. | BRNK-71227 |
Integrations, Loyalty and Webhooks
| # | Problem | Resolution | Ticket |
|---|---|---|---|
| 14 | Adding a value to a Paytronix comp card no longer worked. | The amount is now stored as a plain number. The user-facing description still shows the amount with the location's currency symbol, based on the screen language. | BRNK-73746 |
| 15 | Tillster, a kiosk integrator, reported that promotional prices were not being honored at the register. | The register now uses the order's open time (or the current time, with a clear UTC or local setting) instead of the Business Date to determine promotional pricing. | BBS-14362 |
| 16 | Item data service was processed with severe delays after a message backlog built up during heavy traffic. | The service's processing capacity was increased, and the hours it scales up for peak traffic were extended. | BBS-14154 |
| 17 | InceptAI was not receiving Item Availability Notifications. | The service was reset and additional monitoring was added. | BNZ-1779 |
| 18 | PAR POS printed the same loyalty barcode on receipts for two different guests, resulting in the second guest being blocked from earning loyalty points. | Registers at a location now check each new barcode against a shared list, so two guests no longer receive the same barcode. NOTE: Terminal 1 must allow inbound TCP traffic on port 19850 so the other registers can reach the shared list. |
EPS-11753 |
| 19 | Loyalty barcodes were missing from receipts printed on a network printer when the order was closed on a different register than the one the printer is configured to. | Registers now load their Punchh configuration at startup, so the loyalty barcode prints regardless of which register closed the order. | BBS-13903 |
| 20 | A Punchh loyalty reward applied to an entire combo instead of the single item it was meant for. | The POS now sends the combo structure to Punchh, with each item linked to its combo through hierarchical serial numbers, so the reward applies only to the intended item. | BRNK-72883 |
| 21 | Punchh bonus points were calculated on the entire receipt instead of only the discounted item they were meant for. | Item-level promotions and discounts are now linked to the item they apply to, so bonus points are based on that item's discounted price. | BRNK-66261 |
| 22 | When a Punchh reward was applied on top of an automatically applied promotion, it discounted the item's original price instead of its promotional price, giving the guest a larger discount than intended. | The POS now sends the promotion to Punchh as a child of the item it applies to. Each Punchh reward is matched to its item through the new Line Item Discount ID, so it discounts the price after the promotion. Check-level rewards are still sent as a separate open-dollar discount. | BBS-13538 |
