Interface IInvoiceOperationService

Interface for invoice operation service that extends line operation service

Hierarchy

ILineOperationService
- IInvoiceOperationService

Implemented by

InvoiceOperationService

Index

Properties

db moduleName

Methods

addInvoiceDiscount addItemToLine addLineQuantity addModifier addModifierQuantity addOne addPaxToInvoice addSalesPersonToInvoice autoQuery calculate calculateAddCredit calculateChangeAmount calculateCreditDeduction calculateDeliveryCharge calculateDiscount calculateInvoiceServiceChargeableSubtotal calculateLine calculateLines calculatePointSubtotal calculateRewardCredit calculateRewardPoint calculateRounding calculateServiceCharge calculateTax calculateTaxSubtotalRatio calibrateDuplicates cancelInvoice changeLineDiscount changeLinePrice changeModifierPrice changePayments checkInvoice createInvoice deleteOne duplicateInvoice duplicateLine getAll getDefaultOne getMany getOne getOneByParams getRefId hasAny liveQuery mergeInvoice minusLineQuantity minusModifierQuantity overwriteNoteToInvoice overwriteNoteToLine payInvoice reprintReceipt roundingStep saveMany saveOne switchInvoice updateInvoice updateMany updateOne voidInvoice

Properties

db

db: Dexie

moduleName

moduleName: string

Methods

addInvoiceDiscount

addInvoiceDiscount(invoice, discountType, amountOrPercent, calcFlow?): IInvoice
Adds a discount to an invoice
Parameters
- invoice: IInvoice
  The invoice to add the discount to
- discountType: CalcType
  The type of discount to add
- amountOrPercent: number
  The amount or percent of the discount
- Optional calcFlow: CalcFlow
  The calculation flow to use for the discount
Returns IInvoice
The updated invoice with the added discount
- Defined in src/services/invoice.service.ts:843

addItemToLine

addItemToLine(invoice, customer, appConfig, item, modifiers?, options?): IInvoice
Adds an item to an invoice line. If the item already exists in the invoice, the quantity is increased, otherwise a new line is created.
Parameters
- invoice: IInvoice
  The invoice to add the item to.
- customer: ICustomer
  The customer associated with the invoice.
- appConfig: IAppConfig
  The app configuration.
- item: IItem
  The item to add to the invoice line.
- Optional modifiers: IInvoiceCoreLine[]
  An array of modifiers to apply to the item.
- Optional options: LineOptions
  Additional options for the line.
Returns IInvoice
The updated invoice.
Inherited from ILineOperationService.addItemToLine
- Defined in src/services/invoice.service.ts:488

addLineQuantity

addLineQuantity(invoice, line, quantity): IInvoice
Increases the quantity of an item in an invoice line.
Parameters
- invoice: IInvoice
  The invoice to increase the item quantity in.
- line: IInvoiceLine
  The invoice line to increase the item quantity in.
- quantity: number
  The quantity of the item to increase.
Returns IInvoice
The updated invoice.
Inherited from ILineOperationService.addLineQuantity
- Defined in src/services/invoice.service.ts:521

addModifier

addModifier(modifiers, modifier): IInvoiceCoreLine[]
Adds a modifier to a list of modifiers, if the modifier already exists in the list, the quantity is increased, otherwise a new modifier is created.
Parameters
- modifiers: IInvoiceCoreLine[]
  The list of modifiers to add the modifier to.
- modifier: IInvoiceCoreLine
  The modifier to add to the list.
Returns IInvoiceCoreLine[]
The updated list of modifiers.
Inherited from ILineOperationService.addModifier
- Defined in src/services/invoice.service.ts:546

addModifierQuantity

addModifierQuantity(modifiers, modifier, quantity?): IInvoiceCoreLine[]
Increases the quantity of a modifier in a list of modifiers.
Parameters
- modifiers: IInvoiceCoreLine[]
  The list of modifiers to increase the quantity in.
- modifier: IInvoiceCoreLine
  The modifier to increase the quantity of.
- Optional quantity: number
  The quantity of the modifier to increase.
Returns IInvoiceCoreLine[]
The updated list of modifiers.
Inherited from ILineOperationService.addModifierQuantity
- Defined in src/services/invoice.service.ts:564

addOne

addOne(item): Promise<IInvoice>
Parameters
- item: IInvoice
Returns Promise<IInvoice>
Inherited from ILineOperationService.addOne
- Defined in src/services/abstract.service.ts:205

addPaxToInvoice

addPaxToInvoice(invoice, pax): IInvoice
Adds a pax to an invoice
Parameters
- invoice: IInvoice
  The invoice to add the pax to
- pax: number
  The pax to add to the invoice
Returns IInvoice
- Defined in src/services/invoice.service.ts:858

addSalesPersonToInvoice

addSalesPersonToInvoice(invoice, salesUserUid): IInvoice
Adds a payment to an invoice
Parameters
- invoice: IInvoice
  The invoice to add the sales person to
- salesUserUid: string
  The sales person's uid to add to the invoice
Returns IInvoice
- Defined in src/services/invoice.service.ts:865

autoQuery

autoQuery(options): Promise<QueryResponse<IInvoice>>
Auto query invoices
Parameters
- options: IInvoicesQuery
  query options
Returns Promise<QueryResponse<IInvoice>>
- Defined in src/services/invoice.service.ts:878

calculate

calculate(invoice, appConfig): IInvoice
Parameters
- invoice: IInvoice
- appConfig: IAppConfig
Returns IInvoice
Inherited from ILineOperationService.calculate
- Defined in src/services/invoice.service.ts:40

calculateAddCredit

calculateAddCredit(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from ILineOperationService.calculateAddCredit
- Defined in src/services/invoice.service.ts:57

calculateChangeAmount

calculateChangeAmount(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from ILineOperationService.calculateChangeAmount
- Defined in src/services/invoice.service.ts:59

calculateCreditDeduction

calculateCreditDeduction(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from ILineOperationService.calculateCreditDeduction
- Defined in src/services/invoice.service.ts:53

calculateDeliveryCharge

calculateDeliveryCharge(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from ILineOperationService.calculateDeliveryCharge
- Defined in src/services/invoice.service.ts:45

calculateDiscount

calculateDiscount(invoice, flow): void
Parameters
- invoice: IInvoice
- flow: CalcFlow
Returns void
Inherited from ILineOperationService.calculateDiscount
- Defined in src/services/invoice.service.ts:48

calculateInvoiceServiceChargeableSubtotal

calculateInvoiceServiceChargeableSubtotal(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from ILineOperationService.calculateInvoiceServiceChargeableSubtotal
- Defined in src/services/invoice.service.ts:46

calculateLine

calculateLine(line): void
Parameters
- line: IInvoiceLine
Returns void
Inherited from ILineOperationService.calculateLine
- Defined in src/services/invoice.service.ts:42

calculateLines

calculateLines(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from ILineOperationService.calculateLines
- Defined in src/services/invoice.service.ts:41

calculatePointSubtotal

calculatePointSubtotal(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from ILineOperationService.calculatePointSubtotal
- Defined in src/services/invoice.service.ts:44

calculateRewardCredit

calculateRewardCredit(invoice, aboveInvoiceAmount, includeServiceCharge, includeTax): void
Parameters
- invoice: IInvoice
- aboveInvoiceAmount: number
- includeServiceCharge: boolean
- includeTax: any
Returns void
Inherited from ILineOperationService.calculateRewardCredit
- Defined in src/services/invoice.service.ts:56

calculateRewardPoint

calculateRewardPoint(invoice, aboveInvoiceAmount, includeServiceCharge, includeTax): void
Parameters
- invoice: IInvoice
- aboveInvoiceAmount: number
- includeServiceCharge: boolean
- includeTax: boolean
Returns void
Inherited from ILineOperationService.calculateRewardPoint
- Defined in src/services/invoice.service.ts:58

calculateRounding

calculateRounding(invoice, roundingBase, roundingUp, roundingCashless): void
Parameters
- invoice: IInvoice
- roundingBase: number
- roundingUp: boolean
- roundingCashless: boolean
Returns void
Inherited from ILineOperationService.calculateRounding
- Defined in src/services/invoice.service.ts:49

calculateServiceCharge

calculateServiceCharge(invoice, rate): void
Parameters
- invoice: IInvoice
- rate: number
Returns void
Inherited from ILineOperationService.calculateServiceCharge
- Defined in src/services/invoice.service.ts:51

calculateTax

calculateTax(invoice, taxRate, taxMethod): void
Parameters
- invoice: IInvoice
- taxRate: number
- taxMethod: TaxMethod
Returns void
Inherited from ILineOperationService.calculateTax
- Defined in src/services/invoice.service.ts:52

calculateTaxSubtotalRatio

calculateTaxSubtotalRatio(invoice): number
Parameters
- invoice: IInvoice
Returns number
Inherited from ILineOperationService.calculateTaxSubtotalRatio
- Defined in src/services/invoice.service.ts:55

calibrateDuplicates

calibrateDuplicates(invoice): IInvoice
Calibrates the duplicates in an invoice.
Parameters
- invoice: IInvoice
  The invoice to calibrate the duplicates in.
Returns IInvoice
The updated invoice.
Inherited from ILineOperationService.calibrateDuplicates
- Defined in src/services/invoice.service.ts:503

cancelInvoice

cancelInvoice(invoice, sectionItem, employee?): Promise<CancelInvoiceOptions>
Cancels an invoice
Parameters
- invoice: IInvoice
  The invoice to cancel
- sectionItem: ISectionItem
  The section item to associate with the invoice
- Optional employee: IEmployeeEntity
  The employee to associate with the invoice
Returns Promise<CancelInvoiceOptions>
A promise that resolves with the cancelled invoice options
- Defined in src/services/invoice.service.ts:786

changeLineDiscount

changeLineDiscount(line, discountType, amountOrPercent): IInvoiceLine
Changes the discount of an existing invoice line.
Parameters
- line: IInvoiceLine
  The invoice line to change the discount in.
- discountType: CalcType
  The type of discount to apply.
- amountOrPercent: number
  The amount of the discount to apply.
Returns IInvoiceLine
The updated invoice.
Inherited from ILineOperationService.changeLineDiscount
- Defined in src/services/invoice.service.ts:538

changeLinePrice

changeLinePrice(line, price): IInvoiceLine
Changes the unit price of an existing invoice line.
Parameters
- line: IInvoiceLine
  The invoice line to change the item price in.
- price: number
  The new price of the item.
Returns IInvoiceLine
The updated invoice.
Inherited from ILineOperationService.changeLinePrice
- Defined in src/services/invoice.service.ts:529

changeModifierPrice

changeModifierPrice(modifier, price): IInvoiceCoreLine
Changes the unit price of a existing modifier.
Parameters
- modifier: IInvoiceCoreLine
  The modifier to change the price of.
- price: number
  The new price of the modifier.
Returns IInvoiceCoreLine
The updated list of modifiers.
Inherited from ILineOperationService.changeModifierPrice
- Defined in src/services/invoice.service.ts:572

changePayments

changePayments(invoice, options): Promise<IInvoice>
Change payments of an invoice
Parameters
- invoice: IInvoice
  invoice to change
- options: IChangePaymentMethodOption[]
Returns Promise<IInvoice>
- Defined in src/services/invoice.service.ts:887

checkInvoice

checkInvoice(invoice, SectionItem, employee?): Promise<CheckInvoiceOptions>
Checks an invoice
Parameters
- invoice: IInvoice
  The invoice to check
- SectionItem: ISectionItem
  The section item to associate with the invoice
- Optional employee: IEmployeeEntity
  The employee to associate with the invoice
Returns Promise<CheckInvoiceOptions>
A promise that resolves with the checked invoice options
- Defined in src/services/invoice.service.ts:795

createInvoice

createInvoice(invoice, sectionItem, employee?): Promise<CreateInvoiceOptions>
Creates an invoice
Parameters
- invoice: IInvoice
  The invoice to create
- sectionItem: ISectionItem
  The section item to associate with the invoice
- Optional employee: IEmployeeEntity
  The employee to associate with the invoice
Returns Promise<CreateInvoiceOptions>
A promise that resolves with the created invoice options
- Defined in src/services/invoice.service.ts:768

deleteOne

deleteOne(model): Promise<IInvoice>
Parameters
- model: IInvoice
Returns Promise<IInvoice>
Inherited from ILineOperationService.deleteOne
- Defined in src/services/abstract.service.ts:208

duplicateInvoice

duplicateInvoice(invoice, employee?): Promise<IInvoice>
duplicate an invoice
Parameters
- invoice: IInvoice
  the invoice to duplicate
- Optional employee: IEmployeeEntity
  the employee to associate with the invoice
Returns Promise<IInvoice>
- Defined in src/services/invoice.service.ts:821

duplicateLine

duplicateLine(invoice, line): IInvoice
Duplicates an invoice line
Parameters
- invoice: IInvoice
  The invoice to duplicate the line in.
- line: IInvoiceLine
  The line to duplicate.
Returns IInvoice
The updated invoice.
Inherited from ILineOperationService.duplicateLine
- Defined in src/services/invoice.service.ts:496

getAll

getAll(): Promise<IInvoice[]>
Retrieves all entities with optional pagination.

Returns Promise<IInvoice[]>
A Promise that resolves to an array of retrieved entities.
Inherited from ILineOperationService.getAll
- Defined in src/services/abstract.service.ts:77

getDefaultOne

getDefaultOne(): Promise<IInvoice>
Retrieves a single entity by its unique identifier.

Returns Promise<IInvoice>
A Promise that resolves to the retrieved entity or undefined.
Inherited from ILineOperationService.getDefaultOne
- Defined in src/services/abstract.service.ts:69

getMany

getMany(params, options): Promise<{
    count: number;
    list: IInvoice[];
    page: number;
    pageSize: number;
}>
Retrieves multiple entities with optional pagination and filtering.
Parameters
- params: any
  [UNUSED PARAMETER, KEPT FOR POSSIBLE FUTURE USE] Filtering parameters.
- options: {
  page?: number;
  pageSize?: number;
  }
  Query options including pagination.
  - Optional page?: number
  - Optional pageSize?: number
Returns Promise<{
    count: number;
    list: IInvoice[];
    page: number;
    pageSize: number;
}>
An object containing the retrieved entities and total count.
Inherited from ILineOperationService.getMany
- Defined in src/services/abstract.service.ts:86

getOne

getOne(id): Promise<IInvoice>
Retrieves a single entity by its unique identifier.
Parameters
- id: string
  Unique identifier of the entity to retrieve.
Returns Promise<IInvoice>
A Promise that resolves to the retrieved entity or undefined.
Inherited from ILineOperationService.getOne
- Defined in src/services/abstract.service.ts:56

getOneByParams

getOneByParams(params): Promise<IInvoice>
Retrieves a single entity by its unique identifier.
Parameters
- params: Partial<IInvoice>
  Filtering parameters.
Returns Promise<IInvoice>
A Promise that resolves to the retrieved entity or undefined.
Inherited from ILineOperationService.getOneByParams
- Defined in src/services/abstract.service.ts:63

getRefId

getRefId(): Promise<string>
Returns Promise<string>
- Defined in src/services/invoice.service.ts:880

hasAny

hasAny(): Promise<boolean>
Checks if any entity exists.

Returns Promise<boolean>
A Promise that resolves to true if any entity exists or false otherwise.
Inherited from ILineOperationService.hasAny
- Defined in src/services/abstract.service.ts:50

liveQuery

liveQuery<T>(expr): Observable<any>
Creates a live query.
Type Parameters
- T
Parameters
- expr: (() => T)
  Function that returns the query expression.
  - - (): T
    - Returns T
Returns Observable<any>
A live query.
Inherited from ILineOperationService.liveQuery
- Defined in src/services/abstract.service.ts:30

mergeInvoice

mergeInvoice(localInvoice, remoteInvoice): IInvoice
merge invoice from local db and invoice sent from signalr
Parameters
- localInvoice: IInvoice
  invoice from local db
- remoteInvoice: IInvoice
  invoice sent from signalr
Returns IInvoice
- Defined in src/services/invoice.service.ts:872

minusLineQuantity

minusLineQuantity(invoice, line, quantity): IInvoice
Decreases the quantity of an item in an invoice line.
Parameters
- invoice: IInvoice
  The invoice to decrease the item quantity in.
- line: IInvoiceLine
  The invoice line to decrease the item quantity in.
- quantity: number
  The quantity of the item to decrease.
Returns IInvoice
The updated invoice.
Inherited from ILineOperationService.minusLineQuantity
- Defined in src/services/invoice.service.ts:512

minusModifierQuantity

minusModifierQuantity(modifiers, modifier, quantity?): IInvoiceCoreLine[]
Decreases the quantity of a modifier in a list of modifiers.
Parameters
- modifiers: IInvoiceCoreLine[]
  The list of modifiers to decrease the quantity in.
- modifier: IInvoiceCoreLine
  The modifier to decrease the quantity of.
- Optional quantity: number
  The quantity of the modifier to decrease.
Returns IInvoiceCoreLine[]
The updated list of modifiers.
Inherited from ILineOperationService.minusModifierQuantity
- Defined in src/services/invoice.service.ts:555

overwriteNoteToInvoice

overwriteNoteToInvoice(invoice, note): IInvoice
Overwrites the note for an invoice
Parameters
- invoice: IInvoice
  The invoice to overwrite the note for
- note: string
  The new note for the invoice
Returns IInvoice
The updated invoice with the new note
- Defined in src/services/invoice.service.ts:851

overwriteNoteToLine

overwriteNoteToLine(line, note): IInvoiceLine
Overwrites the note of an invoice line.
Parameters
- line: IInvoiceLine
  The invoice line to overwrite the note of.
- note: string
  The new note to overwrite the old note with.
Returns IInvoiceLine
The updated invoice line.
Inherited from ILineOperationService.overwriteNoteToLine
- Defined in src/services/invoice.service.ts:580

payInvoice

payInvoice(invoice, sectionItem, till?, employee?): Promise<PayInvoiceOptions>
Pays an invoice
Parameters
- invoice: IInvoice
  The invoice to pay
- sectionItem: ISectionItem
  The section item to associate with the invoice
- Optional till: ITill
  (optional) The till to use for the payment
- Optional employee: IEmployeeEntity
  (optional) The employee to associate with the invoice
Returns Promise<PayInvoiceOptions>
A promise that resolves with the paid invoice options
- Defined in src/services/invoice.service.ts:805

reprintReceipt

reprintReceipt(invoice): Promise<boolean>
Parameters
- invoice: IInvoice
Returns Promise<boolean>
- Defined in src/services/invoice.service.ts:833

roundingStep

roundingStep(total, roundingBase, rounding, roundingUp): number
Parameters
- total: number
- roundingBase: number
- rounding: number
- roundingUp: boolean
Returns number
Inherited from ILineOperationService.roundingStep
- Defined in src/services/invoice.service.ts:50

saveMany

saveMany(items): Promise<IInvoice[]>
Saves multiple entities.
Parameters
- items: IInvoice[]
  Entities to save.
Returns Promise<IInvoice[]>
A Promise that resolves to the saved entities.
Inherited from ILineOperationService.saveMany
- Defined in src/services/abstract.service.ts:44

saveOne

saveOne(item): Promise<IInvoice>
Saves a single entity.
Parameters
- item: IInvoice
  Entity to save.
Returns Promise<IInvoice>
A Promise that resolves to the saved entity.
Inherited from ILineOperationService.saveOne
- Defined in src/services/abstract.service.ts:37

switchInvoice

switchInvoice(invoice, targetSectionItem, sourceSectionItem, employee?): Promise<SwitchInvoiceOptions>
Switches an invoice from one section item to another
Parameters
- invoice: IInvoice
  The invoice to switch
- targetSectionItem: ISectionItem
  The target section item to switch to
- sourceSectionItem: ISectionItem
  The source section item to switch from
- Optional employee: IEmployeeEntity
  The employee to associate with the invoice
Returns Promise<SwitchInvoiceOptions>
A promise that resolves with the switched invoice options
- Defined in src/services/invoice.service.ts:831

updateInvoice

updateInvoice(invoice, sectionItem, employee?): Promise<CreateInvoiceOptions>
Updates an invoice
Parameters
- invoice: IInvoice
  The invoice to update
- sectionItem: ISectionItem
  The section item to associate with the invoice
- Optional employee: IEmployeeEntity
  The employee to associate with the invoice
Returns Promise<CreateInvoiceOptions>
A promise that resolves with the updated invoice
- Defined in src/services/invoice.service.ts:777

updateMany

updateMany(items): Promise<IInvoice[]>
Parameters
- items: IInvoice[]
Returns Promise<IInvoice[]>
Inherited from ILineOperationService.updateMany
- Defined in src/services/abstract.service.ts:207

updateOne

updateOne(id, item): Promise<IInvoice>
Parameters
- id: number
- item: Partial<IInvoice>
Returns Promise<IInvoice>
Inherited from ILineOperationService.updateOne
- Defined in src/services/abstract.service.ts:206

voidInvoice

voidInvoice(invoice, till?, reason?, employee?): Promise<VoidInvoiceOptions>
Voids an invoice
Parameters
- invoice: IInvoice
  The invoice to void
- Optional till: ITill
  The till to use for the void
- Optional reason: string
  The reason for the void
- Optional employee: IEmployeeEntity
Returns Promise<VoidInvoiceOptions>
A promise that resolves with the voided invoice options
- Defined in src/services/invoice.service.ts:814

Interface IInvoiceOperationService

Hierarchy

Implemented by

Index

Properties

Methods

Properties

db

moduleName

Methods

addInvoiceDiscount

Parameters

invoice: IInvoice

discountType: CalcType

amountOrPercent: number

Optional calcFlow: CalcFlow

Returns IInvoice

addItemToLine

Parameters

invoice: IInvoice

customer: ICustomer

appConfig: IAppConfig

item: IItem

Optional modifiers: IInvoiceCoreLine[]

Optional options: LineOptions

Returns IInvoice

addLineQuantity

Parameters

invoice: IInvoice

line: IInvoiceLine

quantity: number

Returns IInvoice

addModifier

Parameters

modifiers: IInvoiceCoreLine[]

modifier: IInvoiceCoreLine

Returns IInvoiceCoreLine[]

addModifierQuantity

Parameters

modifiers: IInvoiceCoreLine[]

modifier: IInvoiceCoreLine

Optional quantity: number

Returns IInvoiceCoreLine[]

addOne

Parameters

item: IInvoice

Returns Promise<IInvoice>

addPaxToInvoice

Parameters

invoice: IInvoice

pax: number

Returns IInvoice

addSalesPersonToInvoice

Parameters

invoice: IInvoice

salesUserUid: string

Returns IInvoice

autoQuery

Parameters

options: IInvoicesQuery

Returns Promise<QueryResponse<IInvoice>>

calculate

Parameters

invoice: IInvoice

appConfig: IAppConfig

Returns IInvoice

calculateAddCredit

Parameters

invoice: IInvoice

Returns void

calculateChangeAmount

Parameters

invoice: IInvoice

Returns void

calculateCreditDeduction

Parameters

invoice: IInvoice

Returns void

calculateDeliveryCharge

Parameters

`Optional` calcFlow: CalcFlow

`Optional` modifiers: IInvoiceCoreLine[]

`Optional` options: LineOptions

`Optional` quantity: number

`Optional` employee: IEmployeeEntity