1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-08 20:22:42 +01:00
invoiceninja/docs/introduction.rst
2016-08-30 16:49:56 +03:00

112 lines
7.0 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Introduction
============
Lets get acquainted with a basic overview of the structure of the Invoice Ninja website. Once youve wrapped your mind around a few central concepts, its as easy as ABC to effectively manage your freelance business accounts.
The Invoice Ninja system is based on two main pillars:
- **List pages** are summary pages of the various activities in your account. These include the Clients list page, Tasks list page, Invoices list page and Payments list page. List pages are located in the main taskbar of the Invoice Ninja site. Simply click on Clients, Tasks, Invoices or Payments to open the list page you need. The list pages provide a centralized overview and management station for the particular component of your account. For example, the Clients list page is a list of all your clients, with accompanying information and handy links, so you can manage all your clients on one page.
- **Action pages** are pages dedicated to a specific action you can take in your Invoice Ninja account. Examples include Create New Client, Enter Credit, Create New Invoice, Create Recurring Invoice, Enter Credit, Enter Payment and Create New Task. All actions you take will be recorded in the List pages, updated in real time to reflect your invoicing activity from minute to minute.
So remember the ninja rule: **list pages provide a summary overview**, and **action pages facilitate your invoicing activity**.
Youre invited to browse the user guide for more detailed information. Were always looking to take Invoice Ninja one step ahead, so if you have any comments, queries or suggestions, wed love to hear from you.
Dashboard
^^^^^^^^^
Welcome to the Dashboard page of your Invoice Ninja account. This is the first page youll see when you login. It provides a general overview of the invoicing status of your freelance business. It is easy on the eye, and easy to digest. When you arrive at the Dashboard page, youll glimpse a comprehensive and user-friendly snapshot of whats going on right now in your invoicing world.
So lets jump right in and take a look at the different elements that make up your invoicing dashboard.
When you login to your Invoice Ninja account, youll automatically arrive on the Dashboard page. To go to the Dashboard page from anywhere in the site, click the Dashboard tab on the main taskbar.
The first thing youll notice about the Dashboard page is the three large data boxes at the top of the screen. These are designed to offer a simple yet powerful overview of your total business accounts:
- **Total Revenue**: The total amount that your business has brought in to date.
- **Average Invoice**: The amount of the current average invoice. Note this will change over time, depending upon your income.
- **Outstanding**: The total amount of all unpaid invoices.
.. TIP:: If you are being paid in a range of currencies, the three data boxes on your dashboard will display the relevant amounts in all currencies.
Below the three main data boxes, there are four windows summarizing different aspects of your invoicing activity.
Window 1: Notifications
"""""""""""""""""""""""
The Notifications list is incredibly useful as it presents an up-to-date, action-packed summary of what is happening across your entire invoicing account. Every action taken, whether by you or by one of your clients, is listed in chronological order, together with the date the action occurred. The list is updated in real time, with more recent actions showing first, so you get a minute-to-minute understanding of your invoicing activity.
The Notifications list includes all possible actions occurring within your Invoice Ninja account, including:
- Creating an invoice
- Sending an invoice
- Creating a new client
- Archiving/deleting a client
- Creating a credit
- Your client viewing your invoice
- Your client sending a payment
- And many, many more
.. TIP:: You can view a real-time tally of the number of invoices sent, displayed at the top right side of the blue Notifications header bar.
Window 2: Recent Payments
"""""""""""""""""""""""""
The Recent Payments list provides a summary of your clients payments, with the most recent payments showing at the top of the list. The Recent Payments list presents an overview of the following key information:
- **Invoice #**: The invoice reference number
- **Client**: The clients name
- **Payment Date**: The date the payment was made
- **Amount**: The amount of the payment. Note that the amount will be displayed in the currency in which it was paid.
.. NOTE:: In order for Invoices or Quotes to appear on the Dashboard page, the Due Date and Valid Until fields must be completed. Invoices or Quotes lacking this information will not be viewable on the Dashboard.
Window 3: Upcoming Invoices
"""""""""""""""""""""""""""
The Upcoming Invoices list provides a summary of all invoices with due dates approaching. The Upcoming Invoices list presents an overview of the following key information:
- **Invoice #**: The invoice reference number
- **Client**: The clients name
- **Due Date**: The due date of the payment
- **Balance Due**: The amount due
Window 4: Invoices Past Due
"""""""""""""""""""""""""""
The Invoices Past Due list provides a summary of all unpaid invoices. The Invoices Past Due list presents an overview of the following key information:
- **Invoice #**: The invoice reference number
- **Client**: The clients name
- **Due Date**: The original due date of the overdue payment
- **Balance**: Due The amount overdue
.. NOTE:: Archived invoices, payments and quotes will appear on the dashboard, and their amounts will be included in the account totals at the top of the page. Deleted invoices, payments and quotes will not appear, nor will their amounts be included on the Dashboard page.
Window 5: Upcoming Quotes
"""""""""""""""""""""""""
If you have a Pro account, the Dashboard will also include two extra windows displaying your Upcoming Quotes and Expired Quotes.
The Upcoming Quotes list provides a summary of all quotes with "Valid Until" dates approaching. The Upcoming Quotes list presents an overview of the following key information:
- **Quote**: # The quote reference number
- **Client**: The clients name
- **Due Date**: The valid until date
- **Balance Due**: The amount of the quote
Window 6: Expired Quotes
""""""""""""""""""""""""
The Expired Quotes list provides a summary of all quotes that have already passed their "Valid Until" date. The Expired Quotes list presents an overview of the following key information:
- **Quote #**: The quote reference number
- **Client**: The clients name
- **Due Date**: The valid until date
- **Balance Due**: The amount of the quote
.. TIP:: In addition to displaying a helpful overview of your invoicing activity, the Dashboard page is rich in clickable links, providing you with a shortcut to relevant pages you may wish to view. For example, all invoice numbers are clickable, taking you directly to the specific invoice page, and all client names are clickable, taking you directly to the specific client summary page.