Interface ICashRegister

The interface for the primary thing to be implemented in a plugin please look for details in existing plugins note: should be default export

Hierarchy

ICashRegister

Index

Properties

depositCash? getSettings handleRefund? handleSale initialize? makeXReport? makeZReport? printText? withdrawCash?

Properties

`Optional` depositCash

depositCash?: ((options: DepositCashOptions) => Promise<void>)

Type declaration

- (options: DepositCashOptions): Promise<void>
- Cash deposit handler
  Parameters
  - options: DepositCashOptions
  Returns Promise<void>

getSettings

getSettings: (() => Promise<CashRegisterSettings>)

Type declaration

- (): Promise<CashRegisterSettings>
- Settings getter function (will be called after initialization finish))
  
  Returns Promise<CashRegisterSettings>

`Optional` handleRefund

handleRefund?: ((handleRefundRequest: HandleRefundRequest) => Promise<PrintedRefundReceipt>)

Type declaration

- (handleRefundRequest: HandleRefundRequest): Promise<PrintedRefundReceipt>
- Refund handler
  Parameters
  - handleRefundRequest: HandleRefundRequest
  Returns Promise<PrintedRefundReceipt>

handleSale

handleSale: ((handleSaleRequest: HandleSaleRequest) => Promise<PrintedReceipt>)

Type declaration

- (handleSaleRequest: HandleSaleRequest): Promise<PrintedReceipt>
- Sale handler
  Parameters
  - handleSaleRequest: HandleSaleRequest
  Returns Promise<PrintedReceipt>

`Optional` initialize

initialize?: ((options: InitializationOptions) => Promise<void>)

Type declaration

- (options: InitializationOptions): Promise<void>
- Plugin initialization function (will be called right after plugin download/installation and every time on page reload/cashierapp start)
  Parameters
  - options: InitializationOptions
  Returns Promise<void>

`Optional` makeXReport

makeXReport?: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Call for X-report (usually - statistics for the current time)
  
  Returns Promise<void>

`Optional` makeZReport

makeZReport?: ((options: MakeZReportOptions) => Promise<void>)

Type declaration

- (options: MakeZReportOptions): Promise<void>
- Call for ending the cash shift (e.g. end of workday or schedule) (usually, also final report printed)
  Parameters
  - options: MakeZReportOptions
  Returns Promise<void>

`Optional` printText

printText?: ((options: PrintTextOptions) => Promise<void>)

Type declaration

- (options: PrintTextOptions): Promise<void>
- Print any text, such as informational block, promo details or pos terminal slip. NOTE: implement this only if your country/business require printing terminal slips or info checks
  Parameters
  - options: PrintTextOptions
  Returns Promise<void>

`Optional` withdrawCash

withdrawCash?: ((options: WithdrawCashOptions) => Promise<void>)

Type declaration

- (options: WithdrawCashOptions): Promise<void>
- Cash withdrawal handler
  Parameters
  - options: WithdrawCashOptions
  Returns Promise<void>

Generated using TypeDoc