zibri
    Preparing search index...

    Type Alias InvoicingOptions

    Options used throughout the plugin.

    type 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;
    }
    Index

    Properties

    bankDetailsLabel bankName bicLabel ceoLabel companyInfo dateLabel dueDateLabel emailLabel footerFontSize headline headlineFontSize ibanLabel images invoiceNumberLabel invoiceNumberNotice itemAmountLabel itemNameLabel itemSinglePriceLabel itemTotalPriceLabel logo numberCompanyAbbreviationCharacters numberOfDigits numberPrivateCustomerAbbreviationCharacters performanceDateLabel phoneLabel separator showDueDate showPerformanceDate tableFontSize taxLabel taxNumberLabel taxOffice totalAfterTaxLabel totalBeforeTaxLabel totalLabel

    Properties

    bankDetailsLabel: string

    The label for the bank details in the footer.

    'Bank details:'
    bankName: string | undefined

    The bank name to display in the footer. Can be omitted.

    bicLabel: string

    The label for the bic to display in the footer.

    'BIC/SWIFT:'
    ceoLabel: string

    The label for the ceo on the invoice.

    'CEO:'
    companyInfo: CompanyInfo

    The information about the company sending out the invoice.

    dateLabel: string

    The label for the date on the invoice.

    'Date'
    dueDateLabel: string

    The label for the due date on the invoice.

    'Due date'
    emailLabel: string

    The label for the email on the invoice.

    'E-Mail'
    footerFontSize: number

    The font size that should be used for the footer.

    10
    headline: string

    The headline of the invoice.

    'Invoice'
    headlineFontSize: number

    The font size of the headline.

    20
    ibanLabel: string

    The label for the iban to display in the footer.

    'IBAN:'
    images: Record<string, PdfImageDefinition> | undefined

    Globally defined images which can be referenced by name inside the document definition.

    undefined
    invoiceNumberLabel: string

    The label for the invoice number on the invoice.

    'Invoice No.'
    invoiceNumberNotice: string

    The notice below the invoice number.

    'Please specify when making payments and invoicing!'
    itemAmountLabel: string

    The label for item amount on the invoice.

    'Amount'
    itemNameLabel: string

    The label for item name on the invoice.

    'Name'
    itemSinglePriceLabel: string

    The label for single price of an item on the invoice.

    'Price'
    itemTotalPriceLabel: string

    The label for total price of an item on the invoice.

    'Total'
    logo: 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.

    undefined
    numberCompanyAbbreviationCharacters: number

    How many characters of the company name should be used in the invoice number.

    6
    numberOfDigits: number

    The number of digits used to generate the consecutive number.

    4
    numberPrivateCustomerAbbreviationCharacters: number

    How many characters of the private customer first and last name should be used in the invoice number.

    3
    performanceDateLabel: string

    The label for the date of performance on the invoice.

    'Date of performance'
    phoneLabel: string

    The label for the phone number on the invoice.

    'Phone'
    separator: string

    The separator for the parts of the invoice number.

    '-'
    showDueDate: boolean

    Whether or not a due date should be displayed on the invoice.

    true
    showPerformanceDate: boolean

    Whether or not a performance date should be displayed on the invoice.

    false
    tableFontSize: number

    The font size that should be used inside the tables.

    12
    taxLabel: string

    The label for tax value on the invoice.

    'VAT'
    taxNumberLabel: string

    The label for tax number on the invoice.

    'Tax number:'
    taxOffice: string | undefined

    The tax office to display in the footer. Can be omitted.

    totalAfterTaxLabel: string

    The label for the total after tax value on the invoice.

    'Total (incl. tax)'
    totalBeforeTaxLabel: string

    The label for the total before tax value on the invoice.

    'Total (excl. tax)'
    totalLabel: string

    The label for the total when no taxes exist on the invoice.

    'Total'

    Settings

    Member Visibility

    On This Page

    Properties