Class InvoiceCalcService

Default implementation of the invoice calculation service.

Implements

InvoiceCalcServiceInterface<Invoice>

Index

Constructors

Methods

getItemTotalPriceAfterTax getItemTotalPriceBeforeTax getItemTotalTax getTotalAfterTax getTotalBeforeTax getTotalBeforeTaxForTaxGroup getTotalTax getTotalTaxForTaxGroup

Constructors

constructor

new InvoiceCalcService(): InvoiceCalcService
Returns InvoiceCalcService

Methods

getItemTotalPriceAfterTax

getItemTotalPriceAfterTax(item: InvoiceItem): BigNumber
Gets the total price of an item after tax.
Parameters
- item: InvoiceItem
  The invoice item to get the price from.
Returns BigNumber
The total price before tax times 1 + tax/100.
Implementation of InvoiceCalcServiceInterface.getItemTotalPriceAfterTax
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:18

getItemTotalPriceBeforeTax

getItemTotalPriceBeforeTax(item: InvoiceItem): BigNumber
Gets the total price of an item before tax.
Parameters
- item: InvoiceItem
  The invoice item to get the price from.
Returns BigNumber
The amount of the item times its price.
Implementation of InvoiceCalcServiceInterface.getItemTotalPriceBeforeTax
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:13

getItemTotalTax

getItemTotalTax(item: InvoiceItem): BigNumber
Gets the total tax for the given item.
Parameters
- item: InvoiceItem
  The item to get the total tax from.
Returns BigNumber
The total price before tax times tax/100.
Implementation of InvoiceCalcServiceInterface.getItemTotalTax
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:25

getTotalAfterTax

getTotalAfterTax<Invoice extends Invoice>(invoice: Invoice): BigNumber
Gets the total price of an invoice after tax.
Type Parameters
- Invoice extends Invoice
Parameters
- invoice: Invoice
  The invoice to get the price from.
Returns BigNumber
The addition of the total price before tax and the total tax of the invoice.
Implementation of InvoiceCalcServiceInterface.getTotalAfterTax
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:40

getTotalBeforeTax

getTotalBeforeTax<Invoice extends Invoice>(invoice: Invoice): BigNumber
Gets the total price of an invoice before tax.
Type Parameters
- Invoice extends Invoice
Parameters
- invoice: Invoice
  The invoice to get the price from.
Returns BigNumber
The addition of the total price before tax of all items in the invoice. If this would be negative this returns 0.
Implementation of InvoiceCalcServiceInterface.getTotalBeforeTax
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:31

getTotalBeforeTaxForTaxGroup

getTotalBeforeTaxForTaxGroup<Invoice extends Invoice>(
    invoice: Invoice,
    group: Vat,
    groupOnlyByRate: boolean,
): BigNumber
Gets the total price of an invoice before tax.
Type Parameters
- Invoice extends Invoice
Parameters
- invoice: Invoice
  The invoice to get the price from.
- group: Vat
  The tax group to get the total before from.
- groupOnlyByRate: boolean
  Whether or not VAT groups are only determined by rate and not by category code.
Returns BigNumber
The addition of the total price before tax of all items in the invoice. If this would be negative this returns 0.
Implementation of InvoiceCalcServiceInterface.getTotalBeforeTaxForTaxGroup
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:66

getTotalTax

getTotalTax<Invoice extends Invoice>(invoice: Invoice): BigNumber
Gets the total tax of the invoice.
Type Parameters
- Invoice extends Invoice
Parameters
- invoice: Invoice
  The invoice to get the total tax from.
Returns BigNumber
The addition of the tax of all items of the invoice.
Implementation of InvoiceCalcServiceInterface.getTotalTax
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:47

getTotalTaxForTaxGroup

getTotalTaxForTaxGroup<Invoice extends Invoice>(
    invoice: Invoice,
    group: Vat,
    groupOnlyByRate: boolean,
): BigNumber
Gets the total tax for a specific tax group (eg. 19%).
Type Parameters
- Invoice extends Invoice
Parameters
- invoice: Invoice
  The invoice to get the total tax from.
- group: Vat
  The tax group for which the total tax should be calculated.
- groupOnlyByRate: boolean
  Whether or not VAT groups are only determined by rate and not by category code.
Returns BigNumber
The addition of the tax of all items that are in the provided tax group.
Implementation of InvoiceCalcServiceInterface.getTotalTaxForTaxGroup
- Defined in src/plugin/invoicing/services/invoice-calc.service.ts:56