View POS settings
Open Harbor Soho POS settings to review the current location-level configuration without saving changes. POS view or manage permission is required for the administrative screen; KDS-only access can read a restricted settings payload from KDS surfaces but does not grant access to this page.
In this article
Use this guide when a location manager or POS administrator needs to check Harbor Soho's current POS configuration before service.
The General, Billing, Payment methods, and Printers and outputs tabs can all show values loaded from the same location-scoped `tpv_settings` payload. This action is read-only; saving settings, editing resources, and changing terminal restrictions belong to separate actions.
KDS-only consumers are a permission boundary, not an alternate way into the POS settings page. They may receive a restricted API payload through KDS surfaces, with POS-management fields cleared.
Before you start
- The operator is signed in to Harbor Demo Group with Harbor Soho selected as the active location.
- The operator has `tpv:view` or `tpv:manage` for Harbor Soho to open the administrative POS settings screen.
- The route includes both `orgId` and `locationId`.
- KDS-only consumers read settings only through permitted KDS surfaces and receive a restricted payload.
Instructions
- 1.
Open Harbor Soho POS settings
Open `/:orgId/:locationId/location/tpv`, or use `/:orgId/:locationId/location/tpv?tab=general` to land explicitly on General. If no tab is provided, or the tab is not recognised, the screen resolves to General.
- 2.
Review the General settings
Wait for the settings to load, then review employee access mode, product images, quick mode, KDS enablement, quick payment defaults, output preferences, brand reference, and billing-derived values. Operators with `tpv:view` can review values but cannot save changes.
- 3.
Review Billing without editing
Open `/:orgId/:locationId/location/tpv?tab=billing` to inspect billing and fiscal information such as Harbor Soho Demo Ltd. These values come from `tpv_settings.billing_config`; fiscal edits and save confirmations are outside this view action.
- 4.
Inspect terminal preferences
Open Payment methods and Printers and outputs only to review settings-backed terminal preferences. Quick payment rows come from `quick_payment_method_preferences`, and output routing rows come from `output_device_preferences`. Payment method, output device, terminal, and `allowed_terminal_ids` management are sibling actions.
- 5.
Handle KDS-only reads correctly
When documenting KDS screens, describe the settings call as a restricted support read. KDS-only callers can read the fields needed by KDS surfaces, but they should not be shown opening the administrative POS settings page.
Validations and limits
- The administrative POS settings screen is gated by `tpv:view` or `tpv:manage`; without either permission, the app shows a no-access state.
- The settings query is enabled only when the frontend has a selected organisation, selected location, and the relevant screen permission.
- `GET /api/app/{orgId}/{locationId}/tpv-settings` accepts POS or KDS permissions, but returns `PermissionDenied` when none are present.
- If no `tpv_settings` row exists, the backend returns service defaults without creating a new row.
- Empty stored JSON fields are normalised on read: payment methods, quick payment preferences, and output preferences become `[]`, while billing config becomes `{}`.
- KDS-only reads clear POS-management fields such as payment methods, billing config, default output IDs, quick payment IDs, terminal preferences, and brand ID.
- Do not document `tab=brands` as part of this action because it redirects to brand settings.
Expected result
Harbor Soho's POS settings have been reviewed without edits. The operator can confirm the current General, Billing, and terminal preference values while keeping all save, resource-management, fiscal edit, and terminal-management behaviours in their own guides.