Technical beta: Guide checked against the published ImaCash 4.4.3.1528 beta. The connector requires controlled validation of your installation before handling cash; this version is not presented as the latest stable release.
This connector is exclusively for Lightspeed Retail X-Series, formerly Vend. It is not compatible with Lightspeed Restaurant K-Series or Ikentoo.
Prerequisites
- Confirm the Retail X-Series edition, API access and the private store prefix or URL with your provider. Do not use a Restaurant K-Series address or the shop’s trading name.
- A Private App approved by the store administrator, with sales:read, users:read and payment_types:read. Lightspeed lists Private Apps as available on Plus plans; confirm your account. Personal tokens are a legacy option for accounts that still support them.
- Outbound HTTPS on port 443 to *.retail.lightspeed.app. No inbound ports or local database access are required.
- An active cash payment type. ImaCash only imports sales that are already closed in Lightspeed.
ImaCash configuration
- Open Configuration > Integration > POS and select Lightspeed Retail X-Series. Retail describes its sector; a separate selector with that name is not required. Your ImaCash account must be authorised to access and change configuration.
- In API URL, enter your store prefix or HTTPS URL ending in retail.lightspeed.app. A historical vendhq.com URL is adapted to the current domain. Do not enter a database path or another product’s URL.
- In API key, enter the private token of the approved application. It is neither the ImaCash password nor a register identifier. Do not publish it or send screenshots containing it; confirm its validity with the store manager.
- When validating new or changed settings, ImaCash reads payment types and users through the API; at least one cash type must be recognised. Saving unchanged settings may reuse the previous validation. Success does not prove complete reads, filtering or physical cash. General saving has several stages: exiting or cancelling afterwards does not undo saved changes; reopen and check them. Sales permission and retrieval are checked at the first synchronisation, not when users are loaded. Use restart only when offered by the configuration summary.
Behaviour and scope
- Cash sales are imported for their cash amount; card-only sales are ignored.
- For a mixed payment, only the cash component is imported. Negative cash amounts are treated as refunds.
- The beta is read-only: it does not confirm payments or modify sales in Lightspeed.
- Paged reads cover at most the last two hours, with a two-minute overlap and at least fifteen seconds between requests. A failure or incomplete batch does not advance synchronisation. If Lightspeed limits requests, wait for the service’s stated interval. A long interruption may leave sales outside the window and requires review.
Store and user scope
User filters affect the local ImaCash view; they do not restrict Private App access or get sent to the API. The seller list is loaded, but store and register lists are not. Sale references do not prove isolation between stores. Check account and workstation scope during supervised validation.
Confirmations and uncertain outcomes
Confirming in ImaCash does not write a payment, closure or cancellation in Lightspeed. A closed sale already contains payments recorded in the POS. Its appearance in ImaCash does not prove cash delivery or authorise charging it again. Check references, status and actual cash before repeating, resynchronising or restarting.
What this connector does not include
It does not synchronise products, stock, shifts or ticket lookup by EAN. It does not import card-only sales or an independent banking total. The token is supplied privately; there is no automatic OAuth renewal wizard. The iKentoo guide covers Restaurant K-Series and remains separate. Read-only refers to the Lightspeed API: the normal ImaCash workflow may operate a cash-handling machine.
Mandatory test before production
Before commercial use, agree a supervised test of cash, card, mixed payment, refund and connection recovery with your provider. Check references and actual outcomes in both systems. The guide, code and a successful connection do not establish that validation.