Type Alias InvoicingOptions

InvoicingOptions: {
    bankDetailsLabel: string;
    bankName: string | undefined;
    bicLabel: string;
    ceoLabel: string;
    companyInfo: CompanyInfo;
    dateLabel: string;
    dueDateLabel: string;
    emailLabel: string;
    footerFontSize: number;
    headline: string;
    headlineFontSize: number;
    ibanLabel: string;
    images: Record<string, PdfImageDefinition> | undefined;
    invoiceNumberLabel: string;
    invoiceNumberNotice: string;
    itemAmountLabel: string;
    itemNameLabel: string;
    itemSinglePriceLabel: string;
    itemTotalPriceLabel: string;
    logo: string | undefined;
    numberCompanyAbbreviationCharacters: number;
    numberOfDigits: number;
    numberPrivateCustomerAbbreviationCharacters: number;
    performanceDateLabel: string;
    phoneLabel: string;
    separator: string;
    showDueDate: boolean;
    showPerformanceDate: boolean;
    tableFontSize: number;
    taxLabel: string;
    taxNumberLabel: string;
    taxOffice: string | undefined;
    totalAfterTaxLabel: string;
    totalBeforeTaxLabel: string;
    totalLabel: string;
}

Options used throughout the plugin.

Type declaration

ReadonlybankDetailsLabel: string
The label for the bank details in the footer.
Default
```
'Bank details:'
```
ReadonlybankName: string | undefined
The bank name to display in the footer. Can be omitted.
ReadonlybicLabel: string
The label for the bic to display in the footer.
Default
```
'BIC/SWIFT:'
```
ReadonlyceoLabel: string
The label for the ceo on the invoice.
Default
```
'CEO:'
```
ReadonlycompanyInfo: CompanyInfo
The information about the company sending out the invoice.
ReadonlydateLabel: string
The label for the date on the invoice.
Default
```
'Date'
```
ReadonlydueDateLabel: string
The label for the due date on the invoice.
Default
```
'Due date'
```
ReadonlyemailLabel: string
The label for the email on the invoice.
Default
```
'E-Mail'
```
ReadonlyfooterFontSize: number
The font size that should be used for the footer.
Default
```
10
```
Readonlyheadline: string
The headline of the invoice.
Default
```
'Invoice'
```
ReadonlyheadlineFontSize: number
The font size of the headline.
Default
```
20
```
ReadonlyibanLabel: string
The label for the iban to display in the footer.
Default
```
'IBAN:'
```
Readonlyimages: Record<string, PdfImageDefinition> | undefined
Globally defined images which can be referenced by name inside the document definition.
Default
```
undefined
```
ReadonlyinvoiceNumberLabel: string
The label for the invoice number on the invoice.
Default
```
'Invoice No.'
```
ReadonlyinvoiceNumberNotice: string
The notice below the invoice number.
Default
```
'Please specify when making payments and invoicing!'
```
ReadonlyitemAmountLabel: string
The label for item amount on the invoice.
Default
```
'Amount'
```
ReadonlyitemNameLabel: string
The label for item name on the invoice.
Default
```
'Name'
```
ReadonlyitemSinglePriceLabel: string
The label for single price of an item on the invoice.
Default
```
'Price'
```
ReadonlyitemTotalPriceLabel: string
The label for total price of an item on the invoice.
Default
```
'Total'
```
Readonlylogo: string | undefined
Available options:
- A reference by name to an image defined in PdfMakeDocumentDefinition.images
- A data URL
- A remote URL via http:// or https://.
Supported image formats: JPEG, PNG.
Default
```
undefined
```
ReadonlynumberCompanyAbbreviationCharacters: number
How many characters of the company name should be used in the invoice number.
Default
```
6
```
ReadonlynumberOfDigits: number
The number of digits used to generate the consecutive number.
Default
```
4
```
ReadonlynumberPrivateCustomerAbbreviationCharacters: number
How many characters of the private customer first and last name should be used in the invoice number.
Default
```
3
```
ReadonlyperformanceDateLabel: string
The label for the date of performance on the invoice.
Default
```
'Date of performance'
```
ReadonlyphoneLabel: string
The label for the phone number on the invoice.
Default
```
'Phone'
```
Readonlyseparator: string
The separator for the parts of the invoice number.
Default
```
'-'
```
ReadonlyshowDueDate: boolean
Whether or not a due date should be displayed on the invoice.
Default
```
true
```
ReadonlyshowPerformanceDate: boolean
Whether or not a performance date should be displayed on the invoice.
Default
```
false
```
ReadonlytableFontSize: number
The font size that should be used inside the tables.
Default
```
12
```
ReadonlytaxLabel: string
The label for tax value on the invoice.
Default
```
'VAT'
```
ReadonlytaxNumberLabel: string
The label for tax number on the invoice.
Default
```
'Tax number:'
```
ReadonlytaxOffice: string | undefined
The tax office to display in the footer. Can be omitted.
ReadonlytotalAfterTaxLabel: string
The label for the total after tax value on the invoice.
Default
```
'Total (incl. tax)'
```
ReadonlytotalBeforeTaxLabel: string
The label for the total before tax value on the invoice.
Default
```
'Total (excl. tax)'
```
ReadonlytotalLabel: string
The label for the total when no taxes exist on the invoice.
Default
```
'Total'
```

Type Alias InvoicingOptions

Type declaration

ReadonlybankDetailsLabel: string

Default

ReadonlybankName: string | undefined

ReadonlybicLabel: string

Default

ReadonlyceoLabel: string

Default

ReadonlycompanyInfo: CompanyInfo

ReadonlydateLabel: string

Default

ReadonlydueDateLabel: string

Default

ReadonlyemailLabel: string

Default

ReadonlyfooterFontSize: number

Default

Readonlyheadline: string

Default

ReadonlyheadlineFontSize: number

Default

ReadonlyibanLabel: string

Default

Readonlyimages: Record<string, PdfImageDefinition> | undefined

Default

ReadonlyinvoiceNumberLabel: string

Default

ReadonlyinvoiceNumberNotice: string

Default

ReadonlyitemAmountLabel: string

Default

ReadonlyitemNameLabel: string

Default

ReadonlyitemSinglePriceLabel: string

Default

ReadonlyitemTotalPriceLabel: string

Default

Readonlylogo: string | undefined

Default

ReadonlynumberCompanyAbbreviationCharacters: number

Default

ReadonlynumberOfDigits: number

Default

ReadonlynumberPrivateCustomerAbbreviationCharacters: number

Default

ReadonlyperformanceDateLabel: string

Default

ReadonlyphoneLabel: string

Default

Readonlyseparator: string

Default

ReadonlyshowDueDate: boolean

Default

ReadonlyshowPerformanceDate: boolean

Default

ReadonlytableFontSize: number

Default

ReadonlytaxLabel: string

Default

ReadonlytaxNumberLabel: string

Default

ReadonlytaxOffice: string | undefined

ReadonlytotalAfterTaxLabel: string

Default

ReadonlytotalBeforeTaxLabel: string

Default

ReadonlytotalLabel: string

Default

Settings

`Readonly`bankDetailsLabel: string

`Readonly`bankName: string | undefined

`Readonly`bicLabel: string

`Readonly`ceoLabel: string

`Readonly`companyInfo: CompanyInfo

`Readonly`dateLabel: string

`Readonly`dueDateLabel: string

`Readonly`emailLabel: string

`Readonly`footerFontSize: number

`Readonly`headline: string

`Readonly`headlineFontSize: number

`Readonly`ibanLabel: string

`Readonly`images: Record<string, PdfImageDefinition> | undefined

`Readonly`invoiceNumberLabel: string

`Readonly`invoiceNumberNotice: string

`Readonly`itemAmountLabel: string

`Readonly`itemNameLabel: string

`Readonly`itemSinglePriceLabel: string

`Readonly`itemTotalPriceLabel: string

`Readonly`logo: string | undefined

`Readonly`numberCompanyAbbreviationCharacters: number

`Readonly`numberOfDigits: number

`Readonly`numberPrivateCustomerAbbreviationCharacters: number

`Readonly`performanceDateLabel: string

`Readonly`phoneLabel: string

`Readonly`separator: string

`Readonly`showDueDate: boolean

`Readonly`showPerformanceDate: boolean

`Readonly`tableFontSize: number

`Readonly`taxLabel: string

`Readonly`taxNumberLabel: string

`Readonly`taxOffice: string | undefined

`Readonly`totalAfterTaxLabel: string

`Readonly`totalBeforeTaxLabel: string

`Readonly`totalLabel: string