Configure a Custom Filename for Statement PDF Email Attachments
Overview
When Aria emails a statement PDF to your customers, the system generates a filename for the attachment. By default, this filename uses a sequential number that does not map back to an account, statement, or invoice, which makes it difficult to track or index the file after your customers receive it.
You can configure a custom filename format for the statement PDF email attachment. The custom filename can include a combination of fields, such as the account number and the invoice number, so that your customers and your internal tools can identify the statement without opening the file.
Note: This setting controls only the filename of the PDF attachment in the email. It does not change the PDF file stored on the file system.
Configure the Custom Filename
Follow these steps to configure a custom filename for the statement PDF email attachment.
- Navigate to Configuration > Notifications > Notification Settings > Custom PDF Statement Filename.
- Select the checkbox next to each field you want to include in the filename. You can choose from the following fields:
- Account Client ID
- Account Number
- Aria Statement Number
- Aria Invoice Number
- Invoice Date
- Statement Sequence Number
- Drag the selected fields into the order you want them to appear in the filename. Click the "X" icon to remove a field.
- Review the filename preview to confirm the format matches what you want.
- Click Save.
Notes:
- You must select at least two fields to save a custom filename format. If you do not configure any fields, the system uses the default filename.
- Include at least one field that is unique to each statement, such as the Aria Statement Number or the Aria Invoice Number. This practice prevents duplicate filenames when your customers receive multiple statements.
- If your field selections do not appear in the filename preview, or the configuration does not save, clear your browser cache and try again
View the Configuration Status
The Notification Settings landing page shows the current status of this setting. The page displays Configured when you have saved a custom filename format, and Not Configured when you have not.
Retrieve the Custom Filename Through the API
If you retrieve statement data through the get_acct_statement_all_m API, the response includes the <custom_filename> field. This field returns the custom filename for the statement when you have configured one. If you have not configured a custom filename, the field returns a null value.