Custom Invoice report

Custom Invoice report

Category

Documents and diagrams

Category

Documents and diagrams

Description

Generates a printable invoice from Jira worklogs and an hourly rate, with your company and recipient details.

Overview

The Custom Invoice report turns Jira worklogs into a printable invoice. Each issue with time logged in the selected period becomes one line: the logged hours are the quantity, and your hourly rate is the unit price. Your company details, the recipient and your contact information fill the header and the footer.

Custom Invoice report with the invoice preview and the Configure panel

Custom Invoice is a scripted report: the invoice layout is written in HTML and JavaScript, so you can change it to match your own branding.

Create the report

In Report Builder, open the Templates tab and type Invoice in the search field. Click the Custom Invoice template.

The invoice preview opens on the left and the Configure panel on the right. Above the preview are the tabs Preview, Fields, Permissions, Template, Script, Split editor and External editor. Stay on Preview to fill in the invoice.

If the selected issues have no worklogs in the period, you see Nothing was found for the selected scope and filters. Change Issues or Range as described below.

Select the issues and the period

  • Issues — the projects, issues or saved filters to bill. Only these issues can appear as invoice lines.

  • Range — the period of worklogs to include. Pick a start and an end date in the calendar, or choose a relative period on the right: Today, Yesterday, This Week, Last Week, This Month, Last Month, or a number of days up to today / days starting from today. The default is Last Month.

Range picker with the Relative Date Filter options

A relative period such as Last Month moves with the calendar, so a saved report always bills the previous month.

Set the invoice number and the rate

  • Invoice number — shown next to the Invoice title.

  • Hourly Rate — the price per logged hour. The default is 100.

Add your company and the recipient

  • Link to Company Logo — the URL of your logo image, shown in the top-left corner.

  • Company Name and Company Address — your details under the logo.

  • Recipient Company Name and Recipient Company Address — the customer, shown under To.

  • Telephone, Fax, Email and Web Address — the contact block at the bottom of the invoice.

After you change a field, click Refresh (↻) next to Add to My Reports to update the invoice.

Read the invoice

Invoice table with Subtotal, Total Due By Date and the contact block
  • Date — the date the report is run.

  • Quantity — the hours logged on the issue in the selected period.

  • Description — the issue key and summary.

  • Unit Price — the hourly rate.

  • Total — Quantity × Unit Price.

  • Subtotal and Total Due By Date — the sum of all lines.

The layout, the currency sign and the columns are defined in the template code. To change them, edit the Template (HTML) and Script (JavaScript) tabs, or open both side by side in Split editor. Use Fields to add or rename the fields in the Configure panel.

Save, print and export

Click Add to My Reports to save the invoice settings as your own report. Changes to the template are not saved until you do this.

The ••• menu next to it has more options:

  • Save as… — save a copy under a new name.

  • Print — print the invoice.

  • Export To PDF (as Image) — download the invoice as a PDF.

  • Export JSON — download the report definition, for example to import it on another Jira site with the Import Scripted Report template.