File Name Pattern Configuration for Billing Documents

Knowledge Center > Billing and Payments > Billing Settings > File Name Pattern Configuration for Billing Documents

File Name Pattern Configuration for Billing Documents

You can configure the name patterns for the files that are generated for billing documents, including invoices, credit memos, and debit memos. 

The Credit and Debit Memos feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

With configurable file name patterns, you can reflect more information in the names of the files that are generated for billing documents.

Configuration

You can use the supported merge field tags to configure the name patterns for the files that are generated for billing documents. A supported merge field tag consists of a supported data source object and its corresponding field.

The following table lists the default file name patterns for billing documents.

Billing Document Type File Name Pattern
Invoices <Invoice.InvoiceNumber>_<Account.AccountNumber>_<Invoice.InvoiceDate>
Credit memos <CreditMemo.MemoNumber>_<Account.AccountNumber>_<CreditMemo.MemoDate>
Debit memos <DebitMemo.MemoNumber>_<Account.AccountNumber>_<DebitMemo.MemoDate>

You can manage file name patterns for billing documents with the following operations from the Zuora UI:

Supported Data Source Objects

A supported merge field tag consists of a supported data source object and its corresponding field.

The following table lists the data source objects supported by invoices, credit memos, and debit memos.

Billing Document Type Invoices Credit memos Debit memos
Supported Data Source Objects
  • Account
  • Bill To
  • Bill To Contact Snapshot
  • Default Payment Method
  • Invoice
  • Parent Account
  • Sold To
  • Sold To Contact Snapshot
  • Account
  • Bill To
  • Bill To Contact Snapshot
  • Default Payment Method
  • Invoice
  • Parent Account
  • Sold To
  • Sold To Contact Snapshot
  • Credit Memo
  • Account
  • Bill To
  • Bill To Contact Snapshot
  • Default Payment Method
  • Invoice
  • Parent Account
  • Sold To
  • Sold To Contact Snapshot
  • Debit Memo

Limitations

When configuring file name patterns for billing documents, keep the following limitations in mind:

  • The file name pattern configured for billing documents can contain a maximum of 300 characters.
  • The file name pattern configured for billing documents can only contain supported data source merge field tags, alphabetic letters, digits, underscores, and dashes.
  • The file name pattern configured for billing documents must contain at least one supported data source merge field tag.
  • The name of files generated for billing documents can contain a maximum of 255 characters.
  • The final name of files generated for billing documents can contain only alphabetic letters, digits, dashes, and underscores. For example, INV00000013_A00000005_05132019.doc.
  • In the name of files generated for billing documents, any continuous spaces, dashes, and dots are replaced with only one dash; any other characters are removed from the final file name.
  • In the names of files generated for billing documents, the format of date type fields is MMDDYYYY. For example, INV00000391_A00000610_04242019.pdf.
Last modified

Tags

Classifications

(not set)