View template information

📝 Note: This feature only supports invoice template customizations. Document Builder, which supports both invoice and quote template customizations, might be available on your marketplace. For more information, see Document Builder.

Marketplace Managers can view invoice template information as follows:

• On the Invoice templates listing page, you see all of the PDF templates.
• On the Invoice template details page, you see details for one invoice.

To view the invoice templates listing page

Go to Manage > Marketplace > Settings > Invoice templates . The Invoice templates listing page opens. Following is a description of the information and options displayed on the page:

• Invoice template list—Lists all PDF templates. The list includes at minimum one default AppDirect template for each language that the marketplace supports.
  • Search—Enter the template file name (or a portion of the name) to find a specific template.
  • Filters—Use one or a combination of the following filters:
    • Language—The language associated with each template. For each language that the marketplace supports, there is one default template. There can be an unlimited number of user-defined templates, and there is at least one template in Active status.
    • Template type
      • Default template—AppDirect -provided default templates.
      • User-defined template—Templates that users create.
    • Status
      • Active—Templates that the AppDirect platform uses to generate PDF invoices when users download them.
      • Not Active—Templates that the AppDirect platform does not use to generate PDF invoices when users download them. This includes templates that were active and have been deactivated.
  • Name column—Toggle the column heading to reverse how the list is displayed (in alphabetical order). Each template has a unique name.
  • Last modified column—Toggle the column to reverse the order in which templates are displayed, based on when they were last update (user-modified templates only).
  • Gear icon drop-down list
    • Copy Template—Create a new template that you can edit, or to save the template as backup of the current state of the original template. For more information, see Copy templates.
    • Download JSON—Download the JSON file for the template. The JSON for default templates is also the template JSON structure. For more information, see Download template JSON files.
    • Edit JSON—For user-defined templates only. Opens the Edit JSON page. For more information, see Edit JSON templates.
• Add custom templates pane
  • JSON Structure—Download the generic JSON template structure (this is the same as the JSON you can download from the default invoice for the primary language of your marketplace at {defaultTemplateInvoiceName} | Gear icon > Download JSON). For more information, see Download template JSON files.
  • Add Template—Opens the New Template page to create a new template. For more information, see Add new templates.
  • Learn More—Opens the Invoice templates user documentation.

To view the invoice template details page

1. Go to Manage > Marketplace > Settings > Invoice templates . The Invoice Templates listing page opens.
2. Click invoiceName. The invoice details page opens. The upper pane displays the following:
   • Template name
   • Status
     • Active—The AppDirect platform uses this template to generate PDF invoices when users download them.
     • Not active—The AppDirect platform does not use this template to generate PDF invoices when users download them. On this page, only templates that have never been active appear with the Not active status.
     • Deactivated—Templates that were in Active status and are Not active now, appear as Deactivated with the date of deactivation and the name of the user who published the alternative invoice for the same language.
   • Created—(User-defined templates only) The date the user created the template. Replaced with Last updated after you have edited it.
   • Last updated—(User-defined templates only) The date the last edits were saved, and the name of the user who made the edits.
   • Language—The language associated with the template.
   • Publish—Available for templates in Not Active and deactivated status, and templates in Active status that you have edited since they were last published. The Publish button is active when there are unpublished changes. It is inactive when there are no changes to publish. For more information, see Publish templates.
   • Gear icon drop-down list (user-defined templates only):
     • Rename—Option to rename the template. The name must be unique among templates associated with the same language.
     • Copy template—Option to copy the template, name the copy, and publish the template. For more information, see Copy templates.
   • Copy template—(Default templates only.) Option to copy the template, name the copy, and publish the template. For more information, see Copy templates.
   • Template preview—By default, displays the template view (no data populated) of the most current version .
     • Last updated drop-down list—Option to select to view the published version, or the last-updated version.
       When you have made no changes since you published the template, the published version of the template is the same as the last updated version.
       When you have edited the template since you last published it (the last update is more recent than the published date), the last updated version will be more recent than the published version and there are unpublished changes.
       The Publish button is active when there are unpublished changes. It is inactive when there are no changes to publish.
     • Hidden template preview pane menu bar—Pause on the space between the top of the invoice preview page and the upper edge of the preview pane. A menu bar appears with the following options:
       • Template ID—Unique identifier for the template version.
       • Rotate icon—Turn the preview page 90 degrees clockwise.
       • Download icon—Download a PDF of the template preview (displays no data).
       • Print icon—Print a PDF of the template preview (displays no data).
   • Export JSON—Export the template JSON for the version selected in the Last Updated drop-down list.
   • Preview PDF—The preview pane displays the template populated with mock data.
     • The Hidden PDF preview pane menu bar is the same as for the template preview, except that the download icon prompts the download of a PDF of the template populated with mock data.
   • Edit JSON—Go to the Edit JSON page to edit the template.