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
| Input | Type | Description | Default Value |
|---|---|---|---|
api_key | string | API Key. | |
my_dolibarr_domain_url | string | my_dolibarr_domain/url. Enter your domain/dolibarr_url without https:// Example: mydomain.com/dolibarr | |
start_date | date | Earliest 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 Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|---|---|---|---|---|
| Products list | product_id | DefaultPaginator | ✅ | ✅ |
| Products category id list | No pagination | ✅ | ❌ | |
| Product categories list | category_id | DefaultPaginator | ✅ | ✅ |
| Customer invoices list | invoice_id | DefaultPaginator | ✅ | ✅ |
| Customer invoices lines list | No pagination | ✅ | ❌ | |
| Customers list | customer_id | DefaultPaginator | ✅ | ✅ |
| Supplier invoices list | supp_invoice_id | DefaultPaginator | ✅ | ✅ |
| Supplier invoices lines list | No pagination | ✅ | ❌ | |
| Suppliers list | supplier_id | DefaultPaginator | ✅ | ✅ |
| Internal Users | user_id | DefaultPaginator | ✅ | ✅ |
| Company profile data | No pagination | ✅ | ❌ | |
| Customer invoices payments list | ref | No pagination | ✅ | ❌ |
| Supplier invoices payments list | ref | No pagination | ✅ | ❌ |
Reference
Config fields reference
Field
Type
Property name
API Key
required
string
api_key
string
my_dolibarr_domain_url
string
start_date