Skip to main content

Configure and test default templates

📝 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.

📝 Note: If the AppDirect logo appears in the upper-left corner of the page, when Manage > Marketplace appears in this topic, click the grid icon > Switch to | Store, instead.

There is one default template in Active status for each language the marketplace supports. The AppDirect platform uses templates in Active status to generate PDF invoices. This feature is enabled by default for new marketplaces. If it is not enabled on your marketplace, contact your AppDirect technical representative.

important

The AppDirect platform uses the default templates to generate PDF invoices when users download them. We recommend that you use the procedure on this page to configure and test the default templates immediately. This ensures the PDF invoices that users download appear as you expect them to and avoid, for example, distorted logo images. Thereafter, you can publish templates that you tailor or build.

The default templates reference the following content that you define at Manage > Marketplace > Settings > Invoice settings :

  • Payable to (Seller's details) text formatted with Markdown syntax. It is referenced in the default template JavaScript Object Notation (JSON) with the {{Seller}} token.
  • Invoice logo. It is referenced in the default template JSON with the {{Invoice Logo}} token.
  • Memo content text formatted with Markdown syntax. It is referenced in the default template JSON with the {{Memo}} token.

Note that the same content that you configure on the Invoice settings page (see Configure invoice headers and content) appears when users view invoices on-screen and on PDF invoices that they download when the PDF invoice templates include one or more of those three tokens (see Tokens). You must test the on-screen and PDF outputs when you make changes on the Invoice settings page.

To configure and test the default template

  1. Go to one of the following to download the PDF version of an invoice that your marketplace issued to a user:
    • Manage > Marketplace > Invoices > {invoiceID} > Download
    • Manage > Marketplace > Users > {userID} > {invoiceID} > Download
    • Manage > Marketplace > Companies > {companyID} > Billing > {invoiceNumber} > Download
      The invoice downloads.
  2. Use PDF viewer software to review the invoice. When the Payable to, logo, and Memo content is acceptable, you are done. When any of them does not meet your expectations, continue to the next step to edit the content before you test the output again.
  3. Go to Manage > Marketplace > Settings > Invoice settings . The Invoice settings page opens.
  4. (Optional) Edit the Payable to (Seller details) field, then click Save.
  5. (Optional) Edit the Invoice logo URL to change the image that appears on invoices. The URL for an image that you store on a content file server such as Amazon S3, then click Save.
  6. (Optional) Edit the Memo field, then click Save.
  7. Repeat this procedure until the PDF invoice output is acceptable.

Was this page helpful?