Skip to main content

Dolibarr

Connector for the Dolibarr ERP/CRM REST API focused on GET operations

Pre-requisites

  • A Dolibarr Installation in Cloud SaaS, On-premises, Web Hosting or cPanel Server.
  • Identify your public Dolibarr URL that will be required to configure the conector.
  • Configure your company data in the Setup menu - Configure your company/organization: Dolibarr documentation Wiki
  • In the module setup menu enable the Module Web Services API REST (developer) and configure it.
  • Enable the ERP/CRM modules of Dolibarr from you want to GET data with the REST API end points
  • For the API Key access create a Dolibarr user in your installation with the permissions to "read" modules corresponding to the REST API end points you will use with the streams. (some streams or end points, like GET company information, will require that your user be administrator or have read/write permissions to works fine with the GET end point)
  • In the setup/modify menu of the user created in the previous step, generate the API Key (different to the user password) that will be required for the setup of the connector.
  • Now your are ready to work with this connector.

Configuration

InputTypeDescriptionDefault Value
api_keystringAPI Key.
my_dolibarr_domain_urlstringmy_dolibarr_domain/url. Enter your domain/dolibarr_url without https:// Example: mydomain.com/dolibarr
start_datedateEarliest start date of synchronization in source data in format YYYY-MM-DDTHH:mm:ssZ Enter the earliest modification date of data you want to incrementally synchronize

Streams

Stream NamePrimary KeyPaginationSupports Full SyncSupports Incremental
Products listproduct_idDefaultPaginator
Products category id listNo pagination
Product categories listcategory_idDefaultPaginator
Customer invoices listinvoice_idDefaultPaginator
Customer invoices lines listNo pagination
Customers listcustomer_idDefaultPaginator
Supplier invoices listsupp_invoice_idDefaultPaginator
Supplier invoices lines listNo pagination
Suppliers listsupplier_idDefaultPaginator
Internal Usersuser_idDefaultPaginator
Company profile dataNo pagination
Customer invoices payments listrefNo pagination
Supplier invoices payments listrefNo pagination

Reference

Config fields reference

Field
Type
Property name
API Key
required
string
api_key
string
my_dolibarr_domain_url
string
start_date

Changelog

Expand to review
VersionDatePull RequestSubject
1.0.02025-06-0561388Implements incremental sync in all applicable parent streams, improves the performance and efficiency of data extraction, compatible with Dolibarr 21.0.0 or higher versions
0.0.12025-05-20Initial release by @leonmm2 via Connector Builder
Was this page helpful?