Explore the Dolibarr API data model

See how the various Dolibarr endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the Dolibarr API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Dolibarr API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Contact

Documentation: https://wiki.dolibarr.org/index.php?title=Module_Third_Parties_(developer)

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Name	string	-	-
Statut	int	-	-
Lastname	string	-	-
Firstname	string	-	-
CivilityCode	string	-	-
Civility	string	-	-
Gender	string	-	-
Address	string	-	-
Zip	string	-	-
Town	string	-	-
Poste	string	-	-
FkSoc	long	ThirdParty → ID	-
Email	string	-	-
Mail	string	-	-
PhonePro	string	-	-
PhonePerso	string	-	-
PhoneMobile	string	-	-
Fax	string	-	-
Priv	boolean	-	-
Birthday	long	-	-
StatutCommercial	string	-	-
DateCreation	long	-	-
DateModification	long	-	-
Ref	string	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
RefExt	string	-	-

Contract

Documentation: https://wiki.dolibarr.org/index.php?title=Module_Contract_(developer)

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
FkProject	long	Project → ID	-
FkSoc	long	Company → ID	-
Status	int	-	-
TotalHt	decimal	-	-
TotalTva	decimal	-	-
TotalLocaltax1	decimal	-	-
TotalLocaltax2	decimal	-	-
TotalTtc	decimal	-	-
RefClient	string	-	-
RefCustomer	string	-	-
CommercialSignatureID	long	-	-
CommercialSuiviID	long	-	-
Nbofservices	int	-	-
Nbofserviceswait	int	-	-
Nbofservicesopened	int	-	-
Nbofservicesexpired	int	-	-
Nbofservicesclosed	int	-	-
Ref	string	-	-
UserAuthorID	long	User → ID	-
DateCreation	long	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
RefExt	string	-	-

SaleOrder

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
FkProject	long	Project → ID	-
FkMulticurrency	long	-	-
Status	int	-	-
ModeReglementID	long	-	-
CondReglementID	long	-	-
DemandReasonID	long	-	-
ShippingMethodID	long	-	-
MulticurrencyCode	string	-	-
MulticurrencyTx	decimal	-	-
MulticurrencyTotalTva	decimal	-	-
MulticurrencyTotalHt	decimal	-	-
MulticurrencyTotalTtc	decimal	-	-
ModelPdf	string	-	-
TotalHt	decimal	-	-
TotalTva	decimal	-	-
TotalLocaltax1	decimal	-	-
TotalLocaltax2	decimal	-	-
TotalTtc	decimal	-	-
UserCreationID	long	User → ID	-
UserAuthorID	long	User → ID	-
Code	string	-	-
LocationIncoterms	string	-	-
RefClient	string	-	-
RefCustomer	string	-	-
Billed	boolean	-	-
CondReglementCode	string	-	-
CondReglementDoc	string	-	-
ModeReglementCode	string	-	-
AvailabilityID	long	-	-
AvailabilityCode	string	-	-
Availability	string	-	-
DemandReasonCode	string	-	-
OnlinePaymentUrl	string	-	-
Date	long	-	-
DateValidation	long	-	-
DateCreation	long	-	-
DateModification	long	-	-
DeliveryDate	long	-	-
Ref	string	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
RefExt	string	-	-

Shipment

Documentation: https://wiki.dolibarr.org/index.php?title=Module_Contract_(developer)

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
FkProject	long	Project → ID	-
OriginID	long	-	-
Origin	string	-	-
StatusName	string	-	-
TotalHt	decimal	-	-
TotalTva	decimal	-	-
TotalLocaltax1	decimal	-	-
TotalLocaltax2	decimal	-	-
TotalTtc	decimal	-	-
RefCustomer	string	-	-
ShippingMethod	string	-	-
CommercialSignatureID	long	-	-
CommercialSuiviID	long	-	-
UserAuthorID	long	User → ID	-
TrackingNumber	string	-	-
TrackingUrl	string	-	-
TrueWeight	decimal	-	-
WeightUnits	decimal	-	-
TrueWidth	decimal	-	-
WidthUnits	decimal	-	-
TrueHeight	decimal	-	-
HeightUnits	decimal	-	-
TrueDepth	decimal	-	-
DepthUnits	decimal	-	-
TrueSize	string	-	-
SizeUnits	string	-	-
DateDelivery	long	-	-
DateExpedition	long	-	-
DateShipping	long	-	-
DateValid	long	-	-
DateCreation	long	-	-
Ref	string	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
RefExt	string	-	-

ThirdParty

Documentation: https://wiki.dolibarr.org/index.php?title=Module_Third_Parties_(developer)

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Name	string	-	-
ModelPdf	string	-	-
Email	string	-	-
CodeClient	string	-	-
CodeFournisseur	string	-	-
Client	int	-	-
Prospect	boolean	-	-
Fournisseur	boolean	-	-
TvaAssuj	boolean	-	-
TvaIntra	boolean	-	-
Idprof1	string	-	-
Idprof2	string	-	-
Idprof3	string	-	-
Idprof4	string	-	-
Idprof5	string	-	-
Idprof6	string	-	-
Managers	string	-	-
Capital	string	-	-
DefaultLang	string	-	-
Logo	string	-	-
LogoSmall	string	-	-
LogoMini	string	-	-
LogoSquarred	string	-	-
LogoSquarredSmall	string	-	-
LogoSquarredMini	string	-	-
Address	string	-	-
Zip	string	-	-
Town	string	-	-
Parent	long	ThirdParty → ID	-
Localtax1Value	decimal	-	-
Localtax2Value	decimal	-	-
VatReverseCharge	boolean	-	-
StatusProspectLabel	string	-	-
AccountancyCodeSell	string	-	-
AccountancyCodeBuy	string	-	-
DateCreation	long	-	-
DateModification	long	-	-
Ref	string	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
RefExt	string	-	-

Invoice

Documentation: https://wiki.dolibarr.org/index.php?title=Module_Customers_Invoices_(developer)

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
FkProject	long	Project → ID	-
FkMulticurrency	long	MultiCurrency → ID	-
Status	int	-	-
TotalHt	decimal	-	-
TotalTva	decimal	-	-
TotalLocaltax1	decimal	-	-
TotalLocaltax2	decimal	-	-
TotalTtc	decimal	-	-
MulticurrencyCode	string	-	-
MulticurrencyTx	decimal	-	-
MulticurrencyTotalTva	decimal	-	-
MulticurrencyTotalHt	decimal	-	-
MulticurrencyTotalTtc	decimal	-	-
Totalpaid	decimal	-	-
ModelPdf	string	-	-
LastMainDoc	string	-	-
UserCreationID	long	User → ID	-
ModeReglementID	long	-	-
CondReglementID	long	-	-
RetainedWarrantyFkCondReglement	boolean	-	-
Type	int	-	-
CondReglementCode	string	-	-
CondReglementDoc	string	-	-
ModeReglementCode	string	-	-
Revenuestamp	decimal	-	-
Remaintopay	decimal	-	-
SituationFinal	int	-	-
Date	long	-	-
DateLimReglement	long	-	-
RetainedWarrantyDateLimit	long	-	-
DateCreation	long	-	-
DateModification	long	-	-
Ref	string	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
RefExt	string	-	-

MultiCurrency

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Name	string	-	-
Code	string	-	-
Rate	decimal	-	-
RateSyncDate	long	-	-

Product

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Status	boolean	-	-
StatusBuy	boolean	-	-
StatusBatch	int	-	-
Label	string	-	-
PriceTtc	decimal	-	-
PriceTtcFormated	decimal	-	-
PriceMin	decimal	-	-
PriceMinTtc	decimal	-	-
TvaTx	decimal	-	-
Localtax1Tx	decimal	-	-
Localtax2Tx	decimal	-	-
Localtax1Type	long	-	-
Localtax2Type	long	-	-
PriceBaseType	string	-	-
Pmp	decimal	-	-
Duration	string	-	-
Weight	decimal	-	-
WeightUnits	int	-	-
Length	decimal	-	-
LengthUnits	int	-	-
Width	decimal	-	-
WidthUnits	int	-	-
Height	decimal	-	-
HeightUnits	int	-	-
Surface	decimal	-	-
SurfaceUnits	int	-	-
Volume	decimal	-	-
VolumeUnits	int	-	-
AccountancyCodeSell	string	-	-
AccountancyCodeSellIntra	string	-	-
AccountancyCodeSellExport	string	-	-
AccountancyCodeBuy	string	-	-
AccountancyCodeBuyIntra	string	-	-
AccountancyCodeBuyExport	string	-	-
Barcode	string	-	-
BarcodeType	int	-	-
BarcodeTypeCode	string	-	-
Logo	string	-	-
LogoSmall	string	-	-
LogoMini	string	-	-
LogoSquarred	string	-	-
LogoSquarredSmall	string	-	-
LogoSquarredMini	string	-	-
Type	int	-	-
Desiredstock	decimal	-	-
BatchMask	string	-	-
Customcode	string	-	-
TypeName	string	-	-
Finished	boolean	-	-
Address	string	-	-
Zip	string	-	-
Town	string	-	-
DateCreation	datetime	-	-
DateModification	datetime	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
Ref	string	-	-
RefExt	string	-	-

ProductAttribute

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Label	string	-	-
Position	int	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
Ref	string	-	-
RefExt	string	-	-

ProductCombination

Column	Type	Relates to	Notes
RemoteID	string	-	-
ProductRemoteID	string	Product → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
FkProductParent	long	Product → ID	-
FkProductChild	long	Product → ID	-
VariationWeight	decimal	-	-
VariationPrice	decimal	-	-
VariationPricePercentage	decimal	-	-
VariationRefExt	string	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
Ref	string	-	-
RefExt	string	-	-

Warehouse

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Description	string	-	-
Label	string	-	-
Lieu	string	-	-
Color	string	-	-
Address	string	-	-
Zip	string	-	-
Fax	string	-	-
Phone	string	-	-

Event

Documentation: https://wiki.dolibarr.org/index.php?title=Module_Agenda_(developer)

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Status	long	-	-
Datep	long	-	-
Datef	long	-	-
TypeID	long	-	-
Type	string	-	-
TypeCode	string	-	-
Code	string	-	-
Label	string	-	-
Fulldayevent	boolean	-	-
Eventpaid	boolean	-	-
Percentage	int	-	-
Location	string	-	-
Transparency	int	-	-
Priority	int	-	-
Userownerid	long	User → ID	-
Authorid	long	User → ID	-
ElementID	long	-	-
Element	string	-	-
Datec	long	-	-
Datem	long	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
Ref	string	-	-
RefExt	string	-	-

Project

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Description	string	-	-
Title	string	-	-
UserAuthorID	long	User → ID	-
Status	long	-	-
Dateo	long	-	-
Datee	long	-	-
DateStart	long	-	-
DateEnd	long	-	-
DateStartEvent	long	-	-
DateEndEvent	long	-	-
DateClose	long	-	-
BudgetAmount	decimal	-	-
Public	boolean	-	-
UsageOpportunity	boolean	-	-
UsageTask	boolean	-	-
UsageBillTime	boolean	-	-
UsageOrganizeEvent	boolean	-	-
AcceptConferenceSuggestions	boolean	-	-
AcceptBoothSuggestions	boolean	-	-
OppStatus	long	-	-
OppAmount	decimal	-	-
OppPercent	decimal	-	-
Type	string	-	-
DateC	long	-	-
DateM	long	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
Ref	string	-	-
RefExt	string	-	-

Company

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Name	string	-	-
Module	string	-	-
StateID	long	-	-
RegionID	long	-	-
CountryID	long	-	-
UserModificationID	long	User → ID	-
Specimen	boolean	-	-
CountryCode	string	-	-
NotePublic	string	-	-
NotePrivate	string	-	-
Ref	string	-	-
RefExt	string	-	-
Phone	string	-	-
Fax	string	-	-
Email	string	-	-
Idprof1	string	-	-
Idprof2	string	-	-
Idprof3	string	-	-
Idprof4	string	-	-
Idprof5	string	-	-
Idprof6	string	-	-
Managers	string	-	-
Capital	string	-	-
DefaultLang	string	-	-
Logo	string	-	-
LogoSmall	string	-	-
LogoMini	string	-	-
LogoSquarred	string	-	-
LogoSquarredSmall	string	-	-
LogoSquarredMini	string	-	-
Address	string	-	-
Zip	string	-	-
Town	string	-	-

Group

Documentation: https://wiki.dolibarr.org/index.php?title=Module_Users_(developer)

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	long	-	-
Name	string	-	-
Entity	long	-	-
Datec	long	-	-
Tms	long	-	-

Unit

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
Rowid	long	-	-
Code	string	-	-
Label	string	-	-
ShortLabel	string	-	-
Active	boolean	-	-
Scale	long	-	-
UnitType	string	-	-

User