invoiceninja/docs/reports.rst

Reports
=======

It's easy to get caught up in the job you are currently working on, sending invoices and chasing payments. But it's just as important to take a step back from time to time, and to look at the bigger picture of how your freelance business is doing.

The Reports function helps you do just that. You can define your parameters and extract the exact information you need to generate a range of reports.

Report Settings
"""""""""""""""

The Report Settings section enables you to set parameters and filter the data to generate the right report for you.

- **Type**: Click on the drop-down menu and choose the type of report you want to create. There's a wide range of report types to choose from, such as Invoice, Payment, Client, Quote, Expense, Profit and Loss, and more.

- **Date Range**: Click on the drop-down menu and choose the desired date range of your report. There are a number of pre-defined ranges to choose from, such as Last 7 Days, Last Month, Last Year and This Year. Or you can select a custom date range with the Start and End calendars. Click Apply to implement the custom range.

- **Group Sort**: You can sort the report results according to various parameters. Click the drop-down menu to select a sort function from the options available for the chosen report type.

.. TIP:: For some report types, there is an extra filter function that you can apply. When you select a report type that has an extra filter function, the filter field will automatically appear beneath the Group Sort field. For example, if you select Invoice report type, a field will appear below Group Sort that allows you to filter the report according to invoice status.

- **Run**: Once you've selected all the parameters, click the green Run> button. The extracted data will show in the report display section below.  TIP: When you click Run>, the report will generate automatically, and includes only the relevant columns and data, based on the type of reports and dates selected. To view another report, simply change your selections and click Run>.

- **Export**: To export the report data, click the gray Export button. The report will automatically download as a .csv file. If you want to export the data as an Excel, PDF or Zip file, click the drop-down menu at the left of the Export button and choose the desired file type. Then click Export. The file will download in the format you selected.

- **Schedule**: Don't have the time or mindspace to remember to download reports? You don't have to! With the Schedule feature, you can pre-select reports to be automatically generated at a frequency of your choosing, and sent to the email address linked to your Invoice Ninja account.

To schedule receiving the defined report, click the blue Schedule button.

In the pop-up box, select the Frequency you'd like to receive the report. Options include Daily, Weekly, Biweekly or Monthly. Then select the Start Date from when you want to begin receiving the report.

After the report has been scheduled, you'll see a gray Cancel Schedule button on your Reports page. You can cancel the scheduled report at any time by clicking on the cancel button.

Calendar
""""""""

Want a calendar style visualization of your Invoice Ninja activity? Click the gray Calendar button that appears at the top right of the Reports page. You can view details of Invoices, Payments, Quotes, Projects, Tasks and Expenses on the dates they occurred on the calendar.

The calendar will include details of all transactions by default. To filter the calendar so it only displays some of your invoicing data, click inside the Filter field at the top right of the page. Select your desired filters from the drop-down menu.

The calendar is customizable so you can create your preferred view. At the top right of the calendar, there are 4 periodic views tabs to choose from: Month, Week, Day or List. Click the preferred tab and the view will change automatically.

Select today's date by clicking the Today tab at the top left of the calendar. Or click the left or right arrows to move between time periods.