Interface ILineOperationService

Represents a service that provides operations for manipulating invoice lines.

Hierarchy

IInvoiceBaseService
- ILineOperationService
  - IInvoiceOperationService

Implemented by

LineOperationService

Properties

db

db: Dexie

moduleName

moduleName: string

Methods

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.
- 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.
- 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.
- 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.
- Defined in src/services/invoice.service.ts:564

addOne

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

calculate

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

calculateAddCredit

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

calculateChangeAmount

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

calculateCreditDeduction

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

calculateDeliveryCharge

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

calculateDiscount

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

calculateInvoiceServiceChargeableSubtotal

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

calculateLine

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

calculateLines

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

calculatePointSubtotal

calculatePointSubtotal(invoice): void
Parameters
- invoice: IInvoice
Returns void
Inherited from IInvoiceBaseService.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 IInvoiceBaseService.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 IInvoiceBaseService.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 IInvoiceBaseService.calculateRounding
- Defined in src/services/invoice.service.ts:49

calculateServiceCharge

calculateServiceCharge(invoice, rate): void
Parameters
- invoice: IInvoice
- rate: number
Returns void
Inherited from IInvoiceBaseService.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 IInvoiceBaseService.calculateTax
- Defined in src/services/invoice.service.ts:52

calculateTaxSubtotalRatio

calculateTaxSubtotalRatio(invoice): number
Parameters
- invoice: IInvoice
Returns number
Inherited from IInvoiceBaseService.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.
- Defined in src/services/invoice.service.ts:503

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.
- 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.
- 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.
- Defined in src/services/invoice.service.ts:572

deleteOne

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

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.
- 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 IInvoiceBaseService.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 IInvoiceBaseService.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 IInvoiceBaseService.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 IInvoiceBaseService.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 IInvoiceBaseService.getOneByParams
- Defined in src/services/abstract.service.ts:63

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 IInvoiceBaseService.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 IInvoiceBaseService.liveQuery
- Defined in src/services/abstract.service.ts:30

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.
- 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.
- Defined in src/services/invoice.service.ts:555

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.
- Defined in src/services/invoice.service.ts:580

roundingStep

roundingStep(total, roundingBase, rounding, roundingUp): number
Parameters
- total: number
- roundingBase: number
- rounding: number
- roundingUp: boolean
Returns number
Inherited from IInvoiceBaseService.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 IInvoiceBaseService.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 IInvoiceBaseService.saveOne
- Defined in src/services/abstract.service.ts:37

updateMany

updateMany(items): Promise<IInvoice[]>
Parameters
- items: IInvoice[]
Returns Promise<IInvoice[]>
Inherited from IInvoiceBaseService.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 IInvoiceBaseService.updateOne
- Defined in src/services/abstract.service.ts:206

Interface ILineOperationService

Hierarchy

Implemented by

Index

Properties

Methods

Properties

db

moduleName

Methods

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>

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

`Optional` modifiers: IInvoiceCoreLine[]

`Optional` options: LineOptions

`Optional` quantity: number