diff --git a/docs/clients.rst b/docs/clients.rst index c8987850e789..7123dd1abcb1 100644 --- a/docs/clients.rst +++ b/docs/clients.rst @@ -10,13 +10,10 @@ List Clients The Clients page is a list page that presents a summary of all your clients in a user-friendly table. Think of your Clients page as the “central station” of your invoicing activity. Most of your day-to-day invoicing actions can be taken from the various links and buttons that appear on the Clients list page. Now, we’ll take a closer look at the setup of the Clients page, and the range of actions available to you on the Clients page. -Let’s Begin -^^^^^^^^^^^ - To view your client list page, go to the main taskbar and click the Clients tab. -Understanding the Clients page -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Overview +^^^^^^^^ The Clients page presents a list summary of all your current clients in a table format. The main elements of the table include: @@ -28,8 +25,8 @@ The Clients page presents a list summary of all your current clients in a table - **Balance:** The client’s payment balance - **Action:** A range of actions you can take to manage activity relating to the selected client -Action -^^^^^^ +Actions +^^^^^^^ To select an action for a particular client, hover with your mouse anywhere in the row entry of the client. A gray Select button will appear. Click on the Select arrow and a drop-down list will open. @@ -58,8 +55,8 @@ Filter the clients list by completing the Filter field, situated at the top righ .. Tip:: Need to search for a specific client in your Clients list? Start typing the first letters of the client's name and the filter will automatically present the relevant listings. -Archiving/Deleting Clients -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Archiving/Deleting +^^^^^^^^^^^^^^^^^^ To archive or delete a specific client, hover over the client entry row, and open the Action drop-down list. Select Archive client or Delete client from the list. The Clients table will automatically refresh. Archived clients will appear in the table with a lighter gray font color, while deleted clients are hidden from view. Note: You can also archive or delete one or more clients via the gray Archive button that appears at the top left side of the Clients table. To archive or delete clients, check the relevant clients in the check boxes that appear in the far left column next to the client name. Then click on the Archive button, open the drop-down list and select the desired action. @@ -87,8 +84,7 @@ There are two ways to enter a new client: Here, we’re going to focus on entering a new client via the Create Client page. -Let’s Begin -^^^^^^^^^^^ +**Let’s Begin** To enter a new client, go to the Clients tab, open the drop-down menu, and click on New Client. This will open the Create Client page. diff --git a/docs/credits.rst b/docs/credits.rst index f01bbfa6a677..843f23d74595 100644 --- a/docs/credits.rst +++ b/docs/credits.rst @@ -8,8 +8,8 @@ Your workload and fee structure vary from client to client. What’s more, your At times, payments can get really tricky. Perhaps you’ve been paid in advance for work that has been delayed, or maybe the scope of work changed and you were overpaid. Whatever the reason, there will come a time when you will need to issue a credit to your client’s account. This is where the Credits function comes in handy. -Understanding the Credits List -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Overview +^^^^^^^^ The Credits list page is a summary of all credits issued to all clients. @@ -23,8 +23,8 @@ On the Credits page, credit information is presented in a simple, user-friendly - **Private Notes**: Comments or reminders that you included FYI - **Action**: Option to archive or delete the credit -Archiving/Deleting Credits -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Archiving/Deleting +^^^^^^^^^^^^^^^^^^ To archive or delete a credit, hover over the credit entry row, and open the Action drop-down list. Select Archive credit or Delete credit from the list. The Credits table will automatically refresh, and archived or deleted credits will no longer appear in the list. @@ -35,8 +35,8 @@ Want to view archived or deleted credits? Check the box marked Show archived/del - Deleted credits are displayed with a red Deleted button. To restore deleted credits, hover on the red Deleted button. A gray Select button will appear. Click on the Select arrow, and select Restore credit in the drop-down list. - Archived credits are displayed with an orange Archived button. To restore or delete the archived credit, hover on the orange Archived button. A gray Select button will appear. Click on the Select arrow, and choose Restore credit from the drop-down list. To delete an archived credit, select Delete credit from the drop-down list of the Select button. -Sorting & Filtering Credit Information -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Sorting & Filtering +^^^^^^^^^^^^^^^^^^^ The sort and filter functions make it easy for you to manage and analyze your credits. @@ -50,8 +50,7 @@ Enter Credit Creating a new credit is fast and simple. Remember, all credits you create will appear in the Credits list page. -Let’s Begin -^^^^^^^^^^^ +**Let’s Begin** To issue a credit, you’ll need to open the Credits / Create page. @@ -63,8 +62,8 @@ There are three ways to open this page: Ok, so you’ve successfully landed on the Credits / Create page. -How to Create a New Credit -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Overview +^^^^^^^^ The Credits / Create page has four fields for you to complete. Let’s take a closer look at each field: diff --git a/docs/introduction.rst b/docs/introduction.rst index 51290d8baeab..293120e2edbf 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -22,9 +22,6 @@ So let’s jump right in and take a look at the different elements that make up When you login to your Invoice Ninja account, you’ll 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. -Understanding the Dashboard Page -"""""""""""""""""""""""""""""""" - The first thing you’ll 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. @@ -88,14 +85,11 @@ The Invoices Past Due list provides a summary of all unpaid invoices. The Invoic .. 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. -Quotes (Pro Plan Users Only) -"""""""""""""""""""""""""""" - -If you have a Pro account, the Dashboard will also include two extra windows displaying your Upcoming Quotes and Expired Quotes. - 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: diff --git a/docs/invoices.rst b/docs/invoices.rst index e0b84c0ff442..e4cf3f4bfdd6 100644 --- a/docs/invoices.rst +++ b/docs/invoices.rst @@ -10,6 +10,9 @@ List Invoices With numerous invoices to keep track of, the Invoices list page is your go-to guide for the entire history and status of all your invoices – including those that have been paid, those sent but unpaid, and those still in the drafting and editing stage. +Overview +^^^^^^^^ + The life of an invoice in the Invoice Ninja system is made up of a number of stages: - **Draft**: When you’ve created an invoice, but have not yet sent it. You may still need to edit. @@ -20,14 +23,8 @@ The life of an invoice in the Invoice Ninja system is made up of a number of sta In order to understand exactly how the Invoices list page works, we’ll take you through it step by step. -Let’s Begin -^^^^^^^^^^^ - To view your Invoices list page, click the Invoices tab on the main taskbar. This will open the Invoices list page. -Understanding the Invoices List page -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - The Invoices list page displays a table of all your invoices, at every stage, from the moment you create a new invoice, to the moment you archive or delete an invoice. Let's explore the invoices list according to the tabs on the main header bar of the table from left to right: @@ -60,8 +57,7 @@ Create Invoice Here, we’re going to focus on how to create a new invoice. -Let’s Begin -^^^^^^^^^^^ +**Let’s Begin** To create a new invoice, go to the Invoices tab on the main taskbar, open the drop-down menu, and click on New Invoice. This will open the Invoices / Create page. diff --git a/docs/payments.rst b/docs/payments.rst index 676f36ab33c9..89070a90e160 100644 --- a/docs/payments.rst +++ b/docs/payments.rst @@ -7,12 +7,12 @@ List Payments """"""""""""" In the meantime, we’re going to take you through the Payments list page to give you an idea of the complete payment picture. -Let’s Begin -^^^^^^^^^^^ - To view the Payments list page, click on the Payments tab on the main taskbar. This will open the Payments list page. Understanding the Payments List Page +Overview +^^^^^^^^ + The Payments list page displays a summary of all payments once they have been received. Payments are recorded in two ways: 1. **Automatic payment**: If your client has paid you via any of Invoice Ninja’s 45+ payment gateways, the payment will be automatically recorded in the Payments list. You will be notified by Invoice Ninja on your Dashboard page in the Payments table, and also via email (if you have chosen the relevant notification setting on the Settings / Notifications page). @@ -35,8 +35,8 @@ The final column to the right is the Action column. To view the actions, hover y .. TIP:: To sort the Payments list according to any of the columns, click on the orange column tab of your choice. A small arrow will appear. If the arrow is pointing up, data is sorted from lowest to highest value. If the arrow is pointing down, data is sorted from highest to lowest value. Click to change the arrow direction. -Archiving/ Deleting Payments -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Archiving/Deleting +^^^^^^^^^^^^^^^^^^ To archive or delete a payment, hover over the payment entry row, and open the Action drop-down list. Select Archive Payment or Delete Payment from the list. The Payments table will automatically refresh, and archived or deleted payments will no longer appear in the list. @@ -62,13 +62,7 @@ Enter Payment Once you’ve received payment, you’ll need to enter the payment on the Invoice Ninja system. If your client paid via one of Invoice Ninja’s 45+ payment partners, the system will automatically record the payment and send a downloadable PDF receipt to the client’s email address. If you were paid via cash, check, bank transfer, credit card, credit or any other payment method not automatically linked to the Invoice Ninja system, you will be required to enter the payment. The procedure of entering a payment is simple and lightning fast. Now, we’ll take you through the payment entry process, step by step. -Let’s Begin -^^^^^^^^^^^ - -To enter a payment, click on the Payments tab on the main taskbar. Select Enter Payment from the drop-down menu and the Payments / Create page will open. - -How to Enter a Payment -^^^^^^^^^^^^^^^^^^^^^^ +**Let’s Begin** The Payments / Create page features a number of fields that you’ll need to complete. @@ -80,8 +74,8 @@ Apply Credit: Here, you can apply credit from the client’s existing credit acc - **Payment Date**: The date the payment was received. Click on the calendar icon to the right side of the Payment Date field and select the appropriate date. - **Transaction Reference**: Enter any information you wish for your future reference. This information can be useful when managing your accounts. -Email payment receipt to the client -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Email payment receipt +^^^^^^^^^^^^^^^^^^^^^ If you wish to send a receipt to your client for the payment received, check the “Email payment receipt to the client” box. A downloadable PDF receipt will be generated and sent to the client’s email address. diff --git a/docs/quotes.rst b/docs/quotes.rst index c2e87d6198bf..f0071cd42f0f 100644 --- a/docs/quotes.rst +++ b/docs/quotes.rst @@ -12,13 +12,10 @@ As a freelancer, many jobs – whether big or small – will begin as a quote. H Once the price quote is accepted by the client, the Invoice Ninja system enables automatic creation of an invoice that imports all the quote data, so your quotes and invoices are linked, organized and easily traceable. An advanced Invoice Ninja feature, Quotes is truly the cherry on top, giving you maximum functionality from A to Z in your invoicing activity. -Let’s Begin -^^^^^^^^^^^ - To view your Quotes list page, click the Invoices tab on the main taskbar, and select Quotes from the drop-down menu. This will open the Quotes list page. -Understanding the Quotes List page -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Overview +^^^^^^^^ The Quotes list page displays a table of all your quotes, at every stage, whether at the drafting stage, sent to the client, accepted by the client and converted to invoice, or archived/ deleted quotes. Use your Quotes list to get a better grasp of where you stand in terms of possible future projects and income. @@ -53,8 +50,8 @@ Filter To filter the Quotes list, enter the filter data in the Filter field, situated at the top right of the page, to the left of the blue New Quote + button. Quotes can be filtered according to the client name or quote number, or elements of these data. Let’s filter the table for a client named “Best Ninja”. You can type “best ninja”, or “best” or “ninja”, or even “bes”, or “nin”, or “ja”, or any other grouping of letters in the client name. Alternatively, you can filter according to quote number. The filter function will automatically locate and present the relevant entries. -Archiving/ Deleting Quotes -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Archiving/Deleting +^^^^^^^^^^^^^^^^^^ To archive or delete a quote, hover over the quote entry row, and open the Action drop-down list. Select Archive quote or Delete quote from the list. The Quotes table will automatically refresh, and archived or deleted quotes will no longer appear in the list. diff --git a/docs/recurring_invoices.rst b/docs/recurring_invoices.rst index f1c64495f814..bfd245b6148c 100644 --- a/docs/recurring_invoices.rst +++ b/docs/recurring_invoices.rst @@ -8,8 +8,8 @@ List Recurring Invoices To view the Recurring Invoices list page, go to the Invoices tab on the main taskbar and click to open the drop-down menu. Select Recurring Invoices to open the Recurring Invoices list page. -Let’s Begin -^^^^^^^^^^^ +Overview +^^^^^^^^ The recurring invoices list provides a display of the information and settings for all recurring invoices. It is not a list of the actual invoices as they are sent. Invoices sent by the recurring invoices feature are recorded as regular numbered invoices in the Invoices list page. @@ -36,8 +36,8 @@ Filter To filter the Recurring Invoices list, enter the filter data in the Filter field, situated at the top right of the page, to the left of the blue New Recurring Invoice + button. Recurring invoices can be filtered according to Frequency or Client name. Enter the data or parts of the data, and the filter function will automatically locate and present the relevant entries. -Archiving/ Deleting Recurring Invoices -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Archiving/Deleting +^^^^^^^^^^^^^^^^^^ To archive or delete a recurring invoice, hover over the Action area of the recurring invoice entry row, and open the Action drop-down list. Select Archive recurring invoice or Delete recurring invoice from the list. The Recurring Invoices table will automatically refresh, and archived or deleted recurring invoices will no longer appear in the list. You can also archive or delete one or more recurring invoice via the gray Archive button that appears at the top left side of the Recurring Invoices list page. To archive or delete recurring invoices, check the relevant recurring invoices in the check boxes that appear in the far left column next to the Frequency field. The number of recurring invoices selected for archiving/deleting will automatically update and show on the Archive button. Then click on the Archive button, open the drop-down list and select the desired action. @@ -56,13 +56,7 @@ When you create a recurring invoice, you are creating a pre-defined frequency fo Now, we’ll explore how to set up a recurring invoice. -Let’s Begin -^^^^^^^^^^^ - -To create a new recurring invoice, go to the Invoices tab on the main taskbar and click to open the drop-down menu. Select New Recurring Invoice to open the Recurring Invoices / Create page. - -How to Create a Recurring Invoice -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +**Let’s Begin** To create a recurring invoice, you'll first need to complete the data fields in the top section of the Recurring Invoice / Create page. Let's go over the fields to get a better understanding: diff --git a/docs/tasks.rst b/docs/tasks.rst index f9ce0b39b8a6..0cf1fa75a10a 100644 --- a/docs/tasks.rst +++ b/docs/tasks.rst @@ -12,15 +12,12 @@ The Tasks list page not only displays a summary of all your tasks, for all clien - **Logged**: A task that has been completed, recorded, but not yet invoiced. - **Invoiced**: A task that has been completed and the invoice sent to the client. -The Tasks list page provides a range of opportunities to carry out actions relating to each specific task. Now, we’ll explore the Tasks list and show you all the features and actions that make managing tasks so easy. - -Let’s Begin -^^^^^^^^^^^ - To view your Tasks list page, click the Tasks tab on the main taskbar. This will open the Tasks list page. -Understanding the Tasks List page -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Overview +^^^^^^^^ + +The Tasks list page provides a range of opportunities to carry out actions relating to each specific task. Now, we’ll explore the Tasks list and show you all the features and actions that make managing tasks so easy. The Tasks list page displays a table of all your tasks, at every stage, from Running to Logged to Invoiced, together with handy accompanying information about each task. @@ -62,8 +59,8 @@ Tasks can be invoiced directly from the Tasks list page. To invoice a task, chec .. TIP:: You can invoice more than one task to the same client in a single invoice. To invoice more than one task in the same invoice, select the desired tasks in the check boxes to the left of the client name column, and then click the Invoice button. You’ll be redirected to the Invoices / Create page. All the selected tasks will be automatically included in the invoice. Each task will appear as a separate line item in the invoice. -Archiving/ Deleting Tasks -^^^^^^^^^^^^^^^^^^^^^^^^^ +Archiving/Deleting +^^^^^^^^^^^^^^^^^^ To archive or delete a task, hover over the task entry row, and open the Action drop-down list. Select Archive Task or Delete Task from the list. The Tasks table will automatically refresh, and archived or deleted tasks will no longer appear in the list. @@ -83,14 +80,10 @@ With many clients, and any number of projects ongoing at the same time, you need Either way, the Tasks component of Invoice Ninja allows you to record and manage your tasks and sessions for every one of your clients. -Let’s Begin -^^^^^^^^^^^ +**Let’s Begin** To create a new task, go to the main taskbar and click the Tasks tab. Then, select New Task from the drop-down menu. The Tasks / Create page will open. -How to Create a New Task -^^^^^^^^^^^^^^^^^^^^^^^^ - .. NOTE:: Before creating a new task, it is vital to ensure that the correct time zone is set. To set the time zone, go to the Settings button on the right side of the main taskbar. Click to open the drop-down menu. Select Localization. The Localization window will open. Here you can choose your time zone, enable 24 hour time, and select your preferred Time/Date Format. Now that you’ve set the correct time zone, you can begin creating a new task. @@ -119,8 +112,8 @@ Want to save the task information and move on to something else? Click Save. The .. TIP:: With Manual entry, the dates and times you enter must be logical with no overlaps. If you’ve entered sessions that cannot exist simultaneously for the task, the relevant time fields will be highlighted in red, and you’ll be instructed to fix the incorrect times before leaving the page. -How to Edit a Task -^^^^^^^^^^^^^^^^^^ +Edit a Task +^^^^^^^^^^^ Whether Timer or Manual, once you’ve saved or stopped a task session, you’ll be automatically redirected to the Tasks / Edit page. To edit the task, click the blue Edit Details button situated just below the task information. This will open a list of all sessions for this task accrued so far, both Timer-based and Manual sessions. Now you can manually edit them. If you wish to add a session manually, enter the start and end times in the new row below the list of existing sessions.