Dolibarr icon

Dolibarr

Open-source ERP and CRM suite for invoices, customers, and business operations.

4 triggers14 searches25 actionsPollingAuth: API key

AI-assisted documentation20 min read

This documentation is compiled from our integration source code, internal specs for Dolibarr, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Dolibarr on WEXTL →

Before you set up the credential, make sure you have an active Dolibarr account and an API access token from your account settings ready.[3]

  • Environment URLtextRequired

    Your instnance URL. For example, https://dolibarr.mycompany.com.

    [1]
  • API KeypasswordRequired

    Log into Dolibarr as an admin. Navigate to the Modules / Applications settings. Activate the API module and generate API key for secure access.

    [1]
  1. Log in to your WEXTL account, add the Dolibarr node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Dolibarr account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting Dolibarr to WEXTL®
Video slide demonstrates how to integrate Dolibarr in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch ContactsTrigger
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
Watch OrdersTrigger
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idsarray
Linked Objects Idsarray
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
83other output fields
Watch ProposalsTrigger
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
Watch ShipmentsTrigger
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
State IDtext
91other output fields
Get a ContactAction
Input fields[3]
FieldType
ContactRequired
choice
Include Countchoice
Include Roleschoice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
Get a ProductAction
Input fields[3]
FieldType
Product IDRequired
choice
Output fields[3]
FieldType
IDnumber
Reftext
Labeltext
Get a Third PartyAction
Input fields[3]
FieldType
ThirdpartyRequired
choice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
137other output fields
Get DocumentsAction
Input fields[3]
FieldType
Module PartRequired
choice
IDtext
Reftext
Sort Fieldchoice
Sort Orderchoice
Output fields[3]
FieldType
Nametext
Pathtext
Level 1nametext
Relativenametext
Fullnametext
Datedate
Sizenumber
Typetext
Labeltext
Entitytext
Filenametext
Filepathtext
Fullpath Origtext
Descriptiontext
Keywordstext
Covertext
Positiontext
Gen Or Uploadedtext
Extraparamstext
Date Cdate
9other output fields
Get Order LinesAction
Input fields[3]
FieldType
OrderRequired
choice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
116other output fields
List ContactsSearch
Input fields[3]
FieldType
Thirdparty IDschoice
Sort Fieldtext
Sort Orderchoice
Categorynumber
SQL Filterstext
Include Countchoice
Include Roleschoice
Propertiestext
Limitnumber
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
List GroupsSearch
Input fields[3]
FieldType
Group IDschoice
Sort Fieldtext
Sort Orderchoice
SQL Filterstext
Propertiestext
Limitnumber
Output fields[3]
FieldType
Moduletext
IDnumber
Entitynumber
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
56other output fields
List Groups of a UserSearch
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
Moduletext
IDnumber
Entitynumber
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
56other output fields
List OrdersSearch
Input fields[3]
FieldType
Thirdparty IDschoice
Sort Fieldtext
Sort Orderchoice
SQL Filterstext
SQL Filter Linestext
Propertiestext
Limitnumber
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idsarray
Linked Objects Idsarray
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
83other output fields
List ProductsSearch
Input fields[3]
FieldType
Sort Fieldtext
Sort Orderchoice
SQL Filterstext
SQL Filter Linestext
Limitnumber
Output fields[3]
FieldType
IDnumber
Reftext
Labeltext
List ProposalsSearch
Input fields[3]
FieldType
Thirdparty IDschoice
Sort Fieldtext
Sort Orderchoice
SQL Filterstext
Propertiestext
Limitnumber
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
List ShipmentsSearch
Input fields[3]
FieldType
Thirdparty IDschoice
Sort Fieldtext
Sort Orderchoice
SQL Filterstext
Propertiestext
Limitnumber
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
State IDtext
91other output fields
List ThirdpartiesSearch
Input fields[3]
FieldType
Sort Fieldtext
Sort Orderchoice
Modechoice
Categorynumber
SQL Filterstext
Propertiestext
Limitnumber
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
137other output fields
List UsersSearch
Input fields[3]
FieldType
User IDschoice
Sort Fieldtext
Sort Orderchoice
Categorynumber
SQL Filterstext
Propertiestext
Limitnumber
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsobject
Options First Nametext
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
112other output fields
Close a ProposalAction
Input fields[3]
FieldType
ProposalRequired
choice
Private Notetext
Public Notetext
Statuschoice
Triggerchoice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
Close a ShipmentAction
Input fields[3]
FieldType
ShipmentRequired
choice
TriggerRequired
choice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
State IDtext
91other output fields
Close an OrderAction
Input fields[3]
FieldType
OrderRequired
choice
TriggerRequired
choice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idsarray
Linked Objects Idsarray
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
83other output fields
Create a ContactAction
Input fields[3]
FieldType
Last NameRequired
text
First Nametext
Civilitychoice
Addresstext
ZIP Codetext
Towntext
Country IDRequired
choice
Emailemail
Professional Phonetext
Personal Phonetext
Faxtext
Private Notetext
Public Notetext
Default Languagetext
Custom Fieldsarray
Field NameRequired
text
ValueRequired
text
Create a ProposalAction
Input fields[3]
FieldType
Third Party IDRequired
choice
Proposal Creation DateRequired
date
Validity Datedate
Client Reference Numbertext
Total Amount Excluding Taxesnumber
Total Tax Amountnumber
Total Amount Including Taxesnumber
Internal Notestext
Public Notestext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Create a ShipmentAction
Input fields[3]
FieldType
Third Party IDRequired
choice
Date ShippingRequired
date
Shipping Method IDchoice
Private Notetext
Public Notetext
Warehouse IDchoice
Model PDFtext
Originchoice
Origin IDchoice
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Create a Third PartyAction
Input fields[3]
FieldType
NameRequired
text
Country IDRequired
choice
Name Aliastext
Client Typechoice
Addresstext
ZIPtext
Towntext
Phonetext
Faxtext
Emailemail
Websiteurl
Default Languagetext
VAT Numbertext
Unique Identifiertext
Bank Codetext
Private Notetext
Public Notetext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Create a UserAction
Input fields[3]
FieldType
LoginRequired
text
PasswordRequired
text
Last NameRequired
text
First NameRequired
text
Emailemail
Administratorchoice
Entitytext
Notetext
Office Phonetext
Mobile Phonetext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Create OrderAction
Input fields[3]
FieldType
Third Party IDRequired
choice
Order DateRequired
date
Expected Delivery Datedate
Internal Notetext
Public Notetext
Order Linesarray
PDF Modeltext
Payment Term IDnumber
Payment Mode IDnumber
Global Discount Percentagenumber
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Create Order LinesAction
Input fields[3]
FieldType
OrderRequired
choice
DescriptionRequired
text
Unit PriceRequired
number
QuantityRequired
number
Product IDtext
VAT Ratenumber
Discount Percentagenumber
Delete a ContactAction
Input fields[3]
FieldType
ContactRequired
choice
Delete a ThirdpartyAction
Input fields[3]
FieldType
ThirdpartyRequired
choice
Delete an OrderAction
Input fields[3]
FieldType
OrderRequired
choice
Download a DocumentAction
Input fields[3]
FieldType
Module PartRequired
choice
Original FileRequired
text
Output fields[3]
FieldType
Filenametext
Content Typetext
Filesizenumber
Contenttext
Encodingtext
Make an API Calluniversal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Update a ContactAction
Input fields[3]
FieldType
ContactRequired
choice
Last Nametext
First Nametext
Civilitychoice
Addresstext
ZIP Codetext
Towntext
Country IDchoice
Emailemail
Professional Phonetext
Personal Phonetext
Faxtext
Private Notetext
Public Notetext
Default Languagetext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
Update a ProposalAction
Input fields[3]
FieldType
ProposalRequired
choice
Third Party IDchoice
Proposal Creation Datedate
Validity Datedate
Client Reference Numbertext
Total Amount Excluding Taxesnumber
Total Tax Amountnumber
Total Amount Including Taxesnumber
Internal Notestext
Public Notestext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idsarray
Linked Objects Idsarray
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statutnumber
Statusnumber
Country IDtext
Country Codetext
85other output fields
Update a ShipmentAction
Input fields[3]
FieldType
Shipment IDchoice
Third Party IDchoice
Date Shippingdate
Shipping Method IDchoice
Private Notetext
Public Notetext
Warehouse IDchoice
Model PDFtext
Originchoice
Origin IDchoice
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
State IDtext
91other output fields
Update a Third PartyAction
Input fields[3]
FieldType
ThirdpartyRequired
choice
Nametext
Country IDchoice
Name Aliastext
Client Typechoice
Addresstext
ZIPtext
Towntext
Phonetext
Faxtext
Emailemail
Websiteurl
Default Languagetext
VAT Numbertext
Unique Identifiertext
Bank Codetext
Private Notetext
Public Notetext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Update a UserAction
Input fields[3]
FieldType
UserRequired
choice
Logintext
Passwordtext
Last Nametext
First Nametext
Emailemail
Administratorchoice
Entitytext
Notetext
Office Phonetext
Mobile Phonetext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Update OrderAction
Input fields[3]
FieldType
Order IDRequired
choice
Internal Notetext
Public Notetext
Custom Fieldsarray
Field NameRequired
choice
ValueRequired
text
Upload a DocumentAction
Input fields[3]
FieldType
FilenameRequired
text
Module PartRequired
choice
Referencetext
Subdirectorytext
File Content TypeRequired
choice
Overwrite If Existschoice
Create Dir If Not Existschoice
Output fields[3]
FieldType
User IDnumber
Validate a ProposalAction
Input fields[3]
FieldType
ProposalRequired
choice
Private Notetext
TriggerRequired
choice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
89other output fields
Validate a ShipmentAction
Input fields[3]
FieldType
ShipmentRequired
choice
TriggerRequired
choice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idstext
Linked Objects Idstext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
State IDtext
91other output fields
Validate an OrderAction
Input fields[3]
FieldType
OrderRequired
choice
TriggerRequired
choice
Output fields[3]
FieldType
Moduletext
IDtext
Entitytext
Import Keytext
Array Optionsarray
Array Languagestext
Contacts Idsarray
Linked Objects Idsarray
Canvastext
Fk Projecttext
Contact IDtext
Usertext
Origin Typetext
Origin IDtext
Reftext
Ref Exttext
Statuttext
Statustext
Country IDtext
Country Codetext
83other output fields

Look for Dolibarr templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Dolibarr Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Dolibarr.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:39