Here is the list of the default variables that can be used within filenames for Paperless-ngx:

  • {{ asn }}: The archive serial number of the document, or “none”.
  • {{ correspondent }}: The name of the correspondent, or “none”.
  • {{ document_type }}: The name of the document type, or “none”.
  • {{ tag_list }}: A comma separated list of all tags assigned to the document.
  • {{ title }}: The title of the document.
  • {{ created }}: The full date (ISO 8601 format, e.g. 2024-03-14) the document was created.
  • {{ created_year }}: Year created only, formatted as the year with century.
  • {{ created_year_short }}: Year created only, formatted as the year without century, zero padded.
  • {{ created_month }}: Month created only (number 01-12).
  • {{ created_month_name }}: Month created name, as per locale
  • {{ created_month_name_short }}: Month created abbreviated name, as per locale
  • {{ created_day }}: Day created only (number 01-31).
  • {{ added }}: The full date (ISO format) the document was added to paperless.
  • {{ added_year }}: Year added only.
  • {{ added_year_short }}: Year added only, formatted as the year without century, zero padded.
  • {{ added_month }}: Month added only (number 01-12).
  • {{ added_month_name }}: Month added name, as per locale
  • {{ added_month_name_short }}: Month added abbreviated name, as per locale
  • {{ added_day }}: Day added only (number 01-31).
  • {{ owner_username }}: Username of document owner, if any, or “none”
  • {{ original_name }}: Document original filename, minus the extension, if any, or “none”
  • {{ doc_pk }}: The paperless identifier (primary key) for the document.

NOTE

Refer to Paperless-ngx documentation - Placeholders for more information.