Module Dolimport

From Dolibarr ERP CRM Wiki
(Redirected from Dolimport api)
Jump to navigation Jump to search


Informations

Module name DOLIMPORT API & DOLIMPORT CSV
Editor / Editeur Florian DUFOURG - demo
Download or buy page / Page achat ou téléchargement www.dolistore.com
Status / Statut / Estado Stable
Prerequisites / Prérequis Dolibarr min version 9.0.0   
Last update date / Date mise à jour fiche / Fecha última actualización 2020-05-27
Note / Nota

Features

Import your bank statements from a csv file or connect directly the information from your QONTO bank account. Then many options are available :

  1. Create and paye a customer invoice
  2. Create and paye a vendor invoice
  3. Create and pay a VAT
  4. Create and pay a salary
  5. Create and pay a social and fiscal taxes
  6. Pay an existing customer invoice
  7. Pay an existing vendor invoice
  8. Pay a loan
  9. Pay an expense report
  10. Link a payment to a transaction

If you use QONTO API, you can download the attached files of QONTO directly from Dolibarr. Also the VAT and all other usefull information will be used to generate the Dolibarr elements.

If the reconciliation option of the bank account is activated in Dolibarr, Dolimport API will also automaticaly reconciliate the statement.

Install

  • Download archive file of module (.zip file) from web site www.dolistore.com or from any other source.
  • Install module into the custom folder of Dolibarr:
    • Go to Home - Setup - Modules - Deploy/install external app/module
    • Upload the file. Note: If it fails, you can manually unzip the file into the custom directory from command line: Go into the *custom* directory and uncompress file with command unzip modulefile.zip
  • Module is ready to be activated and used.

Setup

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears Cog circle.svg on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.

Module Configuration

Module setup page

Configure the module from the module setup page, you can define :

  • The default project you want to link the element (this value can be change later in the form)
  • The default VAT value (this value can be change later in the form or directly define in the CSV file or in QONTO)
  • An option to show only open project in dolimport API form or all projects
  • An option to add a unique number for vendor reference (avoid double reference)
  • The period of time you want to show in the list of transaction

Connect to QONTO API

If you want to use the module with a csv file, you have nothing more to do.

To connect Qonto to Dolibarr, go to the bank account card in Dolibarr.

Dolimport API automatically add 3 fields : ID API, KEY API and BANK API.

Extrafield BANK API setup

Select QONTO as BANK API value (for now it is the only option).

Extrafield ID API & KEY API setup

Go to your QONTO account : | QONTO

On the left menu of the QONTO web page, select "paramètres."


On the left menu select "intégration API".


Now you can go back to Dolibarr and fill the ID and KEY API with the info found on the QONTO website.

Menu

You can see this module in the left menu of the "bank" top menu.

If you choose the QONTO API option, only one link will appear in the menu, this is the list of transactions.
If you are not using QONTO API (so you are using CSV import), 2 links will appears in the menu, one to import transaction from a csv file and an other to see and process the transactions.

Import a file (only if you use CSV files)

Go to the page : "load a csv file".

DOLIMPORT API Import csv page 2.png

The left section of this page allows to prepare the import of the CSV file. All the parameters are saved for the next import.

  1. Select the date format as it is on the csv file
  2. Select how the amount (credit and debit) are shown in the csv file
  3. Select how the payment is defined in the csv file, if the payment mode is define so we need the translation between the Dolibarr payment mode and your bank statement csv file. The files below "translation" allow to explain how the payment mode are named in the csv file.


The right section of this page show the csv statement already importes. You can delete the statement doing click on the trash bin icon.

Setting of the lines

Once your csv file is uploaded, select the category of each column (date of operation, date of value, amount, label, secondary label).

The fields operation date, label and amount are required, the other fields are optionnals.

Uncheck the lines that you do not want to import (for example if there is a title line).

DOLIMPORT API Import csv page 3.png


Before to import give a name to the bank statement, it will help to reconcile.


Sometime PHP limits the quantity of datas you can import, if a message shows that there is too much columns and rows, you should delete columns in the csv file or divide the csv file in many files.

Generate Dolibarr elements from the list of transaction

If you already successfully load a csv file or if your QONTO bank account is connected to Dolibarr, you can see the list of the transaction doing click on the name of the bank account in the menu.

Generate the elements (invoices, taxes, salaries,loan...)

To generate a Dolibarr element (invoice, expense report, payment, loan...) you have to make a click on an icon on the right of the click.

DOLIMPORT List of transactions 2.png

Select the icon depending of the type of element you want to generate.

DOLIMPORT generation of vendor invoice.png