Class InvoiceBaseService

Interface for a generic service.

Hierarchy

AppRemoteService<IInvoice>
- InvoiceBaseService
  - LineOperationService

Implements

IInvoiceBaseService

Constructors

constructor

new InvoiceBaseService(http, db, options, moduleName?, methodName?): InvoiceBaseService
Parameters
- http: AxiosInstance
- db: Dexie
- options: IServiceOptions
- moduleName: string = 'invoices'
- methodName: string = 'invoice'
Returns InvoiceBaseService
Overrides AppRemoteService.constructor
- Defined in src/services/invoice.service.ts:81

Properties

`Protected` configService

configService: ConfigService

`Readonly` db

db: Dexie

`Readonly` http

http: AxiosInstance

`Readonly` methodName

methodName: string = 'invoice'

`Readonly` moduleName

moduleName: string = 'invoices'

`Readonly` options

options: IServiceOptions

`Protected` printJobService

printJobService: PrintJobService

`Protected` printTemplateService

printTemplateService: PrintTemplateService

`Protected` printerService

printerService: PrinterService

`Protected` sectionItemService

sectionItemService: ISectionItemService

`Protected` tillService

tillService: ITillService

Methods

addOne

addOne(item): Promise<IInvoice>
Parameters
- item: IInvoice
Returns Promise<IInvoice>
Implementation of IInvoiceBaseService.addOne
Inherited from AppRemoteService.addOne
- Defined in src/services/abstract.service.ts:218

calculate

calculate(invoice, appConfig): IInvoice
Parameters
- invoice: IInvoice
- appConfig: IAppConfig
Returns IInvoice
Implementation of IInvoiceBaseService.calculate
- Defined in src/services/invoice.service.ts:90

calculateAddCredit

calculateAddCredit(invoice): void
Parameters
- invoice: IInvoice
Returns void
Implementation of IInvoiceBaseService.calculateAddCredit
- Defined in src/services/invoice.service.ts:395

calculateChangeAmount

calculateChangeAmount(invoice): void
Parameters
- invoice: IInvoice
Returns void
Implementation of IInvoiceBaseService.calculateChangeAmount
- Defined in src/services/invoice.service.ts:446

calculateCreditDeduction

calculateCreditDeduction(invoice): void
Adjusts the grand total of the invoice by the deduction balance
Parameters
- invoice: IInvoice
  The invoice to adjust.
Returns void
void
Implementation of IInvoiceBaseService.calculateCreditDeduction
- Defined in src/services/invoice.service.ts:352

calculateDeliveryCharge

calculateDeliveryCharge(invoice): void
Calculate the delivery charge of an invoice
Parameters
- invoice: IInvoice
  The invoice object containing delivery charge and type
Returns void
The updated invoice object with calculated grand total
Implementation of IInvoiceBaseService.calculateDeliveryCharge
- Defined in src/services/invoice.service.ts:292

calculateDiscount

calculateDiscount(invoice, flow): void
Calculate the total discount amount of an invoice and update grand total accordingly
Parameters
- invoice: IInvoice
  The invoice object containing discount details and lines
- flow: CalcFlow
  The calculation of discount flow
Returns void
The updated invoice object with calculated discount and grand total
Implementation of IInvoiceBaseService.calculateDiscount
- Defined in src/services/invoice.service.ts:235

calculateInvoiceServiceChargeableSubtotal

calculateInvoiceServiceChargeableSubtotal(invoice): void
Calculate the invoice subtotal without considering take out
Parameters
- invoice: IInvoice
  The invoice object containing invoice lines
Returns void
The updated invoice object with calculated subtotals
Implementation of IInvoiceBaseService.calculateInvoiceServiceChargeableSubtotal
- Defined in src/services/invoice.service.ts:180

calculateLine

calculateLine(line): void
Parameters
- line: IInvoiceLine
Returns void
Implementation of IInvoiceBaseService.calculateLine
- Defined in src/services/invoice.service.ts:150

calculateLines

calculateLines(invoice): void
Parameters
- invoice: IInvoice
Returns void
Implementation of IInvoiceBaseService.calculateLines
- Defined in src/services/invoice.service.ts:138

calculatePointSubtotal

calculatePointSubtotal(invoice): void
Parameters
- invoice: IInvoice
Returns void
Implementation of IInvoiceBaseService.calculatePointSubtotal
- Defined in src/services/invoice.service.ts:166

calculateRewardCredit

calculateRewardCredit(invoice, aboveInvoiceAmount, includeServiceCharge, includeTax): void
Calculates the rewarded credit for an invoice.
Parameters
- invoice: IInvoice
  The invoice to calculate the rewarded credit for.
- aboveInvoiceAmount: number
  The minimum invoice amount required to be eligible for rewarded credit.
- includeServiceCharge: boolean
  Whether to include the service charge in the calculation.
- includeTax: any
  Whether to include the tax in the calculation.
Returns void
Implementation of IInvoiceBaseService.calculateRewardCredit
- Defined in src/services/invoice.service.ts:380

calculateRewardPoint

calculateRewardPoint(invoice, aboveInvoiceAmount, includeServiceCharge, includeTax): void
Calculates and sets the rewarded points for the given invoice based on various conditions.
Parameters
- invoice: IInvoice
  The invoice to calculate rewarded points for.
- aboveInvoiceAmount: number
- includeServiceCharge: boolean
- includeTax: boolean
Returns void
void
Implementation of IInvoiceBaseService.calculateRewardPoint
- Defined in src/services/invoice.service.ts:411

calculateRounding

calculateRounding(invoice, roundingBase, roundingUp, roundingCashless): void
Calculates the rounding for an invoice based on the given parameters.
Parameters
- invoice: IInvoice
  The invoice to calculate the rounding for.
- roundingBase: number
  The base value to round to.
- roundingUp: boolean
  Whether to round up or down.
- roundingCashless: boolean
  Whether to apply rounding only for cash payments.
Returns void
Implementation of IInvoiceBaseService.calculateRounding
- Defined in src/services/invoice.service.ts:258

calculateServiceCharge

calculateServiceCharge(invoice, rate): void
Calculate and set the service charge for a given invoice. The method updates the service_charge and grand_total fields of the invoice.
Parameters
- invoice: IInvoice
  invoice to calculate the service charge for
- rate: number
  service charge rate. e.g. 0.1 for 10%
Returns void
Implementation of IInvoiceBaseService.calculateServiceCharge
- Defined in src/services/invoice.service.ts:306

calculateTax

calculateTax(invoice, taxRate, taxMethod): void
Calculates the tax for an invoice based on the tax rate and tax method.
Parameters
- invoice: IInvoice
  The invoice to calculate the tax for.
- taxRate: number
  The tax rate to apply.
- taxMethod: TaxMethod
  The tax method to use (inclusive or exclusive).
Returns void
Implementation of IInvoiceBaseService.calculateTax
- Defined in src/services/invoice.service.ts:331

calculateTaxSubtotalRatio

calculateTaxSubtotalRatio(invoice): number
Calculate the tax subtotal ratio for the invoice.
Parameters
- invoice: IInvoice
  The invoice for which the ratio is calculated.
Returns number
The calculated ratio as a number.
Implementation of IInvoiceBaseService.calculateTaxSubtotalRatio
- Defined in src/services/invoice.service.ts:364

deleteOne

deleteOne(model): Promise<IInvoice>
Parameters
- model: IInvoice
Returns Promise<IInvoice>
Implementation of IInvoiceBaseService.deleteOne
Inherited from AppRemoteService.deleteOne
- Defined in src/services/abstract.service.ts:227

getAll

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

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

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.
Implementation of IInvoiceBaseService.getDefaultOne
Inherited from AppRemoteService.getDefaultOne
- Defined in src/services/abstract.service.ts:152

getMany

getMany(params?, options?): Promise<IGetManyResult<IInvoice>>
Retrieves multiple entities with optional pagination and filtering.
Parameters
- params: any = {}
  [UNUSED PARAMETER, KEPT FOR POSSIBLE FUTURE USE] Filtering parameters.
- options: any = {}
  Query options including pagination.
Returns Promise<IGetManyResult<IInvoice>>
An object containing the retrieved entities and total count.
Implementation of IInvoiceBaseService.getMany
Inherited from AppRemoteService.getMany
- Defined in src/services/abstract.service.ts:164

getOne

getOne(uid): Promise<IInvoice>
get one by uid
Parameters
- uid: string
  Primary nano id
Returns Promise<IInvoice>
Implementation of IInvoiceBaseService.getOne
Inherited from AppRemoteService.getOne
- Defined in src/services/abstract.service.ts:144

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.
Implementation of IInvoiceBaseService.getOneByParams
Inherited from AppRemoteService.getOneByParams
- Defined in src/services/abstract.service.ts:148

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.
Implementation of IInvoiceBaseService.hasAny
Inherited from AppRemoteService.hasAny
- Defined in src/services/abstract.service.ts:135

liveQuery

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

roundingStep

roundingStep(total, roundingBase, rounding, roundingUp): number
Parameters
- total: number
- roundingBase: number
- rounding: number
- roundingUp: boolean
Returns number
Implementation of IInvoiceBaseService.roundingStep
- Defined in src/services/invoice.service.ts:271

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.
Implementation of IInvoiceBaseService.saveMany
Inherited from AppRemoteService.saveMany
- Defined in src/services/abstract.service.ts:122

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.
Implementation of IInvoiceBaseService.saveOne
Inherited from AppRemoteService.saveOne
- Defined in src/services/abstract.service.ts:111

updateMany

updateMany(items): Promise<IInvoice[]>
Parameters
- items: IInvoice[]
Returns Promise<IInvoice[]>
Implementation of IInvoiceBaseService.updateMany
Inherited from AppRemoteService.updateMany
- Defined in src/services/abstract.service.ts:224

updateOne

updateOne(id, item): Promise<IInvoice>
Parameters
- id: number
- item: Partial<IInvoice>
Returns Promise<IInvoice>
Implementation of IInvoiceBaseService.updateOne
Inherited from AppRemoteService.updateOne
- Defined in src/services/abstract.service.ts:221

Class InvoiceBaseService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

http: AxiosInstance

db: Dexie

options: IServiceOptions

moduleName: string = 'invoices'

methodName: string = 'invoice'

Returns InvoiceBaseService

Properties

Protected configService

Readonly db

Readonly http

Readonly methodName

Readonly moduleName

Readonly options

Protected printJobService

Protected printTemplateService

Protected printerService

Protected sectionItemService

Protected tillService

Methods

addOne

Parameters

item: IInvoice

Returns Promise<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

invoice: IInvoice

Returns void

calculateDiscount

Parameters

invoice: IInvoice

flow: CalcFlow

Returns void

calculateInvoiceServiceChargeableSubtotal

Parameters

invoice: IInvoice

Returns void

calculateLine

Parameters

line: IInvoiceLine

Returns void

calculateLines

Parameters

invoice: IInvoice

Returns void

calculatePointSubtotal

Parameters

invoice: IInvoice

Returns void

calculateRewardCredit

Parameters

invoice: IInvoice

aboveInvoiceAmount: number

includeServiceCharge: boolean

`Protected` configService

`Readonly` db

`Readonly` http

`Readonly` methodName

`Readonly` moduleName

`Readonly` options

`Protected` printJobService

`Protected` printTemplateService

`Protected` printerService

`Protected` sectionItemService

`Protected` tillService