Class InvoiceNumberService

Default implementation of the invoice number service.

Implements

InvoiceNumberServiceInterface<InvoiceAddress>

Index

Constructors

Methods

generateInvoiceNumber generateTemporaryInvoiceNumber

Constructors

constructor

new InvoiceNumberService(
    invoiceRepository: Repository<Invoice>,
    numberInvoicesRepository: Repository<
        NumberInvoices,
        OmitStrict<NumberInvoices, "id">,
        OmitStrict<NumberInvoices, "id">,
    >,
    options: InvoicingOptions,
): InvoiceNumberService
Parameters
- invoiceRepository: Repository<Invoice>
- numberInvoicesRepository: Repository<
      NumberInvoices,
      OmitStrict<NumberInvoices, "id">,
      OmitStrict<NumberInvoices, "id">,
  >
- options: InvoicingOptions
Returns InvoiceNumberService
- Defined in src/plugin/invoicing/services/invoice-number.service.ts:13

Methods

generateInvoiceNumber

generateInvoiceNumber(
    recipientId: string,
    invoiceAddress: InvoiceAddress,
    transaction: undefined | Transaction,
    nameAbbreviation?: string,
): Promise<string>
Generates a new invoice number.
Parameters
- recipientId: string
  The id of the recipient of the invoice.
- invoiceAddress: InvoiceAddress
  The address data of the recipient of the invoice.
- transaction: undefined | Transaction
  An optional transaction from outside to make sure any changes only apply when the transaction is committed.
- OptionalnameAbbreviation: string
  An optional name abbreviation if you don't want to generate one.
Returns Promise<string>
A promise of the new invoice number.
Implementation of InvoiceNumberServiceInterface.generateInvoiceNumber
- Defined in src/plugin/invoicing/services/invoice-number.service.ts:27

generateTemporaryInvoiceNumber

generateTemporaryInvoiceNumber(
    recipientId: string,
    invoiceAddress: InvoiceAddress,
    nameAbbreviation?: string,
): Promise<string>
Generates a temporary invoice number with the prefix "TEMP". This does not increase the number of invoices which can be helpful if you create an invoice that might not be sent out.
Parameters
- recipientId: string
  The id of the recipient of the invoice.
- invoiceAddress: InvoiceAddress
  The address data of the customer.
- OptionalnameAbbreviation: string
  An optional name abbreviation if you don't want to generate one.
Returns Promise<string>
A promise of the new temporary invoice number.
Implementation of InvoiceNumberServiceInterface.generateTemporaryInvoiceNumber
- Defined in src/plugin/invoicing/services/invoice-number.service.ts:43