Build footers

The footer is a required element that defines the placement and style for a default footer. You must add at least one row component to it. Within the row(s), you add cells to contain the content that appears on invoices.

The displayFooterOnFirstPage property (see Build pages) determines whether a footer appears on all pages or on all pages except the first page, as shown in the following table.

default footer is defined in footer section displayFooterOnFirstPage setting in page properties Result
Yes true Default footer appears on all pages.
Yes false Default footer appears on all pages except the first page.

Prerequisites

None.

Optional: Set displayFooterOnFirstPage in page properties (see Build pages).

Default template JSON sample

In the Appdirect Template_EN_US default template, see lines 2-48.

To download the default template, go to .

JSON structure context for footer

Footer is one of three sections in the highest-level template structure, in addition to page.

{
    "page": {},
    "header": {},
    "body": {},
    "footer": {}
}

Footer JSON schema

{
  "footer": {
    "default": {
      "type": "footer",
      "style": {},
      "properties": {},
      "components": []
    }
  }
}

Elements to build footer components

Element       Type Description
footer       object

Required. Defines content, styles, and behaviors for page footers.

  default     object Required. Defines the default footer component. On which pages the invoice displays it is subject to other settings (see the introduction for this topic).
    type   string

Required. Defines the component type as footer.

Valid value:

footer
    style   object

Required. Defines formatting for default footer.

Valid values: HTML element names and CSS styles for the named HTML element.

All HTML styles. Only relevant styles that the Invoice Builder can render appear in the user interface preview and the PDF.

      height string

Required. Defines footer height.

HTML style name and CSS style.

Example:

"height": "40px"
    properties   object

Required. Define visibility.

    components   array

Required. Style and elementary components that define content, and the location of content, in the footer. Requires at least one row.

Valid values:

row
verticalSpacer

See:

Build row components

Build vertical spacers