Dolibarr ERP CRM Wiki - User contributions [en]

Integration of Dolibarr to the Airbyte data integration platform

2026-03-27T19:18:22Z

Leonm2: Added some specific pre-requisites for the modules configuration in the Dolibarr instance to work with the Dolibarr source connector in Airbyte

[[Category:ImportsEn]]
{{TemplateDocDevEn}}

=Introduction=
'''Airbyte''' (https://airbyte.com/) is an open-source '''ELT platform''' that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=Prerequisites=
For this guide you need to complete the following prerequisites:

*Have an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Have a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]
*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Additionall to the default activated modules, activate at least the following modules: Third Parties, Vendors, Invoices, Banks & Cash, Products, Services and Stocks. It is required because the preconfigured streams of the Dolibarr source connector in Airbyte rely on these API endpoints.
*Activate any additional Dolibarr modules from which you want to retrieve data. (If the stream for the module and the API endpoint is not configured in the Dolibarr source connector, you will need to edit the connector in the Airbyte Connector Builder to add them)
*Generate operational data in Dolibarr by your business activity.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=Create the Airbyte Connection=
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one, or you can create your own destination connector with the UI Connector Builder.

===Select Dolibarr source connector.===
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

===Enter the authentication credentials for the Dolibarr connector:===
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
===Select the sync mode and streams for the schema:===
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.

===Overview of streams or data tables with important column names on each sheet and their corresponding meaning===

{| class="wikitable"
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

===Final connection configuration:===
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=Go further=
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=Conclusion=
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Web services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Documentación Desarrolladores

2025-07-11T18:59:12Z

Leonm2: /* Interfaces y enlaces con otras aplicaciones */

[[en:Developer_documentation]]
[[fr:Documentation_Développeur]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]


Esta página es el índice de artículos relacionados con la documentación del desarrollador. Para la documentación del usuario, [[Documentación_usuarios| ver aquí]].

= Información general =
Este capítulo incluye información general que es necesaria leer antes de comenzar cualquier desarrollo en Dolibarr.
# [[Proyecto Dolibarr]]
# [[Antes de Empezar|A saber antes de empezar]]
# [[Herramientas de Desarrollo|Entorno y Herramientas de desarrollo]]
# [[Librerías externas y dependencias]]
# [[Recuperar, actualizar GIT fuentes del proyecto|Recuperar una versión desde los fluentes]]

= Normas de Desarrollo =
# [[Lenguaje y Normas de Desarrollo|Lenguaje y normas de desarrollo (PHP, SQL, HTML)]]
# [[:Category:Table SQL|Listado de tablas]]

= Listado de módulos =
La documentación específica de un módulo funcional estándar de Dolibarr se encuentra en la página del módulo.

* El listado de módulos estándar está disponible en la página [[:Category:Listado_de_Módulos_(desarrollador)|Listado de Módulos]]
* El Listado de módulos complementarios se encuentra en la página [[:Category:Módulos_complementarios|Módulos complementarios]]

= Desarrollar un nuevo módulo/extensión para el GUI =
Esta sección describe cómo desarrolllar un nuevo módulo sobre la interfaz de usuario de Dolibarr (GUI). Un módulo para IHM contiene tanto pantallas como datos propios y una hoja de estilo. El desarrollo del script no entra en esta parte y está descrito en el capítulo siguiente. El desarrollo de módulos de numeración, de documentos, de temas o de disparadores también se describe en los capítulos siguientes.

Para desarrollar tu propio módulo de extensión de GUI, ve al tutorial: [[Desarrollo de un módulo]]

= Desarrollar un script en línea de comandos o lote =
Esta sección describe cómo desarrollar su propio script de comandos por lotes para realizar procesos en Dolibarr (lectura, escritura, etc.).
La realización de modificaciones del interfaz de usuario (GUI) no entra dentro de este perímetro. Véase el capítulo anterior para ello.

Para desarrollar un script de comandos de cualquier tipo, tales como un script de proceso o un script para importar los datos desde otro sistema, consulte la página: [[Desarrollo de scripts]]

= Técnica sistemas de Dolibarr =
== Árbol de archivos ==
La jerarquía de los archivos de la versión actual es visible en la [http://doxygen.dolibarr.org documentación doxygen de los fuentes]. (el estilo de la documentación generada es "javadoc").

Sin embargo, las rutas a usar para añadir sus archivos en la creación de un nuevo módulo son descritas en la documentación para el desarrollo de un nuevo módulo (ver más abajo).

== El Sistema de Parametrización ==
Existen 3 niveles de parametrización en Dolibarr.
* La configuración técnica de Dolibarr (modo de autentificación en la aplicación, identificador de la base de datos y la localización del espacio de almacenamiento de ficheros) está definida en el fichero único de configuración conf/conf.php. Ver [[Fichero de configuración]] para más información.
* El global se guarda en la [[Table llx_const]]. Ver la página [[ConstantesES|Constantes]].
* La parametrización propia a un usuario se guarda en la [[Table llx_user_param]]. Ver la página [[ConstantesES|Constantes]].

== Los objetos de negocio ==
Ver la página [[Objetos de negociado]]

== El Sistema de menús ==
Ver la página [[Sistema de menús]]

== El Sistema de pestañas ==
Ver la página [[Sistema de pestañas]]

== El Sistema de temas ==
Ver la página [[Temas]]

== El Sistema de paneles ==
Ver la página [[Sistema de paneles]]

== El Sistema de autenticación ==
Ver la página [[Autentificación]]

== El Sistema de permisos ==
Ver la página [[Permisos]]

== El Sistema de traducción ==
Ver la página [[Sistema de traducción]]

== La Gestión de errores ==
Ver la página [[Gestión de errores]]

== El sistema Canvas (sobrecarga de pantallas) ==
Canvas es una funcionalidad destinada a desarrolladores para reemplazar a las pantallas de creación, actualización o visualización de fichas (productos, terceros, contactos, ...). Por ejemplo, puede reemplazar el formulario de creación de terceros, el de actualización o el de visualización.

Vea la página [[Desarrollo Canvas]]

== El sisteme Triggers ==
Ver [[Interfaces Dolibarr hacia el exterior|Interfaces y enlaces con otras aplicaciones]].

== El sistema Hooks ==
Vea la página [[El sistema Hooks]]

== El sistema de substitución de variables ==
Ver [[Sistema de substitución de variables]]

== Services Web ==
Dolibarr puede configurarse para proveer servicios accesibles a un sistema exterior.

Ver [[Módulo Services Web API REST (programador)]].

El [[Módulo Services Web API SOAP (programador)]] es deprecated.

== El almacenamiento de ficheros/documentos ==
Ver la página [[Documentos generados]]

== Los módulos de numeración ==
Para cada entidad creada en la aplicación, Dolibarr le asigna una referencia. Con el fin de adaptar la referencia a cualquier uso, Dolibarr utiliza módulos para definir la regla de generación de esta referencia. Los módulos se suministran como estándar, por lo tanto, algunos son genéricos y se utilizan para definir la máscara de numeración (x número de caracteres, con o sin prefijo, incluyendo la fecha o no, etc), pudiendo satisfacer la mayoría de las necesidades. Sin embargo, aún hay casos en los que el módulo estándar incluido no responde a la necesidad. En este caso es necesario para desarrollar su propio módulo de numeración.

Más información en la página [[Crear un módulo de numeración]]

== Los modelos y la generación de documentos ==
Información referente a la generación de documentos desde modelos disponible en la página [[Crear un modelo de documento PDF]] o [[Crear un modelo de documento ODT]]

= Las exportaciones/importaciones en masa =
#[[Importaciones|Importaciones en masa]]
#[[Módulo Exportaciones|Exportaciones en masa]]

= Interfaces y enlaces con otras aplicaciones =

Interfaces con API o WebHooks:

*[[Interfaces Dolibarr hacia el exterior]] (Triggers, Hooks, o WebHooks Dolibarr)
*[[Interfaces del Exterior hacia Dolibarr]] (WebService)

Interfaces con synchronization platform:

*[[Module Splash|Integration of Dolibarr with Splash]]

Interfaces con automation/nocode platform:

*[[Integration of Dolibarr to the Zapier automation platform]]
*[[Integration of Dolibarr to the n8n automation platform]]
*[[Integration of Dolibarr to the Make automation platform]]

Interfaces con ELT/ETL/data integration/no code platforms:

*[[Integration of Dolibarr to the Airbyte data integration platform]]

= FAQ =
Todos los FAQ se encuentran disponibles desde la página índice [[:Category:FAQ ES|FAQ ES]]

Integration of Dolibarr to the Airbyte data integration platform

2025-07-11T18:44:53Z

Leonm2:

[[Category:ImportsEn]]
{{TemplateDocDevEn}}

=Introduction=
'''Airbyte''' (https://airbyte.com/) is an open-source '''ELT platform''' that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=Prerequisites=
For this guide you need to complete the following prerequisites:

*Have an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Have a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]
*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Activate the Dolibarr modules which you want to get data from.
*Generate operational data in Dolibarr by your business activity.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=Create the Airbyte Connection=
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one, or you can create your own destination connector with the UI Connector Builder.

===Select Dolibarr source connector.===
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

===Enter the authentication credentials for the Dolibarr connector:===
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
===Select the sync mode and streams for the schema:===
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.

===Overview of streams or data tables with important column names on each sheet and their corresponding meaning===

{| class="wikitable"
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

===Final connection configuration:===
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=Go further=
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=Conclusion=
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Web services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T13:40:41Z

Leonm2:

[[Category:No Code Data Integration]]
{{TemplateDocDevEn}}

=Introduction=
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=Prerequisites=
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Activate de Dolibarr modules from you wnat to get data.
*Generate operational data in Dolibarr by your business activity.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=Create the Airbyte Connection=
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one, or you can create your own destination connector with the UI Connector Builder.

===Select Dolibarr source connector.===
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

===Enter the authentication credentials for the Dolibarr connector:===
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
===Select the sync mode and streams for the schema:===
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
==='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''===
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

===Final connection configuration:===
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=Go further=
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=Conclusion=
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Web services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T13:34:38Z

Leonm2: /* Select Dolibar source connector. */

[[Category:No Code Data Integration]]
{{TemplateDocDevEn}}

=Introduction=
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=Prerequisites=
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Activate de Dolibarr modules from you wnat to get data.
*Generate operational data in Dolibarr by your business activity.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=Create the Airbyte Connection=
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one.

===Select Dolibarr source connector.===
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

===Enter the authentication credentials for the Dolibarr connector:===
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
===Select the sync mode and streams for the schema:===
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
==='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''===
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

===Final connection configuration:===
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=Go further=
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=Conclusion=
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Web services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T06:30:23Z

Leonm2:

[[Category:No Code Data Integration]]
{{TemplateDocDevEn}}

=Introduction=
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=Prerequisites=
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=Create the Airbyte Connection=
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one.

===Select Dolibar source connector.===
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

===Enter the authentication credentials for the Dolibarr connector:===
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
===Select the sync mode and streams for the schema:===
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
==='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''===
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

===Final connection configuration:===
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=Go further=
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=Conclusion=
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Wbe services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T06:24:29Z

Leonm2:

=Introduction=
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=Prerequisites=
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=Create the Airbyte Connection=
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one.

===Select Dolibar source connector.===
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

===Enter the authentication credentials for the Dolibarr connector:===
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
===Select the sync mode and streams for the schema:===
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
==='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''===
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

===Final connection configuration:===
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=Go further=
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=Conclusion=
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Wbe services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T06:23:54Z

Leonm2:

=Introduction=
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=Prerequisites=
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=Create the Airbyte Connection=
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one.

===Select Dolibar source connector.===
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

===Enter the authentication credentials for the Dolibarr connector:===
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
===Select the sync mode and streams for the schema:===
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
===='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''====
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

===Final connection configuration:===
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=Go further=
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=Conclusion=
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Wbe services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T06:20:48Z

Leonm2:

=='''Introduction'''==
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

=='''Prerequisites'''==
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

=='''Create the Airbyte Connection'''==
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one.

==== Select Dolibar source connector. ====
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 

==== Enter the authentication credentials for the Dolibarr connector: ====
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
====Select the sync mode and streams for the schema:====
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
===='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''====
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

====Final connection configuration:====
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
=='''Go further'''==
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

=='''Conclusion'''==
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Wbe services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T06:14:53Z

Leonm2: /* 1. Select Dolibar source connector. */

==='''Introduction'''===
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

==='''Prerequisites'''===
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

==='''Create the Airbyte Connection'''===
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one.

====1. Select Dolibar source connector.====
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

You can find additional documentation of the Dolibarr source connector in: https://docs.airbyte.com/integrations/sources/dolibarr 
====2. Enter the authentication credentials for the Dolibarr connector:====
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
====3. Select the sync mode and streams for the schema:====
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
===='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''====
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

====4. Connection configuration:====
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
==='''Go further'''===
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

==='''Conclusion'''===
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Wbe services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

Integration of Dolibarr to the Airbyte data integration platform

2025-07-04T06:11:57Z

Leonm2: I created the guide for Dolibarr data integration with Airbyte open source tool and the Dolibarr source connector available in this.

==='''Introduction'''===
Airbyte is an open-source ELT platform that allows to create data integration streams with no code interface, in this tutorial will be explained the use of the Dolibarr source connector available in the marketplace of the different options of Airbyte installations. This connector also could be edited, personalized, and updated to contribute by the users through the graphic UI Connector Builder of the Airbyte platform.

==='''Prerequisites'''===
For this guide you need to complete the following prerequisites:

*Create an instance of Dolibarr (in cloud SaaS service, on-premises installation with a public URL or in a cPanel server or hosting server) and configure it to use SSL encryption (with the HTTPS protocol)
*Create a Dolibarr user account with administrator rights.
*Activate the “Web Services API REST” module following the [https://wiki.dolibarr.org/index.php?title=First_setup#Modules official documentation]

*Generate an API key for your current admin user account or create a new user to generate in this new user the API Key that you will use to execute the data integration streams.
*Give read permissions, to the user with the API key generated, for the modules that will be source of data in the data extraction 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)

==='''Create the Airbyte Connection'''===
Access to your Airbyte installation.

If you don’t have it, you could follow the next guide: https://docs.airbyte.com/platform

For the Open Source version: https://docs.airbyte.com/platform/using-airbyte/getting-started/oss-quickstart

When you have your Airbyte instance, now you can create a connection where you will select a source and destination. In this guide we will only do the Dolibarr source connector configuration, but you can select any destination connector from the available options and follow the specific configuration guide for each one.

====1. Select Dolibar source connector.====
[[File:Airbyte 1Captura de pantalla 2025-07-03 234202.png|thumb|Dolibarr source connector selection in Airbyte]]
In the home page of your Airbyte installation select the bottom “Create Connection”, then you will be able to select the source connector from a list. You must select Dolibarr connector from the Marketplace connectors list.

 
====2. Enter the authentication credentials for the Dolibarr connector:====
After selecting the Dolibarr source connector you will be required to enter the public domain of your Dolibarr instance (please follow the Dolibarr connector instructions that appears in Airbyte) and the API key that you previously configured for your Dolibarr user.

Additionally, you must enter the “Start Date” that defines the oldest date of the data you want to synchronize.
[[File:Airbyte 2Captura de pantalla 2025-07-03 234044.png|thumb|Dolibarr source connector authentication credentials configuration in Airbyte]]

Airbyte will make a connection test previously to save the configuration and let you continue to the destination configuration. For the destination you must follow the configuration guide for your selected connector.

 
====3. Select the sync mode and streams for the schema:====
After the source and destination connector configuration, you need to select the sync mode you want and the streams and fields you want to include in your schema of the data you will extract and synchronize. For each stream in your schema, you will be able to select the sync mode, is recommended to select “Full refresh | overwrite” initially and if you want to enable the incremental sync modes you will need to validate the compatibility with your destination doing some sync tests.
[[File:Airbyte 3Captura de pantalla 2025-07-03 234344.png|thumb|Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte]]

As a guide to select the streams and fields for your schema you could keep in mind the streams and fields description table below. Some fields where modified or created inside the Dolibarr source connector and may not match with the original Dolibarr database field names.

Remember that your Dolibarr user with the API key must have the adequate permissions for the modules related with the streams and fields you are extracting for synchronization.
{| class="wikitable"
| colspan="2" |
===='''Overview of streams or data tables with important column names on each sheet and their corresponding meaning'''====
|-
|
|
|-
| colspan="2" |'''- Product list stream (list of all products)'''
|-
|'''barcode'''
|Product barcode
|-
|'''cost_price'''
|Purchase price (manually defined cost price)
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''label'''
|Product Name
|-
|'''pmp'''
|Average purchase price (cost price calculated from supplier invoices)
|-
|'''price_min_ttc'''
|minimum sale price (maximum discount)
|-
|'''price_ttc'''
|Sale price
|-
|'''product_id'''
|Product Identifier
|-
|'''ref'''
|Product reference
|-
|'''status'''
|Availability for sale status
|-
|'''status_buy'''
|Availability for purchase status
|-
|'''stock_reel'''
|actual inventory to date
|-
|'''stock_theorique'''
|Theoretical inventory stocks to date
|-
|
|
|-
| colspan="2" |'''- Products category id list stream (listing of all product ids with their respective product category id)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''product_id'''
|Product Identifier
|-
|
|
|-
| colspan="2" |'''- Product categories list stream (listing all product categories)'''
|-
|'''category_id'''
|Product Category Identifier
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''description'''
|Product Category Description
|-
|'''label'''
|Product Category Name
|-
|
|
|-
| colspan="2" |'''- Customer invoices list stream (list of all sales invoices to customers to date)'''
|-
|'''customer_id'''
|Identifier of the customer to whom the sale was made
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''date_validation'''
|validation date in Unix timestamp format
|-
|'''invoice_id'''
|Customer invoice ID
|-
|'''module_source'''
|Invoice generator module
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''pos_source'''
|POS-generated invoice status
|-
|'''ref'''
|Customer Invoice reference
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''totalpaid'''
|Total invoice payment amount
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Customer invoices lines list stream (list of all product lines associated with all customer invoices)'''
|-
|'''description'''
|Manually entered product or service name
|-
|'''invoice_id'''
|ID of the customer invoice to which the line corresponds
|-
|'''marge_tx'''
|Profit margin over the purchase price of the line
|-
|'''marque_tx'''
|Profit margin over the sale price of the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''total_sell_price'''
|Total sale price of the line
|-
|'''unit_buy_price'''
|Purchase unit price or cost of the product in the line
|-
|'''unit_sell_price'''
|unit selling price of the product in the line
|-
|
|
|-
| colspan="2" |'''- Customer invoices payments list stream (list of payments associated with each customer invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''num'''
|Reference of the customer invoice to which the payment belongs.
|-
|'''ref'''
|Payment identifier.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Customers list stream (list of all customers)'''
|-
|'''address'''
|Residence address.
|-
|'''client'''
|client status.
|-
|'''code_client'''
|Customer reference code.
|-
|'''country_code'''
|country code of residence.
|-
|'''customer_id'''
|customer identifier.
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|supplier status.
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Customer's name.
|-
|'''name_alias'''
|short name of the client.
|-
|'''phone'''
|telephone.
|-
|'''prospect'''
|Prospect status.
|-
|'''status'''
|active or inactive status.
|-
|'''town'''
|city or town of residence.
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Supplier invoices list stream (list of all supplier purchase invoices to date)'''
|-
|'''date_echeance'''
|payment deadline in Unix timestamp format
|-
|'''datec'''
|creation date in Unix timestamp format
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''paye'''
|invoice payment status
|-
|'''ref'''
|Supplier invoice reference
|-
|'''supp_invoice_id'''
|Supplier invoice ID
|-
|'''supplier_id'''
|Supplier ID from whom the purchase invoice was received
|-
|'''tms'''
|Date of modification in Unix timestamp format
|-
|'''total_ttc'''
|Total amount of the invoice including taxes.
|-
|'''user_creation_id'''
|Creator User ID
|-
|'''user_validation_id'''
|validating user identifier
|-
|
|
|-
| colspan="2" |'''- Supplier invoices lines list stream (listing of all product lines associated with all supplier invoices)'''
|-
|'''buy_unit_price'''
|Purchase unit price or cost of the product in the line
|-
|'''multicurrency_code'''
|Used Currency Code
|-
|'''product_barcode'''
|Product barcode
|-
|'''product_id'''
|product identifier on the line
|-
|'''product_label'''
|Product Name
|-
|'''product_ref'''
|Product reference
|-
|'''qty'''
|Quantity of products
|-
|'''supp_invoice_id'''
|Identifier of the supplier invoice to which the line corresponds
|-
|'''total_buy_price'''
|Total purchase price of the line
|-
|
|
|-
| colspan="2" |'''- Supplier invoices payments list stream (list of payments associated with each supplier invoice)'''
|-
|'''amount'''
|total amount of the payment.
|-
|'''date'''
|date of payment.
|-
|'''ref'''
|Payment identifier.
|-
|'''supp_invoice_id'''
|Identifier of the invoice to which the payment belongs.
|-
|'''type'''
|type of payment (CB: credit card, LIQ: cash, PRE: debit payment order, RAP: Rappi transfer, VIR: bank transfer).
|-
|
|
|-
| colspan="2" |'''- Suppliers list stream (list of all suppliers)'''
|-
|'''address'''
|Residence Address
|-
|'''client'''
|Client status
|-
|'''code_fournisseur'''
|Supplier reference code
|-
|'''country_code'''
|Country code of residence
|-
|'''date_creation'''
|creation date in Unix timestamp format
|-
|'''date_modification'''
|Date of modification in Unix timestamp format
|-
|'''email'''
|Email address
|-
|'''fournisseur'''
|Supplier status
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Citizenship card/NIT/Foreigner's card
|-
|'''name'''
|Supplier Name
|-
|'''name_alias'''
|Supplier's short name
|-
|'''phone'''
|telephone
|-
|'''prospect'''
|Customer Prospect Status
|-
|'''status'''
|Active or inactive status
|-
|'''supplier_id'''
|Supplier Identifier
|-
|'''town'''
|city or town of residence
|-
|'''url'''
|Website Address
|-
|
|
|-
| colspan="2" |'''- Internal Users stream (list of company users in the ERP/CRM system)'''
|-
|'''address'''
|Residence Address
|-
|'''country_code'''
|Country code of residence
|-
|'''datelastlogin'''
|date of last login in Unix timestamp format
|-
|'''datem'''
|date of user modification in Unix timestamp format
|-
|'''datepreviouslogin'''
|date of prior entry into the system in Unix timestamp format
|-
|'''email'''
|User's email address
|-
|'''firstname'''
|User Name
|-
|'''job'''
|role or job within the company
|-
|'''lastname'''
|User's Last Name
|-
|'''office_phone'''
|Work Office Phone
|-
|'''user_id'''
|User Identifier
|-
|'''user_mobile'''
|cell phone
|-
|
|
|-
| colspan="2" |'''- Company profile data stream (ERP/CRM company profile data)'''
|-
|'''address'''
|Business or premise location address
|-
|'''company_id'''
|Company identifier in the ERP system
|-
|'''country_code'''
|country code of operation
|-
|'''default_lang'''
|Default language
|-
|'''email'''
|Email address
|-
|'''idprof1'''
|R.U.T.
|-
|'''idprof2'''
|Legal ID/NIT of the company
|-
|'''managers'''
|Names of the administrators
|-
|'''name'''
|Legal Company name
|-
|'''phone'''
|telephone
|-
|'''socialnetworks'''
|Social Media URLs
|-
|'''town'''
|city or town of company location
|-
|'''url'''
|Website Address
|-
|'''zip'''
|zip code
|}

====4. Connection configuration:====
[[File:Airbyte 4Captura de pantalla 2025-07-04 000006.png|thumb|Dolibarr source connector - final connection configuration in Airbyte]]

Finally, you must configure the name, schedule type, frequency and destination namespace for your connection. After these definitions you could save your connection and Airbyte will execute the first synchronization.
 
==='''Go further'''===
The Dolibarr source connector in Airbyte will let you modify and customize the streams, fields and API methods used by editing the connector in the UI Connector Builder, is important that you explore the Airbyte public documentation (<nowiki>https://docs.airbyte.com/platform/connector-development/connector-builder-ui/overview</nowiki> ) to make improvements to your connectors and get the maximum benefits of the Dolibarr data integration with this tool and contribute to the connector update.

==='''Conclusion'''===
Airbyte is versatile and powerful open source tool that allows you to create a no code data integrations between Dolibarr and many third-party applications using the Wbe services API REST to explode your operational data in analytics, business intelligence, AI tools to have added value from your data to make business decisions.

File:Airbyte 4Captura de pantalla 2025-07-04 000006.png

2025-07-04T06:08:16Z

Leonm2:

Dolibarr source connector - final connection configuration in Airbyte

File:Airbyte 3Captura de pantalla 2025-07-03 234344.png

2025-07-04T06:06:47Z

Leonm2:

Dolibarr source connector - sync mode, streams and fields schema selection in Airbyte

File:Airbyte 2Captura de pantalla 2025-07-03 234044.png

2025-07-04T06:01:50Z

Leonm2:

Dolibarr source connector authentication credentials configuration.

File:Airbyte 1Captura de pantalla 2025-07-03 234202.png

2025-07-04T05:55:28Z

Leonm2:

Dolibarr source connector selection in Airbyte

Developer documentation

2025-07-04T05:40:05Z

Leonm2: /* Interfaces and links with other applications */

<seo metak="developer, development, documentation, guide, doc, tutorial, usage, help, api, coding, standard, rules" />


[[fr:Documentation_Développeur]]
[[es:Documentación_Desarrolladores]]
[[de:Entwickler_Dokumentation]]
[[zh:开发文档]]
[[ja:JA_Developer_documentation]]


This page is main index of documents relating to developer documentation. For user documentation [[User documentation|see here]].

=Development organization and tools=
This chapter contains global information that must be read before starting any development on Dolibarr.

#[[Dolibarr Project|Organization of project]]
#[[To known before to start|To be known before starting to develop]]
#[[Environment and development tools]]
#[[Dependencies and external libraries]]
#[[FAQ_Get,update_project_sources|Get or update sources of a development version]]

=Coding rules and best practices=

#[[Prerequisite|Prerequisites]]
#[[Language and development rules|Language and development rules (PHP, SQL, HTML)]]
#[[:Category:Table SQL|List of tables]]
#Tree structure of files and classes are available in the [https://doxygen.dolibarr.org/ doxygen generated documentation]

=List of modules=
Technical documentation on standard business modules is available in each module's developer documentation pages. Choose the appropriate page you are interested in:

*[[:Category:List of Modules (developer)‎|List of standard modules]]
*[[:Category:Complementary modules|List of complementary modules]]
*[[Informations for developpers of complementary modules]]

=To develop a new module/addon for GUI=
This section describes how to develop a new module changing the Dolibarr user interface. This can be screens, themes, data, its own CSS stylesheet, source code or all of this.

Script development is not included in this section (this is described in the next chapter).

To develop your own module, check the [[Module development]] tutorial.

=To develop a batch or command line script=
This chapter describes how to develop command line scripts to execute tasks in Dolibarr (read, update data...).

Making modifications to the graphical user interface (GUI) is not included in this chapter. See the previous chapter for this.

To develop a script, like a cron script or a command line import tool to import data from an external source, you can have a look at the [[Script development]] page.

=Technical components of Dolibarr=
==Tree structure==
The path hierarchy of the current version files is available from the [http://doxygen.dolibarr.org/ doxygen generated documentation] (similar to generated "javadoc" documentation).

Paths to use to add new files by a new module are defined in the documentation to develop a new module (see [[Module development]]).

==Setup storage==
There are 3 places for Dolibarr setup parameters.

*Dolibarr technical setup parameters (authentication mode, database logins and storage area for files) are defined in only one setup file: <code>/conf/conf.php</code> .

:See [[Configuration file]] for more information.

*Global features parameters are stored in [[Table llx_const]].

:See the [[Constants]] page for more information.

*Feature parameters specific to a user are stored in [[Table llx_user_param]].

==Business objects==
See [[Business Objects]]

==Menus system==
See [[Menus system]]

==Tabs system==
See [[Tabs system]]

==Skins system==
See [[Skins]]

==Widget system==
See [[Widget system]]

==Authentication system==
See [[Authentication]]

==Permission system==
See [[Permissions En|Permissions]]

==Translation system==
See [[Translation system]]

==Error management==
See [[Error reporting|Error reporting]]

==Canvas system==
Canvas is a developer feature to replace screens to create, update or view a record (products, thirdparties, contacts, ...). For example, you can replace the input form used to create a new third party, or its editing form, or replace its viewing template.

See [[Canvas development]]

==Triggers system==
Triggers are a development feature to execute personalized code during a Dolibarr "business event" (creation of an invoice, deleting a user, update of third party, etc...), and only for a business event. To personalize code for other contexts, see the '''Hooks system''' chapter instead.

For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]].

==Hooks system==
See [[Hooks system]]

==Variable substitution system==
See [[Variable substitution system]]

==Web services==
Dolibarr can be setup to provide some services.

See [[Module Web Services API REST (developer)]]

Note: The [[Module Web Services API SOAP (developer)]] is deprecated.

==Files/Documents storage management==
See [[Generated documents]]

==Numbering modules==
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the reference generation rule. Several standard modules are supplied. Some are generic and are used to define the numbering mask (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided don't meet the needs. In this case it is necessary to develop a custom numbering module.

For more information, see [[Create numeration module|Create numbering module]].

==Document templates and documents generation==

More documentation about document generation from templates is available to [[Create a PDF document template]] or [[Create an ODT document template]].

==Extrafields==
See [[Extrafields]]

==Online payment system==
See [[Online payment system]]

==Other internal function==
There are many internal libraries your code can use.
You may find a lot of generic functions in the functions.lib.php, functions2.lib.php or admin.lib.php. Any function found in htdocs/core/lib/*.lib files can be used.

'''To specify a requirement based on Dolibarr version number'''

For example, to make a condition based on requiring Dolibarr version > 3.5, you can use versioncompare and versiondolibarrarray found in admin.lib.php:

<syntaxhighlight lang="PHP">
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
</syntaxhighlight>

=Mass exports/imports=

*[[Mass imports]]
*[[Module Exports En|Mass exports]]

=Interfaces and links with other applications=

Interfaces using API or WebHooks:

*[[Interfaces Dolibarr toward foreign systems]] or Dolibarr toward Dolibarr (Dolibarr Triggers, Hooks or WebHooks)
*[[Interfaces from foreign systems toward Dolibarr]] (API WebServices)

Integrate Dolibarr to synchronization platforms:

*[[Module Splash|Integration of Dolibarr with Splash]]
*[[Integration of Dolibarr with SyncHub]]

Integrate Dolibarr to automation/no code platforms:

*[[Integration of Dolibarr to the Zapier automation platform]]
*[[Integration of Dolibarr to the n8n automation platform]]
*[[Integration of Dolibarr to the Make automation platform]]

Integrate Dolibarr to data integration/no code platforms:

*[[Integration of Dolibarr to the Airbyte data integration platform]]

=FAQ=
All FAQs are available through the FAQ index page [[:Category:FAQ EN|FAQ EN]]
[[Category:Development]]