</ul>
<h4 id="setup-server">
Use your own Server <?php
IP::headlineLink('/en/1.0/help/setup-cron#setup-server');
?>
</h4>
<p>As there are various different types of operating software for web servers (e.g. Ubuntu, CentOS, Windows Server or even Mac OSX Server) there is not <em>one</em> tutorial on how to setup a cron. Because of this we listed tutorials for the most used systems below and wrote an example for Unix-based operating systems.</p>
<ul>
<li><a href="https://help.ubuntu.com/community/CronHowto" class="ext">Ubuntu</a></li>
<li><a href="https://www.centos.org/docs/5/html/Deployment_Guide-en-US/ch-autotasks.html" class="ext">CentOS</a></li>
<li><a href="http://www.myscienceisbetter.info/add-new-cron-job-on-windows-2008-server-using-task-scheduler.html" class="ext">Windows Server (2008)</a></li>
</ul>
<p><b>Example for Unix-based systems</b></p>
<p>Open the crontab file with <code>crontab -e</code> and paste the following line</p>
<pre>0 0 * * * wget -O - http://yoursite.com/invoices/cron/recur/your-cron-key >/dev/null 2>&1</pre>
<p>where <code>yoursite.com</code> is the domain you use for InvoicePlane and <code>your-cron-key</code> the cron key from your settings.</p>
<h4 id="setup-online">
Use an Online Service <?php
IP::headlineLink('/en/1.0/help/setup-cron#online');
?>
</h4>
<p>There are a lot of online services that offer running a cron for you, for example <a href="https://cron-job.org/en/" class="ext">cron-job.org</a> or <a href="http://www.mywebcron.com" class="ext">mywebcron.com</a> any many other.<br/>Please read the documentation of the service you use to know how to setup a cron with their system.</p>
@stop
<ol>
<li><a href="https://invoiceplane.com/downloads">Download</a> and copy all files to your server.</li>
<li>Create an empty database on your web server.</li>
<li>Upload the InvoicePlane files to your web server, either into its own subdirectory or into the public root
of the web server.
</li>
<li>Run the InvoicePlane installer from your web browser and follow his instructions: <code>http://your-domain.com/setup</code>
</li>
</ol>
<p>Once the installer finished, the installation is complete and you may log into InvoicePlane using the email
address and password you have chosen during the installation.</p>
<h3 id="subdir">
Run InvoicePlane in a sub directory <?php
IP::headlineLink('/en/1.0/getting-started/installation#subdir');
?>
</h3>
<p>If you want to run InvoicePlane in a sub directory (e.g. <code>http://yourdomain.com/invoices/</code>) you have to modify the <code>.htaccess</code> file which is located in the root directory. You must add the line</p>
<pre>RewriteBase /sub-directory</pre>
<p>where <code>sub-directory</code> is the directory you want to use. The content of the file should look like this:</p>
<pre>RewriteEngine on
RewriteBase /sub-directory
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule . index.php [L]</pre>
<?php
?>
</h3>
<p>To create a new email template, click the settings icon <code><i class="fa fa-cogs"></i></code> near the right hand side of the main menu, select <code>Email Templates</code>, and click the <code>New</code> button near the top right of the page.</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_email_templates.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_email_templates.jpg">
</a>
</p>
<p>Template variables can be inserted into the body of your email by clicking the name of the variable to include from the list below the form. The example above shows what an email template for a new invoice might look like.</p>
<h3 id="default-templates">
Setting Default Email Templates <?php
IP::headlineLink('/en/1.0/settings/email-templates#default-templates');
?>
</h3>
<p>To access the settings for your default templates, click the settings icon <code><i class="fa fa-cogs"></i></code>, select <code>System Settings</code>, and choose either the <code>Invoices</code> or the <code>Quotes</code> tab</p>
<p><b>Invoices</b></p>
<ul>
<li>Default Email Template - The selected template would be used for invoices in draft, sent and viewed statuses.</li>
<li>Paid Email Template - The selected template would be used for invoices in paid status.</li>
<li>Overdue Email Template - The selected template would be used for invoices which are overdue.</li>
</ul>
<p><b>Quotes</b></p>
<ul>
IP::headlineLink('/en/1.0/modules/invoices#delete');
?>
</h3>
<p>By default InvoicePlane prevents the deletion of invoices because it's legally forbidden to delete invoices that
were sent to customers. We decided that it should be not possible to delete invoices that are beyond the <code
class="status-draft">Draft</code> status.<br/>
But you can still enable invoice deletion even if it's not recommended. Open <code>/application/config/config.php</code>
and replace<br/>
<code>$config['enable_invoice_deletion'] = FALSE;</code><br/>
with<br/>
<code>$config['enable_invoice_deletion'] = TRUE;</code></p>
<h3 id="read-only">
Read-only <?php
IP::headlineLink('/en/1.0/modules/invoices#read-only');
?>
</h3>
<p>InvoicePlane will set invoices to read-only based on its status and the invoice can't be changed anymore. You can
change the status that will be used for the read-only mode in the settings.<br/>
If you don't want invoices to be set to read-only you can disable this feature. Open <code>/application/config/config.php</code>
and replace<br/>
<code>$config['disable_read_only'] = FALSE;</code><br/>
with<br/>
<code>$config['disable_read_only'] = TRUE;</code></p>
<?php
$article_pagination = array('previous' => array('url' => '/en/1.0/modules/quotes', 'title' => 'Quotes', 'type' => 'article'), 'next' => array('url' => '/en/1.0/modules/recurring-invoices', 'title' => 'Recurring Invoices', 'type' => 'article'));
?>
@section('content')
<h2 class="page-title">Taxrates</h2>
<p>If you want to add taxes to products / items or invoices you have to configure them on the Taxrates settings page.</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_taxrates.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_taxrates.jpg">
</a>
</p>
<h3 id="add">
Add a new Taxrate <?php
IP::headlineLink('/en/1.0/settings/taxrates#add');
?>
</h3>
<p>To add a new taxrate, click the settings icon <code><i class="fa fa-cogs"></i></code> near the right hand side of the main menu, select <code>Taxrates</code>, and click the <code>New</code> button near the top right of the page.</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_taxrates_form.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_taxrates_form.jpg">
</a>
</p>
<p>First enter the official name of the taxrate. Be careful as this will be displayed on quotes or invoices as a description of the taxrate. Then enter the percentage of the taxrate and click on <code class="green">Save</code>.</p>
<?php
$article_pagination = array('previous' => array('url' => '/en/1.0/settings/payment-methods', 'title' => 'Payment Methods', 'type' => 'article'), 'next' => array('url' => '/en/1.0/settings/user-accounts', 'title' => 'User Accounts', 'type' => 'article'));
<p>When entering a payment, first select the invoice to enter the payment for. This will default the invoice amount
into the Amount field. Adjust the date and amount, if necessary, and optionally select the payment method and
enter any pertinent notes and press the <code>Save</code> button near the top right of the page.</p>
<h3 id="online">
Online Payments <?php
IP::headlineLink('/en/1.0/modules/payments#online');
?>
</h3>
<p>InvoicePlane can be configured to allow clients to make payments online. The only payment gateway currently
tested with InvoicePlane is PayPal.</p>
<h4 id="paypal">
Configure PayPal for Online Payments <?php
IP::headlineLink('/en/1.0/modules/payments#paypal');
?>
</h4>
<p>To configure InvoicePlane integration with PayPal, you must first have valid PayPal API credentials. If you
don't, follow <a href="https://developer.paypal.com/docs/classic/api/apiCredentials/" class="ext">these
instructions</a> first to obtain the credentials.</p>
<p>Once you have your API credentials, perform the following in InvoicePlane:</p>
<ol>
<li>Click the <code>Settings</code> icon and choose the <code>System Settings</code> entry.</li>
<li>Click the <code>Merchant Account</code> tab.</li>
<li>Set <code>Enable Online Payments</code> to <code>Yes</code>.</li>
<li>Choose the appropriate <code>Merchant Driver</code>.</li>
<li>Set the <code>Test Mode</code> to <code>No</code>.</li>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_invoices_make_recurring.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_invoices_make_recurring.jpg">
</a>
</p>
<p>The invoice can be set to recur every week, month, year, quarter or six months. Since the first invoice has
already been created, the start date should be set to the next date this particular invoice should recur on.
Generally the start date should be a date in the future. If the invoice should stop recurring on a particular
date, then enter an end date as well. If the invoice should recur perpetually, then leave the end date
empty.</p>
<h3 id="view">
Viewing Recurring Invoices <?php
IP::headlineLink('/en/1.0/modules/recurring-invoices#view');
?>
</h3>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_invoices_recurring.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_invoices_recurring.jpg">
</a>
</p>
<p>The list of recurring invoices displays each recurring invoice set up in your system. Recurring invoices may be
stopped or deleted from the <code>Options</code> button in the list of recurring invoices.</p>
<?php
$article_pagination = array('previous' => array('url' => '/en/1.0/modules/invoices', 'title' => 'Invoices', 'type' => 'article'), 'next' => array('url' => '/en/1.0/modules/payments', 'title' => 'Payments', 'type' => 'article'));
@section('content')
<h2 class="page-title">Using Templates</h2>
<p>First of all, the templates shipped with InvoicePlane are what they are called: templates. You <em>can</em> use them directly for your business but they are meant to be duplicated and customized.</p>
<p>There are two main types of templates which are used:</p>
<ul>
<li>PDF Templates - Used to generate the quote and invoices PDF files</li>
<li>Web Templates - Used to display the quotes and invoices in a web browser for guest users (clients)</li>
</ul>
<h3 id="pdf">
Using PDF Templates <?php
IP::headlineLink('/en/1.0/templates/using-templates#pdf');
?>
</h3>
<p>All PDF templates can be found in the following folders of the application:</p>
<ul>
<li><code>/application/views/invoice_templates/pdf</code> for invoices</li>
<li><code>/application/views/quote_templates/pdf</code> for quotes</li>
</ul>
<p>You can select which templates should be used in the system settings for either <a href="/en/1.0/settings/invoices">Invoices</a> or <a href="/en/1.0/settings/quotes">Quotes</a>. You can find the select boxes below the headline "Templates". Simply select the template, save and the template will be used for the next quote or invoice.</p>
<?php
$article_pagination = array('previous' => array('url' => '/en/1.0/settings/', 'title' => 'Settings', 'type' => 'section'), 'next' => array('url' => '/en/1.0/templates/customize-templates', 'title' => 'Customize Templates', 'type' => 'article'));
?>
<td>Upload an image that will be displayed above the login form.<br/>
<small>Recommended size: about 300px width</small>
</td>
</tr>
<tr>
<td>Cron Key</td>
<td>You will need this cron key to setup <a href="/en/1.0/modules/recurring-invoices">recurring
invoices</a>.
</td>
</tr>
</table>
</div>
<h3 id="interface">
System settings <?php
IP::headlineLink('/en/1.0/settings/general#system');
?>
</h3>
<div class="table-responsive">
<table class="table table-condensed table-striped">
<tr>
<td>Send all outgoing emails as BCC to the admin account</td>
<td>If you enable this option <b>every</b> outgoing email is sent as an anonymous copy (BCC) to the
administrator. The administrator is the user that was created during the InvoicePlane setup.
</td>
</tr>
<tr>
<td>Cron Key</td>
<td>You will need this cron key to setup <a href="/en/1.0/modules/recurring-invoices">recurring
invoices</a>.
<h4 id="create-invoice">
Send the invoice <?php
IP::headlineLink('/en/1.0/getting-started/quickstart#send-invoice');
?>
</h4>
<p>If viewing a list of invoices, click the <code>Options</code> button on the row of the invoice to send. If
viewing a single invoice, click the Options button near the top right of the page. Select <code>Send
Email</code> from the <code>Options</code> button, review the information and submit the form. The client
will receive an email with the invoice attached as a PDF.</p>
<hr/>
<h3 id="enter-payment">
Entering a Payment <?php
IP::headlineLink('/en/1.0/getting-started/quickstart#enter-payment');
?>
</h3>
<p>Offline payments are entered by clicking <code>Payments</code> from the main menu at the top of the page and
selecting <code>Enter Payment</code>. Fill in the appropriate information and submit the form to enter the
payment.</p>
<p>Online payments allow a client to pay their invoice online. When an online payment occurs, the payment is
automatically entered back into InvoicePlane, eliminating the need to manually enter an offline payment. Online
payments require additional setup before they can be used.</p>
<p>More information about payments can be found on the <a href="/en/1.0/modules/payments">Payments</a> page.</p>
<?php
$article_pagination = array('previous' => array('url' => '/en/1.0/getting-started/installation', 'title' => 'Installation', 'type' => 'article'), 'next' => array('url' => '/en/1.0/getting-started/updating-ip', 'title' => 'Updating InvoicePlane', 'type' => 'article'));
?>
<pre>
stdClass Object
(
[invoice_custom_id] => 13
[invoice_id] => 24
[invoice_custom_archive_id] =>
[client_custom_id] => 8
...
</pre>
<p>This is the list of all available variables where the part in the brackets (e.g. <code>invoice_id</code>) is the
name of the variable and the part after the <code>=></code> is the content of the variable.</p>
<h3 id="code-examples">
Code Examples <?php
IP::headlineLink('/en/1.0/templates/customize-templates#code-examples');
?>
</h3>
<p>Here is a list of some examples for code that can be used to display variables.<br/>
Replace <code>invoice</code> with <code>quote</code> when editing quote templates.<br/>
Replace <code>variable_name</code> with the actual name of the variable.</p>
<div class="table-responsive">
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Description</th>
<th>Code</th>
</tr>
</thead>
<tr>
<td>Current month</td>
<td><code>{{{month}}}</code></td>
<td>Inserts the current month with 2 digits</td>
</tr>
<tr>
<td>Current day</td>
<td><code>{{{day}}}</code></td>
<td>Inserts the current day with 2 digits</td>
</tr>
</table>
</div>
<h4 id="examples">
Formatting Examples <?php
IP::headlineLink('/en/1.0/settings/invoice-groups#examples');
?>
</h4>
<div class="table-responsive">
<table class="table table-condensed table-striped">
<tr>
<th>Template</th>
<th>Output</th>
</tr>
<tr>
<td><code>{{{year}}}/{{{ID}}}</code></td>
<td>{{ date('Y') }}/456</td>
</tr>
<tr>
<td><code>{{{year}}}_{{{month}}}_{{{ID}}}</code></td>
@section('content')
<h2 class="page-title">Payment Methods</h2>
<p>Payment Methods</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_payment_methods.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_payment_methods.jpg">
</a>
</p>
<h3 id="add">
Add a Payment Method <?php
IP::headlineLink('/en/1.0/settings/payment-methods#add');
?>
</h3>
<p>To add a new payment method, click the settings icon <code><i class="fa fa-cogs"></i></code> near the right hand side of the main menu, select <code>Payment Methods</code>, and click the <code>New</code> button near the top right of the page.</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_payment_methods_form.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_payment_methods_form.jpg">
</a>
</p>
<p>Simply enter the name of the payment method and click on <code class="green">Save</code> button. The method will be available when adding a payment.</p>
<?php
$article_pagination = array('previous' => array('url' => '/en/1.0/settings/invoicegroups', 'title' => 'Invoicegroups', 'type' => 'article'), 'next' => array('url' => '/en/1.0/settings/taxrates', 'title' => 'Taxrates', 'type' => 'article'));
Choose the appropriate tax rate and placement from the window that appears and press the <code class="green">Submit</code>
button. That tax will be calculated against the quote total.</p>
<h4 id="copy-quote">
Copying the Quote <?php
IP::headlineLink('/en/1.0/modules/quotes#copy-quote');
?>
</h4>
<p>To copy a quote, choose <code>Copy Quote</code> from the <code>Options</code> button on the edit quote page.
Change the client name, if appropriate, and then select the quote date and quote group and submit the form. All
items, taxes and amounts from the source quote will be copied to a new quote.</p>
<h4 id="quote-to-invoice">
Generate Invoice from Quote <?php
IP::headlineLink('/en/1.0/modules/quotes#quote-to-invoice');
?>
</h4>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_quotes_quote_to_invoice.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_quotes_quote_to_invoice.jpg">
</a>
</p>
<p>When a client accepts a quote, you can convert that quote to an invoice by using the <code>Quote to
Invoice</code> menu item from the <code>Options</code> button. Choose the invoice date and invoice group and
press the <code class="green">Submit</code> button. The items from the quote will be copied over to your new
invoice.</p>
from the client list, click the <code>New</code> button near the top right of the page.</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_clients_add.jpg" class="thumbnail"
data-lightbox="image-1">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_clients_add.jpg">
</a>
</p>
<p>When adding a new client, the only field required is the <code>Client Name</code> field, although if you plan to
email invoices and quotes to your clients, the <code>Email Address</code> field should be filled in as well. Any
<a href="/en/1.0/settings/custom-fields">custom fields</a> created for client records will display at the bottom
of the client form.</p>
<h3 id="client-login">
Client Logins <?php
IP::headlineLink('/en/1.0/modules/clients#client-login');
?>
</h3>
<p>Clients can be granted permission to log into InvoicePlane to view their quotes and invoices, approve or reject
quotes and pay their invoices. See the <code>Guest Account</code> section of the <a
href="/en/1.0/settings/user-accounts">User Accounts</a> page for instructions on creating logins for
your clients.</p>
<?php
$article_pagination = array('next' => array('url' => '/en/1.0/modules/quotes', 'title' => 'Quotes', 'type' => 'article'));
?>
@stop
<td>Default Terms</td>
<td>You can enter the default terms for any invoice here</td>
</tr>
<tr>
<td>Automatically email recurring invoices</td>
<td>If you have recurring invoices you can choose if InvoicePlane should send an email with the invoice attached to the client automatically</td>
</tr>
<tr>
<td>Mark Invoices as sent when PDF is generated</td>
<td>Choose if InvoicePlane should set the status of an invoice to <code class="status-sent">Sent</code> when you download the PDF</td>
</tr>
<tr>
<td>Invoice Logo</td>
<td>Upload an image that should be placed on templates.</td>
</tr>
</table>
</div>
<h3 id="templates">
Templates <?php
IP::headlineLink('/en/1.0/settings/invoices#templates');
?>
</h3>
<p>All following settings allow you to set default PDF and email templates for different states and purposes. At the end in the PDF Footer you can enter information that should be placed at the bottom of each PDF template.</p>
<?php
$article_pagination = array('previous' => array('url' => '/en/1.0/settings/general', 'title' => 'General Settings', 'type' => 'article'), 'next' => array('url' => '/en/1.0/settings/quotes', 'title' => 'Quote Settings', 'type' => 'article'));
?>
@stop
of the main menu and select <code>User Accounts</code>.</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_useraccounts.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_useraccounts.jpg">
</a>
</p>
<p>To navigate between pages, use the pager buttons located on the submenu bar.</p>
<p>The <code>Options</code> button at the end of each row displays a menu from which you can edit or delete an user.
</p>
<h3 id="add">
Add an User Account <?php
IP::headlineLink('/en/1.0/settings/user_accounts#add');
?>
</h3>
<p>To add a new user account, click the settings icon <code><i class="fa fa-cogs"></i></code> near the right hand
side of the main menu, select <code>User Accounts</code>, and click the <code>New</code> button near the top
right of the page.</p>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_useraccounts_form.jpg" rel="lightbox">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_useraccounts_form.jpg">
</a>
</p>
<p>To create the user account, provide the user's name (typically their full name), email address (this is what
they'll use to log in with), password and password verification. When selecting the user type, choose between
@extends('layouts.master')
@section('content')
<h2 class="page-title">Translation / Localization</h2>
<p>InvoicePlane comes with the English language by default. To contribute to or to download other language packs
please visit the <a href="http://translations.invoiceplane.com/" class="ext">translation repository</a>.</p>
<h3 id="install">
Install a new translation <?php
IP::headlineLink('/en/1.0/system/translation-localization#install');
?>
</h3>
<div class="alert alert-warning">
Please notice: some translations are not complete so some texts will be displayed in English. So do not delete
the english language folder!
</div>
<ol>
<li>Download the translation pack from the <a href="http://translations.invoiceplane.com/" class="ext">translation
repository</a></li>
<li>Open the folder of the language you want to install (<code>de</code> = German)</li>
<li>Copy the folder that should be called something like <code>de_DE</code>, <code>fr_FR</code> or
<code>es_AR</code></li>
<li>Paste the folder to the following directory of your InvoicePlane installation:
<code>/application/language/</code></li>
<li>Apply the language in your <a href="/en/1.0/settings/general">general settings</a>.</li>
</ol>
<p>
<a href="//invoiceplane.com/content/screenshots/web/ip_custom_fields_form.jpg" class="thumbnail"
data-lightbox="image-1">
<img src="//invoiceplane.com/content/screenshots/web_thumb/ip_custom_fields_form.jpg">
</a>
</p>
<p>When adding custom fields, it is recommended to only use alpha and numeric characters for the label name. Once a
custom field has been added to an object, the custom field will display at the bottom of the form for that
object (so a custom field created for the client object will appear on the client form).</p>
<h3 id="add-to-template">
Adding Custom Fields to Invoice
Templates <?php
IP::headlineLink('/en/1.0/settings/custom-fields#add-to-template');
?>
</h3>
Simply creating the custom field won't place it on our invoice. We still need to modify the invoice template to do so.
To output this value to an invoice, take note of the Column value (in this case it's <code>client_custom_tax_id_number</code>). Edit an invoice template and add the following line where you'd like it to display:
<pre>
<?php echo $invoice->client_custom_tax_id_number; ?>
</pre>
Now any time an invoice is generated using the template you modified, the custom field will display along with the value you entered for that client.
This same procedure is used for adding custom fields to any of the other available objects and for adding those fields to our invoices.
