Dolibarr ERP CRM Wiki - User contributions [en]

Module Web Services API REST (developer)

2021-06-30T19:28:24Z

Egils: /* Use */ sqlfilters example

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

= Function =
When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

= Dolibarr REST web services server =
Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx''' where xxx is name of the API to call.

A list of APIs on your installation can be found via the explorer.

==Apache setup==
There is nothing to do. If your Dolibarr is working with Apache, the REST API should also work. APIs will be served by the same virtual web server than your application.

==Nginx setup==
Like Apache, if your Dolibarr is working inside a NGinx virtual host, you should have nothing to do to have your API working. APIs will be served by the same virtual web server than your application.

However, NGinx default setup on a lot of distribution is often a gaz engine and you may experience troubles. If you experience suche troubles, you can try to edit your NGinx config file to match the following example. This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).

<syntaxHighlight lang="nginx">
worker_processes 1;
error_log /var/log/nginx/error.log;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</syntaxHighlight>

= List of provided services =
Only few services are available. Starting to Dolibarr 5.0 version, you can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

You can then test directly from this explorer any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

= Installation =

To install, open the modules page and activate de API REST module. On the configuration page of the module, there's a link to an explorer. Click on it to open the API explorer.

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

= Use =

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<syntaxHighlight lang="php">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</syntaxHighlight>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :
* $method : string, "GET", "POST", "PUT", "DELETE"
* $apikey : string, "your <token> generated earlier"
* $url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
* $data : string, datas in json format. This parameter is not mandatory.

==Accepted parameters==
This is documented somewhat in the REST Explorer. Check that first. Second try and see what response you get. Third look at the source code for the given API.

=== sqlfilters ===
They are passed on to the database after a check.
These work on the product endpoint:
* (t.fk_product_type: = :'0') and (t.tosell: = :'1') and (t.label: ilike :'%string')

==Date==
The ISO date format is accepted: %Y-%m-%d e.g. 2020-07-14. yymmdd is not accepted.

= Examples with PHP =

This is more examples, for different uses cases:

In every examples, we have:
* $apiKey = "<my token>";
* $apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<syntaxHighlight lang="php">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</syntaxHighlight>
Comments :
* I retrieve the 10'000 first products sorted on their ID in the base
* html_entity_decode is necessary as single quotes are encoded
* It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<syntaxHighlight lang="php">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</syntaxHighlight>
Comments :
* before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<syntaxHighlight lang="php">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</syntaxHighlight>
Comments :
* I check if the ref of my product exist in the array created in the first example.
* If it exists, I use it's key in the array as ID
* If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
* I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<syntaxHighlight lang="php">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</syntaxHighlight>
Comments :
* $clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
* type => 0, This is a customer order (while 1 = supplier order)

<syntaxHighlight lang="php">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</syntaxHighlight>
Comments :
* in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult is the ID of the order created in the previous example

<syntaxHighlight lang="php">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</syntaxHighlight>
Comments :
* limit => 1 only 1 customer
* mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
* sqlfilters a bit special but there are more examples on the explorer page

<syntaxHighlight lang="php">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</syntaxHighlight>
Comments :
* client => 1 He is a customer (not a supplier)
* code_client => -1 so the customer code will be generated automatically.
* we get the customer ID in $clientDoliId

= Examples with Python =
See https://pypi.org/project/dolipy/ and https://pypi.org/project/dolibarr/

= Develop your own service / API =
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You take the example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, the file may be generated for you.

The framework detects automatically the API and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

Some more informations in the Dolibarr code. You can look here : htdocs/<directory>/class/api_xxx_class.php 
Ex : htdocs/societe/class/api_thirdparties.class.php for thirdparties. 
Ex : Invoices are in htdocs/compta/facture/class

Module Web Services API REST (developer)

2021-06-30T11:04:49Z

Egils: /* Examples with Python */ new section

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

= Function =
When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

= Dolibarr REST web services server =
Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx''' where xxx is name of the API to call.

A list of APIs on your installation can be found via the explorer.

==Apache setup==
There is nothing to do. If your Dolibarr is working with Apache, the REST API should also work. APIs will be served by the same virtual web server than your application.

==Nginx setup==
Like Apache, if your Dolibarr is working inside a NGinx virtual host, you should have nothing to do to have your API working. APIs will be served by the same virtual web server than your application.

However, NGinx default setup on a lot of distribution is often a gaz engine and you may experience troubles. If you experience suche troubles, you can try to edit your NGinx config file to match the following example. This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).

<syntaxHighlight lang="nginx">
worker_processes 1;
error_log /var/log/nginx/error.log;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</syntaxHighlight>

= List of provided services =
Only few services are available. Starting to Dolibarr 5.0 version, you can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

You can then test directly from this explorer any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

= Installation =

To install, open the modules page and activate de API REST module. On the configuration page of the module, there's a link to an explorer. Click on it to open the API explorer.

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

= Use =

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<syntaxHighlight lang="php">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</syntaxHighlight>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :
* $method : string, "GET", "POST", "PUT", "DELETE"
* $apikey : string, "your <token> generated earlier"
* $url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
* $data : string, datas in json format. This parameter is not mandatory.

==Accepted parameters==
This is documented somewhat in the REST Explorer. Check that first. Second try and see what response you get. Third look at the source code for the given API.

==Date==
The ISO date format is accepted: %Y-%m-%d e.g. 2020-07-14. yymmdd is not accepted.

= Examples with PHP =

This is more examples, for different uses cases:

In every examples, we have:
* $apiKey = "<my token>";
* $apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<syntaxHighlight lang="php">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</syntaxHighlight>
Comments :
* I retrieve the 10'000 first products sorted on their ID in the base
* html_entity_decode is necessary as single quotes are encoded
* It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<syntaxHighlight lang="php">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</syntaxHighlight>
Comments :
* before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<syntaxHighlight lang="php">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</syntaxHighlight>
Comments :
* I check if the ref of my product exist in the array created in the first example.
* If it exists, I use it's key in the array as ID
* If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
* I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<syntaxHighlight lang="php">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</syntaxHighlight>
Comments :
* $clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
* type => 0, This is a customer order (while 1 = supplier order)

<syntaxHighlight lang="php">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</syntaxHighlight>
Comments :
* in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult is the ID of the order created in the previous example

<syntaxHighlight lang="php">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</syntaxHighlight>
Comments :
* limit => 1 only 1 customer
* mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
* sqlfilters a bit special but there are more examples on the explorer page

<syntaxHighlight lang="php">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</syntaxHighlight>
Comments :
* client => 1 He is a customer (not a supplier)
* code_client => -1 so the customer code will be generated automatically.
* we get the customer ID in $clientDoliId

= Examples with Python =
See https://pypi.org/project/dolipy/ and https://pypi.org/project/dolibarr/

= Develop your own service / API =
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You take the example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, the file may be generated for you.

The framework detects automatically the API and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

Some more informations in the Dolibarr code. You can look here : htdocs/<directory>/class/api_xxx_class.php 
Ex : htdocs/societe/class/api_thirdparties.class.php for thirdparties. 
Ex : Invoices are in htdocs/compta/facture/class

Prerequisites

2021-06-18T20:40:59Z

Egils: /* PHP */ refer to Releases for older versions to only have it in one place

[[fr:Prérequis]]
[[es:Prerrequisitos]]
[[zh:安装前提条件]]
[[de:Voraussetzungen]]


[[Category:Admin_en]]
{{TemplateDocUser}}

Dolibarr was built to work on following components:

= OS (Operating Systems) =
Nearly every modern OS is supported.
* Clients: every OS, that can run a webbrowser
* Server: every os, that supports a webserver with PHP and a SQL Database (see below)

for example: GNU/Linux, BSD, Windows, MacOS, AIX, ...

'''Note for Windows 7 users:'''

When using Windows 7 the Visual C++ Redistributable for Visual Studio 2012 Update 4 must be already installed.
An error message during installation will indicate if this is missing.
'''Make sure you choose the 32-bit version (vcredist_x86.exe).'''
It can be obtained here:
* https://www.microsoft.com/en-us/download/details.aspx?id=30679

= Database =
* MySQL {{MySqlMinVersion}} (any MySQL options/parameters supported).
!! Do not use MySQL version 5.5.40 nor 5.5.41, this version has critical bugs with data loss.
If using option mode=STRICT returns some warnings or error, please report them to us.
* MariaDB {{MySqlMinVersion}}
* PostgreSQL {{PostgresMinVersion}}

* MS SQL (experimental support not working yet)

* Database size need is lower than '''1Mb per 100''' customers/suppliers registered into database.

= PHP =
* Min. required version: {{PHPMinVersion}}, Max {{PHPMaxVersion}}
* Support for user sessions must be enabled (it is the default value for PHP)
* PHP configuration must allow use of {{PHPMinMemory}}Mb of memory (parameter PHP memory_limit).
* Works however safe_mode parameter is set

[[Releases|Details for older versions]].

= Disk storage =

* Dolibarr program files use about '''150 MByte''' on disk.
* Extra Modules or Templates need some additional disk space.
* Dolibarr Database Files use about '''35 MByte''' on disk.
* Database-System itself need also some disk-space and more space for temporary files.

However, it will need more disk space if you upload joined files or to store generated PDF or ODT documents. Storage will depend on number and size of attached files.

= CPU =
You can start even with an old Intel Pentium processor or equal.
If you have more than 30 users, a 1GHz CPU or more is recommended.

Prerequisite

2021-06-18T20:37:24Z

Egils: Egils moved page Prerequisite to Prerequisites: better english

#REDIRECT [[Prerequisites]]

Prerequisites

2021-06-18T20:37:24Z

Egils: Egils moved page Prerequisite to Prerequisites: better english

[[fr:Prérequis]]
[[es:Prerrequisitos]]
[[zh:安装前提条件]]
[[de:Voraussetzungen]]


[[Category:Admin_en]]
{{TemplateDocUser}}

Dolibarr was built to work on following components:

= OS (Operating Systems) =
Nearly every modern OS is supported.
* Clients: every OS, that can run a webbrowser
* Server: every os, that supports a webserver with PHP and a SQL Database (see below)

for example: GNU/Linux, BSD, Windows, MacOS, AIX, ...

'''Note for Windows 7 users:'''

When using Windows 7 the Visual C++ Redistributable for Visual Studio 2012 Update 4 must be already installed.
An error message during installation will indicate if this is missing.
'''Make sure you choose the 32-bit version (vcredist_x86.exe).'''
It can be obtained here:
* https://www.microsoft.com/en-us/download/details.aspx?id=30679

= Database =
* MySQL {{MySqlMinVersion}} (any MySQL options/parameters supported).
!! Do not use MySQL version 5.5.40 nor 5.5.41, this version has critical bugs with data loss.
If using option mode=STRICT returns some warnings or error, please report them to us.
* MariaDB {{MySqlMinVersion}}
* PostgreSQL {{PostgresMinVersion}}

* MS SQL (experimental support not working yet)

* Database size need is lower than '''1Mb per 100''' customers/suppliers registered into database.

= PHP =
* Min. required version: {{PHPMinVersion}}, Max {{PHPMaxVersion}}
* Support for user sessions must be enabled (it is the default value for PHP)
* PHP configuration must allow use of {{PHPMinMemory}}Mb of memory (parameter PHP memory_limit).
* Works however safe_mode parameter is set

'''Oldest versions'''

'''Dolibarr 9.0.x'''
* min. required version: PHP 5.4+
* max version: PHP 7.3

'''Dolibarr 8.0.x'''
* min. required version: PHP 5.4+
* max version: PHP 7.2

'''Dolibarr 7.0.x'''
* min. required version: PHP 5.3+
* max version: PHP 7.2

= Disk storage =

* Dolibarr program files use about '''150 MByte''' on disk.
* Extra Modules or Templates need some additional disk space.
* Dolibarr Database Files use about '''35 MByte''' on disk.
* Database-System itself need also some disk-space and more space for temporary files.

However, it will need more disk space if you upload joined files or to store generated PDF or ODT documents. Storage will depend on number and size of attached files.

= CPU =
You can start even with an old Intel Pentium processor or equal.
If you have more than 30 users, a 1GHz CPU or more is recommended.

User talk:Eldy

2021-05-18T08:15:30Z

Egils: /* Typo on main page */ new section

== Discourse migration ==

Hello, I tried the subfolder thing : https://wiki.dolibarr.org/index.php/User_talk:Jtraulle/DiscourseMigration#Domain_requirement

== FEC is not an XML format ==

Hi Eldy

I think FEC is not an XML format.
Therefore I have changed your edit of 25 July 2020: 
https://wiki.dolibarr.org/index.php?title=Template:AccountingExpertExportExamples&diff=next&oldid=47998&diffmode=source

Please review my changes: 
https://wiki.dolibarr.org/index.php/Module_Comptabilit%C3%A9_en_Partie_Double#Export_FEC

[[User:Oliver|Oliver]] ([[User talk:Oliver|talk]]) 03:21, 15 August 2020 (CEST)

=> True. FEC is a txt format.

== Révocation modification User:Jtraulle/DiscourseMigration/Implementation ==

J'ai révoqué ta modification concernant la section permettant de reconstruire le container data du Discourse.

Contrairement à ce que l'on pourrait penser, il ne s'agit pas d'une coquille mais la commande est bien à exécuter deux fois comme indiqué dans la page mise en référence (il me semble que la première exécution permet la migration des des données d'une version majeure de PostgreSQL à l'autre et la seconde permet d'effectivement effectuer la mise à jour du container ou l'inverse mais il est bien nécessaire de l'exécuter deux fois ;) )

[[User:Jtraulle|Jtraulle]] ([[User talk:Jtraulle|talk]]) 10:39, 18 October 2020 (CEST)

== Typo on main page ==

Screenshots galery -> Screenshots gallery--[[User:Egils|Egils]] ([[User talk:Egils|talk]]) 08:15, 18 May 2021 (UTC)

Installation - Upgrade

2021-05-18T07:24:07Z

Egils: /* For installation that used GIT */ 12 -> 13

[[fr:Installation_-_Mise_à_jour]]
[[es:Instalación_-_Actualización]]
[[zh:安装_-_升级]]


[[Category:Admin_en]]
{{TemplateDocUser}}

The following documentation describes processes to install or upgrade Dolibarr on a Windows, MAC OS or Unix like platform.

=Install Dolibarr=
This chapter describe different available methods to install Dolibarr for the first time (from the most simple to the manual one). See next chapter for upgrades.

==On your dedicated computer/server (installation "On Premise")==
===[[File:Logo_windows.png]] Manually or with DoliWamp===
- '''Prerequisite''': Windows

- '''Level''': Non experienced users

This process works only for Windows users and is recommended for user with no computer knowledge. If you have experience with Apache, PHP and Mysql installation, next chapter is better for you.

If you have time and want to learn how to install an Apache, PHP and MariaDB web server, see the [[Manual installation on Windows]] page for step-by-step instructions.

However, if you are a newbie user and running Windows, you can use DoliWamp. DoliWamp is a specialized Dolibarr distribution for Windows. This distribution allows you to make an installation under Windows with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge. This is steps to install DoliWamp:

*Download last Dolibarr version for Windows DoliWamp.

For this, see at {{TemplateURLToDownloadDoliWamp}}

*Run the downloaded .exe and follow instructions.

===[[File:Logo_ubuntu.png]] With DoliDeb (Debian or Ubuntu .deb package)===
- '''Prerequisite''': Linux Ubuntu

- '''Level''': Non experienced users

This process works only for Ubuntu or Debian Linux users and is recommended for user with little computer knowledge. If you are experienced with Apache, PHP and Mysql installation, the chapter 'with standard package' is better for you. However, if you are a newbie user and running Ubuntu, you can use DoliDeb. DoliDeb is a specialized Dolibarr distribution for Debian or Ubuntu. This distribution allows you to make an installation under Ubuntu with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge.

*Steps to install DoliDeb are described into page [[Dolibarr for Ubuntu or Debian]].

===[[File:Logo_rpm.png|42px]] With DoliRpm (Fedora, Redhat, Mandriva, Mageia or OpenSuse .rpm package)===
- '''Prerequisite''': Linux Fedora, Redhat, Mandriva, Mageia or OpenSuse

- '''Level''': Non experienced users

This process works only for Fedora, Redhat, Mandriva, Mageia or OpenSuse Linux users and is recommended for user with no computer knowledge. If you have experience with Apache, PHP and Mysql installation, next chapter 'with standard package' is better for you. However, if you are a newbie user and running Fedora or Redhat, you can use DoliRpm. DoliRpm is a specialized Dolibarr distribution for Fedora, Redhat or Mandriva. This distribution allows you to make an installation under such OS with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge.

*Steps to install DoliRpm are described into page [[Dolibarr for Redhat or Fedora (rpm package)]] or [[Dolibarr for Mandriva or Mageia (rpm package)]] or [[Dolibarr for OpenSuse (rpm package)]].

===[[File:Gnu.png]] With Dolibarr (standard .zip package or from git)===
- '''Prerequisite''': Apache, PHP and a database server (MySQL or PostgreSQL) are already running correctly and user/pass (of a new database or root server) is known.

- '''Level''': Users with few Web and Database administration knowledge.

This procedure describe manual (and recommended) installation on a GNU/Linux system (Debian, Mandriva, ...), it can be used for other OS with minor changes.
You can follow this tutorial for any Dolibarr version >= 2.0.0

*Check that you have installed Apache, PHP {{PHPMinVersion}} and a database server (MySQL {{MySqlMinVersion}} or PostGreSQL) correctly (check list of installed packaged on your server by using the package manager of your distribution). If not, install them (use last recent version).

*Check that main root or admin user/password couple for the server is known and works correctly. If this root or admin user/password is not known because not yet defined, read following chapter. Otherwise go on next step:

For Linux users, if you have just installed a MySQL server, the admin user is''' root'''. If the root password has never been set yet, you must run the following command to initialize the password:
<source lang="bash">
mysql
</source>
Once in Mysql interface, run the SQL command to modify the root password:
<source lang="sql">
grant all privileges on *.* to root@'localhost' identified by 'newrootpass' with grant option;
</source>
Then enter and \q to quit.

To check that the connection with the new couple user/password works, launch the command
<source lang="bash">
mysql -u root -p
</source>
And type your password ''newrootpass'' then \q to quit if the connection has been successful.

For Linux users, if you have just installed a PostgreSQL server, you must run the following command to initialize an admin user and password. For this, add the following line in file '''/etc/postgresql/x.x/main/pg_hba.conf''' (replace x.x with your postgres version)
<source lang="ini">
local all dolibarrowner md5
</source>
Also, comment the line
<source lang="ini">
#local all all ident
</source>
This line ensure that system login used to connect to database (it will be login the web server run with), is same than database account (this is never the case).

Then launch commands from a root shell
<source lang="bash">
sudo -s -u postgres
createuser dolibarrowner
psql -h localhost -d template1 -c "alter user dolibarrowner with password 'dolibarrownerpass'"
exit
sudo /etc/init.d/postgresql restart
</source>
You can test a connection with this user with command
<source lang="bash">
psql -d postgres -U dolibarrowner -W
</source>
And type your ''dolibarrownerpass'' as password and \q to quit if connection is ok.

*Go into the directory where to install Dolibarr (the web root directory defined for your web server)

#For Debian and Ubuntu families, it is generally: /var/www (newer versions: /var/www/html)
#For Mandriva, RedHat, Fedora: /var/www/html
#For Suse: /srv/www/htdocs

<source lang="bash">
$ cd /var/www
or
$ cd /var/www/html
</source>

*Get the application archive of last stable version

'''from zip file'''
<source lang="bash">
$ wget http://www.dolibarr.org/files/dolibarr.zip
</source>

*Uncompress archive

<source lang="bash">
$ unzip dolibarr.zip
</source>

'''or from git repository'''
<source lang="bash">
$ git clone -b X.Y http://github.com/Dolibarr/dolibarr.git dolibarr
</source>
Replace X.Y with the version you want to get.

*Rename directory dolibarr-x.y.z into dolibarr to have a directory name that does not depends on version (replace x.y.z with source version)

<source lang="bash">
$ mv dolibarr-x.y.z dolibarr
</source>

*Change permission and owner of the 'dolibarr' directory to that of the group under which the web server runs (assumed to be 'www-data' for debian, 'apache' for redhat, mandriva, fedora)

<source lang="bash">
$ chmod -R 755 /var/www/dolibarr
$ chown -R www-data.www-data /var/www/dolibarr
or
$ chmod -R 755 /var/www/html/dolibarr
$ chown -R apache.apache /var/www/html/dolibarr
</source>

*For Fedora, since SELinux is usually enabled, it is also advisable to run the following commands to make the 'dolibarr' directory compliant with the SELinux requirement (else you are likely to get quite a few alerts) :

<source lang="bash">
$ semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/dolibarr(/.*)?'
$ restorecon -R -v '/var/www/html/dolibarr'
</source>

*As a root user, create, into directory dolibarr/htdocs/conf, an empty configuration file called conf.php and set, as owner, the web server user (example www-data on Debian, apache on Mandriva, RedHat, Fedora or other distributions ...). This is required because the web server will have to write into this file during install process.

<source lang="bash">
$ cd dolibarr ; touch htdocs/conf/conf.php ; chown www-data htdocs/conf/conf.php
</source>
Note: For Ubuntu no need of htdocs, you just have to make dolibarr root by placing all files and folders of htdocs in /var/www/dolibarr then from browser do <MyIP>/dolibarr/index.php (see this discussion as reference to this addendum [http://askubuntu.com/questions/874456/php-code-displays-in-browser?noredirect=1#comment1357943_874456])

*As a root user, create a directory that will be used to save all files generated and stocked by Dolibarr (PDf invoices, uploaded images, ...), and attribute to this directory a owner that must be the web server (example www-data on Debian, apache on Mandriva, RedHat, Fedora...). The web server must have write permission into this directory. It is recommanded to use a directory outside of your directory of web pages, for example - "/var/lib/dolibarr/documents"

<source lang="bash">
$ mkdir -p /var/lib/dolibarr/documents ; chown www-data /var/lib/dolibarr/documents
</source>

*Now call your browser to point to the main page

<source lang="ini">
http://127.0.0.1/dolibarr/htdocs/
</source>
or if you didn't create the htdocs directory
<source lang="ini">
http://127.0.0.1/dolibarr/
</source>

*Follow instructions of setup steps until end of install process.

*For security reason, we recommend, once setup is finished, to create a file install.lock into Dolibarr document directory that only root user can delete. This will lock the call of the install process again (you will have to remove this file for upgrades).

If this is not done, Dolibarr will show you a warning once logged by an administrator user.
<source lang="bash">
$ touch /var/lib/dolibarr/documents/install.lock; chmod go-w /var/lib/dolibarr/documents;
</source>

==On a mutualized Web Hosting Provider (without terminal/SSH access)==
It is not possible to provide a generic documentation to install Dolibarr on a particular Web hosting provider as this depends on provider.
In most cases, using the following process should works for most providers:

- '''Prerequisite''': Apache web server, PHP and a database server (MySQL or PostgreSQL) are already running correctly and user/pass (of a new database or root server) is known.

- '''Level''': Users with few Web and Database administration knowledge. Knowledge to use a tool (FTP, SFTP) to upload files on the server.

*Check that you have an Apache web server, PHP and a database server (MySQL or PostGreSQL) that works correctly.

[[File:warning.png]] Warning, check that code page of PHP server and database server are same (utf8 recommended).

*Check that main root or admin user/password couple for the server is known and works correctly. Ask them to your Web Hosting Provider if unknown.

*Get the application archive of last stable version and uncompress it locally.

*Upload all content of htdocs directory to your web root directory, for example using FTP in binary mode.

*Create a directory called "documents" into Dolibarr directory that will serve to save all documents generated and stocked by Dolibarr (PDF invoices, uploaded images, ...). The web server must have write permission into this directory. You can set permissions with your FTP client.

*Now call your browser to point to the main page index.php

*Follow instructions of setup steps until end of install process.

*For security reason, we recommend, once setup is finished, to create a file install.lock into Dolibarr installed directory. This will lock the call of the install process again (you will have to remove it for upgrades). If this is not done, Dolibarr will show you a warning once logged as an administrator user.

==On a SaaS or Cloud web hosting provider==
Dolibarr is also available on a lot of "ready to use" SaaS or Cloud platforms/services that provides preinstalled versions.

See page [[Cloud Solutions]].

Dolibarr can also be installed manually on all Cloud platforms that support PHP and Mysql.

See page [[Cloud Solutions]].

==Using Docker==
For admins with Docker experience, it is possible to use the docker build files located in the source repo here: https://github.com/Dolibarr/dolibarr/tree/develop/build
git clone https://github.com/Dolibarr/dolibarr/
cd ./dolibarr
git checkout tags/<desiredrelease>

Read the README carefully. As of version 12+ it recommends to use the built in docker files for development only, while an outside repo: https://hub.docker.com/r/tuxgasy/dolibarr is recommended for production environments.

=Setup=

==First setup==
See page [[First setup|Setup]].

==Setup a LDAP connection==
If you want to use a LDAP: See [[Install and configure OpenLDAP]].

=Import external data=
For this operation, read page [[Mass imports]].

=Upgrade Dolibarr=
This chapter describe processes to upgrade an existing installation of Dolibarr from an old version to a new one. The process is the same, whatever version you are coming from and version you are going to, but it will differ according to the distribution/operating system you used for your first installation. You should use the same for upgrade.

==[[File:Logo_windows.png]] With DoliWamp (Windows .exe package)==

*First make a backup of your current installation
*Download new .exe package of DoliWamp.
*Run downloaded .exe file and follow steps without changing any default values. This will upgrades all your files.
*At the end of the execution, your browser is launched with a page to ask you to run upgrade of your database. Choose the upgrade according to your case.

If there is more than one version late, the page in your browser will loop to start again the upgrade wizard as often as required to run upgrade process, version by version, until your reach the new installed version.

==[[File:Logo_ubuntu.png]] With DoliDeb (Debian or Ubuntu .deb package)==

*First make a backup of your current installation
*Process to upgrade using Debian/Ubuntu package is the same as the install process (see previous chapters), so it is as easy as installing a package.

You can also read page [[Dolibarr for Ubuntu or Debian]].

==[[File:Logo_rpm.png|40px]] With DoliRpm (Fedora, Redhat, Mandriva, Mageia or OpenSuse .rpm package)==

*First make a backup of your current installation
*Process to upgrade using rpm package is the same as the install process, so it is as easy as installing a package (see previous chapters).

==[[File:Gnu.png]] With Dolibarr (standard .zip package or from Git)==
This is tutorial to use when using standard distribution for a manual upgrade.

*First make a backup of your current installation

*Go into the directory where you installed Dolibarr (it might be the root directory of your web, for example /var/www under Debian)

<source lang="bash">
$ cd /var/www
</source>

=== For installation that used the zip file ===
*Get archive of last version

<source lang="bash">
$ wget https://www.dolibarr.org/files/dolibarr.zip
</source>

*Uncompress the archive

<source lang="bash">
$ unzip dolibarr.zip
</source>

*Copy all new extracted files (the one uncompressed into directory dolibarr-x.y.z) to the directory where you put your old Dolibarr version. This will overwrite old files with new ones without removing files specifics to your installation (like conf.php file or complementary non official installed modules).

<source lang="bash">
$ cp -r dolibarr-x.y.z/* dolibarr
</source>

*If no error, you can now remove the directory of source files

<source lang="bash">
$ rm -fr dolibarr-x.y.z
</source>

*Now open your Dolibarr in your browser. It should open automatically the install/

and choose ''Update'' in suggested menu.

=== For installation that used GIT ===
If you already cloned the repo simply upgrade by checking out a version tag like so:
<source lang="bash">
$ git checkout -b 13.0 --depth 1
</source>

*Now open your Dolibarr in your browser. It should open automatically the install/

and choose ''Update'' in suggested menu.

Note:

If you want to script the database upgrade process (to avoid the upgrade process from web browser), you can run the 3 upgrade processes from command line:
<source lang="bash">
$ cd htdocs/install
$ php upgrade.php oldx.oldy.oldz x.y.z > output.html
$ php upgrade2.php oldx.oldy.oldz x.y.z > output2.html
$ php step5.php oldx.oldy.oldz x.y.z > output3.html
</source>
Note: z must be "0" because only major versions have a migration script to run.

Return code will be 0 if success, 1 if error (if this happens, see file output.html, output2.html or output3.html).

Note: If you have a message that tell the install process is locked by a file, remove the file install.lock stored in Dolibarr root directory.

*For security reason, once setup is finished, you should create a file install.lock into Dolibarr documents directory. This will lock the call of the install process again (you will have to remove this file for future upgrades). If this is not done, Dolibarr will show you a warning once logged with an administrator user.

<source lang="bash">
$ echo > documents/install.lock
$ chmod 444 documents/install.lock
</source>

Error reporting

2021-05-18T07:22:01Z

Egils: /* Other rare system logs */ rename section and add nginx log

[[fr:Gestion_d'erreur]]
[[es:Gestión_de_errores]]


[[Category:Core]]
{{TemplateDocDevEn}}

= Functions =
Following function allows to log informations in Dolibarr log file
<source lang="php">dol_syslog($message, LOG_DEBUG|LOG_INFO|LOG_WARNING|LOG_ERR);</source>
The log level is related to setup defined in module Syslog (see lower).

Following function can be used to add error information on screen. Usage must be reserved in never reached code.
<source lang="php">dol_print_error($db,texte);</source>

= Module Syslog =
The error reporting module is integrated with other Dolibarr modules. It allows you to configure what level of errors you would like to be reported and where.

To get to the error reporting module configuration page, go to Home, Configuration, Modules and use the configuration icon of the last module on the screen: ''Syslog''.

Of course, this module ('''Syslog''') must be activated for the following to work.

The '''facility''' option allows you to use pre-set facilities to log your errors. Facilities are a system-level feature to tell your syslog operator where this error comes from, to judge priority and all that. You can find more about this inside the PHP documentation for the ''openlog()'' function which is used inside the ''dol_syslog()'' function: http://www.php.ne/openlog
Really, you should leave it to '''LOG_USER''' unless you know exactly what you're doing.

The next option, '''file''', allows you to choose a file in which you will store the logs. The path you will indicate there should be relative to the system root (/). If you live it as it is (default option DOL_DOCUMENT_ROOT/dolibarr.log), it will likely be opened in document directory. Of course, to do that, your web server must have write permissions on the directory you are using.

Generally, the '''file''' facility will work more easily because it doesn't depend on your server configuration (or only for the directory that needs to be writeable).

Finally, the level of reporting is how many types of errors you want to report. LOG_DEBUG(7) is the strongest option, reporting pretty much everything that calls a dol_syslog() function. LOG_EMERG(0) is the opposite, letting you see only the errors that would really block your system.

More information on page [[Module Syslog (developer)]].

= Webserver logs =
== Apache ==
Note that you can have also find some technical PHP/Apache errors in apache log file (whatever is status/setup of this module). But this occurs only if there is a technical problem in your installation: On a typical Linux install, such logs will be available somewhere in '''/var/log/apache[2]/[dolibarr]-error.log'''. You can watch it ''live'' from the terminal by using:
<source lang="bash">tail -f /var/log/apache2/dolibarr-error.log</source>
== Nginx ==
If you are using nginx to serve Dolibarr some useful debugging information is often to be found there.
<source lang="bash">tail -f /var/log/nginx/error.log</source>

Report board meeting 20210511 teleconf

2021-05-13T09:31:17Z

Egils: spelling fix

{{TemplateAssoEn}}
{{TemplateAssoFr}}

=Title/Date/Location=

*Title: Foundation board meeting

*Date: 11/05/2021

*Location: Online with Jitsi

=Presents=
Valid members of the board (subscription up to date), present:

*Nicolas Zabouri

*Florian Henry

*Laurent Destailleur

*Jean Heimburger

*Maxime Kohlhaas (sorry for being (very) late !)

=Topics=

*Send AG convocation and vote for Year 2020

=> Done

*Proofreading of Dolibarr for some modules

Google sheet with first fixes to do has been delivered.

=> Update: Tasks for 200€ was finished (Proofreading on 8 modules done and merged into develop). We agree on maximum of 2K€ budget, Laurent will decide how spend it on translation.

*Talking about fiscal report about developer refund

=> Find a way to retrieve email of developers that have "long term deposit" on Dolistore to invite them to reclaim their "reward". We will add a notice to incite developers to ask at least one time per year their "reward". Send a mailing to module developers to inform change of CGV of Dolistore
=> Task for Laurent to enhance to current tool.

*VAT from Dolistore

Next step will be to have a button to generate all invoices monthly ?

=> We continue manually for the moment as now. We wait next point.

*RGPD

=> Jean will write an article to inform/remind on the RPGD compliance of the Dolibarr foundation.

*Accounting:

=> Now we have a distinction in the Dolibarr of the foundation between different services bought by the foundation.

*Module Banking4Dolibarr from Open-Dsi.

Alexandre will install the module. Alexandre must setup the module and present it to Philippe (to help to conciliate supplier invoices)

*Task done by Laurent during past month (access not public):

https://admin.dolibarr.org/projet/tasks/time.php?projectid=1&withproject=1&search_month=4&search_year=2021&search_user=2

=> Page of partners on dolibarr.org into Dolibarr CMS has been started:
https://www.dolibarr.org/partners.php
TODO: Service will be tag on thirdparty into the foundation dolibarr and logo management

=> Yogocha: Campaign is still opened. Founds are available.

=> Change feature is needed:
"Mots clefs" have to be reword "Version"
The search by tags block must be on top of category
On display modules with tag search, displayed them randomly
When go into category the tag filters must only apply into the category

Nicolas will check if modules exists or if we let Laurent deal with it, or subcontract

* Trend validation (Building a module to organize events + module to manage preferred partner)

** Module organize events!
=> Project Meeting planned with Laurent
=> PR ongoing

** Module parntership management

=> NextConcept 80% on going by PR

*Dolibarr Promotional Video

More than 50 videos are online

Ask for quotation for promotional video (Ecosystem + Promotional)

*Doliday 2021 + Virtual congress.

Laurent will install a server to test the tool workadventure. After tests, it appears that solution is not yet ready to be hosted by ourself. Problems with HTTPS that need manual validation on warning page of browser.

=> Waiting for COVID news, Florian will check with , workaventure if we can use their platform

You have a setting cost of 150€ + 4€/user for an event on WorkAdventure.
If you need us to customize a map, it's 1 to 3 working days of our designer to add (750€/day).

=> Florian will make a call on the forum (configuration https, root access, participation granted)

*Preferred partners page on the website

L. Destailleur will create basic pages for each preferred partners on the website, by copying the wiki pages. Partners will send a specific text if they want. Update will be done manually in the foundation's Dolibarr.
A list of preferred partners will be added to the website
Communication will be done later

=> Pages started

*New templates of website with 4Runner

They are into Dolibarr foundation. What do we do with this template. Alexandre send invoice to Phillip to pay it.
Nicolas try to integrate this template into Dolibarr's CMS

*MOOC

https://courses.dolibarr.org/

Quotation request send to https://admin.dolibarr.org/comm/action/card.php?id=9651

'''A tool has been done to translate any course into another language''. Will ask juanjo to check the spanish course that is now online on https://courses.dolibarr.org

The tools is available into https://github.com/Dolibarr/dolibarr-foundation/tree/develop/courses. We can enhance it to push strings to translation into transifex...

Table llx societe

2020-08-24T10:01:45Z

Egils: /* Table */ details for client

[[Category:Table SQL]]
[[Category:Third parties]]
[[Category:Société]]
[[Category:Empresas]]
{{ListOfTables}}

= Content/Contenu/Contenido =
{{flag en}} Contains the list of third parties stored in Dolibarr (thirdparties are customers, suppliers, prospects).

{{flag fr}} Contient les tiers enregistrés dans Dolibarr (les tiers sont les clients, fournisseurs ou prospects).

{{flag sp}} Contiene los terceros registrados en Dolibarr.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
|-
| rowid
| int(11)
| NO
| PRI
|
| auto_increment
| technical index
|-
| nom
| varchar(60)
| YES
|
| NULL
|
| name
|-
| entity
| int(11)
| NO
|
| 1
|
| multi company id
|-
| ref_ext
| varchar(60)
| YES
| UNI
| NULL
|
| A field only stored and read by Dolibarr but not used. You can use it to store your id of thirdparty into another external system. This will help synchronisation tools.
|-
| ref_int
| varchar(60)
| YES
|
| NULL
|
|
|-
| statut
| tinyint(4)
| YES
|
| 0
|
| state
|-
| parent
| int(11)
| YES
|
| NULL
|
| parent
{{FieldTms}}
|-
| datec
| datetime
| YES
|
| NULL
|
| creation date
|-
| status
| tinyint(4)
| YES
|
| 1
|
| Thirdparty status : 0=activity ceased, 1= in activity
|-
| code_client
| varchar(24)
| YES
| MUL
| NULL
|
| client's code
|-
| code_fournisseur
| varchar(24)
| YES
|
| NULL
|
| Supplier code
|-
| code_compta
| varchar(24)
| YES
|
| NULL
|
| Customer account code
|-
| code_compta_fournisseur
| varchar(24)
| YES
|
| NULL
|
| Supplier account code
|-
| address
| varchar(255)
| YES
|
| NULL
|
| company address
|-
| zip
| varchar(10)
| YES
|
| NULL
|
| postal code
|-
| town
| varchar(50)
| YES
|
| NULL
|
| town
|-
| fk_departement
| int(11)
| YES
|
| 0
|
| ID of province/state ([[Table llx_c_departements|llx_c_departements]]->rowid)
|-
| fk_pays
| int(11)
| YES
|
| 0
|
| ID of country ([[Table llx_c_pays|llx_c_pays]]->rowid)
|-
| phone
| varchar(20)
| YES
|
| NULL
|
| phone number
|-
| fax
| varchar(20)
| YES
|
| NULL
|
| fax number
|-
| url
| varchar(255)
| YES
|
| NULL
|
| web url
|-
| email
| varchar(128)
| YES
|
| NULL
|
| email
|-
| fk_secteur
| int(11)
| YES
|
| 0
|
| This column/field does not exist anymore in 3.3.0+
|-
| fk_effectif
| int(11)
| YES
|
| 0
|
| ID of range of number of employees ([[Table llx_c_effectif|llx_c_effectif]]->id)
|-
| fk_typent
| int(11)
| YES
|
| 0
|
| ID of type of entity ([[Table llx_c_typent|llx_c_typent]]->id)
|-
| fk_forme_juridique
| int(11)
| YES
|
| 0
|
| ID of legal status ([[Table llx_c_forme_juridique|llx_c_forme_juridique]]->rowid)
|-
| fk_currency
| int(11)
| YES
|
| 0
|
|
|-
| siren
| varchar(128)
| YES
|
| NULL
|
| IDProf1
|-
| siret
| varchar(128)
| YES
|
| NULL
|
| IDProf2
|-
| ape
| varchar(128)
| YES
|
| NULL
|
| IDProf3
|-
| idprof4
| varchar(128)
| YES
|
| NULL
|
| IDProf4
|-
| idprof5
| varchar(128)
| YES
|
| NULL
|
| IDProf5
|-
| idprof6
| varchar(128)
| YES
|
| NULL
|
| idprof6 (this column/field has been newly added)
|-
| tva_intra
| varchar(20)
| YES
|
| NULL
|
| VAT ID
|-
| capital
| double
| YES
|
| NULL
|
| capital of society
|-
| description
| text
| YES
|
| NULL
|
|
|-
| fk_stcomm
| int(11)
| NO
|
| 0
|
| ID of commercial status ([[Table llx_c_stcomm|llx_c_stcomm]]->id)
|-
| note_private
| text
| YES
|
| NULL
|
| private note
|-
| note_public
| text
| YES
|
| NULL
|
| public_note
|-
| prefix_comm
| varchar(5)
| YES
| MUL
| NULL
|
| prefix commercial
|-
| client
| tinyint(4)
| YES
|
| 0
|
| type of client (0/1/2/3) 1=customer 3=customer/prospect
|-
| fournisseur
| tinyint(4)
| YES
|
| 0
|
| is it a third party supplier (0/1)?
|-
| supplier_account
| varchar(32)
| YES
|
| NULL
|
| account of a supplier
|-
| fk_prospectlevel
| varchar(12)
| YES
|
| NULL
|
| ID of prospect level ([[Table llx_c_prospectlevel|llx_c_prospectlevel]]->code)
|-
| customer_bad
| tinyint(4)
| YES
|
| 0
|
| is the customer deadbeat (0/1)?
|-
| customer_rate
| double
| YES
|
| 0
|
| reliability rate of customer (0 to 1)?
|-
| supplier_rate
| double
| YES
|
| 0
|
| reliability rate of supplier (0 to 1)?
|-
| fk_user_creat
| int(11)
| YES
| MUL
| NULL
|
| ID of user who created the entry ([[Table llx_user|llx_user]]->rowid)
|-
| fk_user_modif
| int(11)
| YES
| MUL
| NULL
|
| ID of user who last modified the entry ([[Table llx_user|llx_user]]->rowid)
|-
| remise_client
| double
| YES
|
| 0
|
| systematic discount for the customer
|-
| mode_reglement
| tinyint(4)
| YES
|
| NULL
|
| default payment mode
|-
| cond_reglement
| tinyint(4)
| YES
|
| NULL
|
| default payment conditions
|-
| tva_assuj
| tinyint(4)
| YES
|
| 1
|
| Supplier: issues invoices with VAT? / Customer: is subject to VAT?
|-
| localtax1_assuj
| tinyint(4)
| YES
|
| 0
|
| is subject to localtax1?
|-
| localtax2_assuj
| tinyint(4)
| YES
|
| 0
|
| is subject to localtax2?

|-
| barcode
| varchar(255)
| YES
|
| NULL
|
| This field is used to store barcode value of thirdparty when module barcode is enabled
|-
| fk_barcode_type
| int(11)
| YES
|
| 0
|
| This field is used to store barcode type (EAN, ISBN, ...) of thirdparty when module barcode is enabled
|-
| price_level
| int(11)
| YES
|
| NULL
|
| level of price for multiprices
|-
| outstanding_limit
| double(24,8)
| YES
|
| NULL
|
| Amount of allowed outstanding invoices before warning
|-
| default_lang
| varchar(6)
| YES
|
| NULL
|
| default language for this thirdparty
|-
| logo
| varchar(255)
| YES
|
| NULL
|
|
|-
| canvas
| varchar(32)
| YES
|
| NULL
|
|
{{FieldImportKey}}
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|-
| uk_societe_prefix_comm
| UNIQUE
| prefix_comm,entity
|-
| uk_societe_code_client
| UNIQUE
| code_client,entity
|-
| idx_societe_user_creat
| MULTIPLE
| fk_user_creat
|-
| idx_societe_user_modif
| MULTIPLE
| fk_user_modif
|} 

= Note =
{{flag en}} Third parties can be:
* suppliers or customers companies (depending on the sub-elements defined) or both.
* A normal person.
* A foundation.

{{flag fr}} Un tiers peut être:
* une entreprises cliente ou fournisseur (ou les deux)
* une personne physique
* une association/fondation

{{flag sp}} Un tercero puede ser:
* una empresa cliente o proveedor (o los dos)
* una persona física
* una asociación/fundación

Transaction type

2020-08-04T18:53:22Z

Egils: defaults found explained in a sql file

Dolibarr uses the following transaction types in the [[Module_Banks_and_Cash_(developer)]]:
{| class="wikitable"
|-
! fk_type !! Meaning
|-
| TYP || does not exist among the defaults. Probably a typo in the source file comment here: https://github.com/Dolibarr/dolibarr/blob/68fa8fdcaa84f1987ec6d9a05a3c32584db61ed4/htdocs/compta/bank/class/account.class.php#L472
|-
| VIR || Transfer, Used for virtual transfers to/from a bank account
|-
| PRE || Debit order
|-
| LIQ || Cash
|-
| VAD || Online payment
|-
| CB || Credit card
|-
| CHQ || Cheque
|-
| OW || Owners insert
|}
The defaults are listed here: https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_c_paiement.sql

Transaction type

2020-08-04T18:28:39Z

Egils:

Dolibarr uses the following transaction types in the [[Module_Banks_and_Cash_(developer)]]:
{| class="wikitable"
|-
! fk_type !! Meaning
|-
| TYP || ?
|-
| VIR || Used for virtual transfers to/from a bank account e.g. owners inserts
|-
| PRE || ?
|-
| LIQ || ?
|-
| VAD || ?
|-
| CB || ?
|-
| CHQ || Used for check
|}

Table llx bank

2020-08-04T18:28:20Z

Egils: /* Table */ insert link

[[Category:Table SQL]]
[[Category:Bank]]
[[Category:Banque]]
[[Category:Banco]]

{{ListOfTables}}

= Content/Contenu/Contenido =

{{flag en}} Contains the transactions operated on bank accounts.

{{flag fr}} Contient les opérations effectuées sur les comptes bancaires.

{{flag sp}} Contiene las transaccions efectuadas en las cuentas bancarias.

= Structure =
== Table ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Field
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Null
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Default
|style="background-color: #e9e9ef"| Extra
|style="background-color: #e9e9ef"| Description
{{FieldRowid}}
|-
|datec
|datetime
|YES
| 
|NULL
| 
|date of creation technical
{{FieldTms}}
|-
|datev
|date
|YES
|MUL
|NULL
| 
|value date of the transaction
|-
|dateo
|date
|YES
|MUL
|NULL
| 
|date of the transaction
|-
|amount
|double(24,8)
|NO
| 
|0.00000000
| 
|amount of the transaction
|-
|label
|varchar(255)
|YES
| 
|NULL
| 
|label
|-
|fk_account
|int(11)
|YES
|MUL
|NULL
| 
|account number on which the transaction took place
|-
|fk_user_author
|int(11)
|YES
| 
|NULL
| 
| ID of user author of the information ([[Table llx_user|llx_user]]->rowid)
|-
|fk_user_rappro
|int(11)
|YES
| 
|NULL
| 
| ID of user author of the rapprochement ([[Table llx_user|llx_user]]->rowid)
|-
|fk_type
|varchar(4)
|YES
| 
|NULL
| 
|[[Transaction_type|transaction type]]
|-
|num_releve
|varchar(50)
|YES
| 
|NULL
| 
|number of summary of the bank on which the transaction
|-
|num_chq
|int(11)
|YES
| 
|NULL
| 
|number of check if significant
|-
|rappro
|tinyint(4)
|YES
|MUL
|0
| 
|indicates whether the line was rapproched or not
|-
|note
|text
|YES
| 
|NULL
| 
|note
|-
|fk_bordereau
|int(11)
|YES
| 
|0
| 
|Id du bordereau de remise de cheque
|-
|banque
|varchar(255)
|YES
| 
|NULL
| 
|name of the bank received the check
|-
|emetteur
|varchar(255)
|YES
| 
|NULL
| 
|name of the issuer of the check
|-
|author
|varchar(40)
|YES
| 
|NULL
| 
|to delete after migration
|} 

== Keys ==
{| align="left" width="100%" border="0" cellpadding="1" cellspacing="0" class="dolbox"
|style="background-color: #e9e9ef"| Key
|style="background-color: #e9e9ef"| Type
|style="background-color: #e9e9ef"| Fields
|-
| PRIMARY
| PRIMARY
| rowid
|-
| idx_bank_datev
| MULTIPLE
| datev
|-
| idx_bank_dateo
| MULTIPLE
| dateo
|-
| idx_bank_fk_account
| MULTIPLE
| fk_account
|-
| idx_bank_rappro
| MULTIPLE
| rappro
|}

Transaction type

2020-08-04T18:27:24Z

Egils: Created page with "Dolibarr uses the following transaction types in the Module_Banks_and_Cash_(developer): TYP,VIR,PRE,LIQ,VAD,CB,CHQ {| class="wikitable" |- ! fk_type !! Meaning |- | TYP ||..."

Dolibarr uses the following transaction types in the [[Module_Banks_and_Cash_(developer)]]:
TYP,VIR,PRE,LIQ,VAD,CB,CHQ
{| class="wikitable"
|-
! fk_type !! Meaning
|-
| TYP || ?
|-
| VIR || Used for virtual transfers to/from a bank account e.g. owners inserts
|-
| PRE || ?
|-
| LIQ || ?
|-
| VAD || ?
|-
| CB || ?
|-
| CHQ || Used for check
|}

2020-08-01T22:22:11Z

Egils: /* File:Lug.png Subscribe for first time to the foundation */ language improvements

[[fr:Adhérer]]
[[es:Subscribirse]]


[[Category:Foundation]]
{{TemplateAssoEn}}

You can help and support Dolibarr project by subscribing to the [[Dolibarr foundation]]. For this, go to chapter [[#Subscribe for first time to the foundation|Subscribe for first time to the foundation]].

= [[File:Lug.png]] Subscribe for the first time to the foundation =

Amount to subscribe depends on your status ('''personal''', '''company''', '''foundation''', '''organization'''...). The page "[[Subscription amount Dolibarr Foundation]]" show you the minimum amount of a subscription.

Have you decided to become a member? Choose the method you prefer...

=== To subscribe using a credit card ===
* Fill the form available on page {{FoundationSubscribeUrl}}
* Once the form is submitted, click on "Pay with credit card", you will reach a page to type your Credit or Debit card information.
Once this page is validated, your subscription will be automatically recorded and you should receive an email with the invoice of your subscription/membership.

=== To subscribe using Paypal ===
* Fill the form available on page {{FoundationSubscribeUrl}}
* Once the form is submitted, click on "Pay with credit card or Paypal", you will arraive on a page to type your credit card information.
Once this page is validated, your subscription will be automatically recorded and you should receive an email with the invoice of your subscription/membership.

=== To subscribe making a bank transfer ===
* Fill the form available on page {{FoundationSubscribeUrl}}
* Once this is done, make a bank transfer with amount defined in page [[Subscription amount Dolibarr Foundation]], on the bank account of foundation. This is BAN informations:
Name of bank: CAISSE D'EPARGNE
Bank code: 14505
Desk code: 00001
Account number: 08000207968
Key RIB: 70
IBAN: FR7614505000010800020796870
BIC/SWIFT: CEPAFRPP450
* Once bank transfert is done, send a mail to '''contact@dolibarr.org''' with this content:
Hi, i've just made the bank transfer for my subscription to the Dolibarr foundation.
This is description of movement:
My name: _______
Date of bank transfer: _______
Amount: _______
Thanks to send me a mail once my subscription has been validated.
If you need an invoice, please ask it by email to '''contact@dolibarr.org'''

= [[File:Event.png]] Renew your subscription to foundation =
If you are already a member, to renew your membership, just wait to receive the mail that will invite you to renew your subscription. Instructions to make your renewal will be described.
If you don't receive the mail, please contact foundation at '''tresorier@dolibarr.org'''

Dolibarr Preferred Partner

2020-08-01T22:18:03Z

Egils: /* For all countries */ clarified by adding a word

[[fr:Dolibarr_Preferred_Partner_fr]]
[[es:Dolibarr_Preferred_Partner_es]]


{{TemplateAssoEn}}
<center>
[[File:Business people large.png|120px]]
</center>
This page describe the '''Dolibarr Preferred Partner''' program of '''Dolibarr ERP & CRM''' software. You will find here terms and condition to be certified, and constraints and benefits.
For a list of partners in the world, see page [[List of Dolibarr partners and providers]].

= What is a Dolibarr Preferred Partner (Provided services) =
A "'''Dolibarr Preferred Partner'''" is a supplier that provides services around Dolibarr ERP-CRM while offering guarantees to be reliable and competent around product and offered services.

The following is list of all services a company can provide as a certified [[File:Dolibarr_preferred_partner_int.png|100px]]
# Installation/Setup
# User training / Development training
# Help and support
# Custom development
# Dolibarr web hosting (SaaS or cloud hosting)

Partners can offer one or more of these services but not necessarily all of them. Also, a company can offer all of these services without being certified. The label is above all a guarantee of quality for customers but it can also be a way to benefit from some advantages (see below).

Do not confuse "Dolibarr Preferred Partner" with "Dolibarr Communities". Communities are groups of enthusiasts who work (without necessarily having references) promoting Dolibarr. If you want to also create a Dolibarr community in your region or country, see [[Create a Dolibarr local community]].

The list of Preferred Partners is available on the [[List of Dolibarr partners and providers]] page.

= Eligibility Rules =
Eligibility rules for the label are:

* Being a company registered in your country.

Then you have to enter the criteria for your country:

== For France, Belgium, Switzerland, Luxembourg (cumulative points) ==
* A) The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).
* B) The company must be a member of the Dolibarr foundation (either as a moral member or as an individual member) for more than 1 year. To be a member of the Dolibarr foundation, just follow instructions on page [[Subscribe#Subscribe_for_first_time_to_the_foundation|Subscribe]].
* C) The company should have
** submitted/published at least 500 approved lines of code or translations (in the source code, into a module on dolistore.com or onto the wiki.dolibarr.org)
** OR have represented Dolibarr in at least one computer room or congress during past year
** OR have published two press releases about Dolibarr into past year.
This point C is to guarantee that company is active in the project community.
* D) The company must agree to have in its ranks at least one active contributor ("active" will be define by analyzing github, wiki or forums contributions).

== For Spain and Latino America ==
* All rules are defined into page https://www.dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner
* The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).

== For other countries (cumulative points) ==
* A) The company must have a website and at least 1 link to the web site https://www.dolibarr.org or https://www.dolibarr.xx (where xx is fr, es, it, de, pt...) must be included on a page (home page is better).
* B) The company must be a member of the Dolibarr foundation (either as a moral member or as an individual member) for more than 1 year. To be a member of the Dolibarr Foundation, just follow instructions on page [[Subscribe#Subscribe_for_first_time_to_the_foundation|Subscribe]].
* C) The company should
** have submitted at least 500 approved lines of code or translations during past year (in the source code, into a module on dolistore.com or onto the wiki.dolibarr.org)
** OR have represented Dolibarr in at least one computer room or congress during past year
** OR have published two press releases about Dolibarr during past year.
This point C is to guarantee that company is active in the project community.
* D) The company must agree to have in its ranks at least one active contributor ("active" will be define by analyzing github, wiki and/or forums contributions).

These rules are subject to change by strengthening over time. The board members of the Dolibarr foundation may decide to grant the label even if one criteria is not completely filled, checking that the partner has otherwise proved his involvement and contribution in the project. This case, however, requires an unanimous vote (no votes against) from the board members after request by a member of the Dolibarr foundation.

= Constraints =
== For all countries ==
The following constraints must be met:

A1) The company must redirect clients with tasks that it can't provide to another Dolibarr Preferred Partner (list available here: [[List of Dolibarr partners and providers]]). Information can be posted on mailing list '''dolibarr-preferred-partners@nongnu.org''' where all Dolibarr Preferred Partners are subscribers.

If the company provides hosting service Dolibarr (SaaS), it must agree to the following:

B1) Time display of a page <2 seconds (measurement made at the Firebug plugin for Firefox)

B2) The host must provide updates of Dolibarr to all of its customers (except if customer request this opposite) of a stable version that is not older than 12 months.

B3) All features included with the standard version of Dolibarr must be enabled. The company is free to add additional modules.

B4) If there are limitations of time or amount that have been added in some offers compared to standard Dolibarr version, the list must appear in the general sales conditions / accommodation.

== Specific to Spain and Latin America ==
* Other constraints are defined in page: https://www.dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner

= Process to get certification =
== For France, Belgium, Switzerland, Luxembourg ==
* Create a GitHub account (go on https://github.com/). At least one login will be required to fill the request form.
* Subscribe to be a member of the [[Subscribe|Dolibarr foundation]].
* Once subscription and payment recevied, fill the following request document: [[Media:Dolibarr preferred partner contract.odt]] and send it by email to '''contact@dolibarr.org'''
Once document will be received, we will examine your file (delay between 1 and {{TemplateDelayPreferredPartner}} month).

If approved, the foundation add you as a Dolibarr partner into the [[List of Dolibarr partners and providers]] and a contract signed by the office of the foundation will be sent, which will serve as a certificate.

== For Spain and Latino America ==
Complete the [http://www.dolibarr.es/index.php/contacto-dolibarr following form] and provide the following to the company '''2Byte.es''':
* CIF Fotocopias del de la empresa.
* Fotocopias certificado de alta de la empresa.
* Fotocopias del IAE.
At the end of this, the application is assessed. If approved, a contract will be signed between 2Byte and the company. 2byte will add the company on the [[List of Dolibarr partners and providers]].

== For all other countries ==
* Create a GitHub account (go on https://github.com/). At least one login will be required to fill the request form.
* Subscribe to be a member of the [[Subscribe|Dolibarr foundation]].
* Fill the following request document: [[Media:Dolibarr preferred partner contract.odt]] and send it by email to '''contact@dolibarr.org'''
Once document will be received, we will examine your file (delay between 1 and {{TemplateDelayPreferredPartner}} month).

If approved, the foundation add you as a Dolibarr partner into the [[List of Dolibarr partners and providers]] and a contract signed by the office of the foundation will be sent, which will serve as a certificate.

= Rules of validity =
* The certification is valid for a period of one year. It is reviewed annually and renewed automatically as long as the conditions are met (Note: The criteria, however, may have hardened in the meantime).
* The certification is valid for the countries whose language used is a language in which the partner serves.

= Benefits =
== For all countries ==
* The company is promoted by the Dolibarr foundation. For example, the company is highlighted on the [[List of Dolibarr partners and providers]] (Send an email to contact@dolibarr.org if it is not), but also on other information channels controlled by the Dolibarr foundation.
* The Company may use the logo "DOLIBARR Preferred Partner" on its website (in such a case, the logo must point to https://partners.dolibarr.org/ web site) and all documents:
<center> [[File: Dolibarr_preferred_partner_int.png | 160px]] </center>
or Spanish-speaking countries:
<center> [[File: Dolibarr_preferred_partner_es.png | 160px]] </center>
* The company can highlight the term "Dolibarr Preferred Partner" on its website and all its documents.
* The company may receive and use all marketing materials provided by the foundation or company 2byte (Spanish speaking countries). For example, business cards, flyers, slide templates or roll-ups available at Git URL: git://github.com/Dolibarr/foundation.git. All of content into this repository is licensed under licence CC-BY-SA. You are free to modify, translate and use them.
* The company is listed on the mailing-list '''dolibarr-preferred-partners@nongnu.org''' ({{TemplateURLMLDev}}) for receiving the following information:
** Miscellaneous information
** Eventually, list of tenders sent by other "Dolibarr Preferred Partners" who can not meet the need of their client (in such case, language of forwarded message may be in any language, not necessarily yours).
* The company can then provide any kind of services on Dolibarr among the one described into first chapter, with price and condition of its choice (note that everybody can do this, even without beeing a Preferred Partner).

== Specific to Spain and Latino America ==
* Partners benefits also services defined in page: https://www.dolibarr.es/index.php/dolibarr-partners/quiero-ser-partner

Module Web Services API REST (developer)

2020-08-01T10:12:56Z

Egils: /* Use */ accepted date format

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

= Function =
When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

= Dolibarr REST web services server =
Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx''' where xxx is name of the API to call.

A list of APIs on your installation can be found via the explorer.

==Apache setup==
There is nothing to do. If your Dolibarr is working with Apache, the REST API should also work. APIs will be served by the same virtual web server than your application.

==Nginx setup==
Like Apache, if your Dolibarr is working inside a NGinx virtual host, you should have nothing to do to have your API working. APIs will be served by the same virtual web server than your application.

If you experience troubles, you can try to edit your NGinx config file to match the following example. This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).
<source language="nginx">
worker_processes 1;
error_log /var/log/nginx/error.log;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</source>

= List of provided services =
Only few services are available. Starting to Dolibarr 5.0 version, you can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

You can then test directly from this explorer any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

= Installation =

To install, open the modules page and activate de API REST module. On the configuration page of the module, there's a link to an explorer. Click on it to open the API explorer.

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

= Use =

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<source lang="php">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</source>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :
* $method : string, "GET", "POST", "PUT", "DELETE"
* $apikey : string, "your <token> generated earlier"
* $url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
* $data : string, datas in json format. This parameter is not mandatory.

==Accepted parameters==
This is documented somewhat in the REST Explorer. Check that first. Second try and see what response you get. Third look at the source code for the given API.

===Date==
The ISO date format is accepted: %Y-%m-%d e.g. 2020-07-14. yymmdd is not accepted.

= Examples with PHP =

This is more examples, for different uses cases:

In every examples, we have:
* $apiKey = "<my token>";
* $apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<source lang="php">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Comments :
* I retrieve the 10'000 first products sorted on their ID in the base
* html_entity_decode is necessary as single quotes are encoded
* It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<source lang="php">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Comments :
* before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<source lang="php">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Comments :
* I check if the ref of my product exist in the array created in the first example.
* If it exists, I use it's key in the array as ID
* If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
* I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<source lang="php">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Comments :
* $clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
* type => 0, This is a customer order (while 1 = supplier order)

<source lang="php">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</source>
Comments :
* in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult is the ID of the order created in the previous example

<source lang="php">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</source>
Comments :
* limit => 1 only 1 customer
* mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
* sqlfilters a bit special but there are more examples on the explorer page

<source lang="php">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Comments :
* client => 1 He is a customer (not a supplier)
* code_client => -1 so the customer code will be generated automatically.
* we get the customer ID in $clientDoliId

= Develop your own service / API =
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You take the example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, the file may be generated for you.

The framework detects automatically the API and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

Some more informations in the Dolibarr code. You can look here : htdocs/<directory>/class/api_xxx_class.php 
Ex : htdocs/societe/class/api_thirdparties.class.php for thirdparties. 
Ex : Invoices are in htdocs/compta/facture/class

Module Products

2020-07-19T10:59:58Z

Egils: variants, images

[[fr:Module_Produits]]
[[es:Módulo_Productos]]
[[de:Modul_Produkte]]
[[zh:产品模块]]


[[Category:Product]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Products|
num=50|
devdoc=[[Module Products (developer)]]|
userdoc=This page|}}

= Introduction =
This module manages the product catalog.

See also [[Module Services En|Modules Services]] to manage a catalog of services, or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definition =
== Products ==
A ''product'' is an object you sell to customers or it is an object you buy from suppliers. It is a physical object as opposed to [[ServicesEn|Services]].

A product follows this rules:
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but cannot be shipped).
* A product is a material good. It's value often decreases with time (the value of a used product is less than a new product).

Some fields are dedicated to products and not available for Services like:
* Weight
* Size
* Customs code = Commodity code = License code = HTS (An international 6 character code to define the category of product)

== Virtual products (kits, also called Pack products) ==
A product or service may be a virtual (parent) product comprising other (real) products. This function is activated from the Products module or the Service configuration page. It allows "packages" or "kits" of products that for use in orders, invoices and inventory as a single element instead of the n products as Lot.

A virtual product complies with the following rules:
* When adding a product in a document (proposals, invoice, order), only the line of the virtual parent product is shown.
* The stock of the individual components of the virtual product is incremented / decremented when the virtual product is incremented / decremented.
* A virtual product may itself be composed of other virtual products that contain the physical products.

Note:
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.

== Multiprices ==
There are 3 types of multiprices in Dolibarr.
*price per customer
*price per quantity
*price per segment

===Price per segment===
Dolibarr supports 5 segments. E.g. if you sell products both locally through a shop and on the internet it can be profitable to have 2 price segments for the same products with a lower price for online sales where the competition is fierce.

As of v12 the REST API support getting but not setting multiprices for a product.

== Categories ==
Products can be added to one or multiple categories.

As of v12 the REST API support getting but not setting categories for a product.

== Image ==
A product can have one (or multiple?) images. This can be manually set from the tab "Linked files" of a product.

As of v12 the REST API does not support getting or setting images for a product.

== Variants ==
A product can have multiple variants, e.g. for sizes or colors.

As of v12 the REST API supports both getting, setting and deleting variants for a product.

= Life cycle / Business rules =
{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}}

Module Products

2020-07-19T10:53:59Z

Egils: multiprices+categories

[[fr:Module_Produits]]
[[es:Módulo_Productos]]
[[de:Modul_Produkte]]
[[zh:产品模块]]


[[Category:Product]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUserEn|
name=Products|
num=50|
devdoc=[[Module Products (developer)]]|
userdoc=This page|}}

= Introduction =
This module manages the product catalog.

See also [[Module Services En|Modules Services]] to manage a catalog of services, or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.

= Installation =
{{NoInstallModuleEn}}

= Configuration =
{{ActivationModuleEn}}

= Definition =
== Products ==
A ''product'' is an object you sell to customers or it is an object you buy from suppliers. It is a physical object as opposed to [[ServicesEn|Services]].

A product follows this rules:
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but cannot be shipped).
* A product is a material good. It's value often decreases with time (the value of a used product is less than a new product).

Some fields are dedicated to products and not available for Services like:
* Weight
* Size
* Customs code = Commodity code = License code = HTS (An international 6 character code to define the category of product)

== Virtual products (kits, also called Pack products) ==
A product or service may be a virtual (parent) product comprising other (real) products. This function is activated from the Products module or the Service configuration page. It allows "packages" or "kits" of products that for use in orders, invoices and inventory as a single element instead of the n products as Lot.

A virtual product complies with the following rules:
* When adding a product in a document (proposals, invoice, order), only the line of the virtual parent product is shown.
* The stock of the individual components of the virtual product is incremented / decremented when the virtual product is incremented / decremented.
* A virtual product may itself be composed of other virtual products that contain the physical products.

Note:
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.

== Multiprices ==
There are 3 types of multiprices in Dolibarr.
*price per customer
*price per quantity
*price per segment

===Price per segment===
Dolibarr supports 5 segments. E.g. if you sell products both locally through a shop and on the internet it can be profitable to have 2 price segments for the same products with a lower price for online sales where the competition is fierce.

As of v12 the REST API support getting but not setting multiprices for a product.

== Categories ==
Products can be added to one or multiple categories.

As of v12 the REST API support getting but not setting categories for a product.

= Life cycle / Business rules =
{{ToComplete}}

= Examples of use cases =
{{ToComplete}}
{{ExamplesCaseEn
|name=UCMP01:
|situation=
|actions=
}}

Installation - Upgrade

2020-07-18T08:31:23Z

Egils: upgrade with git

[[fr:Installation_-_Mise_à_jour]]
[[es:Instalación_-_Actualización]]
[[zh:安装_-_升级]]


[[Category:Admin_en]]
{{TemplateDocUser}}

The following documentation describes processes to install or upgrade Dolibarr on a Windows, MAC OS or Unix like platform.

=Install Dolibarr=
This chapter describe different available methods to install Dolibarr for the first time (from the most simple to the manual one). See next chapter for upgrades.

==On your dedicated computer/server (installation "On Premise")==
===[[File:Logo_windows.png]] Manualy or with Doliwamp===
- '''Prerequisite''': Windows

- '''Level''': Non experienced users

This process works only for Windows users and is recommended for user with no computer knowledges. If you are experimented with Apache, PHP and Mysql installation, next chapter is better for you.

If you have time and want to learn how to install an Apache, PHP and MariaDB web server, see the [[Manual installation on Windows]] page for step-by-step instructions.

However, if you are a newbie user and running Windows, you can use DoliWamp. DoliWamp is a specialized Dolibarr distribution for Windows. This distribution allows you to make an installation under Windows with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge. This is steps to install DoliWamp:

*Download last Dolibarr version for Windows DoliWamp.

For this, see at {{TemplateURLToDownloadDoliWamp}}

*Run the downloaded .exe and follow instructions.

===[[File:Logo_ubuntu.png]] With DoliDeb (Debian or Ubuntu .deb package)===
- '''Prerequisite''': Linux Ubuntu

- '''Level''': Non experienced users

This process works only for Ubuntu or Debian Linux users and is recommended for user with little computer knowledge. If you are experienced with Apache, PHP and Mysql installation, the chapter 'with standard package' is better for you. However, if you are a newbie user and running Ubuntu, you can use DoliDeb. DoliDeb is a specialized Dolibarr distribution for Debian or Ubuntu. This distribution allows you to make an installation under Ubuntu with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge.

*Steps to install DoliDeb are described into page [[Dolibarr for Ubuntu or Debian]].

===[[File:Logo_rpm.png|42px]] With DoliRpm (Fedora, Redhat, Mandriva, Mageia or OpenSuse .rpm package)===
- '''Prerequisite''': Linux Fedora, Redhat, Mandriva, Mageia or OpenSuse

- '''Level''': Non experienced users

This process works only for Fedora, Redhat, Mandriva, Mageia or OpenSuse Linux users and is recommended for user with no computer knowledges. If you are experimented with Apache, PHP and Mysql installation, next chapter 'with standard package' is better for you. However, if you are a newbie user and running Fedora or Redhat, you can use DoliRpm. DoliRpm is a specialized Dolibarr distribution for Fedora, Redhat or Mandriva. This distribution allows you to make an installation under such OS with all prerequisites (Apache, Mysql, PHP) and with no computer knowledge.

*Steps to install DoliRpm are described into page [[Dolibarr for Redhat or Fedora (rpm package)]] or [[Dolibarr for Mandriva or Mageia (rpm package)]] or [[Dolibarr for OpenSuse (rpm package)]].

===[[File:Gnu.png]] With Dolibarr (standard .zip package or from git)===
- '''Prerequisite''': Apache, PHP and a database server (MySQL or PostgreSQL) are already running correctly and user/pass (of a new database or root server) is known.

- '''Level''': Users with few Web and Database administration knowledges.

This procedure describe manual (and recommended) installation on a GNU/Linux system (Debian, Mandriva, ...), it can be used for other OS with minor changes.
You can follow this tutorial for any Dolibarr version >= 2.0.0

*Check that you have installed Apache, PHP {{PHPMinVersion}} and a database server (MySQL {{MySqlMinVersion}} or PostGreSQL) correctly (check list of installed packaged on your server by using the package manager of your distribution). If not, install them (use last recent version).

*Check that main root or admin user/password couple for the server is known and works correctly. If this root or admin user/password is not known because not yet defined, read following chapter. Otherwise go on next step:

For Linux users, if you have just installed a MySQL server, the admin user is''' root'''. If the root password has never been set yet, you must run the following command to initialize the password:
<source lang="bash">
mysql
</source>
Once in Mysql interface, run the SQL command to modify the root password:
<source lang="sql">
grant all privileges on *.* to root@'localhost' identified by 'newrootpass' with grant option;
</source>
Then enter and \q to quit.

To check that connexion with the new couple user/password works, launch the command
<source lang="bash">
mysql -u root -p
</source>
And type your password ''newrootpass'' then \q to quit if connexion has been successfull.

For Linux users, if you have just installed a PostgreSQL server, you must run the following command to initialize an admin user and password. For this, add the following line in file '''/etc/postgresql/x.x/main/pg_hba.conf''' (replace x.x with your postgres version)
<source lang="ini">
local all dolibarrowner md5
</source>
Also, comment the line
<source lang="ini">
#local all all ident
</source>
This line ensure that system login used to connect to database (it will be login the web server run with), is same than database account (this is never the case).

Then launch commands from a root shell
<source lang="bash">
sudo -s -u postgres
createuser dolibarrowner
psql -h localhost -d template1 -c "alter user dolibarrowner with password 'dolibarrownerpass'"
exit
sudo /etc/init.d/postgresql restart
</source>
You can test a connection with this user with command
<source lang="bash">
psql -d postgres -U dolibarrowner -W
</source>
And type your ''dolibarrownerpass'' as password and \q to quit if connection is ok.

*Go into the directory where to install Dolibarr (the web root directory defined for your web server)

#For Debian and Ubuntu families, it is generally: /var/www (newer versions: /var/www/html)
#For Mandriva, RedHat, Fedora: /var/www/html
#For Suse: /srv/www/htdocs

<source lang="bash">
$ cd /var/www
or
$ cd /var/www/html
</source>

*Get the application archive of last stable version

'''from zip file'''
<source lang="bash">
$ wget http://www.dolibarr.org/files/dolibarr.zip
</source>

*Uncompress archive

<source lang="bash">
$ unzip dolibarr.zip
</source>

'''or from git repository'''
<source lang="bash">
$ git clone -b X.Y http://github.com/Dolibarr/dolibarr.git dolibarr
</source>
Replace X.Y with the version you want to get.

*Rename directory dolibarr-x.y.z into dolibarr to have a directory name that does not depends on version (replace x.y.z with source version)

<source lang="bash">
$ mv dolibarr-x.y.z dolibarr
</source>

*Change permission and owner of the 'dolibarr' directory to that of the group under which the web server runs (assumed to be 'www-data' for debian, 'apache' for redhat, mandriva, fedora)

<source lang="bash">
$ chmod -R 755 /var/www/dolibarr
$ chown -R www-data.www-data /var/www/dolibarr
or
$ chmod -R 755 /var/www/html/dolibarr
$ chown -R apache.apache /var/www/html/dolibarr
</source>

*For Fedora, since SELinux is usually enabled, it is also advisable to run the following commands to make the 'dolibarr' directory compliant with the SELinux requirement (else you are likely to get quite a few alerts) :

<source lang="bash">
$ semanage fcontext -a -t httpd_sys_rw_content_t '/var/www/html/dolibarr(/.*)?'
$ restorecon -R -v '/var/www/html/dolibarr'
</source>

*As a root user, create, into directory dolibarr/htdocs/conf, an empty configuration file called conf.php and set, as owner, the web server user (example www-data on Debian, apache on Mandriva, RedHat, Fedora or other distributions ...). This is required because the web server will have to write into this file during install process.

<source lang="bash">
$ cd dolibarr ; touch htdocs/conf/conf.php ; chown www-data htdocs/conf/conf.php
</source>
Note: For Ubuntu no need of htdocs, you just have to make dolibarr root by placing all files and folders of htdocs in /var/www/dolibarr then from browser do <MyIP>/dolibarr/index.php (see this discussion as reference to this addendum [http://askubuntu.com/questions/874456/php-code-displays-in-browser?noredirect=1#comment1357943_874456])

*As a root user, create a directory that will be used to save all files generated and stocked by Dolibarr (PDf invoices, uploaded images, ...), and attribute to this directory a owner that must be the web server (example www-data on Debian, apache on Mandriva, RedHat, Fedora...). The web server must have write permission into this directory. It is recommanded to use a directory outside of your directory of web pages, for example - "/var/lib/dolibarr/documents"

<source lang="bash">
$ mkdir -p /var/lib/dolibarr/documents ; chown www-data /var/lib/dolibarr/documents
</source>

*Now call your browser to point to the main page

<source lang="ini">
http://127.0.0.1/dolibarr/htdocs/
</source>
or if you didn't create the htdocs directory
<source lang="ini">
http://127.0.0.1/dolibarr/
</source>

*Follow instructions of setup steps until end of install process.

*For security reason, we recommend, once setup is finished, to create a file install.lock into Dolibarr document directory that only root user can delete. This will lock the call of the install process again (you will have to remove this file for upgrades).

If this is not done, Dolibarr will show you a warning once logged by an administrator user.
<source lang="bash">
$ touch /var/lib/dolibarr/documents/install.lock; chmod go-w /var/lib/dolibarr/documents;
</source>

==On a mutualized Web Hosting Provider (without terminal/SSH access)==
It is not possible to provide a generic documentation to install Dolibarr on a particular Web hosting provider as this depends on provider.
In most cases, using the following process should works for most providers:

- '''Prerequisite''': Apache web server, PHP and a database server (MySQL or PostgreSQL) are already running correctly and user/pass (of a new database or root server) is known.

- '''Level''': Users with few Web and Database administration knowledges. Knowledge to use a tool (FTP, SFTP) to upload files on the server.

*Check that you have an Apache web server, PHP and a database server (MySQL or PostGreSQL) that works correctly.

[[File:warning.png]] Warning, check that code page of PHP server and database server are same (utf8 recommended).

*Check that main root or admin user/password couple for the server is known and works correctly. Ask them to your Web Hosting Provider if unknown.

*Get the application archive of last stable version and uncompress it locally.

*Upload all content of htdocs directory to your web root directory, for example using FTP in binary mode.

*Create a directory called "documents" into Dolibarr directory that will serve to save all documents generated and stocked by Dolibarr (PDF invoices, uploaded images, ...). The web server must have write permission into this directory. You can set permissions with your FTP client.

*Now call your browser to point to the main page index.php

*Follow instructions of setup steps until end of install process.

*For security reason, we recommend, once setup is finished, to create a file install.lock into Dolibarr installed directory. This will lock the call of the install process again (you will have to remove it for upgrades). If this is not done, Dolibarr will show you a warning once logged as an administrator user.

==On a SaaS or Cloud web hosting provider==
Dolibarr is also available on a lot of "ready to use" SaaS or Cloud platforms/services that provides preinstalled versions.

See page [[Cloud Solutions]].

Dolibarr can also be installed manually on all Cloud platforms that support PHP and Mysql.

See page [[Cloud Solutions]].

=Setup=

==First setup==
See page [[First setup|Setup]].

==Setup a LDAP connexion==
If you want to use a LDAP: See [[Install and configure OpenLDAP]].

=Import external data=
For this operation, read page [[Mass imports]].

=Upgrade Dolibarr=
This chapter describe process to upgrade an existing installation of Dolibarr from an old version to a new one. Process is same whatever is version you are coming fro and version you are going to, but will differ according to the distribution/operating system you used for your first installation. You should use the same for upgrade.

==[[File:Logo_windows.png]] With DoliWamp (Windows .exe package)==

*First make a backup of your current installation
*Download new .exe package of DoliWamp.
*Run downloaded .exe file and follow steps without changing any default values. This will upgrades all your files.
*At the end of the execution, your browser is launched with a page to ask you to run upgrade of your database. Choose the upgrade according to your case.

If there is more than one version late, the page in your browser will loop to start again the upgrade wizard as often as required to run upgrade process, version by version, until your reach the new installed version.

==[[File:Logo_ubuntu.png]] With DoliDeb (Debian or Ubuntu .deb package)==

*First make a backup of your current installation
*Process to upgrade using Debian/Ubuntu package is same way than install process (see previous chapters), so it is as easy as installing a package.

You can also read page [[Dolibarr for Ubuntu or Debian]].

==[[File:Logo_rpm.png|40px]] With DoliRpm (Fedora, Redhat, Mandriva, Mageia or OpenSuse .rpm package)==

*First make a backup of your current installation
*Process to upgrade using rpm package is same way than install process, so it is as easy as installing a package (see previous chapters).

==[[File:Gnu.png]] With Dolibarr (standard .zip package)==
This is tutorial to use when using standard distribution for a manual upgrade.

*First make a backup of your current installation

*Go into the directory where you installed Dolibarr (it might be the root directory of your web, for example /var/www under Debian)

<source lang="bash">
$ cd /var/www
</source>

*Get archive of last version

<source lang="bash">
$ wget https://www.dolibarr.org/files/dolibarr.zip
</source>

*Uncompress the archive

<source lang="bash">
$ unzip dolibarr.zip
</source>

*Copy all new extracted files (the one uncompressed into directory dolibarr-x.y.z) to the directory where you put your old Dolibarr version. This will overwrite old files with new ones without removing files specifics to your installation (like conf.php file or complementary non official installed modules).

<source lang="bash">
$ cp -r dolibarr-x.y.z/* dolibarr
</source>

*If no error, you can now remove the directory of source files

<source lang="bash">
$ rm -fr dolibarr-x.y.z
</source>

*Now open your Dolibarr in your browser. It should open automatically the install/

and choose ''Update'' in suggested menu.

Note:

If you want to script the database upgrade process (to avoid the upgrade process from web browser), you can run the 3 upgrade processes from command line:
<source lang="bash">
$ cd htdocs/install
$ php upgrade.php oldx.oldy.oldz x.y.z > output.html
$ php upgrade2.php oldx.oldy.oldz x.y.z > output2.html
$ php step5.php oldx.oldy.oldz x.y.z > output3.html
</source>
Note: z must be "0" because only major versions have a migration script to run.

Return code will be 0 if success, 1 if error (if this happens, see file output.html or output2.html).

Note: If you have a message that tell the install process is locked by a file, remove the file install.lock stored in Dolibarr root directory.

*For security reason, once setup is finished, you should create a file install.lock into Dolibarr documents directory. This will lock the call of the install process again (you will have to remove this file for future upgrades). If this is not done, Dolibarr will show you a warning once logged with an administrator user.

<source lang="bash">
$ echo > documents/install.lock
$ chmod 444 documents/install.lock
</source>

==[[File:Gnu.png]] With git==
If you already cloned the repo simply upgrade by checking out a version tag like so:
<source lang="bash">
$ git checkout -b 12.0 --depth 1
</source>

*Now open your Dolibarr in your browser. It should automatically open the install/ and choose ''Update'' in the suggested menu.

Module Web Services API REST (developer)

2020-07-13T05:13:36Z

Egils: /* Nginx setup */ fix formatting

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

= Function =
When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

= Dolibarr REST web services server =
Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx''' where xxx is name of the API to call.

A list of APIs on your installation can be found via the explorer.

==Nginx setup==
This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).
<source language="nginx">
worker_processes 1;
error_log /var/log/nginx/error.log;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</source>

= List of provided services =
Only few services are available. Starting to Dolibarr 5.0 version, you can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

You can then test directly from this explorer any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

= Installation =

To install, open the modules page and activate de API REST module. On the configuration page of the module, there's a link to an explorer. Click on it to open the API explorer.

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

= Use =

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<source lang="php">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</source>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :
* $method : string, "GET", "POST", "PUT", "DELETE"
* $apikey : string, "your <token> generated earlier"
* $url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
* $data : string, datas in json format. This parameter is not mandatory.

= Examples with PHP =

This is more examples, for different uses cases:

In every examples, we have:
* $apiKey = "<my token>";
* $apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<source lang="php">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Comments :
* I retrieve the 10'000 first products sorted on their ID in the base
* html_entity_decode is necessary as single quotes are encoded
* It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<source lang="php">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Comments :
* before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<source lang="php">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Comments :
* I check if the ref of my product exist in the array created in the first example.
* If it exists, I use it's key in the array as ID
* If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
* I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<source lang="php">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Comments :
* $clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
* type => 0, This is a customer order (while 1 = supplier order)

<source lang="php">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</source>
Comments :
* in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult is the ID of the order created in the previous example

<source lang="php">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</source>
Comments :
* limit => 1 only 1 customer
* mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
* sqlfilters a bit special but there are more examples on the explorer page

<source lang="php">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Comments :
* client => 1 He is a customer (not a supplier)
* code_client => -1 so the customer code will be generated automatically.
* we get the customer ID in $clientDoliId

= Develop your own service / API =
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You take the example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, the file may be generated for you.

The framework detects automatically the API and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

Some more informations in the Dolibarr code. You can look here : htdocs/<directory>/class/api_xxx_class.php 
Ex : htdocs/societe/class/api_thirdparties.class.php for thirdparties. 
Ex : Invoices are in htdocs/compta/facture/class

Module Web Services API REST (developer)

2020-07-13T05:11:26Z

Egils: /* Dolibarr REST web services server */ nginx setup

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

= Function =
When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

= Dolibarr REST web services server =
Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx''' where xxx is name of the API to call.

A list of APIs on your installation can be found via the explorer.

==Nginx setup==
This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).
<code language=nginx>
#user html;
worker_processes 1;

error_log /var/log/nginx/error.log;
#error_log error.log notice;
#error_log error.log info;

#pid logs/nginx.pid;

events {
worker_connections 1024;
}

http {
include mime.types;
default_type application/octet-stream;

#log_format main '$remote_addr - $remote_user [$time_local] "$request" '
# '$status $body_bytes_sent "$http_referer" '
# '"$http_user_agent" "$http_x_forwarded_for"';

#access_log logs/access.log main;

sendfile on;
#tcp_nopush on;

#keepalive_timeout 0;
keepalive_timeout 65;

#gzip on;

server {
listen 80;
server_name dolibarr.localhost; # adjust to your domain

root /usr/share/webapps/dolibarr/htdocs; # adjust to your path
index index.php;

# from https://github.com/Dolibarr/dolibarr/issues/6163#issuecomment-391265538
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
if (!-f $document_root$fastcgi_script_name) {
return 404;
}

# Mitigate https://httpoxy.org/ vulnerabilities
fastcgi_param HTTP_PROXY "";

root /usr/share/webapps/dolibarr/htdocs;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
# Dolibarr Rest API path support
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_script_name;
}
}
}
</code>

= List of provided services =
Only few services are available. Starting to Dolibarr 5.0 version, you can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

You can then test directly from this explorer any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

= Installation =

To install, open the modules page and activate de API REST module. On the configuration page of the module, there's a link to an explorer. Click on it to open the API explorer.

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

= Use =

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<source lang="php">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</source>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :
* $method : string, "GET", "POST", "PUT", "DELETE"
* $apikey : string, "your <token> generated earlier"
* $url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
* $data : string, datas in json format. This parameter is not mandatory.

= Examples with PHP =

This is more examples, for different uses cases:

In every examples, we have:
* $apiKey = "<my token>";
* $apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<source lang="php">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Comments :
* I retrieve the 10'000 first products sorted on their ID in the base
* html_entity_decode is necessary as single quotes are encoded
* It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<source lang="php">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Comments :
* before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<source lang="php">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Comments :
* I check if the ref of my product exist in the array created in the first example.
* If it exists, I use it's key in the array as ID
* If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
* I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<source lang="php">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Comments :
* $clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
* type => 0, This is a customer order (while 1 = supplier order)

<source lang="php">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</source>
Comments :
* in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult is the ID of the order created in the previous example

<source lang="php">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</source>
Comments :
* limit => 1 only 1 customer
* mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
* sqlfilters a bit special but there are more examples on the explorer page

<source lang="php">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Comments :
* client => 1 He is a customer (not a supplier)
* code_client => -1 so the customer code will be generated automatically.
* we get the customer ID in $clientDoliId

= Develop your own service / API =
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You take the example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, the file may be generated for you.

The framework detects automatically the API and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

Some more informations in the Dolibarr code. You can look here : htdocs/<directory>/class/api_xxx_class.php 
Ex : htdocs/societe/class/api_thirdparties.class.php for thirdparties. 
Ex : Invoices are in htdocs/compta/facture/class

Module Web Services API REST (developer)

2020-07-12T21:22:25Z

Egils: /* Examples */ warning about non-working example

[[fr:Module_Web_Services_API_REST_(développeur)]]


{{TemplateDocDevEn}}
{{TemplateModEN}}
[[Category:List of Modules]]
{{BasculeDevUserEn|
name=Web services|
num=2610|
devdoc=This page|
userdoc=Not applicable|}}

= Function =
When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

= Dolibarr REST web services server =
Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL
'''/api/index.php/xxx.php''' where xxx is name of the API to call.

= List of provided services =
Only few services are available. Starting to Dolibarr 5.0 version, you can see full list of Dolibarr Web services provided, by calling the explorer here at address:

'''http://yourdolibarrurl/api/index.php/explorer'''.

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

For example, you can try the explorer on the demo instance at:

'''https://demo.dolibarr.org/api/index.php/explorer'''

You must first make the first call to the '''login''' api to get the API key.
Then enter api key to get list of all other available API services.

You can then test directly from this explorer any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

= Installation =

To install, open the modules page and activate de API REST module. On the configuration page of the module, there's a link to an explorer. Click on it to open the API explorer.

On the top right corner, paste the <token> of the user you want to use to call the API and click the "explore" button. Note: The token of each user can be defined on the user record page.

After clicking on "Explore", you should see all the actions available with this token. If you don't have a lot of actions, it's probably because the according modules are not activated. If you want to see the invoices, you have to activate the invoice module in the configuration of Dolibarr. Same for products, third parties and so on.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

= Use =

To use the REST API, you have to call an url such as this one : <nowiki>http://<my_server>/api/index.php/<action></nowiki> 
with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

There's different ways to do so. Here's a piece of code but you can also use libraries such as phphttpclient.com

<source lang="php">
// Example of function to call a REST API
function callAPI($method, $apikey, $url, $data = false)
{
$curl = curl_init();
$httpheader = ['DOLAPIKEY: '.$apikey];

switch ($method)
{
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
case "PUT":

curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$httpheader[] = "Content-Type:application/json";

if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}

// Optional Authentication:
// curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// curl_setopt($curl, CURLOPT_USERPWD, "username:password");

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpheader);

$result = curl_exec($curl);

curl_close($curl);

return $result;
}</source>

This is just a working example. There's no error control and security was not in mind but you can use this code, modify it to suit your needs 
The fonction has 4 parameters :
* $method : string, "GET", "POST", "PUT", "DELETE"
* $apikey : string, "your <token> generated earlier"
* $url : string, url to call. Ex : "<nowiki>http://<my_server>/api/index.php/invoices</nowiki>"
* $data : string, datas in json format. This parameter is not mandatory.

= Examples with PHP =

This is more examples, for different uses cases:

In every examples, we have:
* $apiKey = "<my token>";
* $apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

<source lang="php">
// Retrieve products list
$listProduits = [];
$produitParam = ["limit" => 10000, "sortfield" => "rowid"];
$listProduitsResult = CallAPI("GET", $apiKey, $apiUrl."products", $produitParam);
$listProduitsResult = json_decode($listProduitsResult, true);

if (isset($listProduitsResult["error"]) && $listProduitsResult["error"]["code"] >= "300") {
} else {
foreach ($listProduitsResult as $produit) {
$listProduits[intval($produit["id"])] = html_entity_decode($produit["ref"], ENT_QUOTES);
}
}
</source>
Comments :
* I retrieve the 10'000 first products sorted on their ID in the base
* html_entity_decode is necessary as single quotes are encoded
* It's easy to use the same method (replacing products with dictionnarycountries) to retrieve the list of countries and their ID

<source lang="php">
// Create a product
$ref = "my_product_ref_X203ZZ";
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
</source>
Comments :
* before creating a product, it could be wise to check if it exists. Using my first example, you'll have :

<source lang="php">
// my ref
$ref = "my_product_ref_X203ZZ";
// does it exist in my array
$produitKey = array_search($ref, $listProduits);
if ($produitKey) {
// yes
$fk_product = $produitKey;
} else {
// no
// Create the product
$newProduct = [
"ref" => $ref,
"label" => $ref
];
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
$newProductResult = json_decode($newProductResult, true);
if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
// there's been an error
echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
exit;
} else {
// everything good
$fk_product = $newProductResult;
$listProduits[$fk_product] = $ref;
}
}
</source>
Comments :
* I check if the ref of my product exist in the array created in the first example.
* If it exists, I use it's key in the array as ID
* If it doesn't exist, I create the product, then I add it to my array for next time then I use the ID created
* I choose this method to do less API calls when I have to import 500 orders. I just need to retrieve the products list once at the beginning instead of searching Dolibarr each time.

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.

<source lang="php">
// create an order with 2 products

// The array where there will be all the products lines of my order.
$newCommandeLine = [];

// product 1
$ref1 = "my_product_ref_X203ZZ";
$prix1 = 10;
$qtt1 = 100;
$tva1 = 20;
$fk_product1
// product 2
$ref2 = "my_product_ref_B707FD";
$prix2 = 13;
$qtt2 = 37;
$tva2 = 20;

$newCommandeLine[] = [
"desc" => $ref1,
"subprice" => $prix1,
"qty" => $qtt1,
"tva_tx" => floatval($tva1),
"fk_product"=> $fk_product1
];

$newCommandeLine[] = [
"desc" => $ref2,
"subprice" => $prix2,
"qty" => $qtt2,
"tva_tx" => floatval($tva2),
"fk_product"=> $fk_product2
];

if (count($newCommandeLine) > 0) {
$newCommande = [
"socid" => $clientDoliId,
"type" => "0",
"lines" => $newCommandeLine,
"note_private" => "order created automatically with API",
];
$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
$newCommandeResult = json_decode($newCommandeResult, true);
}
</source>
Comments :
* $clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before
* type => 0, This is a customer order (while 1 = supplier order)

<source lang="php">
// Validate an order
$newCommandeValider = [
"idwarehouse" => "0",
"notrigger" => "0"
];
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

</source>
Comments :
* in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate". 
$newCommandeResult is the ID of the order created in the previous example

<source lang="php">
// search in the database if a customer exist
$customer_name = "Acme Inc";

$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
"sortfield" => "t.rowid",
"sortorder" => "ASC",
"limit" => "1",
"mode" => "1",
"sqlfilters" => "(t.nom:=:'".$customer_name."')"
)
), true);
</source>
Comments :
* limit => 1 only 1 customer
* mode => 1 we are looking for a customer, not a supplier (they are thirdparties too but with a different status)
* sqlfilters a bit special but there are more examples on the explorer page

<source lang="php">
// customer doesn't exist. Let's create it and get it's ID
$newClient = [
"name" => "customer company name",
"email" => "customer company email",
"client" => "1",
"code_client" => "-1"
];
$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
$newClientResult = json_decode($newClientResult, true);
$clientDoliId = $newClientResult;
</source>
Comments :
* client => 1 He is a customer (not a supplier)
* code_client => -1 so the customer code will be generated automatically.
* we get the customer ID in $clientDoliId

= Develop your own service / API =
Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.
You take the example into '''htdocs/commande/class/api_orders.class.php'''

Note that if you use the '''modulebuilder''' tool, the file may be generated for you.

The framework detects automatically the API and it should be visible into the explorer.

Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
For a documentation about annotation: https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md

These are just the basics.

Some more informations in the Dolibarr code. You can look here : htdocs/<directory>/class/api_xxx_class.php 
Ex : htdocs/societe/class/api_thirdparties.class.php for thirdparties. 
Ex : Invoices are in htdocs/compta/facture/class

FAQ Custom reporting script EN

2020-03-20T18:10:22Z

Egils:

{{TemplateDocUser}}
[[Category:FAQ EN]]

The standard reporting in Dolibarr did not suit my needs so I created a custom one using a bash script. To use and adapt this script you should familiarize yourself with the columns of the table llx_accounting_bookkeeping as this is where your ledger is stored.

Before running this script, make sure you have committed all your transactions to the journal (Journalization). This script was run on a Dolibarr 9.0.1 install, you might have to adapt it if using another version e.g. if the table or column names have changed.

This outputs the total sale of year 2019 before taxes:

<pre>
#!/bin/bash
DATE="2019"
DAT="19"
PSQL="psql -d dolibarr -U dolibarr -t -c"
SALES="select sum(credit) from llx_accounting_bookkeeping where code_journal = \
'short_code_for_sell_journal' and numero_compte = 'sales_account_number' and doc_date <= '12/31/$DAT' and doc_date >= '\
01/01/$DAT'"
echo Report for year $AAR
echo
echo -n "Total sales before taxes:"
$PSQL "$SALES"
</pre>

On linux with postgres installed I do this in a terminal:
# login as postgres
sudo su postres
# save the script to a file where postgres can write
cd ~ && nano report.sh (paste the content and adjust the short_code_for_sell_journal (defaults to VT), sales_account_number and the DATE/DAT to the year you want)
# give run permissions
chmod +x report.sh
# run the script
./report.sh

This can be expanded very easily to output very long and detailed reports.
== Links ==
* [https://gitlab.com/snippets/1955302 Snippet with a localized script for gathering information for Swedish tax reports]

FAQ Custom reporting script EN

2020-03-20T18:08:30Z

Egils: snippet

{{TemplateDocUser}}
[[Category:FAQ EN]]

The standard reporting in Dolibarr did not suit my needs so I created a custom one using a bash script. To use and adapt this script you should familiarize yourself with the columns of the table llx_accounting_bookkeeping as this is where your ledger is stored.

Before running this script, make sure you have committed all your transactions to the journal (Journalization).

This outputs the total sale of year 2019 before taxes:

<pre>
#!/bin/bash
DATE="2019"
DAT="19"
PSQL="psql -d dolibarr -U dolibarr -t -c"
SALES="select sum(credit) from llx_accounting_bookkeeping where code_journal = \
'short_code_for_sell_journal' and numero_compte = 'sales_account_number' and doc_date <= '12/31/$DAT' and doc_date >= '\
01/01/$DAT'"
echo Report for year $AAR
echo
echo -n "Total sales before taxes:"
$PSQL "$SALES"
</pre>

On linux with postgres installed I do this in a terminal:
# login as postgres
sudo su postres
# save the script to a file where postgres can write
cd ~ && nano report.sh (paste the content and adjust the short_code_for_sell_journal (defaults to VT), sales_account_number and the DATE/DAT to the year you want)
# give run permissions
chmod +x report.sh
# run the script
./report.sh

This can be expanded very easily to output very long and detailed reports.
== Links ==
* [https://gitlab.com/snippets/1955302 Snippet with a localized script for gathering information for Swedish tax reports]

FAQ Custom reporting script EN

2020-03-20T17:14:44Z

Egils:

{{TemplateDocUser}}
[[Category:FAQ EN]]

The standard reporting in Dolibarr did not suit my needs so I created a custom one using a bash script. To use and adapt this script you should familiarize yourself with the columns of the table llx_accounting_bookkeeping as this is where your ledger is stored.

Before running this script, make sure you have committed all your transactions to the journal (Journalization).

This outputs the total sale of year 2019 before taxes:

<pre>
#!/bin/bash
DATE="2019"
DAT="19"
PSQL="psql -d dolibarr -U dolibarr -t -c"
SALES="select sum(credit) from llx_accounting_bookkeeping where code_journal = \
'short_code_for_sell_journal' and numero_compte = 'sales_account_number' and doc_date <= '12/31/$DAT' and doc_date >= '\
01/01/$DAT'"
echo Report for year $AAR
echo
echo -n "Total sales before taxes:"
$PSQL "$SALES"
</pre>

On linux with postgres installed I do this in a terminal:
# login as postgres
sudo su postres
# save the script to a file where postgres can write
cd ~ && nano report.sh (paste the content and adjust the short_code_for_sell_journal (defaults to VT), sales_account_number and the DATE/DAT to the year you want)
# give run permissions
chmod +x report.sh
# run the script
./report.sh

This can be expanded very easily to output very long and detailed reports.

FAQ Custom reporting script EN

2020-03-20T17:13:40Z

Egils:

{{TemplateDocUser}}
[[Category:FAQ EN]]

The standard reporting in Dolibarr did not suit my needs so I created a custom one using a bash script. To use and adapt this script you should familiarize yourself with the columns of the table llx_accounting_bookkeeping as this is where your ledger is stored.

Before running this script, make sure you have committed all your transactions to the journal (Journalization).

This outputs the total sale of year 2019 before taxes:

<pre>
#!/bin/bash
DATE="2019"
DAT="19"
PSQL="psql -d dolibarr -U dolibarr -t -c"
c3000="select sum(credit) from llx_accounting_bookkeeping where code_journal = \
'short_code_for_sell_journal' and numero_compte = 'sales_account_number' and doc_date <= '12/31/$DAT' and doc_date >= '\
01/01/$DAT'"
echo Report for year $AAR
echo
echo -n "Total sales before taxes:"
$PSQL "$c3000"
</pre>

On linux with postgres installed I do this in a terminal:
# login as postgres
sudo su postres
# save the script to a file where postgres can write
cd ~ && nano report.sh (paste the content and adjust the short_code_for_sell_journal (defaults to VT), sales_account_number and the DATE/DAT to the year you want)
# give run permissions
chmod +x report.sh
# run the script
./report.sh

This can be expanded very easily to output very long and detailed reports.

FAQ Custom reporting script EN

2020-03-20T17:12:21Z

Egils:

{{TemplateDocUser}}
[[Category:FAQ EN]]

The standard reporting in Dolibarr did not suit my needs so I created a custom one using a bash script. To use and adapt this script you should familiarize yourself with the columns of the table llx_accounting_bookkeeping as this is where your ledger is stored.

Before running this script, make sure you have committed all your transactions to the journal (Journalization).

This outputs the total sale of year 2019 before taxes:

<pre>
#!/bin/bash
DATE="2019"
DAT="19"
PSQL="psql -d dolibarr -U dolibarr -t -c"
c3000="select sum(credit) from llx_accounting_bookkeeping where code_journal = \
'short_code_for_sell_journal' and numero_compte = 'sales_account_number' and doc_date <= '12/31/$DAT' and doc_date >= '\
01/01/$DAT'"
echo Report for year $AAR
echo
echo -n "Total sales before taxes:"
$PSQL "$c3000"
</pre>

On linux with postgres installed I do this in a terminal:
# login as postgres
sudo su postres
# save the script to a file where postgres can write
cd ~ && nano report.sh (paste the content and adapt to your database)
# give run permissions
chmod +x report.sh
# run the script
./report.sh

Adjust short_code_for_sell_journal (defaults to VT), sales_account_number and the DATE/DAT to the year you want.

This can be expanded very easily to output very long and detailed reports.

FAQ Custom reporting script EN

2020-03-20T17:04:16Z

Egils: Created page with "{{TemplateDocUser}} Category:FAQ EN The standard reporting in Dolibarr did not suit my needs so I created a custom one using a bash script. <code> #!/bin/bash..."

{{TemplateDocUser}}
[[Category:FAQ EN]]

The standard reporting in Dolibarr did not suit my needs so I created a custom one using a bash script.

<code>
#!/bin/bash
DATE="2019"
DAT="19"
PSQL="psql -d dolibarr -U dolibarr -t -c"
c3000="select sum(credit) from llx_accounting_bookkeeping where code_journal = \
'short_code_for_sell_journal' and numero_compte = '3000' and doc_date <= '12/31/$DAT' and doc_date >= '\
01/01/$DAT'"
echo Report for year $AAR
echo
echo -n "Total sales before taxes:"
$PSQL "$c3000"
</code>

This outputs the total sale of year 2019 before taxes.

Adjust short_code_for_sell_journal (defaults to VT) and the DATE/DAT to the year you want.

This can be expanded very easily to output very long and detailed reports.

FAQ Facture EN

2020-03-20T16:55:16Z

Egils: Egils moved page FAQ Facture EN to FAQ Delete invoice in the database EN: translated

#REDIRECT [[FAQ Delete invoice in the database EN]]

FAQ Delete invoice in the database EN

2020-03-20T16:55:16Z

Egils: Egils moved page FAQ Facture EN to FAQ Delete invoice in the database EN: translated

[[fr:FAQ_Facture]]
[[es:FAQ_Facture_ES]]


[[Category:FAQ EN]]
'''How to remove "easily" an invoice customer "by hand" in the database ?'''

You must first remove all records into [[Table llx_facturedet]] (there is one record by invoice line),
and then you can delete invoice in [[Table llx_facture]].

The steps for a MySQL database are:

- get the ID of your invoice (invoice is called "facture" in French). You can get this ID by going to the Invoice's card, and check the address in your browser. For example
dolibarr.xxxxx.com/compta/facture.php?facid=29 the invoice ID is "29"

- connect to your database (via phpmyadmin or command line, for example)

- Type the following commands ('''replace INVOICE_ID by the ID you got earlier'''):

- DELETE FROM llx_facturedet WHERE fk_facture = ''INVOICE_ID'';

- DELETE FROM llx_facture WHERE rowid = ''INVOICE_ID'';

Your invoice should be deleted successfully.

Module Accounting Simplified

2019-09-07T15:47:24Z

Egils: /* Default accounts */ warning

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

Warning: Make sure you have different accounts for the top 3 accounts from the ones at the bottom or else all the reports will be mixed/wrong.

[[File:Accountancy-defaultaccounts.png|800px]]

== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account, taxes and an equity insert/take out.

[[File:Accountancy-journals.png|800px]]
== Vat accounts ==
Setup the applicable vat rates and accounts for your country.

[[File:Vat-accounts.png|800px]]

== Tax accounts ==
Setup the account from which you pay your tax.

[[File:Tax-accounts.png|800px]]

== Export options ==
Change these if needed.

[[File:Accountancy-export.png|800px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-09-07T11:19:24Z

Egils: export

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|800px]]
== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account, taxes and an equity insert/take out.

[[File:Accountancy-journals.png|800px]]
== Vat accounts ==
Setup the applicable vat rates and accounts for your country.

[[File:Vat-accounts.png|800px]]

== Tax accounts ==
Setup the account from which you pay your tax.

[[File:Tax-accounts.png|800px]]

== Export options ==
Change these if needed.

[[File:Accountancy-export.png|800px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

File:Accountancy-export.png

2019-09-07T11:18:11Z

Egils:

Module Accounting Simplified

2019-09-07T11:05:21Z

Egils: /* Tax accounts */

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|800px]]
== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account, taxes and an equity insert/take out.

[[File:Accountancy-journals.png|800px]]
== Vat accounts ==
Setup the applicable vat rates and accounts for your country.

[[File:Vat-accounts.png|800px]]

== Tax accounts ==
Setup the account from which you pay your tax.

[[File:Tax-accounts.png|800px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

File:Tax-accounts.png

2019-09-07T11:03:55Z

Egils:

Module Accounting Simplified

2019-09-07T11:01:32Z

Egils: /* Setup */ vat + size increase

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|800px]]
== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account, taxes and an equity insert/take out.

[[File:Accountancy-journals.png|800px]]
== Vat accounts ==
Setup the applicable vat rates and accounts for your country.

[[File:Vat-accounts.png|800px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

File:Vat-accounts.png

2019-09-07T10:59:14Z

Egils:

Module Accounting Simplified

2019-09-07T09:17:42Z

Egils: /* Journals */ format

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|600px]]
== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account, taxes and an equity insert/take out.

[[File:Accountancy-journals.png|600px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-09-07T09:16:02Z

Egils: /* Journals */ clarify

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|600px]]
== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account, taxes and an equity insert/take out.
[[File:Accountancy-journals.png|600px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-09-07T09:15:38Z

Egils: /* Journals */ limit size

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|600px]]
== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account and an equity insert/take out.
[[File:Accountancy-journals.png|600px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-09-07T09:14:54Z

Egils: /* Setup */

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|600px]]
== Journals ==
Set up your custom journals. Here is an example including a special journal for Upwork "bank" account and an equity insert/take out.
[[File:Accountancy-journals.png]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

File:Accountancy-journals.png

2019-09-07T09:12:29Z

Egils: Example with a few extra swedish journals for putting in and taking out equity.

== Summary ==
Example with a few extra swedish journals for putting in and taking out equity.

Module Accounting Simplified

2019-09-07T08:51:54Z

Egils: /* Default accounts */

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.

[[File:Accountancy-defaultaccounts.png|600px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-09-07T08:50:23Z

Egils: /* Default accounts */

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
After setting up your chart of accounts you have to tell Dolibarr to use them.
[[File:Accountancy-defaultaccounts.png|400px]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-09-07T08:47:56Z

Egils: /* Setup */

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}
== Default accounts ==
[[:File:Accountancy-defaultaccounts.png|File:Accountancy-defaultaccounts.png]]

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

File:Accountancy-defaultaccounts.png

2019-09-07T08:31:51Z

Egils: Example with swedish account numbers.

== Summary ==
Example with swedish account numbers.

Module Accounting Simplified

2019-08-23T21:04:45Z

Egils: /* Chart of accounts */

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa (Benin, Burkina Faso, Cameroon, Central African Republic, Comoros, Congo (Brazzaville), Congo (Kinshasa), Equatorial Guinea, Ghana, Marocco, Niger, Senegal, Tunisia)
* Europe (Belgium, Denmark, Luxembourg, France, Germany, Great Britain, Netherlands, Romania, Switzerland, Spain, Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix]))
* South America (Chile)
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-08-23T21:01:33Z

Egils:

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa
** Benin
** Burkina Faso
** Cameroon
** Central African Republic
** Comoros
** Congo (Brazzaville)
** Congo (Kinshasa)
** Equatorial Guinea
** Ghana
** Marocco
** Niger
** Senegal
** Tunisia
* EU
** Belgium
** Denmark
** Luxembourg
** France
** Germany
** Great Britain
** Netherlands
** Romania
** Switzerland
** Spain
** Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix])
* South America
** Chile
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}

=Use=
This module contain a ledger that enable you to manually add transactions. However this is not recommended for most transactions.

Transactions from the standard sell and purchase journals can easily be committed to the ledger after they have been assigned valid accounts.

The module also contains a balance sheet for you to see the total income and expense of you company.

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}

Module Accounting Simplified

2019-08-23T20:56:31Z

Egils: /* Chart of accounts */

[[fr:Module_Comptabilité]]
[[es:Módulo_Contabilidad]]


[[Category:Accounting]]
{{TemplateDocUser}}
{{TemplateModEN}}
{{BasculeDevUser|
nom=Accountancy|
num=10|
devdoc=[[Module Accounting (developer)]]|
userdoc=This page|}}

=Introduction=
{{ToComplete}}
This module allows you to set up accounting with a suitable chart of accounts.

==Features==
Its features are:
* support for double entry accounting
* grouping transactions in journals
* support for exports (which formats?)

===Chart of accounts===
Dolibarr support multiple countries
* Africa
** Benin
** Burkina Faso
** Cameroon
** Central African Republic
** Comoros
** Congo (Brazzaville)
** Congo (Kinshasa)
** Equatorial Guinea
** Ghana
** Marocco
** Niger
** Senegal
** Tunisia
* EU
** Belgium
** Denmark
** Luxembourg
** France
** Germany
** Great Britain
** Netherlands
** Romania
** Switzerland
** Spain
** Sweden ([https://github.com/Dolibarr/dolibarr/pull/10907 pull request pending fix])
* South America
** Chile
([https://github.com/Dolibarr/dolibarr/blob/develop/htdocs/install/mysql/data/llx_accounting_abc.sql see full list])

=Installation=
{{NoInstallModuleEn}}

=Setup=
{{ActivationModuleEn}}

=Life cycle / Business rules=
{{ToComplete}}

=Examples of use cases=
{{ToComplete}}
{{ExamplesCaseEn
|name=UCAC01:
|situation=
|actions=
}}