Working on readthedocs

.gitignore

@@ -19,7 +19,7 @@ Thumbs.db
 /.env
 /.env.development.php
 /.env.php
-
+/docs/_build
 /error_log
 /auth.json
 /public/error_log

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.

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.

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.

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.