diff --git a/.gitignore b/.gitignore index f1594640bb..f3b06ceeb9 100644 --- a/.gitignore +++ b/.gitignore @@ -19,7 +19,7 @@ Thumbs.db /.env /.env.development.php /.env.php - +/docs/_build /error_log /auth.json /public/error_log diff --git a/docs/api_tokens.rst b/docs/api_tokens.rst new file mode 100644 index 0000000000..61524d2949 --- /dev/null +++ b/docs/api_tokens.rst @@ -0,0 +1,38 @@ +API Tokens +========== + +Invoice Ninja uses API tokens to enable access to third party providers, so you can streamline many of your invoicing and payments functions with our partners. + +Tokens +"""""" + +The API Tokens page displays a table listing your current API tokens. + +To add a new API token, click the blue Add Token + button at the top right of the page. The Tokens/ Create page will open. + +Create Token +^^^^^^^^^^^^ + +Enter the token name in the field and click the green Save button. A new token number will be automatically generated. You will then be redirected to the API Tokens page, where the new token will display in the table next to the relevant Name entry. + +If you want to cancel the new entry before saving it, click the gray Cancel button. + +Edit Token +^^^^^^^^^^ + +To edit an existing token, click on the gray Select button in the Action column of the API Tokens table, and a drop down menu will open. Select Edit Token from the menu, and the Tokens/ Edit page will open. You can now edit the token name. Click Save to apply the changes, or Cancel. + +Archive Token +^^^^^^^^^^^^^ + +To archive an existing token, click on the gray Select button in the Action column of the API Tokens table, and a drop down menu will open. Select Archive Token from the menu, and the token will automatically be sent to archives. It will no longer be viewable in the API Tokens table. + +Documentation +^^^^^^^^^^^^^ + +Need some extra help? Click on the gray Documentation button directly above the API Tokens table, and you'll be redirected to https://www.invoiceninja.com/api-documentation/. Here, you can read all about using API documentation in your Invoice Ninja account. + +Zapier +"""""" + +Invoice Ninja proudly partners with https://zapier.com/ to provide seamless app connections for your Invoice Ninja activity. Check out various Zaps that deliver integrated functionality between Invoice Ninja and other apps to help you streamline your accounting. Click on the gray Zapier button, just to the right of the Documentation button, to find out more. diff --git a/docs/charts_and_reports.rst b/docs/charts_and_reports.rst new file mode 100644 index 0000000000..f151bbad1d --- /dev/null +++ b/docs/charts_and_reports.rst @@ -0,0 +1,24 @@ +Charts & 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 Charts and 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. And the graphical chart display gives you an instant visual understanding of your important business data. + +Report Settings +""""""""""""""" + +The Report Settings section enables you to set parameters and filter the data to generate the right report for you. + +- **Start Date**: Click on the calendar button and select the Start Date for the report. +- **End Date**: Click on the calendar button and select the End Date for the report. +- **Report**: To generate a report, check the Enable box. +- **Type**: To select the report type, click on the Type field and a drop down menu will open. Select the type of report you want from the available list. +- **Chart**: To generate a chart, check the Enable box. +- **Group by**: To select the required timeframe for the data segmentation (Monthly, Weekly or Daily), click on the Group by field and a drop down menu will open. Select the timeframe you want from the list. +- **Chart type**: To select the chart type, click on the Chart type field and a drop down menu will open. Select the type of chart you want from the available list. +- **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>. + +If you enabled the Chart function, a graphical chart will display below the Report data. + +Export To export the report data to Excel or other spreadsheet software, click the blue Export button. The report will automatically download as a .csv file. diff --git a/docs/client_portal.rst b/docs/client_portal.rst new file mode 100644 index 0000000000..4abf89fcf3 --- /dev/null +++ b/docs/client_portal.rst @@ -0,0 +1,15 @@ +Client Portal +============= + +The invoicing process is a two-way street. You bill the client; the client needs to view the invoice and make the payment. Why not make it as easy as possible for you – and for your clients? This is the purpose of Invoice Ninja's Client Portal. With Invoice Ninja, you can provide a portal for your clients where they can open and view your invoices, and even make payments, all via the Invoice Ninja website pages. + +- **Dashboard**: The Client Portal Dashboard is a summary page that shows all your invoicing activity with the specific client. Do you want to display the Dashboard page for your clients when they use the Client Portal? You can choose to show or hide the dashboard. Check the Enable box to show the dashboard. Uncheck to hide the dashboard. +- **Password protect invoices**: To increase security of invoice viewing, you can opt to make the invoices password protected for each individual client. To view your invoice, the client will need to enter a specific password. Check the box to enable the password protect function. +- **Generate password automatically**: If your client does not already have a password for the portal, you can ensure they get one by enabling the system to automatically generate a password. The password will be sent to the client together with the first invoice. To enable this function, check the box. + +Custom CSS +"""""""""" + +Do you have some experience in web design? Want to put your individual fingerprint on your client portal? You can control the look and feel of your client portal by entering custom CSS in your portal layout. Enter the CSS is the Custom CSS field. + +To apply all changes to the Client Portal, click the green Save button at the bottom of the page. diff --git a/docs/clients.rst b/docs/clients.rst index e88ec61071..c8987850e7 100644 --- a/docs/clients.rst +++ b/docs/clients.rst @@ -1,2 +1,121 @@ Clients ======= + +They come in all shapes and sizes. They’re the reason you go to work in the morning. There are new ones coming up, and old ones coming back. What you need is a well-maintained, up-to-date, comprehensive client list to keep your invoicing in order. + +Your clients are the core of your freelance business, and your Clients page is the core of your activity on Invoice Ninja. + +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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Clients page presents a list summary of all your current clients in a table format. The main elements of the table include: + +- **Client:** The name of the client +- **Contact:** The name of the primary contact person +- **Email:** The client email address +- **Date Created:** The date the client was created in the system +- **Last Login:** The date an action was last taken for this client +- **Balance:** The client’s payment balance +- **Action:** A range of actions you can take to manage activity relating to the selected client + +Action +^^^^^^ + +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. + +When you click on an action, you will be automatically redirected to the relevant action page for the selected client. Here are the available actions in the drop-down list of the Action button, and the corresponding action pages that will open: + +- **Edit Client** Edit the client’s details on the Clients / Edit page +- **New Task** Enter a new task on the Tasks / Create page +- **New Invoice** Enter a new invoice on the Invoices / Create page +- **New Quote** Enter a new quote on the Quotes / Create page +- **Enter Payment** Enter a new payment on the Payments / Create page +- **Enter Credit** Enter a new credit on the Credits / Create page +- **Archive client** Click to archive the client +- **Delete client** Click to delete the client + +Credits +^^^^^^^ + +You can manage your credits by visiting the Credits page directly from the Clients page. To open the Credits page, click on the gray Credits button that appears at the top right side of the page, to the left of the New Client + button. +Sorting & Filtering Clients + +The sort and filter functions make it easy for you to manage and view your client information. + +Sort the clients table via any of the following data columns: Client, Contact, Email, Date Created, Last Login, or Balance. To sort, click on the 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. (If you click on the Client, Contact or Email arrow, the data will be displayed in alphabetical or reverse alphabetical order.) + +Filter the clients list by completing the Filter field, situated at the top right of the page, to the left of the gray Credits button. Clients can be filtered according to the client name, contact person name, or elements of the client name or contact person name. Here’s an example: Let’s filter the table for a client named “Joe Smith” of “Best Ninja” company. You can type “best ninja”, or “best” or “ninja”, or even “bes”, or “nin”, or “ja”, or “Joe”, “Smith”, “Jo” “oe”, “th” or any other grouping of letters in the client name or contact person name. The filter function will automatically locate and present all the relevant entries. This function makes it easy to find clients with even minimal input of information. + +.. 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 +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +Want to view archived or deleted clients? Check the box marked Show archived/deleted clients, situated to the right of the Archive button. The table will automatically refresh, and will now feature the full list of clients, including current, archived and deleted clients. + +- **Deleted clients** are displayed with a strike through. +- **Archived clients** are displayed with a lighter gray font color. + +You can choose to restore or delete the archived client. To restore an archived client, hover with your mouse over the Action area for the relevant archived client. A gray Select button will appear. Click on the Select arrow, and choose Restore client from the drop-down list. To delete an archived client, select Delete client from the drop-down list of the Select button. + +Create Client +""""""""""""" + +So, you’ve taken on a new client? Congratulations! + +Your Clients list is at the heart of your invoicing activity, so it's really important to maintain current information on all your clients. When you start working with a new client, the first thing you’ll need to do is to add the new client by entering their contact information and business details. + +When creating and saving a new client to your Clients list, make sure to have the relevant, up-to-date information at hand. You are only required to enter the information one time. Invoice Ninja automatically tracks all invoicing activity for each client. Need to create an invoice, schedule a task or update a payment status? Simply select the client’s name from the Client list. + +There are two ways to enter a new client: + +1. Via the Create Client page. +2. Or, while creating a new invoice. + +Here, we’re going to focus on entering a new client via the Create Client page. + +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. + +The Create Client page is divided into four sections. Enter the information in the relevant fields. + +.. Note:: You don’t have to complete every field. Enter the information that is important or necessary for your needs. + +Let’s take a closer look at each section: + +- **Organization**: Enter details about your client’s business/company/organization, including the company name, ID number, VAT number, website address and telephone number. +- **Contacts**: Enter the name, email address and phone number of your contact person for this client. You can enter as many contact people as you like. To add more contact people, click +Add Contact. +- **Address**: Enter the street address of your client. This will be of particular importance if you need to send hard-copy invoices or payment receipts. +- **Additional Info**: Enter the payment currency, language, payment due date, company size (no. of employees), the relevant industry sector, and any other private notes or reminders you wish to add (don’t worry - no one can see them but you.) + +Once you have filled in the page, click Save to save the new client information. From now on, when you click the Client field, the client’s name will appear in the drop down menu. Simply select the client you need and let the invoicing begin! + +How to Edit Client Information + +The information you enter on the Create Client page acts as your default settings for this client. You can change these settings at any time. How? There are two methods: +Via the Clients list + +1. Select the Clients tab to view your client list. +2. Select the relevant client from the list. The summary page of the client will open. +3. Click on the gray Edit Client button, at the top right corner of the page. You will now be taken to the Clients/Edit page, where you can edit any of the fields. + +During the invoicing process + +1. Open the New Invoice page. +2. Click on the arrow at the right end of the Client field, and select the client name from the drop down menu. +3. Click Edit Client, which appears below the Client field. This will open the Client window. You can now edit the client’s information. diff --git a/docs/credits.rst b/docs/credits.rst new file mode 100644 index 0000000000..f01bbfa6a6 --- /dev/null +++ b/docs/credits.rst @@ -0,0 +1,85 @@ +Credits +======= + +List Credits +"""""""""""" + +Your workload and fee structure vary from client to client. What’s more, your work schedule may change from one month to the next, or even from week to week – and often for the same client. + +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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Credits list page is a summary of all credits issued to all clients. + +To open the Credits page, click on the Clients tab, open the drop-down menu, and click on Credits. +On the Credits page, credit information is presented in a simple, user-friendly table. Let’s take a closer look at the table elements: + +- **Client**: The client’s name +- **Credit**: Amount The amount of the individual credit +- **Credit Balance**: The balance of the individual credit +- **Date of Issue**: The date the individual credit was issued +- **Private Notes**: Comments or reminders that you included FYI +- **Action**: Option to archive or delete the credit + +Archiving/Deleting Credits +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +You can also archive or delete one or more credit via the gray Archive button that appears at the top left side of the Credits list page. To archive or delete credits, check the relevant credits in the check boxes that appear in the far left column next to the client field. The number of credits 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. + +Want to view archived or deleted credits? Check the box marked Show archived/deleted credits, situated to the right of the Archive button. The table will automatically refresh, and will now feature the full list of credits, including current, archived and deleted credits. The status of the archived or deleted credits will appear in the column at the far right of the table. + +- 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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The sort and filter functions make it easy for you to manage and analyze your credits. + +- Sort the credits table via any of the following data columns: Client, Credit Amount, Credit Balance, Credit Date and Private Notes. To sort, click on the 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. (If you click on the Client or Private Notes arrow, the data will be displayed in alphabetical or /reverse alphabetical order.) +- Filter the credits table by completing the Filter field, situated on the top right of the page, to the left of the blue Enter Credit button. Credits can be filtered according to the client name, or elements of the client name. Here’s an example: Let’s filter the table for credits issued to “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. The filter function will automatically locate and present all the relevant entries. This function makes it easy to find credit entries with even minimal input of information. + +.. TIP:: Need to search for a specific client in your Credits list? Start typing the first letters of the client's name and the filter will automatically present the relevant listings. + +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 +^^^^^^^^^^^ + +To issue a credit, you’ll need to open the Credits / Create page. + +There are three ways to open this page: + +1. Go to the Clients tab, open the drop-down menu, and click on Enter Credit. This will open the Credits / Create page. TIP: This is the quickest way to reach the Enter Credit page. +2. Go to the Clients tab, open the drop-down menu, and click on Credits. This will open the Credits list page, which displays a summary of all your clients’ credits. To issue a new credit, click the blue Enter Credit + button in the upper right corner, above the orange bar. +3. Go to the Client's summary page. Locate the blue New Invoice button at the top right of the page. Click on the arrow at the right side of the button. A drop-down list will open. Select Enter Credit. This will open the Credits / Create page. TIP: This method will automatically pre-select the client's name in the Client field of the Enter Credit page. + +Ok, so you’ve successfully landed on the Credits / Create page. + +How to Create a New Credit +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Credits / Create page has four fields for you to complete. Let’s take a closer look at each field: + +- **Client**: Click on the arrow at the right end of the Client field. Select the relevant client from the client list. +- **Amount**: Enter the credit amount. The currency is determined by the currency setting for the specific client. +- **Credit Date**: Select the appropriate date of issue for the credit. It may be today’s date or any other date. +- **Private Notes**: [Optional] Enter any private comments or reminders (don’t worry - no one can see them but you.) + +Saving the Credit +^^^^^^^^^^^^^^^^^ + +To save your new credit, click Save. + +You’ve now completed the process of issuing a credit to your client’s account. + +When you click Save, you’ll be automatically redirected to the client’s summary page. The credit balance will appear in the Standing column, under Credit. + +If you wish to view the client’s credit details in full, click on the gray Credits tab at the right side of the client’s summary page. This will open a table displaying information about all credits issued to the client, including amount, balance, date of issue and private notes. diff --git a/docs/data_visualizations.rst b/docs/data_visualizations.rst new file mode 100644 index 0000000000..9f8b5a8964 --- /dev/null +++ b/docs/data_visualizations.rst @@ -0,0 +1,10 @@ +Data Visualizations +=================== + +Who says analyzing your invoicing data can't be fun? Data Visualizations is an interactive, intuitive and practical feature that helps you understand exactly what is going on with your invoicing numbers. The visualization function takes your data, according to the data group you select, and creates a visual pattern that demonstrates your income proportions according to various parameters. What's more, it's not just a graphical display; it also links to the various data in the illustration, making it easy for you to dig deeper into your numbers, simply by hovering your mouse. + +- **Group by**: To generate a Data Visualization, select the required data group (Clients, Invoices, Products). The visualization will be automatically generated below. + +To view particular data, hover your mouse over the circles within the illustration. Text boxes will automatically appear displaying information about the data grouping. + +.. TIP:: For the Invoices and Clients data visualizations, each display box includes a View link at the top right. To view the specific client or invoice, click on the View link. The Edit Invoice or View Client page will open in another window. diff --git a/docs/email_settings.rst b/docs/email_settings.rst new file mode 100644 index 0000000000..697036d48e --- /dev/null +++ b/docs/email_settings.rst @@ -0,0 +1,24 @@ +Email Settings +============== + +Email communication with your clients is an important part of the Invoice Ninja invoicing process – sending invoices via email, notifying clients that an invoice is due, reminding clients about overdue payments, and more. + +With the Email Settings feature, you can specify certain settings and designs for the notification emails your clients receive from your Invoice Ninja account. + +The Email Settings page includes two sections: **Email Settings** and **Email Designs**. + +Email Settings +"""""""""""""" + +- **Attach PDFs**: Want to be able to attach PDF files to your emails? Check the Enable box. + +- **Invoice Link**: When you email an invoice to a client, the invoice is viewable via a web link that is embedded in the notification email. The default link uses a URL from the Invoice Ninja site. If you wish to change the link to your own website or another subdomain, check the relevant box and enter the URL details. + +Email Design +"""""""""""" + +- **Email Style**: You can make your emails look more professional by choosing a design layout. Select the desired style by opening the drop-down menu. Available styles are Plain (regular email layout), Light (graphical layout featuring light border) and Dark (graphical layout featuring dark border). To preview the different styles, click the question mark icon at the right end of the field. + +- **Enable markup**: Want to give your clients the convenient option to pay you online with a direct link from the invoice notification email? Check Enable markup to add a payment link to the invoice email. Then, your clients can click through to submit an online payment. + +Finished customizing your email settings? Click the green Save button to apply the new settings. diff --git a/docs/index.rst b/docs/index.rst index 0a92d2f7bc..4218b3994d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,7 @@ Invoice Ninja User Guide ======================== -* :ref:`basic-features` -* :ref:`advanced-settings` +Want to find out everything there is to know about how to use your Invoice Ninja account? Look no further than our User Guide, where you’ll learn all about creating and sending invoices, receiving payments, creating tasks, converting quotes to invoices, recurring invoices, entering credits and much, much more. .. _basic-features: @@ -10,11 +9,27 @@ Invoice Ninja User Guide :maxdepth: 2 :caption: Basic Features + introduction clients - + invoices + payments + recurring_invoices + credits + quotes + tasks .. _advanced-settings: .. toctree:: :maxdepth: 2 :caption: Advanced Settings + + invoice_settings + invoice_design + email_settings + templates_and_reminders + client_portal + charts_and_reports + data_visualizations + api_tokens + user_management diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 0000000000..51290d8bae --- /dev/null +++ b/docs/introduction.rst @@ -0,0 +1,117 @@ +Introduction +============ + +Let’s get acquainted with a basic overview of the structure of the Invoice Ninja website. Once you’ve wrapped your mind around a few central concepts, it’s 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**. + +You’re invited to browse the user guide for more detailed information. We’re always looking to take Invoice Ninja one step ahead, so if you have any comments, queries or suggestions, we’d love to hear from you. + +Dashboard +^^^^^^^^^ + +Welcome to the Dashboard page of your Invoice Ninja account. This is the first page you’ll 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, you’ll glimpse a comprehensive and user-friendly snapshot of what’s going on right now in your invoicing world. + +So let’s 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, 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. +- **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 client’s 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 client’s 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 client’s 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. + +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 +""""""""""""""""""""""""" + +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 client’s 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 client’s 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. diff --git a/docs/invoice_design.rst b/docs/invoice_design.rst new file mode 100644 index 0000000000..430cb87f97 --- /dev/null +++ b/docs/invoice_design.rst @@ -0,0 +1,57 @@ +Invoice Design +============== + +Whether you're a design novice or programming pro, Invoice Ninja gives you the power to customize your invoice design, to give your invoices the exact look you want. The design tool is the perfect way to match your invoices to your company's graphical look and feel, including colors, fonts, logos, margin sizes, column names, headers, footers and much more. + +You can design you invoice using the simple selection tools, or go deeper and customize it from the foundations with our customization feature. + +The Invoice Design page is divided into two sections. The top section presents the various options for customization and the bottom section displays a real time PDF sample of your invoice, so you can see your changes as you go along. + +General Settings +"""""""""""""""" + +To customize the invoice design general settings, click on the General Settings tab. You have a number of options for setting changes: + +Design Invoice Ninja provides a selection of design templates to choose from. Examples include 'Bold', 'Elegant', 'Hipster' and 'Business'. The default template setting is 'Clean'. To change the template setting, select a design from the drop down menu. The PDF invoice display below will automatically update to show you a preview of the design template. + +.. TIP:: Your chosen design will only apply after you click the Save button. Feel free to play with the various designs and explore your options before saving. + +- **Body Font**: Select the desired font for the body text of the invoice. +- **Header Font**: Select the desired font for the header text of the invoice. +- **Font Size**: Select the desired font size for the text that appears in the invoice. +- **Primary Color**: Select the desired primary color of the invoice design. +- **Secondary Color**: Select the desired secondary color of the invoice design. + +.. TIP:: The invoice design templates are based on a two-tone color scheme. Make sure to select primary and secondary colors that are complementary and reflect your design taste and your company's design theme. + +Invoice Labels +^^^^^^^^^^^^^^ + +Want to change the column names or terms on your invoice template? To customize the names of the Item, Description, Unit Cost, Quantity, Line Total and Terms on your invoice, enter the desired text in the relevant field. + +Invoice Options +^^^^^^^^^^^^^^^ + +Hide Quantity If your line items are always 1, then you can opt to hide the Quantity field. To hide Quantity, check the box. + +Hide Paid to Date If you wish to hide the Paid to Date column until payment has been made, check the box. Then, your invoices won't ever display 'Paid to Date 0.00'. + +Header/Footer +^^^^^^^^^^^^^ + +Want your header and footer to appear on all pages of the invoice, or the first page only? Select the desired setting here. + +Once you've selected all your settings, click the green Save button and the new settings will apply. + +Customize +""""""""" + +If you have design experience, you can customize the invoice exactly as you want, beyond the options provided by Invoice Ninja. To work on the invoice document, click the blue Customize button. You'll be redirected to the programming page, where you'll have the option of working on the invoice Content, Styles, Defaults, Margins, Header and Footer layout. Simply click on the relevant tab and work away. The design changes you make will be reflected in the sample PDF invoice on the right side of the page. + +To change the invoice design template, select the desired design from the drop down menu at the bottom left of the page. + +To save your customized changes, click the green Save button at the bottom of the page. + +To cancel your customized changes, click the gray Cancel button at the bottom of the page. + +Need help with your customized coding? Click the gray Help button at the bottom of the page. You'll be provided with a link to our support forum and to the website of the software provider, where you can explore how to use it. diff --git a/docs/invoice_settings.rst b/docs/invoice_settings.rst new file mode 100644 index 0000000000..ea52ebb4a5 --- /dev/null +++ b/docs/invoice_settings.rst @@ -0,0 +1,82 @@ +Invoice Settings +================ + +You can customize your invoice template by adding new details about the client, your company, header and footer information, adjusting the numbering format and more. Any changes you make to the Invoice Settings will apply to all your invoices. + +The Invoice Settings page has four sections: + +- Invoice and Quote Numbers +- Custom Fields +- Quote Settings +- Default Messages + +Invoice and Quote Numbers +""""""""""""""""""""""""" + +Want to create your own numbering system for invoices and quotes? + +To customize your invoice numbering system, click on the Invoice Number tab on the left. + +There are two ways to customize the invoice number: by adding a prefix or creating a pattern. + +To add a prefix, select the Prefix button. In the field immediately below, add your chosen prefix. For example, you may choose to add your company initials, such as M&D. The current invoice number appears in the Counter field. + +All your invoices will automatically include the numbering change. So if you chose the prefix M&D, your invoice numbers will appear as M&D001, and so on. 3 + +To create a pattern, select the Pattern button. In the pattern field, enter the custom variable of your choice. For example, if you create a pattern of {$year}-{$counter}, then your invoices will be numbered with the current year and latest invoice number. To view available options for custom patterns, click on the question mark icon at the right end of the Pattern field. + +All your invoices will automatically display invoice numbers according to your customized pattern. + +To customize your quote numbering system, click on the Quote Number tab on the right. + +There are two ways to customize the quote number: by adding a prefix or creating a pattern. + +- To add a prefix, select the Prefix button. In the field immediately below, add your chosen prefix. The prefix will appear before the quote number on all your quotes. +- To create a pattern, select the Pattern button. In the pattern field, enter the custom variable of your choice. To view available options for custom patterns, click on the question mark icon at the right end of the Pattern field. 4 + +All your quotes will automatically display quote numbers according to your customized pattern. + +.. TIP:: You can choose to integrate your quote numbers with the invoice number counter. This is an important feature as it allows you to keep the same number when converting a quote to an invoice. So, Quote-001 will automatically become Invoice-001. To number your quotes with your invoice numbering system, check the Share invoice counter button. To number your quotes separately, uncheck the Share invoice counter button. 5 + +Custom Fields +""""""""""""" + +You can create new fields for your client entries, company details and invoices by assigning new field values and labels in the Custom Fields section. All field changes will automatically appear in the PDF invoice. + +Client Fields +^^^^^^^^^^^^^ + +To add fields to your client entries, click on the Client Fields tab. + +You have the option of adding one or two new fields which will appear on the Client/Create and Client/Edit pages. When creating or editing a client, complete these fields if they are relevant to the client. The field name and information you enter will appear in the Client details section of the PDF invoice. + +Company Fields +^^^^^^^^^^^^^^ + +To add fields to your company details, click on the Company Fields tab. Enter the Field Label and Field Value information in the relevant fields. The information you enter will automatically appear in the Company details section of the PDF invoice. + +Invoice Fields +^^^^^^^^^^^^^^ + +Want to include customized information in your invoices? To add fields to your invoice entry, click on the Invoice Fields tab. Enter the new field name in the Field Label field. You can add one or two new invoice fields. The new fields will appear in the top part of the Create/Invoice page, and will automatically be included in the PDF invoice. + +Invoice Charges +^^^^^^^^^^^^^^^ + +To add new invoice charge fields, click on the Invoice Charge tab. Enter the new charge in the fields provided. You can add one or two new invoice charge fields. The new charge field/s will appear in the Invoice Subtotals section. Amounts entered into these fields during the Create or Edit Invoice process will automatically appear in the PDF invoice. To apply the Tax feature for the new charge, check the Charge tax button. + +Quote Settings +"""""""""""""" + +Want to convert accepted quotes into invoices at a click of a button? Check the Enable button and the auto convert function will apply. So, when a client approves a quote, it will automatically convert into a quote, saving you time and hassle. + +.. TIP:: This feature is extra-helpful if you linked your quote and invoice number counters in the Invoice and Quote Numbers section of the Invoice Settings page. + +To disable the auto convert function, uncheck the Enable button. + +Default Messages +"""""""""""""""" + +Set any customized default text you want to Invoice Terms, Invoice Footer and Quote Terms. + +Completed all your Invoice Settings? Click the green Save button at the bottom of the page, and your customized changes will appear on all your invoices. diff --git a/docs/invoices.rst b/docs/invoices.rst new file mode 100644 index 0000000000..e0b84c0ff4 --- /dev/null +++ b/docs/invoices.rst @@ -0,0 +1,141 @@ +Invoices +======== + +Well, it’s time to bill, and the Invoices function of Invoice Ninja lets you get the job done fast and with perfect accuracy. + +With a bustling freelance business, you’re going to be sending out a lot of invoices. Creating an invoice is simple with the New Invoice page. Once you’ve entered the client, job and rates information, you’ll see a preview of your invoice, and you’ll have a range of actions at your fingertips – from saving a draft, to sending the invoice to the client via email, to printing a PDF hard copy. + +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. + +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. +- **Sent**: You’ve sent the invoice, but the client has not yet paid. +- **Viewed**: The client has opened the invoice email and viewed the invoice. +- **Partial**: The invoice has been partially paid. +- **Paid**: Congratulations! The client has paid the full invoice amount. + +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: + +- **Invoice #**: The number of the invoice +- **Client**: The client name +- **Invoice Date**: The date the invoice was issued +- **Invoice Total**: The total amount of the invoice +- **Balance Due**: The amount owed by the client (after credits and other adjustments are calculated) +- **Due Date**: The date the payment is due +- **Status**: The current status of the invoice (Gray = Draft, Blue = Sent, XX = Viewed, XX = Partial, Green = Paid) +- **Action**: The Action button provides a range of possible actions, depending upon the status of the invoice. + +To view the actions, hover your mouse over the Action area of the relevant invoice entry and a gray Select button will appear. Click on the arrow at the right side of the button to open a drop-down list. For invoices with “Draft” status, the drop-down list presents the following action items: + +- **Edit Invoice**: Edit the invoice information on the Edit Invoice page. +- **Clone Invoice**: Duplicate the invoice. Then you can make minor adjustments. This is a fast way to create a new invoice that is identical or similar to this invoice. +- **View History**: You'll be redirected to the Invoices / History page, where you can view a history of all the actions taken from the time the invoice was created. The Invoices / History page displays a copy of the latest version of the invoice and a drop-down list of all actions and the corresponding version of the invoice. Select the version you wish to view. Click on the blue Edit Invoice button at the top right of the page to edit the invoice. +- **Mark Sent**: When you have sent the invoice to your customer, mark as Sent. This will update the invoice status in the Invoices list, so you can keep track. +- **Enter Payment**: Enter the payment relevant to this invoice. You'll be redirected to the Payments / Create page. +- **Archive Invoice**: Click here to archive the invoice. It will be archived and removed from the Invoices list page. +- **Delete Invoice**: Click here to delete the invoice. It will be deleted and removed from the Invoices list page. + +.. TIP:: For invoices with “Viewed”, “Sent”, “Partial” or “Paid” status, only the relevant and applicable options from the above list will show in the Action drop-down list. + +.. TIP:: To sort the invoices 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. + +Create Invoice +"""""""""""""" + +Here, we’re going to focus on how to create a new invoice. + +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. + +When you open the Invoices / Create page, the Invoice Ninja system will automatically create a new, empty invoice for you to complete. Note that each new invoice you create will be automatically numbered in chronological order. This will ensure your records are kept logical and organized. (You have the option to change the invoice number manually. We'll discuss that a little later.) + +The top section of the invoice contains a range of important information specific to the client and the work you are invoicing. Let’s explore them one by one: + +- **Client**: Click on the arrow at the right end of the Client field. Select the relevant client from the client list. TIP: You can create a new client while creating a new invoice. Simply click on the Create new client link, situated below the Client field on the Invoices / Create page. A pop-up window will open, enabling you to complete the new client’s details. Then continue creating the invoice for this new client. +- **Invoice Date**: The date of creation of the invoice. Click the calendar icon to select the relevant date. +- **Due Date**: The date the invoice payment is due. Click the calendar icon to select the relevant date. +- **Partial**: In the event that you need to bill the client for a partial amount of the total amount due, enter the amount in the Partial field. This will be automatically applied to the invoice. +- **Invoice #**: The invoice number is assigned automatically when you create a new invoice, in order of chronology. TIP: You can manually override the default invoice number by entering a different number in the Invoice # field. +- **PO #**: The purchase order number. Enter the purchase order number for easy reference. +- **Discount**: If you wish to apply a discount to the invoice, you can choose one of two methods: a monetary amount, or a percentage of the total amount due. To choose a method, click on the arrow at the right side of the box next to the Discount field. Select Percent or Amount from the drop-down list. Then enter the relevant figure. For example, to apply a 20% discount, enter the number 20, and select “Percent” from the drop-down list. To apply a $50 discount, enter the number 50, and select “Amount” from the drop-down list. +- **Taxes**: Manage the various tax rates that apply by clicking on the Manage rates link. The Tax Rates pop-up window will open. To apply a tax rate, enter the name of the tax in the Name field, and the percentage amount in the Rate field. For example, to apply a VAT of 17%, enter VAT in the Name field, and 17 in the Rate field. TIP: If you need to apply multiple taxes, add another Name and Rate to the new row. A new row will open automatically as soon as you begin typing in the current row. + +The Tax Rates pop-up box offers various settings for presentation of taxes on the invoice. Check the boxes of the settings you wish to apply. + +- **Enable specifying an invoice tax**: Check this box to apply the tax rate for the entire invoice. It will appear on the invoice above the Balance Due field. +- **Enable specifying line item taxes**: Check this box to apply various tax rates to specific items of the same invoice. This setting enables you to apply different taxes to the different line items. +- **Display line item taxes inline**: Check this box to include a Tax column on the invoice, so your customer can view the tax amounts that apply to each line item. + +After selecting the desired tax settings, you’ll need to choose a tax rate for the invoice, or for each line item. To select a tax rate, click on the arrow at the right side of each Tax field that appears on the invoice. A drop-down list will open, featuring all the tax rates you created. Choose the relevant tax rate from the list. It will automatically apply and the figures in the invoice will adjust accordingly. + +.. TIP:: The currency of the invoice will be according to the default currency specified for this client when you created the client. +Now that we’ve completed the general invoice information, it’s time to finish creating your invoice by specifying the job/s you’re billing for, the amounts due for each job/line item, taxes, discounts and final balance due. Let's explore the various columns of the invoice, from left to right along the orange header bar: + +- **Item**: This is the name of the item you are billing for. You can either enter the details manually, or by selecting one of the set items created by you at the Product Settings stage. To select a set item, click on the arrow at the right side of the item bar and choose the relevant item from the drop-down list. To enter the item manually, click inside the field and enter the item. Here are some examples of an item: 1 hour programming services OR 5 pages translation OR 1 hour consulting. +- **Description**: Add more information about the item. This will help the customer better understand the job completed, and is also useful for your own reference. +- **Unit Cost**: The amount you charge per unit of items. For example, let's say your item is "1 hour consulting", and you charge $80 for an hour of consulting – that is, for 1 item unit. Then you'll enter 80 in the Unit Cost field. Note: If you have selected a set item, the unit cost that you pre-defined at the Product Settings stage will apply by default. You can manually override the default unit cost by clicking in the Unit Cost field and changing the value. +- **Quantity**: The number of units being charged. Continuing the above example, let's say you need to charge for 3 hours of consulting, enter the number 3 in the Quantity field. +- **Tax**: This field will only appear if you selected "Enable specifying line item taxes." To apply tax to the line item, click on the arrow at the right side of the Tax field and select the relevant tax from the drop-down list. +- **Line Total**: This is the amount due for the particular line item. Once you have entered the Unit Cost and Quantity, this figure will be calculated automatically. If you change either value at any time during creation of the invoice, the Line Total will adjust accordingly. + +.. TIP:: You can enter as many line items as you need in the invoice. As soon as you enter any data in a line item, a fresh, blank line item will open in the row below. + +Beneath and to the right of the line item section, you'll find the Balance Due section. It's made up of a number of figures, all leading to the golden number – the final, total Balance Due. + +- **Subtotal**: This is the amount due before other figures are taken into calculation, such as Tax, Partial payments, Credits, etc. +- **Tax**: The tax rate for the invoice. Here you can select the appropriate tax rate for the entire invoice by clicking the arrow at the right side of the Tax field and selecting the relevant tax from the drop-down list. Note: If you selected "Enable specifying line item taxes" in the Manage rates pop-up box, then the tax applied to each line item will appear here, listed individually. +- **Paid to Date**: The amount paid to date, including partial payments and credits. +- **Balance Due**: The final balance owed to you by your customer, after taxes, partial payments and credits have been deducted from the charged amount. + +Directly to the left of the Balance Due section, you'll see a text box with three tabs to choose from: + +- **Note to Client**: Want to write a personal or explanatory note to the client? Enter it here. +- **Invoice Terms**: Want to set terms to the invoice? Enter them here. The terms will appear on the invoice. If you want to make these the default terms for all invoices, check the Save as default terms box. Then these terms will automatically appear on each invoice you create. Need to change the default terms? Click Reset Terms, and the text box will clear. You can enter new terms or leave blank. +- **Invoice Footer**: Want to enter information to appear as a footer on the invoice? Enter it here. The text will appear at the bottom of the invoice. If you want to make this the default footer for all invoices, check the Save as default footer box. Then this footer will automatically appear on each invoice you create. Need to change the default footer? Click Reset footer, and the text box will clear. You can enter a new footer or leave blank. + +.. TIP:: The Invoices 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. + +Invoice Preview +^^^^^^^^^^^^^^^ + +Did you know that all this time you've been creating the new invoice, a preview of the invoice appears below, and it changes in real time according to the data you've entered? + +Scroll down below the invoice data fields to check out the invoice preview. + +But before we get there you'll see a row of colorful buttons, giving you a range of options: + +- **Blue button – Download PDF**: Download the invoice as a PDF file. You can then print or save to your PC or mobile device. +- **Green button – Save Invoice**: Save the last version of the invoice. The data is saved in your Invoice Ninja account. You can return to the invoice at any time to continue working on it. +- **Orange button – Email Invoice**: Email the invoice directly via the Invoice Ninja system to the email address specified for the client. +- **Gray button – More Actions** + +Click on More Actions to open the following action list: + +- **Clone**: Invoice Duplicate the current invoice. Then you can make minor adjustments. This is a fast way to create a new invoice that is identical or similar to a previous invoice. +- **View History**: You'll be redirected to the Invoices / History page, where you can view a history of all the actions taken from the time the invoice was created. The Invoices / History page displays a copy of the latest version of the invoice and a drop-down list of all actions and the corresponding version of the invoice. Select the version you wish to view. Click on the blue Edit Invoice button at the top right of the page to go back to the invoice page. +- **Mark Sent**: When you have sent the invoice to your customer, mark as Sent. This will update the invoice status in the Invoices list, so you can keep track. +- **Enter Payment**: Enter the payment relevant to this invoice. You'll be redirected to the Payments / Create page. +- **Archive Invoice**: Want to archive the invoice? Click here. The invoice will be archived and removed from the Invoices list page. +- **Delete Invoice**: Want to delete the invoice? Click here. The invoice will be deleted and removed from the Invoices list page. + +.. TIP:: At the left of these colorful buttons, you'll see a field with an arrow that opens a drop-down menu. This field provides you with template options for the invoice design. Click on the arrow to select the desired template. When selected, the invoice preview will change to reflect the new template. + +.. IMPORTANT:: Remember to click the green Save Invoice button every time you finish working on an invoice. If you don't click Save, you will lose the changes made. (But don't worry – if you forget to click Save, a dialog box with a reminder to save will open when you try to leave the page.) diff --git a/docs/payments.rst b/docs/payments.rst new file mode 100644 index 0000000000..676f36ab33 --- /dev/null +++ b/docs/payments.rst @@ -0,0 +1,93 @@ +Payments +======== + +The Invoice Ninja system handles your entire invoicing process – from sending a quote (Pro Plan only), to invoicing your client, to receiving payment. What’s more, you can receive payments directly and automatically via Invoice Ninja’s 45+ payment gateway partners, enabling totally smooth management of your customer accounts using your choice of payment provider. To learn more about Invoice Ninja’s payment gateway partners `click here ` + +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 + +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). +2. **Manual payment**: If your client has paid you via cash, check, bank transfer, credit card or any other payment system not linked to Invoice Ninja, you will need to enter the payment manually on the Payments / Create page. + +Whether automatic or manual entry, the Payments list page presents an overview of all payments received in a user-friendly table format. Now, we’ll take you through the various columns in the Payments table from left to right: + +- **Invoice**: The invoice number for the payment +- **Client**: The client name +- **Transaction Reference**: If you have been paid automatically via one of the payment gateways, the reference number of the payment generated by the payment gateway system will be automatically recorded here. If you have entered a manual payment, the Transaction Reference will display the information you entered in the Transaction Reference field when entering the payment. If you left the Transaction Reference field blank when entering the payment, the system will automatically display “Manual entry” as the Transaction Reference on the Payments list. +- **Method**: The method of payment used, ie. PayPal, Bank Transfer, Visa, etc +- **Payment**: Amount The payment amount that was received +- **Payment Date**: The date the payment was received + +The final column to the right is the Action column. To view the actions, hover your mouse over the Action area of the relevant payment entry and a gray Select button will appear. Click on the arrow at the right side of the button to open a drop-down list. These are the action options: + +- **Edit Payment**: Edit the payment information on the Edit Payment page. +- **Archive Payment**: Click here to archive the payment. It will be archived and removed from the Payments list page. +- **Delete Payment**: Click here to delete the payment. It will be archived and removed from the Payments list page. + +.. 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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +You can also archive or delete one or more payment via the gray Archive button that appears at the top left side of the Payments list page. To archive or delete payments, check the relevant payments in the check boxes that appear in the far left column next to the invoice number. The number of payments 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. + +Want to view archived or deleted payments? Check the box marked Show archived/deleted payments, situated to the right of the Archive button. The table will automatically refresh, and will now feature the full list of payments, including current, archived and deleted payments. The status of the archived and deleted payments will be displayed in the far right column. + +- **Deleted payments** are displayed with a red Deleted button. To restore deleted payments, hover on the red Deleted button. A gray Select button will appear. Click on the Select arrow, and select Restore payment in the drop-down list. +- **Archived payments** are displayed with an orange Archived button. To restore the archived payment, hover on the orange Archived button. A gray Select button will appear. Click on the Select arrow, and choose Restore payment from the drop-down list. To delete an archived payment, select Delete payment from the drop-down list of the Select button. + +Enter Payment +^^^^^^^^^^^^^ + +You can enter a new payment directly from the Payments list page by clicking on the blue Enter Payment + button located at the top right side of the page. The Payments / Create page will open. + +Filter +^^^^^^ + +To filter the Payments list, enter the filter data in the Filter field, situated at the top right of the page, to the left of the blue Enter Payment + button. Payments can be filtered according to Client name. Enter the name or parts of the name, and the filter function will automatically locate and present the relevant entries. + +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 +^^^^^^^^^^^^^^^^^^^^^^ + +The Payments / Create page features a number of fields that you’ll need to complete. + +- **Client**: Click on the arrow on the right side of the Client field and select the client from the drop-down list. +- **Invoice**: Enter the invoice corresponding to the received payment. Click on the arrow on the right side of the Invoice field and select the invoice number from the drop-down list. +- **Amount**: Enter the amount of the payment received. TIP: The amount may not correspond to the amount on the invoice. It may be a partial payment, or it may be a higher amount than listed on the invoice, in which case the extra payment will be recorded as a credit on the client’s account balance. +- **Payment**: Type Select the method of payment used. Click on the arrow on the right side of the Payment Type field, and a drop-down list featuring a range of payment methods will open. Select the appropriate method from the list. Options include Bank Transfer, Cash, Debit, all credit cards, Google Wallet, PayPal, check and more. +Apply Credit: Here, you can apply credit from the client’s existing credit accrued in their account balance with your company. To do so, select Apply credit, which is the first option in the Payment Type drop-down list. If the client does not have enough credit to cover the payment, a red warning message will appear to notify you. +- **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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +Saving the Payment +^^^^^^^^^^^^^^^^^^ + +Once you’ve completed all the payment details, click Save and the payment will be saved to the Payments list. To cancel the payment entry, click Cancel. + +.. TIP:: When you click Save, you’ll be automatically redirected to the client’s individual summary page. Here you can view all the client details and actions recently taken in relation to this client, including the payment just entered and the balance adjustment. diff --git a/docs/quotes.rst b/docs/quotes.rst new file mode 100644 index 0000000000..c2e87d6198 --- /dev/null +++ b/docs/quotes.rst @@ -0,0 +1,138 @@ +Quotes +====== + +For Pro Plan users, the Quotes function streamlines your invoicing activity, from the moment you create and send a price quote for a particular job, until the quote is accepted, you invoice the job, receive payment and provide a receipt. With the Quotes function, you can automatically convert accepted quotes into invoices in a swift one-click action. Keeping track of your projected work schedule and potential income, the Quotes feature gives you even greater control of your freelance activity. + +List Quotes +""""""""""" + +.. Note:: The Quotes feature is only available for Pro Plan users. + +As a freelancer, many jobs – whether big or small – will begin as a quote. How so? Well, a client expresses interest in your skills or product, but wants to know how much it’s going to cost, in advance. With the Quotes feature of Invoice Ninja, available to Pro Plan users only, you can easily create a price quote and send it to the client up front, helping them make the decision to commit, and helping you keep track of your projected work schedule and income. + +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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +Now, we’ll explore all the tabs on the main header bar of the table from left to right: + + +.. TIP:: To sort the quotes 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. + +- **Quote #**: The number of the quote +- **Client**: The client name +- **Quote Date**: The date the quote was created +- **Quote Total**: The total amount of the quote, after adjustments for credits and partial payments +- **Valid Until**: The last date that the quote is valid and can be accepted by the client +- **Status**: The current status of the quote (Gray = Draft, Blue = Sent, Converted [clickable link to the invoice]) + +Action The Action button provides a range of possible actions, depending upon the status of the quote. To view the actions, hover your mouse over the Action area of the relevant quote entry and a gray Select button will appear. Click on the arrow at the right side of the button to open a drop-down list. Here are the available actions: + +- **Edit Quote**: Edit the quote information on the Edit Quote page. +- **Clone Quote**: Duplicate the quote. Then you can make minor adjustments. This is a fast way to create a new quote that is identical or similar to this quote. +- **View History**: You'll be redirected to the Quotes / Quote History page, where you can view a history of all the actions taken from the time the quote was created. The Quote History page displays a copy of the latest version of the quote and a drop-down list of all actions and the corresponding version of the quote. Select the version you wish to view. Click on the blue Edit Quote button at the top right of the page to edit the quote. +- **Mark Sent**: When you have sent the quote to your customer, mark as Sent. This will update the quote status in the Quotes list, so you can keep track. +- **Convert to Invoice**: Select this action to automatically convert the quote to an invoice. You'll be redirected to the Invoices / Create page. All the quote information will be imported to the invoice. Continue working on the invoice, save or send it to the client. +- **Archive Quote**: Click here to archive the quote. It will be archived and removed from the Quotes list page. +- **Delete Quote**: Click here to delete the quote. It will be deleted and removed from the Quotes list page. + +.. TIP:: For quotes with “Converted” status, there is also the option to View Invoice in the Action drop-down list. Click View Invoice to see the invoice page linked to the specific quote. + +You can create a new quote directly from the Quotes list page by clicking on the blue New Quote + button located at the top right side of the page. The Quotes / Create page will open. + +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 +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +You can also archive or delete one or more quote via the gray Archive button that appears at the top left side of the Quotes list page. To archive or delete quotes, check the relevant quotes in the check boxes that appear in the far left column next to the quote number. The number of quotes 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. + +Want to view archived or deleted quotes? Check the box marked Show archived/deleted quotes, situated to the right of the Archive button. The table will automatically refresh, and will now feature the full list of quotes, including current, archived and deleted quotes. The status of the archived or deleted quote will appear in the column at the far right of the table. + +- **Deleted quotes** are displayed with a red Deleted button. To restore deleted quotes, hover on the red Deleted button. A gray Select button will appear. Click on the Select arrow, and select Restore quote in the drop-down list. +- **Archived quotes** are displayed with an orange Archived button. To restore or delete the archived quote, hover on the orange Archived button. A gray Select button will appear. Click on the Select arrow, and choose Restore quote from the drop-down list. To delete an archived quote, select Delete quote from the drop-down list of the Select button. + +.. TIP:: The Quotes page features clickable links to relevant pages you may wish to view. For example, all quote numbers are clickable, taking you directly to the specific quote page, and all client names are clickable, taking you directly to the specific client summary page. In addition, if a quote has been converted to an invoice, you can click “Converted” in the status column of the quote entry. This will take you directly to the invoice page for this quote. + +Create Quote +"""""""""""" + +To create a new quote, go to the Invoices tab on the main taskbar, open the drop-down menu, and click on New Quote. This will open the Quotes / Create page. + +How to Create a New Quote + +When you open the Quotes / Create page, the Invoice Ninja system will automatically create a new, empty quote for you to complete. Note that the quote entry page is very similar in format to the invoice entry page. This makes converting the quote to an invoice extremely logical and simple. + +The top section of the quote contains a range of important information specific to the client and the quote. Let’s explore them one by one: + +- **Client**: Click on the arrow at the right end of the Client field. Select the relevant client from the client list. TIP: You can create a new client while creating a new quote. Simply click on the Create new client link, situated below the Client field on the Quotes / Create page. A pop-up window will open, enabling you to complete the new client’s details. Then continue creating the quote for this new client. + + Alternatively, once you’ve selected an existing client from the drop-down client list, you can edit the client or view the client details. Click the Edit Client or View Client links situated directly below the client field. If you click Edit Client, the Edit Client pop-up box will open. If you click View Client, the client summary page will open in a new window. + +- **Quote Date**: The date of creation of the quote. Click the calendar icon to select the relevant date. +- **Valid Until**: The last date that the quote is valid and can be accepted by the client. Click the calendar icon to select the relevant date. +- **Partial**: In the event that you will be billing the client for a partial amount of the quote, enter the amount in the Partial field. This will be automatically applied to the quote, and later, to the invoice. +- **Quote #**: The quote number is assigned automatically when you create a new quote, in order of chronology. You can manually override the default quote number by entering a different number in the Quote # field. +- **PO #**: The purchase order number. Enter the purchase order number for easy reference. +- **Discount**: Applying a discount to a quote is the same as applying a discount to an invoice. To learn how to apply a discount, refer to section 5.11 of the User Guide. + +.. TIP:: The currency of the quote will be according to the default currency specified for this client when you created the client. + +Now that we’ve completed the general quote information, it’s time to finish creating your quote by specifying the job/s you’re billing for, the amounts due for each job/line item, discounts and final balance. Let's explore the various columns of the quote, from left to right along the orange header bar: + +- **Item**: This is the name of the item you are quoting for. You can either enter the details manually, or by selecting one of the set items created by you at the Product Settings stage. To select a set item, click on the arrow at the right side of the item bar and choose the relevant item from the drop-down list. To enter the item manually, click inside the field and enter the item. Here are some examples of an item: 1 hour programming services OR 5 pages translation OR 1 hour consulting. +- **Description**: Add more information about the item. This will help the customer better understand the scope of the price quote, and is also useful for your own reference. +- **Unit Cost**: The amount you intend to charge per unit of items. For example, let's say your item is "1 hour consulting", and you charge $80 for an hour of consulting – that is, for 1 item unit. Then you'll enter 80 in the Unit Cost field. Note: If you have selected a set item, the unit cost that you pre-defined at the Product Settings stage will apply by default. You can manually override the default unit cost by clicking in the Unit Cost field and changing the value. +- **Quantity**: The number of units included in the quote. Continuing the above example, let's say you need to quote for 3 hours of consulting, enter the number 3 in the Quantity field. +- **Line Total**: This is the amount quoted for the particular line item. Once you have entered the Unit Cost and Quantity, this figure will be calculated automatically. If you change either value at any time during creation of the quote, the Line Total will adjust accordingly. + +.. TIP:: You can enter as many line items as you need in the quote. As soon as you enter any data in a line item, a fresh, blank line item will open in the row below. + +Beneath and to the right of the line item section, you'll find the Total value of the quote. It's made up of a number of figures, including Subtotal, Paid to Date and Total: + +- **Subtotal**: This is the amount quoted before other payments made to date are included in the quote calculation, such as Partial payments, Credits, etc. +- **Paid to Date**: The amount paid to date towards the value of the quote, including partial payments and credits. +- **Total**: The final value of the quote for the specified job(s), after partial payments and credits have been deducted from the quoted amount. + +Directly to the left of the Balance Due section, you'll see a text box with three tabs to choose from: + +- **Note to Client**: Want to write a personal or explanatory note to the client? Enter it here. +- **Quote Terms**: Want to set terms to the quote? Enter them here. The terms will appear on the quote. If you want to make these the default terms for all quotes, check the Save as default terms box. Then these terms will automatically appear on each quote you create. Need to change the default terms? Click Reset Terms, and the text box will clear. You can enter new terms or leave blank. +- **Quote Footer**: Want to enter information to appear as a footer on the quote? Enter it here. The text will appear at the bottom of the quote. If you want to make this the default footer for all quotes, check the Save as default footer box. Then this footer will automatically appear on each quote you create. Need to change the default footer? Click Reset footer, and the text box will clear. You can enter a new footer or leave blank. + +Below the quote data fields, you'll see a row of colorful buttons, giving you a range of options: + +- **Blue button – Download PDF**: Download the quote as a PDF file. You can then print or save to your PC or mobile device. +- **Green button – Save Quote**: Save the last version of the quote. The data is saved in your Invoice Ninja account. You can return to the quote at any time to continue working on it. +- **Orange button – Email Quote**: Email the quote directly via the Invoice Ninja system to the email address specified for the client. +- **Gray button – More Actions**: + +Click on More Actions to open the following action list: + +- **Clone Quote**: Duplicate the current quote. Then you can make minor adjustments. This is a fast way to create a new quote that is identical or similar to a previous quote. +- **View History**: You'll be redirected to the Quotes / Quote History page, where you can view a history of all the actions taken from the time the quote was created. The Quote History page displays a copy of the latest version of the quote and a drop-down list of all actions and the corresponding version of the quote. Select the version you wish to view. Click on the blue Edit Quote button at the top right of the page to go back to the quote page. +- **Mark Sent**: When you have sent the quote to your customer, mark as Sent. This will update the quote status in the Quotes list, so you can keep track. +- **Convert to Invoice**: Select this action to automatically convert the quote to an invoice. You'll be redirected to the Invoices / Create page. All the quote information will be imported to the invoice. Continue working on the invoice, save or send it to the client. +- **Archive Quote**: Want to archive the quote? Click here. The quote will be archived and removed from the Quotes list page. +- **Delete Quote**: Want to delete the quote? Click here. The quote will be deleted and removed from the Quotes list page. + +.. TIP:: At the left of these colorful buttons, you'll see a field with an arrow that opens a drop-down menu. This field provides you with template options for the quote design. Click on the arrow to select the desired template. When selected, the quote preview will change to reflect the new template. + +Quote Preview +^^^^^^^^^^^^^ + +Did you know that all this time you've been creating the new quote, a preview of the quote appears below, and it changes in real time according to the data you've entered? The PDF is created in real time; all you have to do is click Save. +To check out the quote preview, scroll down below the invoice data fields. diff --git a/docs/recurring_invoices.rst b/docs/recurring_invoices.rst new file mode 100644 index 0000000000..f1c64495f8 --- /dev/null +++ b/docs/recurring_invoices.rst @@ -0,0 +1,75 @@ +Recurring Invoices +================== + +As a busy freelancer, you work for a variety of clients. Some jobs are one-off, but others are ongoing, whether on a weekly, monthly or other basis. Invoice Ninja’s Recurring Invoice feature automatically creates invoices for ongoing jobs, and sends the current invoice to the client on a regular, pre-defined basis. For each recurring job, you only need to set up the procedure once. Here’s how it works. + +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 +^^^^^^^^^^^ + +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. + +Here is a description of the columns in the recurring invoices list, as displayed in the main header bar of the recurring invoices table, from left to right: + +- **Frequency**: How often the client is billed with this invoice, ie. Weekly, monthly, etc. +- **Client**: The client name +- **Start Date**: The date the recurring invoice first began +- **End Date**: The date the recurring invoice is due to stop +- **Invoice Total**: The amount due +- **Action**: Hover your mouse over the Action area of the relevant recurring invoice entry and a gray Select button will appear. Click on the arrow at the right side of the button to open a drop-down list. The drop-down list presents a range of possible actions for you to choose from: + + - **Edit Invoice**: Edit the recurring invoice information on the Edit Invoice page. + - **Archive Recurring**: Invoice Click here to archive the recurring invoice. It will be archived and removed from the Recurring Invoices list page. + - **Delete Recurring**: Invoice Click here to delete the recurring invoice. It will be deleted and removed from the Recurring Invoices list page. + +New Recurring Invoice +^^^^^^^^^^^^^^^^^^^^^ + +You can create a new recurring invoice directly from the Recurring Invoices list page by clicking on the blue New Recurring Invoice + button located at the top right side of the page. The Recurring Invoices / Create page will open. + +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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +Want to view archived or deleted recurring invoices? Check the box marked Show archived/deleted invoices, situated to the right of the Archive button. The table will automatically refresh, and will now feature the full list of recurring invoices, including current, archived and deleted recurring invoices, with the status of archived or deleted recurring invoices displayed in the Action column. + +- **Deleted recurring invoices** are displayed with a red Deleted button. To restore deleted recurring invoices, hover on the red Deleted button. A gray Select button will appear. Click on the Select arrow, and select Restore recurring invoice in the drop-down list. +- **Archived recurring invoices** are displayed with an orange Archived button. To restore or delete the archived recurring invoice, hover on the orange Archived button. A gray Select button will appear. Click on the Select arrow, and choose Restore recurring invoice from the drop-down list. To delete an archived recurring invoice, select Delete recurring invoice from the drop-down list of the Select button. + +.. TIP:: The Recurring Invoices page is rich in clickable links, providing you with a shortcut to relevant pages you may wish to view. For example, all client names are clickable, taking you directly to the specific client summary page. In addition, the Frequency data is clickable, and will take you to the specific Recurring invoice page where you can edit the frequency value or any other information for this recurring invoice. + +Create Recurring Invoice +"""""""""""""""""""""""" + +When you create a recurring invoice, you are creating a pre-defined frequency for invoicing a particular job and client. The recurring invoice entry as featured in the Recurring Invoices list is not the actual invoice sent. Once an invoice of a recurring invoice is created, it will appear as a regular numbered invoice in the Invoices list page. + +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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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: + +- **Client**: Click on the arrow at the right end of the Client field. Select the relevant client from the client list. TIP: You can create a new client while creating a new recurring invoice. Simply click on the Create new client link, situated below the Client field on the Recurring Invoices / Create page. A pop-up window will open, enabling you to complete the new client’s details. Then continue creating the recurring invoice for this new client. +- **How Often**: Select the frequency the invoice will be sent to the client. Click on the arrow at the right end of the How Often field to open the drop-down list of frequency options. +- **Start Date**: The date the recurring invoice begins +- **End Date**: The date the recurring invoice is due to stop +- **Auto-Bill**: Check the Enable box if you want the system to send the invoice automatically at the selected frequency. TIP: The Auto-Bill feature is currently only available if you use Stripe.com as your payment gateway. +- **PO #**: The purchase order number. Enter the purchase order number for easy reference. +- **Discount**: If you wish to apply a discount to the invoice, you can choose one of two methods: a monetary amount, or a percentage of the total amount due. To find out more about applying discounts to recurring invoices, refer to section diff --git a/docs/tasks.rst b/docs/tasks.rst new file mode 100644 index 0000000000..f9ce0b39b8 --- /dev/null +++ b/docs/tasks.rst @@ -0,0 +1,133 @@ +Tasks +===== + +Got lots of tasks running at the same time? Projects to invoice? Returning to work on that particular job from last month? The Tasks feature keeps all of these details in order, so you can best manage your time, your projects and your clients’ needs. + +List Tasks +"""""""""" + +The Tasks list page not only displays a summary of all your tasks, for all clients, in an easy-to-follow table format. It also tells you exactly what stage each task is at. From the moment you create a task, till you decide to archive or delete, the task will go through three stages: + +- **Running**: A task that is currently in process. +- **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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +Let's explore the tasks list according to the tabs on the main header bar of the table from left to right: + +- **Client**: The client name +- **Date**: The date the task was started, followed by the time it was started +- **Duration**: The total time logged for the task +- **Description**: Information about the task that you entered when you created the task +- **Status**: The current status of the task (Blue = Running, Gray = Logged, Green = Invoiced) +- **Action**: The Action button provides a range of possible actions, depending upon the status of the task. + +To view the actions, hover your mouse over the Action area of the relevant task entry and a gray Select button will appear. Click on the arrow at the right side of the button to open a drop-down list. For tasks with “Running” status, the drop-down list presents the following action items: + +- **Edit Task**: Edit the task information on the Tasks/ Edit page. +- **Stop Task**: Stop the task from running. It will then change status to “Logged”. +- **Invoice Task**: Send an invoice for this task. An invoice will be automatically generated for this task, featuring all relevant information, including invoice number, client name, task duration, description, etc. You can continue creating the invoice and then Save or Send as desired. +- **Archive Task**: Click here to archive the task. It will be archived and removed from the Tasks list page. +- **Delete Task**: Click here to delete the task. It will be deleted and removed from the Tasks list page. + +.. NOTE:: For tasks with “Logged” or “Invoiced” status, only the relevant and applicable options from the above list will show in the Action drop-down list. However, for tasks with “Invoiced” status, the Action drop-down list will also display “View Invoice”. Select this option to view and/or edit the invoice of the specific task on the Invoices / Edit page. + +.. TIP:: To sort the tasks 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. + +Create Task +^^^^^^^^^^^ + +You can create a new task directly from the Tasks list page by clicking on the blue New Task + button located at the top right side of the page. The Tasks / Create page will open. + +Filter +^^^^^^ + +To filter the Tasks list, enter the filter data in the Filter field, situated at the top right of the page, to the left of the blue New Tasks + button. Tasks can be filtered according to the client name or description, 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 the description data. The filter function will automatically locate and present the relevant entries. + +Invoice +^^^^^^^ + +Tasks can be invoiced directly from the Tasks list page. To invoice a task, check the relevant task in the check box that appears in the far left column next to the client name. Then click the blue Invoice button that appears at the top left of the Tasks list page. You’ll be redirected to the Invoices / Create page, and the invoice will automatically include the task and client information. + +.. 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 +^^^^^^^^^^^^^^^^^^^^^^^^^ + +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. + +You can also archive or delete one or more task via the gray Archive button that appears at the top left side of the Tasks list page, to the right of the blue Invoice button. To archive or delete tasks, check the relevant tasks in the check boxes that appear in the far left column next to the client name. The number of tasks 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. + +Want to view archived or deleted tasks? Check the box marked Show archived/deleted tasks, situated to the right of the Archive button. The table will automatically refresh, and will now feature the full list of tasks, including current, archived and deleted tasks. The status of archived and deleted tasks will be displayed in the Action column at the far right of the table. + +- Deleted tasks are displayed with a red Deleted button. To restore deleted tasks, hover on the red Deleted button. A gray Select button will appear. Click on the Select arrow, and select Restore task in the drop-down list. +- Archived tasks are displayed with an orange Archived button. To restore or delete the archived task, hover on the orange Archived button. A gray Select button will appear. Click on the Select arrow, and choose Restore task from the drop-down list. To delete an archived task, select Delete task from the drop-down list of the Select button. + +.. TIP:: The Tasks page provides clickable links to take you directly to a particular client summary page, or a particular task page. To visit the client summary page, click on the client name in the Client column. To visit the Tasks / Edit page of a particular task, click on the date/time data in the Date field. + +Create Task +""""""""""" + +With many clients, and any number of projects ongoing at the same time, you need a simple, automatic way to keep track of the time spent on a particular task or project. Of course, this is really important when you charge clients according to time spent, such as by the hour. Yet, it can also be helpful to know just how much time you are devoting to a client or a project – even if the time spent doesn’t necessarily affect your billing. + +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 +^^^^^^^^^^^ + +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. + +On the Tasks / Create page, begin by selecting the client name from the drop-down list that opens when you click on the arrow at the right side of the Client field. Then, in the Description box, enter any information you want to describe the task at hand. For example, you might enter “Designing company logo”, or “Consulting conference call”. This will make it easier to identify and manage each task. + +There are two ways to record sessions spent on a task: Timer and Manual. + +Timer +^^^^^ + +This is an automatic timer feature that allows you to record working sessions in real time. To begin the timer, press Start. Then get to work. The timer will run until you select Stop. +When you select Stop, you’ll be automatically redirected to the Tasks / Edit page for this created task. Here you can view a summary of the task, including Date, Time and total Duration. + +Manual +^^^^^^ + +The other way you can create a task is by manual entry of the session details. When you check Manual, two separate fields - Start Time and End Time - will automatically open below. Here, you can record the time spent on a task session, no matter when you completed it. Whether last week, yesterday or just now, simply enter the relevant date and time. + +.. TIP:: The Set to Now link, situated at the right side of the time fields, gives you the fast option of selecting today’s date and the time right now. Then you can easily edit and make minor adjustments to record the correct times. +With Manual entry, you can enter multiple sessions for the same task. When you finish entering a start and end time in one row, a new row will automatically open, giving you the option to enter another session. + +If you want to delete a particular session, hover your mouse over the time duration of the session you wish to delete. A small red cancel icon will appear. Click on the icon to delete the entry. + +Want to save the task information and move on to something else? Click Save. The task information will be saved, and you’ll be automatically redirected to the Tasks / Edit page for this created task. Here you can view a summary of the task, including Date, Time and total Duration. + +.. 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 +^^^^^^^^^^^^^^^^^^ + +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. + +The Tasks / Edit page gives you a few options to choose from: + +1. Want to continue working with the timer? To use the Timer function, click Resume, and the timer will begin again. Continue working. When you finish, click Stop. You can resume working as many times as you like for the particular task. When the task is complete, all the time spent will be recorded as one session. +2. Want to save the task information and move on to something else? Click Save. The page will refresh and the task information is saved. +3. Want to invoice the task and get paid? Click More Actions, and select Invoice Task from the list. The task information will be imported directly into a new invoice. Now, you can add your rate, and any other information needed to complete the invoice. +4. Want to archive or delete the task? The task or project no longer relevant? Click More Actions and select Archive Task or Delete Task from the list. After making your selection, you’ll be automatically redirected to the Tasks list page. If you archived the task, it will appear on the list in a lighter gray font. If you deleted the task, it will appear on the list with a strikethrough. +5. Began a task but want to cancel it? Simply click Cancel. diff --git a/docs/templates_and_reminders.rst b/docs/templates_and_reminders.rst new file mode 100644 index 0000000000..16a26c5e61 --- /dev/null +++ b/docs/templates_and_reminders.rst @@ -0,0 +1,34 @@ +Templates & Reminders +===================== + +There are a few different emails your customers receive from you via the Invoice Ninja system as part of your invoicing communications. These include the invoice notification email, quote notification email, payment notification email and various reminder emails. You can customize all your emails by selecting a template, text and design, and by specifying the frequency of reminder emails. + +Email Templates +""""""""""""""" + +Invoice Email / Quote Email / Payment Email +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- **Subject Customize**: the subject line of your invoice/quote/payment emails by entering the desired text. You can also enter variables according to your preference, such as invoice number, company name, due date and many more. Click the question mark icon at the right side of the Subject field to view a list of available variables. To reset your entry, click the Reset link just above the question mark icon. +- **Body**: Customize the email body text by entering the desired text. You can also enter variables according to your preference. Click the question mark icon at the right side of the Subject field to view a list of available variables. To reset your entry, click the Reset link just above the right hand side of the body text box. +- **Toolbar**: Immediately below the body text box, there is a bar featuring all the formatting tools you need to customize your invoice email, including font style, font size, bold/italics/underline, strikethrough, font color, background color, numbering, bulleting, alignment and hyperlinks. + +.. TIP:: Any changes you make to your email settings will instantly appear in the preview at the right hand side of the page. See how your email template will look as you are creating it, so you can get it just right. + +Reminder Emails +""""""""""""""" + +Sometimes, your clients need a friendly reminder about their outstanding payments. Invoice Ninja enables up to 3 reminder emails, and you can totally customize the email content and delivery schedule according to your preference. + +First Reminder / Second Reminder / Third Reminder +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To activate the reminder function, check the Enable box of the First Reminder tab. (TIP: To activate the second and third reminder emails, you'll need to enable them separately. Open the relevant tab and check the Enable box.) + +Schedule Define the schedule for the reminder email by selecting values for the three schedule boxes: the number of days after/ days before the due date/ invoice date. The reminder will be sent according to the values you select in these three fields. + +- **Subject**: Customize the subject line of your reminder email by entering the desired text. You can also enter variables according to your preference, such as invoice number, company name, due date and many more. Click the question mark icon at the right side of the Subject field to view a list of available variables. To reset your entry, click the Reset link just above the question mark icon. +- **Body**: Customize the email body text by entering the desired text. You can also enter variables according to your preference. Click the question mark icon at the right side of the Subject field to view a list of available variables. To reset your entry, click the Reset link just above the right hand side of the body text box. +- **Toolbar**: Immediately below the body text box, there is a bar featuring all the formatting tools you need to customize your reminder email, including font style, font size, bold/italics/underline, strikethrough, font color, background color, numbering, bulleting, alignment and hyperlinks. + +.. TIP:: Any changes you make to your reminder email settings will instantly appear in the preview at the right hand side of the page. See how your reminder email template will look as you are creating it, so you can get it just right. diff --git a/docs/user_management.rst b/docs/user_management.rst new file mode 100644 index 0000000000..a58e15eec7 --- /dev/null +++ b/docs/user_management.rst @@ -0,0 +1,40 @@ +User Management +=============== + +Need help managing your invoicing? As an Invoice Ninja account owner, you can add as many users as you like to your account. Once added, users receive the status of 'Admin'. Your Admins have access to most areas and functions of your Invoice Ninja account. + +The User Management page displays a table that includes all current users, with the following data columns: + +- **Name**: The name of the user +- **Email**: The user's email address +- **Status**: The assigned status (Green = Owner, Blue = Admin, Gray = Pending, Yellow = Disabled) +- **Action**: Hover over the Action area for the relevant user and a gray Select button will appear. Click on the arrow at the right of the button to open a drop down menu. + +For Admins, a number of options will appear: + +- **Edit User**: To edit the user details, click on Edit User. This will open the Edit User window. You can edit the user's name and email address here. +- **Archive User**: To archive the user, click Archive User. The user name will no longer appear in the User list. + +To view archived users, check the Show archived users box that appears at the top left of the User table. All users will now show. Archived users will display a yellow Disabled status. To restore an archived user, click on the gray Select button and select Restore User from the drop down menu. The user will then be restored to an active status. + +.. TIP:: While a user status is Pending, the Action feature also provides an option to Send Invitation. If the user has not responded to your invitation, you can send the invitation again as a reminder. + +To add a user to your user list, click the blue Add User + button that appears at the top right of the User Management page. The Users/ Create page will open. + +Users/ Create +""""""""""""" + +Enter the user's First Name, Last Name, and Email Address. + +Then, click the green Send Invitation button to invite the user to the account. + +If you wish to cancel the entry, click the gray Cancel button. + +Send Invitation +^^^^^^^^^^^^^^^ + +When you click Send Invitation, the user will receive an email with an invitation to join your account. The new user will be prompted to confirm the invitation, and then redirected to the Invoice Ninja log in page. They will need to enter their email address, select and confirm a password to become a registered user. + +Once registered, the new user will take on the status of Admin. Their name and details are now displayed in the User Management table. + +.. TIP:: The user's name in the User Management table is a clickable link that takes you to their User Details page. To view or edit a user's details, hover over the relevant name in the User Management table and click to open.