https://wiki.dolibarr.org/api.php?action=feedcontributions&feedformat=atom&user=SonikfDolibarr ERP CRM Wiki - User contributions [en]2026-11-11T22:28:36ZUser contributionsMediaWiki 1.39.17https://wiki.dolibarr.org/index.php?title=Setup_Other&diff=65981Setup Other2026-04-22T13:04:18Z<p>Sonikf: </p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Paramétrage_Divers]]<br />
[[es:Configuración_Varios]]<br />
[[de:Erweiterte_Einstellungen]]<br />
[[zh:其他设置]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Admin]]<br />
{{TemplateDocUser}}<br />
<br />
'''Help About Screen''': Other setup<br />
<br />
'''Menu Path''': Home ► Setup ► Other<br />
<br />
<br />
<br />
'''Introduction'''<br />
<br />
Some options are not visible in the interface (often because they are deprecated or are beta features). In most cases you do not need these functions and their use may make the application unstable or may not work as expected.<br />
<br />
{{warning|32px}} This page contains the list of some advanced development parameters. In most cases, they are parameters for internal usage, development, external modules, features in development not stable or that may lead to security risk. For standard usage of Dolibarr, such parameters '''SHOULD NOT''' be used. All experimental options are NOT supported. They may be removed in a future, modified at any version and break stability of your application.<br />
<br />
To enable/override a parameter you have to define the constant name and set it to 1 (unless otherwise stated) in <code>Home ► Setup ► Other Setup</code><br />
<br />
<br />
The options here may not be documented since they are not stable and are unsupported (remember they are experimental or development options). The basic format of how the list is written is broken down in the example below:<br />
<br />
UNSTABLE_OR_DEV_OPTION ► ''Description of config and goal'' ► ''(specific version information) or values''<br />
<center><br />
__TOC__<br />
</center><br />
=Global Options=<br />
<br />
*'''ADD_UNSPLASH_LOGIN_BACKGROUND''' ► The background image will be refreshed on every login page refresh. Background image is pulled from the popular open source image website Unsplash. If an already saved static background image exists, then this code will override it (but not delete the saved image). Warning: Using this may allow this external website to steel your login credentials (the value to be put is the URL of the service, exemple<span> </span>: https://source.unsplash.com/random) ► (v10.0)<br />
*'''MAIN_HIDE_POWERED_BY''' ► Hide the "Powered by Dolibarr" picto on public pages<br />
*'''MAIN_APPLICATION_TITLE''' ► This will change the title of software (that appears on the login page by default). Warning: changing this may make Dolibarr version detection to fail by smartphone applications like [[Application Android - DoliDroid]], breaking some features when using Dolibarr from such application. If the text start with a "+", the text will be added to the standard "Dolibarr" label instead of replacing it.<br />
<br />
*'''MAIN_AUTOFILL_DATE''' ► If this constant is defined (to something other than <code>0</code>), the date of invoice, proposal, order or payment are auto-filled with the current date. It is highly recommended to NOT ENABLE this feature. This can create a lot of input errors with data not validated by users. This leads to incorrect values saved in the database causing confusion when you have to do your accountancy reports!<br />
*'''MAIN_AUTOFILL_DATE_PROPOSAL►'''If this constant is defined (to something other than 0), the date of proposal is auto-filled with the current date.<br />
<br />
*'''MAIN_AUTO_TIMESTAMP_IN_PUBLIC_NOTES''' ► Add a timestamp and user automatically when editing the ''public'' note.<br />
<br />
*'''MAIN_AUTO_TIMESTAMP_IN_PRIVATE_NOTES''' ► Add a timestamp and user automatically when editing the ''private'' note.<br />
<br />
*'''MAIN_DEFAULT_PAYMENT_TERM_ID''' ► With ID of a payment term, will use this as default payment term each time you create a new proposal, order, invoice (customer and supplier). Deprecated. Replaced with the default setup feature instead (see French page of wiki for some exemple<span> </span>: [[Paramétrage Valeurs par défaut]])<br />
*'''MAIN_DEFAULT_PAYMENT_TYPE_ID''' ► With ID of a payment type, will use this as default payment type each time you create a new proposal, order, invoice (customer and supplier). Deprecated. Replaced with the default setup feature instead (see French page of wiki for some exemple<span> </span>: [[Paramétrage Valeurs par défaut]])<br />
<br />
*'''MAIN_DEFAULT_LANGUAGE_FILTER''' ► Useful if you do not want to show <code>en_US</code> language option in combo boxes (other languages can easily be removed in <code>langs</code> directory but not <code>en_US</code>) ► (v10.0)<br />
<br />
*'''MAIN_LANGUAGES_ALLOWED''' ► Is a list of languages without spaces, example<span> </span>: <code>fr_FR,en_US,de_DE,it_IT</code> If defined, only those languages will appear in combos. ► (v11.0)<br />
<br />
*'''MAIN_DISABLE_NOTES_TAB''' ► Show or hide notes tab in the card page<br />
<br />
*'''MAIN_DISABLE_CONTACTS_TAB''' ► Show or hide contacts tab in the card page<br />
<br />
*'''MAIN_DISABLE_FULL_SCANLIST''' ► Disables the complete scan of tables to allow the pagination to show total number of pages. May be useful to activate on systems with a very high quantity of data (tables with more than 2 000 000 records).<br />
<br />
*'''MAIN_DISABLE_JQUERY_JNOTIFY''' ► Disable usage of <code>JNotify</code> to show confirm or error messages<br />
<br />
*'''MAIN_DISABLE_AJAX_COMBOX''' ► If you have a large number of third parties or products, you can disable the autocomplete feature on the third parties list by setting this constant to <code>1</code> ► (v3.6.0+)<br />
*'''MAIN_DISABLE_MULTIPLE_FILEUPLOAD''' ► Disable users to upload multiple files at once.<br />
*'''MAIN_DISABLE_TRUNC''' ► Disable all truncings in select list. ► (v7.0+)<br />
<br />
*'''MAIN_DISABLEDRAFTSTATUS''' ► Disable the status "Draft" for some objects (project, donation, ...) so the object is directly created with status "Validated"<br />
<br />
*'''MAIN_DOC_USE_OBJECT_THIRDPARTY_NAME''' ► Add name of thirdparty at begin of generated document.<br />
<br />
*'''MAIN_DOC_USE_TIMING''' ► Add a timestamp at end of generated document. Value must be format of timestamp. For example: <code>%Y%m%d%H%M</code> (only for ODT files)<br />
<br />
*'''MAIN_DOC_UPLOAD_NOT_RENAME_BY_DEFAULT''' ► Disable the auto renaming on upload file ► (v10.0)<br />
<br />
*'''MAIN_DOL_SCRIPTS_ROOT''' ► Define directory who contains 'scripts' directory (e.g. <code>/var/www/dolibarr</code>). Value of this variable may be requested by some external script or tools.<br />
<br />
*'''MAIN_ENABLE_LOG_TO_HTML''' ► If this constant is defined, it is possible to have logs inside pages by adding the parameter <code>&logtohtml=1</code> into URL.<br />
<br />
*'''MAIN_ENABLE_IMPORT_LINKED_OBJECT_LINES''' ► Allow to import lines into current document from "linked" compatible documents ► (v8.0+)<br />
<br />
*'''MAIN_FIRST_TO_UPPER''' ► Dolibarr add uppercase to Third Parties, contacts or members names if not done. Warning: with some languages (whose words with uppercase are not same words, or pagecode does not always have an uppercase, like Cyrillic languages), this feature may alter your data.<br />
<br />
*'''MAIN_ALL_TO_UPPER''' ► Dolibarr puts uppercase for Third Parties, contacts or members names if not done. Warning, with some languages (whose words with uppercase are not same words, or pagecode does not always have an uppercase, like Cyrillic languages), this feature may alter your data. ► (v11.0)<br />
<br />
*'''MAIN_ALL_TOWN_TO_UPPER''' ► Dolibarr puts uppercase for town names if not done. ► (v13.0)<br />
<br />
*'''MAIN_FILESYSTEM_ENCODING''' ► With some PHP versions, PHP is not able to detect the page code for filesystem of the server OS. To solve this, Dolibarr assumes your OS filesystem is <code>UTF-8</code> if on Linux or OSX system, and <code>ISO-8859-1</code> if on Windows. If not, for example on a Windows server with a NTFS <code>UTF-8</code> pagecode, you can set the variable <code>MAIN_FILESYSTEM_ENCODING</code> to "<code>utf-8</code>".<br />
<br />
*'''MAIN_FORCELANGDIR''' ► Relative path of the directory holding your custom <code>langs</code> folder.<br />
*'''MAIN_HTML_TITLE''' ► Can be used to control how the html page title is formatted. If value contains key '<code>noapp</code>', application name will not be output. If value contains '<code>thirdpartynameonly</code>', on tab for thirdparties, only name of thirdparties are output. Value can be list of tags: '<code>noapp;thirdpartynameonly</code>'<br />
<br />
*'''MAIN_HELPCENTER_LINKTOUSE''' ► Define the URL link to use as the target page for link "I need help" onto logon page<br />
<br />
*'''MAIN_LOGOUT_GOTO_URL''' ► URL to which the user will be redirected after LOGOUT<br />
<br />
*'''MAIN_MAXTABS_IN_CARD''' ► Maximum number of tabs visible. Others are grouped into a combo list.<br />
<br />
*'''MAIN_MAXLIST_OVERLOAD''' ► Maximum number of line in space's domain.<br />
<br />
*'''MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING''' ► A warning saying setup of modules is not complete is shown if the number of enabled modules is lower or equal than this value (<code>1</code> if not defined)<br />
<br />
*'''MAIN_NO_CONCAT_DESCRIPTION''' ► Allow to use only input custom description in lines (proposal, order, invoice) ► (v10.0) < v20.0. [ OSBOLETE since 20.0 | SEE Product module admin configuration to set the description behavior of products and services ]. This value is overwritten by PRODUCT_AUTOFILL_DESC, controled by the option in the product module admin configuration, and is no longer used. Kept in code to allow compatibility if custom modules are using it. Removed completely from v22.<br />
<br />
*'''MAIN_OPTIMIZE_SPEED''' ► Use some speed enhancements. See page [[FAQ Increase Performance]] for more information.<br />
*'''MAIN_PASSWORD_FORGOTLINK ►''' Change forgotten password link on login page. ► (v9.0)<br />
<br />
*'''MAIN_PROPAGATE_CONTACTS_FROM_ORIGIN''' ► When creating an order, contract, invoice from another object, specific contacts of objects are set as specific contact of the new object when possible. ► (v4.0+)<br />
<br />
*'''MAIN_PUBLIC_NOTE_IN_ADDRESS''' ► Show public note in address block ► (v4.0+)<br />
<br />
*'''MAIN_REMOVE_INSTALL_WARNING''' ► Remove all security warnings that appear to administrator users if URL <code>/install</code> is public. You should solve the problem if warning occurs, instead of removing the warning! For this, create a file called <code>install.lock</code> into Dolibarr root directory. This will stop the warning but also make the page <code>/install</code> not possible to use, to protect your installation.<br />
<br />
*'''MAIN_REPEATCONTACTONEACHTAB''' ► If added and set to <code>1</code>, this adds contacts on all tabs, not only main tab.<br />
<br />
*'''MAIN_REPLACE_TRANS_xx_XX''' ► Where <code>xx_XX</code> is language code. If value is <code>string1:newstring1;string2:newstring2</code> then replace <code>string1</code> with <code>newstring1</code> in all translation done for language <code>xx_XX</code>.<br />
<br />
*'''MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND''' ► Change way of rounding total including tax of lines, rounding first of after.<br />
<br />
*'''MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND_SUPPLIER'''► Change way of rounding total including tax of lines, rounding first of after.<br />
<br />
*'''MAIN_SERVER_TZ''' ► If you can't set the time zone of your PHP installation, set this constant. Better is to set it to UTC. In future, this constant will be forced to '<code>UTC</code>' so PHP server time zone will not have effect any more. Examples: <code>Europe/Paris</code>, <code>auto</code>. Dolibarr will apply the timezone before saving dates in the database. Meaning that if you remove the parameter the dates saved will not change back to UTC.<br />
<br />
*'''MAIN_SEARCH_FORM_ON_HOME_AREAS''' ► Show the search form on home page areas for core modules (Removed after v5 due to global search combo) ► (v6.0+)<br />
<br />
*'''MAIN_SEARCHFORM_SUPPLIER_INVOICE_DISABLED''' ► Disable the supplier invoice on the search form<br />
<br />
*'''MAIN_SEARCH_DIRECT_OPEN_IF_ONLY_ONE''' ► If only one result is found, then setting this value to <code>1</code> will take you direct to the item (default method). Setting the value to <code>0</code> will show the result in the list as a single result ► (v5.0+)<br />
<br />
*'''MAIN_SERVICES_ARE_ECOMMERCE_200238EC''' ► If seller and buyer are in Europe and buyer is not a company, use the VAT of buying country. It can have value '1' or '2'. If value 2, the VATs available to select only the ones of buying country. If '1', the VATs available to select mix the ones of selling country and the ones of buying country. ► (v18.0+)<br />
<br />
*'''MAIN_SHOW_TUNING_INFO''' ► Add tuning information into JavaScript console. Better when xdebug is enabled.<br />
<br />
*'''MAIN_SHOW_TECHNICAL_ID''' ► Show also technical IDs on elements cards or some lists (not supported everywhere).<br />
<br />
*'''MAIN_SHOWDATABASENAMEINHELPPAGESLINK''' ► Show database name in upper help menu ► (v8.0+)<br />
<br />
*'''MAIN_USE_ALTERNATE_TRANSLATION_FOR''' ► List of fields per object that need an alternate translation. Example: <code>MAIN_USE_ALTERNATE_TRANSLATION_FOR=societe:name,town;contact:firstname,lastname</code><br />
<br />
*'''MAIN_USE_HOURMIN_IN_DATE_RANGE''' ► On all entities lines (invoice, order, contract...), it is possible to add hour and minutes with date on fields "date start" and "date end".<br />
<br />
*'''MAIN_USE_JQUERY_JEDITABLE''' ► Allow to update from screen, directly into database, some properties of elements (invoices, proposals, ...) using Ajax. This make response time faster, but avoid using this feature, because it bypasses some business actions (updates on other data that should be done consistently) and ignores business controls on data you saved. Consequently this feature breaks consistency of data and possibly the stability of the software.<br />
<br />
*'''MAIN_USE_JQUERY_MULTISELECT''' ► Allow to use Ajax when a choice that require multiselect is used (for the moment only external modules uses select box with multiselect values). Set the value to the jQuery plugin name to use (multiselect, multiple-select, select2…). Setting it to any other value will result in unwanted side-effects and/or bugs.<br />
<br />
*'''MAIN_USE_OLD_SEARCH_FORM''' ► Display the old search form in left menu.<br />
<br />
*'''MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS''' ► Allow to force the VAT rate to a given value (instead of higher VAT rate of country) if the VAT rate of product was not defined.<br />
<br />
*'''MAIN_UNKNOWN_CUSTOMERS_ARE_COMPANIES''' ► If we can't guess if a thirdparty is a company or individual (not VAT ID fill, no Prof ID fill, no type of thirdparty fill), then we suppose it is a company (B2B business) if 1, we suppose it is an individual (B2C business) if 0.<br />
<br />
*'''MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL''' ► For intra CEE sales, we use by default, on proposal, order or invoice creation, a 0 VAT for customers that are companies (see MAIN_UNKNOWN_CUSTOMERS_ARE_COMPANIES to change behaviour to know if a thirdparty is a company or an individual). But if the option MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL is set, we will use the 0 VAT only if a VAT ID is defined for the customer.<br />
<br />
*'''MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC''' ► For to use the default VAT of product for individual customers that are out E.E.C. (European Economic Community) ► (v7.0+). ''There is no reason to use this.''<br />
<br />
*'''MAIN_VIEW_LINE_NUMBER''' ► Shows a line number for each line of products/services at documents like proposal / order / invoice. Only on screen, not on PDF.<br />
<br />
*'''MAIN_VIEW_LINE_NUMBER_IN_LIST''' ► Shows a line number in lists ► (v12.0)<br />
<br />
*'''MAIN_VOLUME_DEFAULT_ROUND''' ► Accuracy of volume (number of decimals)<br />
<br />
*'''MAIN_VOLUME_DEFAULT_UNIT''' ► Default unit for weight (<code>0=kg</code>, <code>-3=g</code>, ...)<br />
<br />
*'''MAIN_WEIGHT_DEFAULT_ROUND''' ► Accuracy of weight (number of decimals)<br />
<br />
*'''MAIN_WEIGHT_DEFAULT_UNIT''' ► Default unit for weight (<code>0=kg</code>, <code>-3=g</code>, ...)<br />
<br />
*'''USER_HIDE_INACTIVE_IN_COMBOBOX''' ► Disable display inactive users in combobox.<br />
<br />
*'''MAIN_DISABLE_PDF_THUMBS''' ► Disable thumbs PDF in case of imagick bug<br />
<br />
*'''MAIN_KEEP_REF_CUSTOMER_ON_CLONING''' ► Keep the Customer Reference on cloned object (Propal/Invoice)<br />
<br />
*'''MAIN_DONT_KEEP_NOTE_ON_CLONING''' ► Remove the object notes during cloning ► (v11.0)<br />
<br />
*'''MAIN_DOC_SORT_FIELD''' ► Set the default sorting field on document page (name by default) ► (v11.0)<br />
<br />
*'''MAIN_DOC_SORT_ORDER''' ► Set the default sorting order (ASC or DESC) on document page (ASC by default) ► (v11.0)<br />
<br />
*'''MAIN_USE_ZIPTOWN_DICTIONNARY''' ► Use dictionary ZIP for create card.<br />
<br />
*'''MAIN_USE_TOP_MENU_SEARCH_DROPDOWN''' ► Show search in top menu with theme eldy ► (v11.0)<br />
<br />
*'''MAIN_PHONE_SEPAR''' ► Separ phone number other space ► (v12.0)<br />
<br />
*'''GRAPH_USE_FISCAL_YEAR''' ► Widgets uses fiscal year<br />
<br />
*'''SHOW_SOCINFO_ON_PRINT''' ► Permit to add user company information on each printed document (when click on Dolibarr print button) ► (v12.0)<br />
<br />
*'''MAIN_FEATURES_LEVEL''' ► Level of features to show: <code>-1=stable+deprecated</code>, <code>0=stable only (default)</code>, <code>1=stable+experimental</code>, <code>2=stable+experimental+development</code><br />
<br />
*'''MAIN_SHOW_TECHNICAL_ID''' ► Show technical id for object.<br />
<br />
*'''MAIN_HTTP_CONTENT_SECURITY_POLICY''' ► Allows you to fill in the content security rules ► (v6.0)<br />
<br />
*'''SOCIETE_ON_SEARCH_AND_LIST_GO_ON_CUSTOMER_OR_SUPPLIER_CARD''' ► Allow to change the link of the third party to customer/supplier card instead of contact card on List.<br />
<br />
*'''MAIN_MODULE_SETUP_ON_LIST_BY_DEFAULT''' ► If set to "common" the setup module becomes list by defaut<br />
<br />
*'''MAIN_PAGESIZE_CHOICES''' ► Configure select field to choose number of lines displayed on listing (<code>10:10,15:15,20:20,30:30,40:40,50:50,100:100,250:250,500:500,1000:1000,5000:5000</code>).<br />
<br />
*'''MAIN_USE_TOP_MENU_QUICKADD_DROPDOWN''' ► Add a dropdown menu with shortcuts to create new objects ► (v13.0)<br />
<br />
*'''MAIN_EMAILCOLLECTOR_MAIL_WITHOUT_HEADER''' ► Remove the header stored by email collector ► (v13.0)<br />
<br />
*'''MAIN_USE_VAT_OF_PRODUCT_FOR_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID'''<br />
<br />
*'''MAIN_OPTIMIZEFORTEXTBROWSER''' ► Optimise interface for a text only browser. This variable is set to 1 automatically if your browser is lynx or links<br />
<br />
*'''MAIN_NB_OF_YEAR_IN_WIDGET_GRAPH''' ► Set the number of years visible on some graph of some widgets (2 is default value)<br />
<br />
*'''MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION'''<br />
<br />
*'''API_DISABLE_LOGIN_API''' ►(v14.0)<br />
<br />
*'''MAIN_LOGIN_BADCHARUNAUTHORIZED''' ► Add possibility to define bad character unauthorized into login name REGEX expression (Default value is @<>"\') ► (v16.0)<br />
*'''MAIN_SHOW_ALL_FILES_ON_DOCUMENT_TOOLTIP''' ► Add all files visible from the object to be visible from the list of object.<br />
*'''MAIN_LIST_ALLOW_PUBLIC_NOTES''' ► Display public notes on list<br />
*'''MAIN_LIST_ALLOW_PRIVATE_NOTES''' ► Display private notes on list<br />
<br />
*'''MAIN_CHECKBOX_LEFT_COLUMN''' ► Display private check boxes on the left ► (v17.0)<br />
*'''MAIN_STATS_GRAPHS_SHOW_N_YEARS''' ► Nb of years to shows in widget and graph ► (v14.0)<br />
*'''MAIN_HOOK_DEBUG''' ► if >=2 the hook in the logs are more verbose ► (v18.0)<br />
<br />
*'''MAIN_ENABLE_AJAX_TOOLTIP''' ► if 1 the tooltips are updated with AJAX request ► (v18.0)<br />
*'''MAIN_NO_INPUT_PRICE_WITH_TAX''' ► if 1 the TTC input field is removed from propal/invoices/... ► (v17.0)<br />
<br />
*'''MAIN_DISABLE_SELECT2_FOCUS_PROTECTION''' ► if 1 disable the focus protection ► (v17.0)<br />
*'''MAIN_USE_ADVANCED_PERMS ►''' Add advanced user permission<br />
<br />
*'''MAIN_FREE_PRODUCT_CHECKED_BY_DEFAULT ►''' Check "product" or "service" by default on order/invoices/propal cards (set value "product" or "service")<br />
*'''MAIN_LINK_BY_REF ►''' Allow to link documents by choosing the type and ref from the object linked option<br />
<br />
'''Official supported option'''<br />
<br />
The following options are not hidden option. They are available by default from the interface.<br />
<br />
*'''MAIN_ONLY_LOGIN_ALLOWED ►''' Activate maintenance mode and set user that is allowed to login. Value must be user login. Available into menu Home - Admin tools - User session, it is filled with admin user when clicking on button "Block other session".<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Security Options=<br />
<br />
*'''MAIN_SECURITY_ANTI_SSRF_SERVER_IP''' ► Can set a complete list of IPs of server.<br />
<br />
*'''MAIN_SECURITY_CSRF_WITH_TOKEN''' ► Activate a second anti-CSRF protection on POST (so a POST from another web site can't be done). Note there is also a default protection using test on referrer that is not reliable. This second protection uses TOKEN on forms and is more powerful. Value can be: 0=CSRF protection disabled; 1=CSRF protection is on POST URLs only (default from version Dolibarr 15.0+); 2=CSRF protection is required on POST + some GET URL that contains some white listed parameters like the parameter "action" used to request database change (default from version Dolibarr 16+), 3=CSRF protection is enabled on any POST and GET URLs (a valid CSRF token is expected whatever are the parameters, warning: can be enabled on Dolibarr but some external modules developped by thirdparty may not be ready yet with this option)<br />
<br />
*'''MAIN_MODULES_FOR_EXTERNAL''' ► Limit available modules for external users. By default value is '<code>facture,commande,contact,propal,projet,contrat,societe,ficheinter,expedition,agenda</code>'<br />
<br />
*'''MAIN_ALLOW_SVG_FILES_AS_IMAGES''' ► Allow to use SVG file as image files. Warning: This may introduce security vulnerability (javascript can be embedded into SVG file).<br />
<br />
*'''MAIN_RESTRICTHTML_ONLY_VALID_HTML''' ► Refused parameter if value is not a valid HTML content. The content is also sanitized with Tidy.<br />
<br />
*'''MAIN_RESTRICTHTML_ONLY_VALID_HTML_TIDY''' ► Refused parameter if value is not a HTML content validated by Tidy PHP library. The content is also sanitized with Tidy.<br />
<br />
*'''MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES''' ► Sanitize also non standard attributes on HTML content.<br />
*'''MAIN_SECURITY_SALT''' ► A salt string to base the hashing on. 8 strings length recommended.<br />
<br />
*'''MAIN_SECURITY_MAX_IMG_IN_HTML_CONTENT''' ► Maximum number of Images on the HTML content<br />
*'''MAIN_SECURITY_ALLOW_UNSECURED_LABELS_WITH_HTML''' ► Allow HTML tags into products label<br />
<br />
*'''MAIN_SECURITY_FORCERP''' = "strict-origin-when-cross-origin" (default) so browser doesn't send any referrer when going into another web site domain / "same-origin" / "strict-origin"<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Members Module=<br />
<br />
*'''MEMBER_NEWFORM_FORCEMORPHY''' ► Force nature of member set to "phy" for physical or to "mor" for moral ► (v12.0)<br />
*'''MEMBER_ALLOW_CHANGE_OF_TYPE''' ► Member can edit their type on public subscription page ► (v13.0)<br />
*'''ADHERENT_DEFAULT_CREATE_THIRDPARTY''' ► Thirdparty is created when creating a new member ► (v13.0)<br />
*'''MEMBER_SUBSCRIPTION_SUGGEST_END_OF_MONTH''' ► If set to 1, the member subscription end date will be suggested for the end of the month ► (v18.0)<br />
*'''MEMBER_SUBSCRIPTION_SUGGEST_END_OF_YEAR''' ► If set to 1, the member subscription end date will be suggested for the end of the year ► (v18.0)<br />
*'''MAIN_NB_OF_YEAR_IN_MEMBERSHIP_WIDGET_GRAPH''' ► If set, it limits the number of years visible on graph and widgets of membership (empty is default value to show all) ► (v18.0)<br />
*'''MEMBER_NO_SYNC_LINKED_THIRDPARTY ►''' If set, changes to a member will not be synchronized to a linked third party. ► (v23.0)<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Accounting Module=<br />
<br />
*'''ACCOUNTANCY_COMBO_FOR_AUX''' ► Add graphic option for ACCOUNTANCY_COMBO_FOR_AUX. Having this option on may slow down and even freeze the accounting features if you have a very large number of thirdparties ► (v10.0)<br />
*'''ACCOUNTING_DEFAULT_NOT_NOTIFIED_VALIDATION_DATE''' ► Avoid validating the lines with the accountancy export.(1= box unchecked by default / 0 = box checked by default) ► (v14.0)<br />
*'''ACCOUNTING_DEFAULT_NOT_NOTIFIED_EXPORT_DATE''' ► Avoid flagging the lines as exported with the accountancy export.(1= box unchecked by default / 0 = box checked by default) ► (v14.0)<br />
*'''ACCOUNTANCY_USE_PRODUCT_ACCOUNT_ON_THIRDPARTY ►''' Add 2 fields on thirdparty card which allow you to set an account for all sells products and an other for all buying products for this customer ► (v14.0)<br />
*'''ACCOUNTING_MANAGE_ZERO''' '''►''' Allow to manage char 0 in accounting account (if enabled 1 ≠ 10) ► (v14.0)<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Agenda Module=<br />
<br />
*'''AGENDA_ALL_CALENDARS''' ► Change the default view of calendar pages to see all the Agenda's (instead or yours only be default)<br />
<br />
*'''AGENDA_AUTOSET_END_DATE_WITH_DELTA_HOURS''' ► To automatically set end date of event to start date + delta on event creation page.<br />
<br />
*'''AGENDA_DISABLE_LOCATION''' ► Disable location field in action card ► (>=v5.0)<br />
<br />
*'''AGENDA_MAX_EVENTS_DAY_VIEW''' ► Define the maximum number of visible entries for each day in agenda. Default value is 3. Value 0 means no limit.<br />
<br />
*'''AGENDA_USE_EVENT_TYPE''' ► Add a mandatory field "Type" when creating an event ('''''deprecated''''').<br />
<br />
*'''MAIN_ADD_EVENT_ON_ELEMENT_CARD''' ► Allow to create an event from a document (proposal, order, invoice)<br />
<br />
*'''AGENDA_SUPPORT_PRIORITY_IN_EVENTS''' ► Allow to have priorities in events ► (>=v13.0)<br />
<br />
*'''AGENDA_ADDACTIONFORPHONE''' ► Allow you to create a event from phone number ► (=<v12.0) - Need to be fix for (=>v12.0) https://github.com/Dolibarr/dolibarr/issues/22720<br />
<br />
*'''AGENDA_ADDACTIONFOREMAIL''' ► Allow you to create a event from Email ► (=<v12.0) - Need to be fix for (=>v12.0) https://github.com/Dolibarr/dolibarr/issues/22720<br />
*'''MAIN_ACTIONCOM_CAN_ADD_ANY_CONTACT''' ► Allow you to add any contact on events if set at 1a https://github.com/Dolibarr/dolibarr/releases/tag/18.0.0<br />
<br />
<br />
[[#Top|(back to top)]]<br />
=Bank Module=<br />
<br />
*'''BANK_CAN_RECONCILIATE_CASHACCOUNT''' ► Can reconciliate cash accounts ► (v3.8)<br />
<br />
*'''BANK_DISABLE_CHECK_DEPOSIT''' ► Disable check deposit feature<br />
<br />
*'''BANK_ASK_PAYMENT_BANK_DURING_ORDER''' ► Ask bank account during creation of an order<br />
<br />
*'''BANK_ASK_PAYMENT_BANK_DURING_PROPOSAL''' ► Ask bank account during creation of a proposal<br />
<br />
*'''BANK_USE_OLD_VARIOUS_PAYMENT''' ► To allow to enter miscellaneous payments (not covered by other modules) using old method. '''''Deprecated'''''. Entering various payment is preferred ► (<=v12.0).<br />
*'''MAIN_IBAN_IS_NEVER_MANDATORY''' ► IBAN and BIC informations not mandatory. (V15)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=BOM and MO Module=<br />
<br />
*'''ALLOW_USE_KITS_INTO_BOM_AND_MO'''<br />
*'''BOM_SUB_BOM''' ►Allow to add a BOM in another BOM►(v16.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Bookmarks Module=<br />
<br />
*'''BOOKMARKS_SHOW_IN_MENU''' ► Numbers of bookmark entries to be displayed (10 by default)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Inalterable Log Module=<br />
<br />
*'''BLOCKEDLOG_ADD_ACTIONS_SUPPORTED''' ► Can complete list of triggered action that are logged<br />
*'''BLOCKEDLOG_USE_REMOTE_AUTHORITY''' ► URL of the remote authority for the blockchain<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Category-Tags Module=<br />
<br />
*'''CATEGORY_SHOW_COUNTS''' ► Shows nb of object by tags in tag tree<br />
*'''CATEGORY_EDIT_IN_MENU_NOT_IN_POPUP ►''' Display categories menu instead of managing it only from "Tools"<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Contracts=<br />
<br />
*'''CONTRACT_SUPPORT_PRODUCTS''' ► Products are also suggested into module contract.<br />
*'''CONTRACT_ALLOW_EXTERNAL_DOWNLOAD''' ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)<br />
*'''CONTRACT_HIDE_PLANNED_DATE_ON_PDF''' ► allows you to not display dates on pdf files.<br />
*'''CONTRACT_HIDE_REAL_DATE_ON_PDF''' ► allows you to not display dates on pdf files.<br />
*'''CONTRACT_HIDE_PRICE_ON_PDF''' ► allows you to not display price on pdf files.<br />
*'''CONTRACT_HIDE_QTY_ON_PDF''' ► allows you to not quantity dates on pdf files.<br />
*'''CONTRACT_SHOW_SIGNATURE_STATUS_WITH_SERVICE_STATUS''' ► Show signature status in contract card (Sign by all parties).► (v21.0+)<br />
<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Cron module=<br />
<br />
*'''CRON_DISABLE_KEY_CHANGE''' ► When you provide an instance to a customer, you probably also add an entry in the cron of this user so Dolibarr batch and scheduler can work correctly. For security purpose, it may have a security key that is inside the command line into the cron entry and this entry must match the value defined into Dolibarr setup (setup of module 'Scheduled Jobs'). Because, a customer of a Saas platform will probably have no access to edit the cron file, it is also import that he has no way to edit the key into the Dolibarr setup, so the key in the cron command line will always match the key in Dolibarr setup, and the Dolibarr batches will executed without security errors. To be sure, the customer does not change the value, you can set this constant to 1 into the table [[Table_llx_const]].<br />
<br />
*'''CRON_DISABLE_TUTORIAL_CRON''' ► Disable the tutorial about how to install the cron script (on a SaaS hosting, this should be done by the web hosting provider)<br />
<br />
*'''CRON_WARNING_DELAY_HOURS''' ► Set this value to the frequency set for the cron script (so a warning will be shown to user to warn it about max frequency of its scheduled jobs)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Direct Debit Orders=<br />
<br />
*'''WITHDRAWAL_ALLOW_ANY_INVOICE_STATUS''' ► If this option is set, all invoices status (even already paid) may appear on the list of invoices qualified for a direct debit payment. This is the list of invoices with a payment request done, and not linked to a direct debit payment. By default, only "unpayed" invoices are used to avoid to pay twice the same invoice.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br />
=Donation Module=<br />
<br />
*'''DONATION_USE_THIRDPARTIES''' ► If this option is set, a thirdparty field appear on donation forms.<br />
<br />
[[#Top|(back to top)]]<br />
=Email=<br />
<br />
*'''MAIN_COPY_FILE_IN_EVENT_AUTO''' ► Add attachment document on event auto generated by sending email from dolibarr. ► (v6.0+)<br />
<br />
*'''MAIN_EMAIL_USE_LAYOUT'''► Enable the use of predefined layout when writing an email.<br />
<br />
*'''MAIN_MAILFORM_DISABLE_ENTERKEY''' ► Activate JavaScript code to disable the enter key in the MAIL form. ► (>= 8.0.1)<br />
<br />
*'''MAIN_MAIL_DEBUG''' ► Write content with header of last mail into file <code>dolibarr_mail.log</code> into directory <code>dolibarr_main_data_root</code>.<br />
<br />
*'''MAIN_MAIL_DEBUG_ERR_WITH_DATE''' ► Use a different filename (by adding a prefix of date) for each email sent with error when MAIN_MAIL_DEBUG.<br />
<br />
*'''MAIN_MAIL_DEBUG_LOG_WITH_DATE''' ► Use a different filename (by adding a prefix of date) to log each email sent (whatever is result) when MAIN_MAIL_DEBUG.<br />
<br />
*'''MAIN_MAIL_FORCE_FROM''' ► (v19+) Can force the value into the From field of the SMTP header. Note that email sender is always saved into the "Reply-To".<br />
<br />
*'''MAIN_MAIL_ALLOW_SENDMAIL_F''' ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some cases, the sender email must be provided on command line of sendmail with option <code>-f</code>. This option is here to ask Dolibarr to call the function mail of PHP by adding value for the option <code>-f</code>. Note that in most cases, even with sendmail, sender email is correctly managed as it is added in the email technical header. This option is here only for setup or version of sendmail that ask the -f option to be mandatory or for sendmail setup that does not use by default the From of the header email to define the sender (with this option, the from can be forced on command line to avoid to have the from lost by sendmail).<br />
<br />
*'''MAIN_MAIL_SENDMAIL_FORCE_BA''' ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some case, we want to recipient to be provided to sendmail into the email content instead of its command line parameter. For this we must add the -ba parameter to sendmail. This option asks PHP to provide this parameter when sending a mail. Note that another solution is to edit the mail.force_extra_parameters=-ba into <code>php.ini</code> file.<br />
<br />
*'''MAIN_MAIL_NO_FULL_EMAIL''' ► Recipient email and sender are cleaned to be on form "<email>" instead of "Name <email>". This might solve problem of compatibility with very old mailers.<br />
<br />
*'''MAIN_FIX_FOR_BUGGED_MTA''' ► Some MTA agent are bugged and add some CR chars each time they saw a LF. Because Dolibarr emails are forged to be already cleaned, if MTA agent do that, you will send an email with two CR chars. This may result in having recipient not able to read your email. To fix this, add this constant to 1. Dolibarr will then create an email that is not RFC compliant, but because the MTA agent is bugged, the email will be modified and become correct during sending, solving the problem of bad email received. Add this constant to 1 if your recipient experience problems when opening email for example users using webmail of <code>orange.fr</code> or <code>hotmail.com</code>. Note that some users have reported that when using Exim (Exim 4), you must set this parameter to 0. Default value is 1 but may be changed to 0 in future.<br />
<br />
*'''MAIN_MAIL_DO_NOT_USE_SIGN''' ► Do not add user signature at end of suggested pre-defined email<br />
<br />
*'''MAIN_MAIL_FORCE_NOT_SENDING_TO''' ► If en email is defined into this variable, emails will never be sent to this email.<br />
<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_INVOICE''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Invoice'' module.<br />
<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_ORDER''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Order'' module.<br />
<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_PROPAL''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Proposal'' module.<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_SUPPLIER_PROPOSAL''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Supplier Proposal'' module.<br />
<br />
*'''MAIN_EMAIL_SUPPORT_ACK ►''' Restore email acknowledgment checkbox on sending emails. This feature is commonly abandoned by mailers. Active from Dolibarr V17 - see [https://github.com/Dolibarr/dolibarr/blob/33744f74da1a5c20f8aa9950018ab4e549e00205/ChangeLog#L53 changelog]<br />
*'''MAIN_EMAIL_USECCC''' ► 1 = Shows field BCC into email forms, If value is an email = Shows the BCC pre filled with the email value.<br />
<br />
*'''MAIN_MAIL_AUTOCOPY_PROPOSAL_TO''', '''MAIN_MAIL_AUTOCOPY_ORDER_TO''', '''MAIN_MAIL_AUTOCOPY_INVOICE_TO''', '''MAIN_MAIL_AUTOCOPY_SHIPMENT_TO''', '''MAIN_MAIL_AUTOCOPY_..._TO''' ► Email to use as a BCC recipient when sending email for proposal, order or invoice. You can make this value visible by setting MAIN_EMAIL_USECCC (to 1 or to another email, see previous point)<br />
<br />
*'''MAIN_EMAIL_ADD_TRACK_ID''' ► When value is 1 (this is also default value if option is not set): The record "Message-id" added into smtp header includes a tracking id to define where the email was sent from. When value is 2: you send an email from third party card, the sender email is completed with the email source tracking string "+thiXXX" on email (your email will be sent with the "From" that is myname+thi123@mycompany.com). So when user receiving email will make "Answer", email will be sent to myname@mycompany.com but with the tracking id included (into header or into target email), allowing you to know to which third party or object, the email exchange is related to.<br />
<br />
*'''MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL''' ► Restrict sending of 1 email message to <code>x</code> recipients for same email message (x for To: + CC: + BCC:). If not defined, value is <code>10</code>. Required to fight against spamming that include 1000 recipients in 1 message. Note that '''MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL''', '''MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL''' and '''MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL''' are also available.<br />
<br />
*'''MAIN_MAIL_FORCE_CONTENT_TYPE_TO_HTML''' ► Force to send all email (event with text only content) as HTML formatted email.<br />
<br />
*'''MAIN_MAIL_USE_MULTI_PART''' ► Forge email content using an alternate text part ► (for 5.0.2+). By default with 6.0+<br />
*'''MAIN_INFO_SOCIETE_MAIL_ALIASES''' ► add address aliases for the from field on mail. Set his value with "Firstname Name <firstname.lastname@mydomain.tld, Otherfirstname OtherlastName <othermail@mydomain.tld>,..." ► (v5.0.0+)<br />
<br />
*'''MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS''' ► If images were stored into the medias directory from CKEditor, then images into emails are replaced with "inline content". This may increase seriously risk of being detected as SPAM.<br />
<br />
*'''MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS''' ► (A better name of this option should be MAIN_EXTERNAL_MAIL_CLIENT_IP_ADDRESS). Set here the list of IPs where your Dolibarr instances are hosted. You can also set the URLs where to get the IP addresses, for exemple: "https://ipv4.urltoshowip.com/_service_showmyip.php,https://ipv6.urltoshowup.com/_service_showmyip.php. So when your customer go into the setup area of email:<br />
**If he chose mail method, a message will explain him how to setup its SPF record for its email domain (showing the list of IP). This is to avoid to have its emails, sent from its Dolibarr instance, fails due to strict antispam rule of some emailing servers.<br />
**If he chose smtp method, a message will explain him the list of IP he can use if there is restriction on IP by the SMTP agent. If you also need to add a message to help SPF setup, see option '''MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD'''.<br />
<br />
*'''MAIN_IMAP_USE_PHPIMAP''' ► Use embedded PHP-imap library (not using the native php imap) instead of native php imap extension ► (v17.0+, available as official option in setup of emailcollector by default from v19)<br />
<br />
*'''MAIN_MAIL_ENABLED_USER_DEST_SELECT''' ► Show also internal users into list of recipients of email in email sending form ► (v8.0+)<br />
<br />
*'''MAIL_PREFIX_FOR_EMAIL_ID''' ► Prefix for the mails ID. Default value is <code>$_SERVER["SERVER_NAME"]</code> ► (>= 8.0.1)<br />
*'''MAIL_MASS_ACTION_SEARCH_MOST_RECENT_FILE_IF_NOT_FOUND''' ► When sending an email from a mass action. If the path saved in DB does not point to an existing file, then search for the most recent file and use it as an attahcment.► (>= 24.0.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=SMS= <br />
<br />
*'''MAIN_SMS_DEBUG''' ► Write content of SMS sent into file <code>dolibarr_sms.log</code> into directory <code>dolibarr_main_data_root</code>.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Emailing Module=<br />
<br />
*'''MAILING_PREFIX_FOR_EMAIL_ID''' ► Set the value that will be used to compose the "Email ID" into email headers. If you set this value to '<code>SERVER_NAME</code>', the virtual host of web server will be used. By default, this is not defined, so a hash key, unique to each instance, is used.<br />
<br />
*'''MAILING_NO_USING_PHPMAIL''' ► If set, the module emailing can't be used with mail setup of "phpmail". Using a thirdparty SMTP server is required. You can complete warning message by adding an email to contact for setup help with constant <code>'''MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS'''</code>.<br />
<br />
*'''MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS''' ► Contains the email of contact to show into the message visible to a user when he try to use emailing module without SMTP server and if option '''MAILING_NO_USING_PHPMAIL''' is set to on.<br />
<br />
*'''MAILING_LIMIT_WARNING_PHPMAIL''' ► Show a warning message (var contains the '''message to show''', or '''translation key''') on emailing send form if setup is on "phpmail". Note: The application always try to translate the message considering the message is a translation key, before showing the translation or message if translation was not found.<br />
<br />
*'''MAILING_LIMIT_WARNING_NOPHPMAIL''' ► Show a warning message (var contains the '''message to show''', or '''translation key''') on emailing send form if setup is something else than "phpmail". Note: The application always try to translation the message considering the message is a translation key, before showing the translation or message if translation was not found.<br />
*'''EMAILING_USE_ADVANCED_SELECTOR''' ► Enable the advanced selector for recipients.<br />
<br />
*'''MAILING_LIMIT_SENDBYWEB''' ► Restrict number of emails you can send in same sending session with emailing module from GUI. The value "<code>dolibarr_mailing_limit_sendbyweb</code>" if defined into config file is used in priority for this limit. A negative value means, sending by web is forbidden.<br />
<br />
*'''MAILING_LIMIT_SENDBYCLI''' ► Restrict number of emails you can send in same sending session with emailing module from CLI script. The value "<code>dolibarr_mailing_limit_sendbycli</code>" if defined into config file is used in priority for this limit.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Expense Report=<br />
<br />
*'''EXPENSEREPORT_ALLOW_OVERLAPPING_PERIODS''' ► Can enter several expense reports on same or overlapping date periods. ► (v7.0+)<br />
<br />
*'''EXPENSEREPORT_OVERRIDE_VAT''' ► Setting this constant to 1 will allow expense reports to show VAT even if the global VAT setting is off ► (v10.0)<br />
<br />
*'''EXPENSEREPORT_USE_OLD_NUMBERING_RULE''' ► The module Expense Report use numbering rules that you can setup (like other modules do). If you need to keep the hard-coded numbering rule of expenses report used in v6.0 set this constant to 1 ► (>=v7.0+)<br />
<br />
*'''MAIN_USE_EXPENSE_IK''' ► This feature allows you to set index kilometres against a mileage index for different types of vehicles. ► (v7.0+)<br />
<br />
*'''MAIN_USE_EXPENSE_RULE''' ► This feature allows you to set a variety of rules per user/group/all so they can only create reports within their limits. ► (v7.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Export Module=<br />
<br />
*'''EXPORT_CSV_SEPARATOR_TO_USE''' ► String value to use as default separator to delimit fields of exported files (by default Dolibarr uses "<code>,</code>"). Example: EXPORT_CSV_SEPARATOR_TO_USE=<code>;</code><br />
<br />
*'''EXPORT_CSV_FORCE_CHARSET''' ► Choose the charset used in the output file built by the CSV exporter. By default it is ISO-8859-1. Example: EXPORT_CSV_FORCE_CHARSET= <code>utf-8</code><br />
<br />
*'''EXPORTTOOL_CATEGORIES''' ► Can export categories (several lines) into one column with the "product export profile"<br />
<br />
*'''USE_STRICT_CSV_RULES''' ► Use strict/real CSV format for export. Do not clean/replace CR+LF with '\n' but quote them using the escaping CSV char (<code>"</code>).<br />
*'''EXPORTS_SHARE_MODELS''' ► Share export models between users.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br />
=Foundation Module=<br />
<br />
*'''MEMBER_URL_REDIRECT_SUBSCRIPTION''' ► Link called and shown when a member account is autocreated in member module by a guest user.<br />
<br />
*'''MEMBER_EXT_URL_SUBSCRIPTION_INFO''' ► Link of external page pointed by the "Show here" link added in front of payment cell, into the page to make online subscription.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
=Holiday Module=<br />
<br />
*'''HOLIDAY_HIDE_BALANCE''' ► Hide the user's vacation balance on the vacation request page<br />
<br />
[https://wiki.dolibarr.org/Setup_Other#Top (back to top)]<br />
=Interventions Module=<br />
<br />
*'''FICHINTER_CLASSIFY_BILLED'''► Allow to classify an intervention card as "Billed". This add also trigger <code>FICHINTER_CLASSIFY_BILLED</code> into list of possible automatic event into agenda.<br />
<br />
*'''FICHINTER_DISABLE_DETAILS'''► Disable entry of detail lines on intervention. Can validate with no line. Only one line will be shown per intervention on list.<br />
**If set to <code>2</code> details are disabled only on intervention list ► (v21.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Invoice Module=<br />
<br />
*'''MAIN_DEPOSIT_MULTI_TVA''' ► In deposits invoice, creates one line per VAT rate from the origin document ► (6.0)<br />
*'''PDF_INVOICE_SHOW_PRICE_INCL_TAX''' ► In customer's invoice, add a column with the total including all taxes ►<br />
<br />
*'''INVOICE_ALLOW_REUSE_OF_CREDIT_WHEN_PARTIALLY_REFUNDED''' ► If a credit note was partially refunded (a refund was sent to the customer), with common situation, we wait to have the remain refunded too. With this option, it is possible to convert the remain of invoice into a discount to reuse it into another invoice.<br />
<br />
*'''SUPPLIER_INVOICE_ALLOW_REUSE_OF_CREDIT_WHEN_PARTIALLY_REFUNDED''' ► See INVOICE_ALLOW_REUSE_OF_CREDIT_WHEN_PARTIALLY_REFUNDED, but for supplier credit notes.<br />
<br />
*'''INVOICE_CAN_BE_EDITED_EVEN_IF_PAYMENT_DONE''' ► Allow to edit invoices even if payment was started. Note: If the module "BlockedLog" is active (required in some countries for legal reasons), this will not change content of archived logs tracked by this module. By definition there is no way to change or remove archived records. It will just update data in your application and a new record to track your change will be recorded into the archive log.<br />
<br />
*'''INVOICE_CAN_ALWAYS_BE_REMOVED''' ► Allow to always delete invoices (even if invoice is not last one). Note: If the module "BlockedLog" is active (required by some countries for legal reason), this will not change content of archived logs tracked by this module. By definition there is no way to change or remove archived records. It will just update data in your application and a new record to track your change into the read-only archive log.<br />
<br />
*'''INVOICE_CAN_NEVER_BE_EDITED''' ► Never allow to edit invoices (except draft invoices with ref like (PROV%)). See also INVOICE_CAN_NEVER_BE_REMOVED.<br />
<br />
*'''INVOICE_CAN_NEVER_BE_REMOVED''' ► Never allow to delete invoices (except draft invoices with ref like (PROV%)). See also INVOICE_CAN_NEVER_BE_EDITED<br />
<br />
*'''INVOICE_POSITIVE_CREDIT_NOTE''' ► All amounts on PDF credit notes are positive.<br />
<br />
*'''FACTURE_DEPOSITS_ARE_JUST_PAYMENTS''' ► An old way to create initial payment. This treats deposit invoices as a special case and not as legal deposit invoice. Deposit invoices don't get counted on turnover. They are then applied as a payment, like a discount, on the final invoice. By default, when you include the deposit into draft of final invoice, the amount of final invoice is reduced. With this option, final amount is not reduced but a payment is registered. WARNING: In a lot of european countries, using this option is not allowed.<br />
<br />
*'''FACTURE_SENDBYEMAIL_FOR_ALL_STATUS''' ► Can send invoice by email to customer even if invoice has status "draft".<br />
<br />
*'''INVOICE_CREDIT_NOTE_STANDALONE''' ► Start implementation to allow a credit note even without invoice (dangerous) ► (v3.9)<br />
<br />
*'''INVOICE_USE_SITUATION''' ► 1=Enable the "situation invoice" feature. Warning, this feature is bugged and may not be compatible with the final version of the feature once the bug will be solved. Also, using the double-entry accountancy module is not possible when this option is on (due to the same design problem). 2=Enable the "situation invoice" feature with a rewrite. This mode should be better to become a future stable feature.<br />
<br />
*'''INVOICE_USE_SITUATION_CREDIT_NOTE''' ► Enable the "situation credit note" feature (need <code>INVOICE_USE_SITUATION</code>) ► (v8.0)<br />
*'''INVOICE_USE_RETAINED_WARRANTY''' ► Enable the retained warranty on invoice ► (v14.0)<br />
<br />
*'''INVOICE_DISABLE_DEPOSIT''' ► Disable deposit invoices<br />
<br />
*'''INVOICE_DISABLE_REPLACEMENT''' ► Disable replacement invoices<br />
<br />
*'''INVOICE_DISABLE_CREDIT_NOTE''' ► Disable credit notes<br />
<br />
*<bdi>'''INVOICE_ADD_EXTRAFIELD_IN_NOTE''' ► Add extrafields in note for canelle template ► (v17.0+)</bdi><br />
<br />
*'''INVOICE_DEFAULT_NOTE_PUBLIC''' <bdi>► Default text in public note</bdi><br />
<br />
Note: To decode a QR image of a ZATCA code: https://www.onlinebarcodereader.com/. You can also use the mobile application https://play.google.com/store/apps/details?id=com.posbankbh.einvoiceqrreader&gl=FR<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT''' ► See PDF option<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT_COLUMN''' ► See PDF options<br />
<br />
*'''WORKFLOW_BILL_ON_SHIPMENT''' ► Change label of button with suitable label when you need to create invoice on shipments<br />
<br />
*'''INVOICE_ALLOW_EXTERNAL_DOWNLOAD''' ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. Use the tag __DIRECTDOWNLOAD_URL_INVOICE__ in email template to insert it. ► (v7.0+)<br />
<br />
*'''INVOICE_POINTOFTAX_DATE''' ► Add Point of Tax Date on invoices for country-specific legality reasons ► (v4.0+)<br />
*'''FACTURE_ENABLE_NEGATIVE''' ► Can validate an invoice when amount is negative<br />
<br />
*'''FACTURE_ENABLE_NEGATIVE_LINES''' ► Allows to add negative lines to an invoice ► (v8.0.2+)<br />
*'''SUPPLIER_INVOICE_ENABLE_NEGATIVE''' ► Can validate an supplier invoice when amount is negative ► (V21 ?)<br />
*'''SUPPLIER_INVOICE_ENABLE_NEGATIVE_LINES''' ► Allows to add negative lines to an supplier invoice ► (V21 ?)<br />
<br />
*'''INVOICE_USE_DEFAULT_DOCUMENT''' ► Allow user to select a default invoice documents models according to invoice type. On invoice create page, the model is dynamically changed on invoice type selection. ► (v9.0+)<br />
<br />
*'''FACTURE_REUSE_NOTES_ON_CREATE_FROM''' ► Reuse the Public Note and Private note of the previous object (Proposal,...) when creating the bill.<br />
*'''FACTUREFOURN_REUSE_NOTES_ON_CREATE_FROM''' ► Reuse the Public Note and Private note of the previous object when creating the supplier bill ► (V13.0)<br />
*'''MAIN_SHOW_FACNUMBER_IN_DISCOUNT_LIST''' ► Display the reference of credit notes in discount list when creating the bill.<br />
*'''INVOICE_ALLOW_FREE_REF''' ► Capability to change reference of an invoice. This will be possible as long as the invoice has the status “Draft” and only if your country is not in Europe(V11)<br />
<br />
*'''INVOICE_DISALLOW_REOPEN'''<br />
<br />
*'''INVOICE_MAX_FUTURE_DELAY''' ► Numbers of seconds allowed for billing in the future ► (V14.0)<br />
*'''INVOICE_AUTO_NEXT_MONTH_ON_LINES''' ► Increase start date and end date by one month, if an invoice line is a clone of a time based service AND if this services started on the first day of month and ended on the last day of month ► (V13.0.1)<br />
*'''INVOICE_KEEP_DISCOUNT_LINES_AS_IN_ORIGIN''' ► Does not change a line with a negative price into an absolute discount when creating an invoice ► (V16 ?)<br />
*'''INVOICEREC_SET_AUTOFILL_DATE_START''' and '''INVOICEREC_SET_AUTOFILL_DATE_END ►''' Set start and end date to yes for lines of template invoice when created from a draft invoice ► (V16)<br />
*'''INVOICE_REC_DATE_TO_YES''' '''►''' Set start and end date to yes by default in add line form for template invoice ► (V16)<br />
*'''INVOICE_SUBTYPE_ENABLED''' ► Extends Dolibarr standard invoice with more invoice types used in some countries. A combo box in the new invoice creation card allows the selection of "subtypes" with values from dictionary "Invoice Subtypes" ► (v19.0+)<br />
*'''LIST_OF_QUALIFIED_INVOICES_LIMIT_DEFINED''' '''►''' Perf options to limit list of invoices for "credit note" source (on form "create a credit note"), usable for big quantities of invoices for one customer like you can have with TakePos ► (V22+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Leave=<br />
<br />
*'''MAIN_NON_WORKING_DAYS_INCLUDE_SATURDAY''' ► Set this value to 0 if you want to have the Saturday as a working day<br />
*'''MAIN_NON_WORKING_DAYS_INCLUDE_SUNDAY''' ► Set this value to 0 if you want to have the Sunday as a working day<br />
<br />
=Look or Theme=<br />
<br />
*'''MAIN_FAVICON_URL''' ► favicon url<br />
<br />
*'''MAIN_EASTER_EGG_COMMITSTRIP''' ► Show a comic image from the CommitStrip website. Images are refreshed daily. ► (v6.0+)<br />
<br />
*'''MAIN_INCLUDE_GLOBAL_STATS_IN_OPENED_DASHBOARD''' ► This conf will auto remove global stats box item if there are already in the new dashboard of opened elements and keep displayed stats on the opened item box (not only on mouse over) ► (v11.0+)<br />
<br />
*'''MAIN_USE_TOP_MENU_SEARCH_DROPDOWN''' ► Actually only for eldy theme, this conf move search input to top menu and use new design too ► (v11.0+)<br />
<br />
*'''THEME_AGRESSIVENESS_RATIO''' ► This conf can be used to increase/decrease aggressiveness of colors. Value 0 is medium, value is between -100 (light grey colors) to +100 (very flashy colors) ► (v11.0+)<br />
<br />
*'''THEME_SHOW_BORDER_ON_INPUT'''<br />
*'''MAIN_DISABLE_GLOBAL_WORKBOARD''' ► Hide the work board of the main page ► (v13.0+)<br />
*'''MAIN_DISABLE_GLOBAL_BOXSTATS''' ► Hide the Statistic Box of the main page<br />
*'''ALLOW_THEME_JS ►''' Allow JS file in theme folder (same name as theme folder)<br />
<br />
<br /><br />
<br />
=Manifest (Progressive Web App)=<br />
<br />
*'''MAIN_MANIFEST_APPLI_THEME_COLOR ►''' Theme color for manifest<br />
*'''MAIN_MANIFEST_APPLI_BG_COLOR ►''' Background color for manifest<br />
*'''MAIN_MANIFEST_APPLI_LOGO_URL ►''' Logo for manifest<br />
*'''MAIN_MANIFEST_APPLI_LOGO_URL_SIZE ►''' Logo url size for app (150, 192, 512px) missing 3 configurations<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Order Module=<br />
<br />
*'''MAIN_MASSACTION_CREATEBILLS_REDIRECT_IF_ONE''' ► If set 1, redirects to the one bill created from massaction create bills from order list ► (v20.0)<br />
<br />
*'''MAIN_MASSACTION_CREATEBILLS_REDIRECT_IF_MANY''' ► If set to 1, redirects to the invoice list after plural invoices where generated from tho massaction create bills from order list ► (v20.0)<br />
<br />
*'''MAIN_ORDERLIST_CREATEBILLS_ONEBYTHIRD''' ► Allow defining value for option "one by thirdparty" in massaction create bills from orders list page (no by default, yes if set to 'yes' or 1) ► (v20.0)<br />
<br />
*'''MAIN_USE_PROPAL_REFCLIENT_FOR_ORDER''' => Copy customer reference from proposal to order. ► (v7.0+)<br />
<br />
*'''ORDER_REQUIRE_SOURCE''' => Make the input field "Source of order" mandatory.<br />
<br />
*'''ORDER_VALID_AFTER_CLOSE_PROPAL''' => When an order is created on a proposal close, the order is directly defined with status "Validated".<br />
<br />
*'''ORDER_ALLOW_EXTERNAL_DOWNLOAD''' => When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)<br />
<br />
*'''ORDER_ENABLE_NEGATIVE''' => Can validate an order when amount is negative<br />
<br />
*'''THIRDPARTY_PROPAGATE_EXTRAFIELDS_TO_ORDER''' => Copy also extrafields from thirdparty to order (if name match). ► (v11.0+)<br />
*'''ORDER_DEFAULT_NOTE_PUBLIC''' ► Default text in public note<br />
*'''MAIN_REMOVE_DROPDOWN_CREATE_BUTTONS_ON_ORDER''' => Remove the create dropdown button on order card (introduce on v19) to come back with old buttons. '''►''' (v20.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=PDF Options=<br />
<br />
*'''MAIN_ADD_PDF_BACKGROUND''' ► Define this constant with short name of a PDF file (example "<code>mypdf.pdf</code>") that must be saved into directory "<code>documents/mycompany</code>". This will add PDF as a background of some of your generated PDF files (proposals,invoices,orders). If you need to concat PDF, see instead [[Module Concat PDF]].<br />
<br />
*'''MAIN_DISABLE_FORCE_SAVEAS''' ► If your browser always asks to save downloaded files on disk (like PDF), try this this option. File may be displayed directly in your browser. Values<span> </span>: 0= Default (file is auto downloaded), 1= For to output the file into the browser tab, 2= For to output the file into a browser tab open with target_blank<br />
<br />
*'''MAIN_DISABLE_PDF_AUTOUPDATE''' ► Disable automatic generation of PDF each time we add/update/delete a product line (we can still build document by clicking on "Generate"). This option may increase interface speed on servers with low CPU.<br />
<br />
*'''MAIN_DISABLE_PDF_COMPRESSION''' ► Disable PDF compression.<br />
<br />
*'''MAIN_DOCUMENTS_WITH_PICTURE_WIDTH''' ► Can change size of picture when hidden option <code>MAIN_GENERATE_PROPOSALS_WITH_PICTURE</code> is used. By default value is <code>20</code>.<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS''' ► Adding the company address at the bottom of the page. Disabled by default<br />
<br />
*'''MAIN_GENERATE_PROPOSALS_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for customer proposals.<br />
*'''MAIN_GENERATE_ORDERS_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for customer orders.<br />
<br />
*'''MAIN_GENERATE_INVOICES_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for customer invoices.<br />
<br />
*'''MAIN_GENERATE_SUPPLIER_PROPOSAL_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for supplier proposals ► (v5.0.3+)<br />
*'''MAIN_GENERATE_SUPPLIER_ORDER_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for supplier orders<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT''' ► Disable VAT on generated documents. like for an association. (Works with crabe template)<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT_COLUMN''' ► Hide column with VAT information but only column not total.<br />
<br />
*'''MAIN_INVERT_SENDER_RECIPIENT''' ► Invert sender and recipient in some PDF. Note: This option is set automatically if country if Germany.<br />
<br />
*'''MAIN_ODT_AS_PDF''' ► Activate ODT to PDF conversion. Value can be "libreoffice" or "unoconv". Do not use value '''<nowiki/>'jodconverter'<nowiki/>''' any more, as it is declared deprecated and partly not functional, use value '''<nowiki/>'libreoffice'''' instead, it requires only '''soffice''' (OpenOffice or LibreOffice) installed on server (use '''apt install soffice libreoffice-common libreoffice-writer''').<br />
<br />
If you got this error: javaldx failed! Warning: failed to read path from javaldx with no return to prompt when running soffice --headless -env:UserInstallation=file:"/tmp" --convert-to pdf --outdir xxx ./yyy.odt, check that directory defined into env:UserInstallation parameters exists and is writeable.<br />
<br />
You may also have a look at this page if your server is on Windows: [[Générer automatiquement des documents PDF à partir de fichier ODT avec Doliwamp]]<br />
<br />
*'''MAIN_ODT_AS_PDF_DEL_SOURCE''' ► For ODT generation. If set, then initial behaviour is conserved but ODT file is removed when option to convert it as PDF (see previous) is on. Disabled by default<br />
<br />
*'''MAIN_PDF_FORCE_FONT''' ► To ignore font defined into language file and force usage of a particular font. For example "<code>DejaVuSans</code>".<br />
<br />
*'''MAIN_PDF_FORCE_FONT_SIZE''' ► To force size of font (by default 10). For example "<code>12</code>" ► (v11.0)<br />
<br />
*'''MAIN_PDF_FREETEXT_HEIGHT''' ► Change height of space reserved to output the free text.<br />
<br />
*'''MAIN_PDF_TITLE_BACKGROUND_COLOR''' ► Can define a background color onto title line. Example: <code>220,220,200</code><br />
<br />
*'''MAIN_PDF_USE_LARGE_LOGO''' ► Use the original logo with its higher resolution into the PDF instead of the small thumb. This may lead to very very large PDF !<br />
<br />
*'''MAIN_USE_BACKGROUND_ON_PDF''' ► Define this constant with short name of an image (example "<code>myimage.jpg</code>") that must be saved into directory "<code>documents/mycompany/logos</code>". This will add this background image into your generated PDF files.<br />
<br />
*'''MAIN_USE_COMPANY_NAME_OF_CONTACT''' ► Use contact name and information rather than company<br />
<br />
*'''MAIN_PDF_ADDALSOTARGETDETAILS''' ► If 1, add details of recipient on generated PDFs (email, fax, url and phone). Can be useful in cases where a printed order/invoice etc is given to a delivery driver/courier etc.<br />
<br />
*'''MAIN_TVAINTRA_IN_SOURCE_ADDRESS''' ► Show VAT N° in source address of PDF to comply with legalities in certain countries. Note that VAT number should be already visible in footer of page ► (v8.0.1+)<br />
<br />
*'''MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING''' ► Add optional esign field in pdf propal ► (v8.0+)<br />
<br />
*'''MAIN_PROFID1_IN_SOURCE_ADDRESS''' ► Show Professional ID 1 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID2_IN_SOURCE_ADDRESS''' ► Show Professional ID 2 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID3_IN_SOURCE_ADDRESS''' ► Show Professional ID 3 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID4_IN_SOURCE_ADDRESS''' ► Show Professional ID 4 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID5_IN_SOURCE_ADDRESS''' ► Show Professional ID 5 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID6_IN_SOURCE_ADDRESS''' ► Show Professional ID 6 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''PDF_BANK_HIDE_NUMBER_SHOW_ONLY_BICIBAN''' ► Hide bank number ("code banque/guichet/compte" for France, "sort code/account number" for GB, ...) and keep only BIC/IBAN on PDF.<br />
<br />
*'''PDF_BOLD_PRODUCT_REF_AND_PERIOD''' ► Add more visibility (bold) on product ref and period of service in desc. ► (v12.0)<br />
<br />
*'''PDF_HIDE_PRODUCT_REF_IN_SUPPLIER_LINES''' ► Modify the use/position of Supplier Ref/Internal Ref with the item Label (name) on PDF documents.<br />
<br />
Default (constant not set or Value <code>0</code>): Internal ref followed by supplier ref in brackets."COMPANY-REF-001 (Vendor SKU SUPPLIER-REF-001) - LABEL...".<br />
<br />
Value <code>1</code>: Supplier ref only eg."SUPPLIER-REF-001 - LABEL...".<br />
<br />
Value <code>2</code>: Supplier ref followed by internal ref in brackets. eg."SUPPLIER-REF-001 (InternalRef COMPANY-REF-001) - LABEL...".<br />
<br />
*'''PDF_INCLUDE_ALIAS_IN_THIRDPARTY_NAME''' ► Include alternative/alias name into name on PDF.<br />
<br />
*'''PDF_SECURITY_ENCRYPTION''' ► Encrypt PDF produced by dolibarr. See additional parameters<span> </span>:PDF_SECURITY_ENCRYPTION_RIGHTS (block 'modify' or 'copy') - '''PDF_SECURITY_ENCRYPTION_USERPASS''' - '''PDF_SECURITY_ENCRYPTION_OWNERPASS''' (random if not specified) - '''PDF_SECURITY_ENCRYPTION_STRENGTH''' (0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit) - '''PDF_SECURITY_ENCRYPTION_PUBKEYS''' Array of recipients containing public-key certificates ('c') and permissions ('p') - For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print'))). WARNING: if an 'encrypted PDF' provides a protection against manual change done by mistake, it does NOT provide any protection against modification of your PDF in a security point of view: A protected PDF can still be modified by any advanced PDF editors. Don't forget this: If a software can read the PDF, this software can also rebuild it differently !<br />
<br />
*'''PDF_SHOW_PROJECT''' ► Show project onto PDF (supported on supplier order only for the moment)<br />
<br />
*'''PDF_USE_ALSO_LANGUAGE_CODE''' ► The value of this constant must be a language code ('fr_FR', 'en_US', 'sa_SA', ...). If set, the PDF document will contains both language (default and the one defined by the constant).<br />
*'''DOC_SHOW_FIRST_SALES_REP''' ► Show the sales representant on header (at least on propal azur and rubis template)<br />
*'''MAIN_PDF_DASH_BETWEEN_LINES'''<br />
*<br />
*'''SHOW_SUBPRODUCT_REF_IN_PDF'''<br />
*'''PDF_HIDE_PRODUCT_LABEL_IN_SUPPLIER_LINES''' ► hide product label in supplier order lines (V15+)<br />
*'''SHIPPING_PDF_DISPLAY_AMOUNT_HT''' ► Show HT unit price and HT total price for lines of PDF shipment<br />
<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_FACTURE''' ► To Hide product description in Customer Invoice<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_COMMANDE''' ► To Hide product description in Sales Order<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_ORDER_SUPPLIER''' ► To Hide product description in Purchase Order<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_INVOICE_SUPPLIER''' ► To Hide product description in Vendor Invoice<br />
<br />
*'''PDF_PROPAL_SHOW_PRICE_INCL_TAX''' ► Display price with tax on Proposal(cyan template) (V17+)<br />
*'''PDF_ORDER_SHOW_PRICE_INCL_TAX''' ► Display price with tax on Order(eratosthene template) (V17+)<br />
*'''PDF_INVOICE_SHOW_PRICE_INCL_TAX''' ► Display price with tax on Invoice(sponge template) (V17+)<br />
<br />
*'''PDF_USE_GETALIASNBPAGE_FOR_TOTAL''' ► Display the page number alias<br />
*'''MAIN_PDF_NO_SENDER_FRAME''' ► Do not display the "sender" mention<br />
*'''MAIN_PDF_HIDE_SENDER_NAME''' ► Do not display the sender name<br />
*'''MAIN_PDF_NO_RECIPENT_FRAME''' ► Do not display BillTo<br />
<br />
*'''MULTICURRENCY_SHOW_ALSO_MAIN_CURRENCY_ON_PDF''' ► Show the amount in the 2 currencies on PDF when using the MultiCurrency module<br />
*'''MAIN_PDF_DONOTREPEAT_HEAD ►''' Do not repeat the header of document<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Point of Sale (POS)=<br />
<br />
*'''CASHDESK_SHOW_KEYPAD''' ► Show a mouse key pad into the 'Simple Point of Sale' module.<br />
<br />
*'''POS_ADDON''' ► Set this value to an existing numbering module rule (for example '<code>mod_facture_terre</code>', '<code>mod_facture_mars</code>', ...) to force the numbering module to use for invoice ref definition when invoice is created by the POS. For example setting value <code>POS_ADDON</code> to '<code>mod_facture_terre</code>' will use the numbering module '<code>terre</code>' for invoice generated from POS, whatever is the numbering rule defined into invoice module setup (you can also use POS_NUMBERING_TERRE_FORCE_PREFIX and POS_NUMBERING_MARS_FORCE_PREFIX variable to change the prefix used).<br />
<br />
*'''TAKEPOS_ENABLE_SUMUP''' ► Enable the compatibility of TakePOS with the card reader terminal [https://SumUp.fr SumUp]<br />
*'''TAKEPOS_CAN_FORCE_BANK_ACCOUNT_DURING_PAYMENT''' ► Possibility to force the bank account during the payment in TakePOS ► (v13.0)<br />
*'''TAKEPOS_CONTROL_CASH_OPENING''' ► Control the cash opening<br />
*'''TAKEPOS_NUMPAD_FORCE_PAYMENT_ICONS_LABELS'''<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Products Module=<br />
<br />
*'''CATEGORY_GRAPHSTATS_ON_PRODUCTS''' ► Show graph of products with categories and totals in Products Area screen<br />
<br />
*'''MAIN_PRODUCT_DISABLE_CUSTOMCOUNTRYCODE''' ► Avoid customs code and country of origin to be set as product description when added to Propal/Order/Invoice<br />
<br />
*'''PRODUCT_ADD_TYPE_IN_DOCUMENTS''' ► Add text "Product" or "Service" at beginning of details lines on built PDF documents.<br />
<br />
*'''PRODUCT_DONOTSEARCH_ANYWHERE''' ► When Ajax search is enabled, search is done on criteria anywhere in label of product. By adding this option, search is done only on start of label. This is really faster when you have a huge number of products.<br />
<br />
*'''MAIN_DIRECT_STATUS_UPDATE''' ► Allows you to change the status of the product (''for sale/not for sale for purchase/not for purchase'') directly on the product page via a ''on/off'' switch button. This can be convenient for those who need to quickly disable certain statuses of products without having to go through the editing product page individually. Also can be very useful if used as a filter on the product and product search list. This option doesn't generate a MODIFY trigger, so be careful with external modules. ► (v4.0+)<br />
<br />
*'''MAIN_SEARCH_PRODUCT_BY_FOURN_REF''' ► Allow to search a product by supplier ref in document's add line form. ► (>= 8.0)<br />
<br />
*'''MAIN_DISABLE_FREE_LINES''' ► Disallow using free lines to add line in documents ► (>= 8.0)<br />
<br />
*'''MAIN_SHOW_PRODUCT_ACTIVITY_TRIM''' ► Show Product and Services turnover before for all four quarters tax over recent years recent years on the product area ► (v5.0+)<br />
<br />
*'''PRODUIT_DESC_IN_LIST''' ► Show long description of product/service into lists.<br />
<br />
*'''PRODUCT_DISABLE_PROPAGATE_CUSTOMER_PRICES_ON_CHILD_COMPANIES''' ► Disable propagation of prices per customer from a customer to its child company.<br />
<br />
*'''PRODUCT_DISABLE_PUBLIC_URL''' ► Disable public url in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_STOCK_LEVELS''' ► Disable properties of stock limits and desired optimal value on product ► (v14.0+)<br />
*'''PRODUCT_DISABLE_NATURE''' ► Disable nature in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_WEIGHT''' ► Disable weight in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_PRICES''' ► Disable prices in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_ACCOUNTING''' ► Disable accounting in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_SIZE''' ► Disable size in product card.<br />
<br />
*'''PRODUCT_DISABLE_LENGTH''' ► Disable length in product card ► (v4.0+)<br />
<br />
*'''PRODUCT_DISABLE_SURFACE''' ► Disable surface in product card. ► (v4.0+)<br />
<br />
*'''PRODUCT_DISABLE_VOLUME''' ► Disable volume in product card.<br />
<br />
*'''PRODUCT_DISABLE_CUSTOM_INFO''' ► Disable custom info (custom code and country origin) in product/service card.<br />
<br />
*'''PRODUIT_MULTIPRICES_USE_VAT_PER_LEVEL''' ► When option to use price per level/segment is on, this allows to also set a dedicated vat for each price level.<br />
<br />
*'''PRODUIT_CUSTOMER_PRICES_BY_QTY''' ► If price per quantity ► ''Experimental''<br />
*'''PRODUIT_CUSTOMER_PRICES_BY_QTY_MULTIPRICES''' ► If price per quantity and customer ► ''Experimental''<br />
<br />
*'''PRODUCT_LOT_ENABLE_QUALITY_CONTROL''' ► Enable feature (Display fields for life time and quality control duration) for quality control on product and lot<br />
<br />
*'''PRODUCT_MAX_LENGTH_COMBO''' ► Limit the length of the label displayed when adding lines in proposals/invoices/orders<br />
<br />
*'''PRODUCT_MAX_VISIBLE_PHOTO''' ► Show a maximum number of product photos (as thumbnails) on the product main card. Example, setting this constant to '<code>5</code>' will show the first five product photos found on the product card.<br />
<br />
*'''PRODUIT_PDF_MERGE_PROPAL''' ► Enable module Propal merge product PDF<br />
<br />
*'''PRODUCT_USE_OLD_PATH_FOR_PHOTO''' ► Ask dolibarr to check also old path (before 3.7) where photos were stored.<br />
<br />
*'''PRODUCT_USE_UNITS''' ► Add other units on products (Use same dictionary as default unit feature) and propagate this unit on line of documents.<br />
*'''MAIN_EDIT_LINE_ALLOW_ALL_UNIT_TYPE ►''' Allow the selection of other unit types when editing the document line<br />
<br />
*'''RESOURCE_ON_PRODUCTS''' ► Allow to affect resources on products/services ► (v10.0+)<br />
*'''RESOURCE_ON_SERVICES''' ► Allow to affect resources on products/services ► (v10.0+)<br />
*'''PRODUCT_SHOW_ORIGIN_IN_COMBO''' ► Show origin of products when adding lines in proposals/invoices/orders ► (v12.0+)<br />
*'''PRODUIT_ATTRIBUTES_HIDECHILD''' ► Add option hide child if variantes<br />
<br />
*'''PRODUCT_ADD_FORM_ADD_TO''' ► Add a product to a draft proposal/order/invoice, from the product card.<br />
*'''PRODUCT_DISABLE_SELLBY''' ► Hide the Sell by date ► (v13.0+)<br />
*'''PRODUCT_DISABLE_EATBY''' ► Hide the Eat by date ► (v13.0+)<br />
<br />
*'''PRODUCT_DENY_CHANGE_PRODUCT_TYPE''' ► Forbid to change the product type<br />
<br />
*'''PRODUCT_SORT_BY_CATEGORY''' ► Sort the product by categories instead of by ID<br />
*'''PRODUCT_ADD_NET_MEASURE''' ► Support Net Measure in product's card.php (For real weight, volume or piece; needed for some business ie fruits, vegetables....). Note brut value is already available natively, use this option only if you need 2 weights, 2 volumes, ...for each product) ► (v11.0.1+)<br />
*'''PRODUCT_PRICE_BASE_TYPE''' ► value 'TTC' / 'HT' specify the default value of the price (with or without taxes) ► (v16.0.0+)<br />
<br />
*'''PRODUCT_LOAD_EXTRAFIELD_INTO_OBJECTLINES''' ► Load product extrafiled on object lines<br />
<br />
*'''PRODUCT_USE_SUB_COST_PRICES_IF_COST_PRICE_EMPTY'''<span> </span>: Calculate the parent product production price by child prices.<br />
*'''PRODUCT_SEARCH_AUTO_SELECT_IF_ONLY_ONE'''<span> </span>: Set to 0 to disable or 1 to enable (by default) the auto select product behavior in combobox when there is only one result.(v21.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Projects Module=<br />
<br />
*'''PROJECT_ALLOW_TO_LINK_FROM_OTHER_COMPANY''' ► Option related to the combo list Project on elements. It is a list of thirdparty IDs. If set, you can link an object to a project owned by one of this thirdparty in the list.<br />
<br />
*'''PROJECT_ALLOW_COMMENT_ON_PROJECT''' ► Add comment feature on a project<br />
<br />
*'''PROJECT_ALLOW_COMMENT_ON_TASK''' ► Add comment feature on project task<br />
*'''PROJECT_ALWAYS_DISCARD_CLOSED_PROJECTS_IN_SELECT''' ► Discards closed projects in every select field. A closed project can't be associated to an object ► (v20.0+)<br />
<br />
*'''PROJECT_CAN_ALWAYS_LINK_TO_ALL_SUPPLIERS''' ► Option related to the combo list Project on elements. Can link a supplier element (vendor proposal, purchase order, vendor invoice, reception, ...) to any project even if object has a different supplier than the one of the project to link to. See also PROJECT_ALLOW_TO_LINK_FROM_OTHER_COMPANY that is different because it allows to define some given thirdparty ID to allow.<br />
<br />
*'''PROJECT_CAN_ALWAYS_LINK_TO_ALL_CUSTOMERS''' ► Option related to the combo list Project on elements. Can link a custom element (proposal, sale order, vendor invoice, shipment, ...) to any project even if object has a different customer than the one of the project to link to.<br />
<br />
*'''PROJECT_CREATE_ON_OVERVIEW_DISABLED''' ► Hide the "create ..." button on the overview pagec<br />
<br />
*'''PROJECT_DISABLE_UNLINK_FROM_OVERVIEW''' ► Enable removing the button from a link in the project overview. ► (>= v8.0.1)<br />
<br />
*'''PROJECT_HIDE_UNSELECTABLES''' ► Hide into select list, all project that we can't select (closed or draft)<br />
<br />
*'''PROJECT_HIDE_TASKS''' ► Hide tasks. For user using project only as an analytics key and not using tasks.<br />
<br />
*'''PROJECT_LIST_SHOW_STARTDATE''' ► Shows start date of projects in project lists.<br />
<br />
*'''PROJECT_LINK_ON_OVERWIEW_DISABLED''' ► Hide the "link to" form on the overview page ► (v4.0)<br />
<br />
*'''PROJECT_SHOW_REF_INTO_LISTS''' ► Add column with project ref into list (with 3.7 list of supplier invoices only, will be expanded to other lists)<br />
<br />
*'''PROJECT_TIME_ON_ALL_TASKS_MY_PROJECTS''' ► Can add time spent on tasks, even if i am not assigned to task (however, task must be a project i am a contact).<br />
<br />
*'''PROJECT_OPEN_ALWAYS_ON_TAB''' ► Set to value 'task', or 'preview' to always open the project on the given tab instead of main tab.<br />
<br />
*'''PROJECT_ELEMENTS_FOR_MINUS_MARGIN'''<br />
<br />
*'''TIMESPENT_ALWAYS_UPDATE_THM''' ► when it's on always check current time of user to update it in task time line ► (v17.0)<br />
<br />
*'''PROJECT_CREATE_NO_DRAFT''' ► when you create project status will be validate ► (v19.0)<br />
<br />
*'''PROJECT_ENABLE_SUB_PROJECT''' ► Add support for parent projects ► (v19.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Proposals Module=<br />
<br />
*'''MAIN_GENERATE_PROPOSALS_WITH_PICTURE''' ► Add a picture of the product (the first one found if there are several) into the generated PDF of proposals. Note that using this will reduce the available width for the product description.<br />
<br />
*'''MAIN_PROPAL_CHOOSE_ODT_DOCUMENT''' ► On setup page, you'll be able to select which ODT document to use when close or cancel proposals.<br />
<br />
*'''MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING''' ► add optional esign field in pdf propal ► (v8.0+)<br />
<br />
*'''PROPAL_CLONE_ON_CREATE_PAGE''' ► On the create proposal page, ask if we want to create the proposal by cloning an already existing one. You should use instead the "Clone" button available on existing proposals.<br />
<br />
*'''PROPAL_DISABLE_SIGNATURE''' ► Do no show the box for signature.<br />
*'''PROPAL_SIGNATURE_ON_SPECIFIC_PAGE ►''' Will show the signature on which page you wanted . Set to 1 will show on first page , set to -1 will show on last second page . ( If '''PROPAL_SIGNATURE_ON_ALL_PAGES''' is enabled, the '''PROPAL_SIGNATURE_ON_SPECIFIC_PAGE''' setting will be ignored.)<br />
*'''PROPAL_SIGNATURE_ON_ALL_PAGES ►''' Will show the signature on every pages .<br />
<br />
*'''PRODUIT_PDF_MERGE_PROPAL''' ► When generating the proposal PDF, all PDFs linked to products linked to proposal are also included into final PDF<br />
<br />
*'''PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD''' ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)<br />
<br />
*'''PROPOSAL_AUTO_ADD_AUTHOR_AS_CONTACT''' ► Add Proposal Author as user contact follow proposal<br />
<br />
*'''PROPOSAL_PDF_HIDE_PAYMENTTERM''' ► Do not show the payment term on proposal ► (v11.0+)<br />
<br />
*'''PROPOSAL_PDF_HIDE_PAYMENTMODE''' ► Do not show the payment mode on proposal ► (v11.0+)<br />
<br />
*'''WORKFLOW_PROPAL_CAN_CLASSIFY_BILLED_WITHOUT_INVOICES''' ► Button "Classified Billed" is visible on proposal even if there is no invoice linked to proposal.<br />
*'''PROPAL_REOPEN_UNSIGNED_ONLY''' ► Do not allow reopening of signed (or billed) proposals. (V15)<br />
*'''PROPOSAL_ARE_NOT_BILLABLE''' ► Disable billing button on proposals (V15)<br />
*'''PROPAL_DEFAULT_NOTE_PUBLIC''' ► Default text in public note<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Receptions=<br />
<br />
*'''RECEPTION_STANDALONE''' ► Create a simple Reception not connected to supplier order, warehouse, stock e.t.c. (>=23.0)<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Services Module=<br />
<br />
*'''SERVICE_ARE_ECOMMERCE_200238EC''' ► If seller and buyer are in Europe and buyer is not a company, use the VAT of buying country. For french speaking people, see also the page [[Loi_européenne_TVA_Vente_à_Distance_VAD_et_e-commerce_BtoC]].<br />
<br />
*'''MAIN_FILL_SERVICE_DATES_FROM_LAST_SERVICE_LINE''' ► (v13.0) On add line form add a button to fill service dates from the last service line<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Shipments=<br />
<br />
*'''STOCK_WAREHOUSE_NOT_REQUIRED_FOR_SHIPMENTS''' ► If set, you can add a shipment line, with no stock source defined. ► (>= 8.0.1)<br />
<br />
*'''SHIPMENT_GETS_ALL_ORDER_PRODUCTS''' ► Add all order lines in shipment, including the one with 0 in quantity<br />
*'''SHIPPING_PDF_HIDE_ORDERED''' ►Hide column quantity ordered on shipment pdf (>=15.0)<br />
*'''STOCK_SUPPORTS_SERVICES''' ►Allow to manage services into warehouse and allow to ship services<br />
*'''SHIPMENT_SUPPORTS_SERVICES''' ►Allow to ship services without stock (>=19.0)<br />
*'''SHIPPING_DISPLAY_STOCK_ENTRY_DATE''' ►Display date entry stock exped and sort in date order (>=19.0)<br />
*'''SHIPMENT_STANDALONE ►'''Create a simple shipment not connected to sales order, warehouse, stock e.t.c. (>=23.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Stocks=<br />
<br />
*'''SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED''' ► Disable stock dispatch when total expected was already received<br />
<br />
*'''STOCK_EXCLUDE_VIRTUAL_PRODUCTS''' ► If product is a virtual product, we do not manage stock for it.<br />
*'''STOCK_ALLOW_DELETE_OF_MOVEMENT''' ► Enable massaction option to delete in movements list (be carefull !!).<br />
<br />
*'''ENTREPOT_EXTRA_STATUS''' ► Instead of the 2 status (Closed, Open), a Warehouse has 3 status: Closed, Open (for all movements), Open (for internal movement only). Internal movement only means you can't use the warehouse to make shipment or receptions.<br />
<br />
*'''SUPPLIER_ORDER_STATUS_FOR_VIRTUAL_STOCK''' ► For the calculation of virtual stocks, by default supplier orders with the status 3 (ordered) and 4 (partially received) are used. You can enter the list of statuses to be taken into account separated by commas for this calculation (example: 0,1,2,3)<br />
<br />
*'''STOCK_MOVEMENT_LIST_HIDE_UNIT_PRICE''' ► to hide unit price on some pages (V15+)<br />
<br />
*'''DISABLE_QTY_OVERWRITE''' ► Disable quantity overwrites on inventories ► (v19.0)<br />
*'''MAIN_WAREHOUSE_LIST_DISPLAY_MODE''' ► Change warehouse select list display mode ► (v21.0) (see github pull request [https://github.com/Dolibarr/dolibarr/pull/31013 #31013] for more info)<br />
**0<span> </span>: Default behavior, display parents of warehouse<br />
**1<span> </span>: Display only current warehouse label only<br />
**2<span> </span>: Display last parent warehouse label<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Suppliers Module=<br />
<br />
*'''FOURN_PRODUCT_AVAILABILITY''' ► On the Suppliers price page of the products, activate the supplier product availability. ''This is duplicate feature with delivery_delay introduced with 3.8.''<br />
<br />
*'''RELOAD_PAGE_ON_SUPPLIER_CHANGE''' ► On creation of a supplier order/invoice, reload form with supplier-specific details when supplier is selected from drop-down list.<br />
<br />
*'''SUPPLIER_INVOICE_WITH_PREDEFINED_PRICES_ONLY''' ► Restrict selection of products in supplier invoice to only those with a buying price defined for that supplier. ► (v6.0+)<br />
<br />
*'''SUPPLIER_ORDER_AUTOADD_USER_CONTACT''' ► Add user approving supplier order as a contact automatically.<br />
<br />
*'''SUPPLIER_ORDER_DEFAULT_PAYMENT_MODE_ID''' ► Set the default payment method for suppliers (<code>rowid</code> in table <code>llx_c_paiement</code>).<br />
<br />
*'''SUPPLIER_ORDER_USE_DISPATCH_STATUS''' ► Add a status on each dispatch order line when receiving products from suppliers ► (v4.0+)<br />
<br />
*'''SUPPLIER_ORDER_NO_DIRECT_APPROVE''' ► No button "Validate and Approve". Always do step "Validate" and "Approve" in 2 steps.<br />
<br />
*'''SUPPLIER_ORDER_WITH_PREDEFINED_PRICES_ONLY''' ► Restrict selection of products in supplier order to only those with a buying price defined for that supplier. ► (v6.0+)<br />
<br />
*'''SUPPLIER_ORDER_EDIT_BUYINGPRICE_DURING_RECEIPT''' ► Can modify the buying price used for PMP calculation when making a stock reception on a supplier order. ► (v6.0+)<br />
*'''SUPPLIER_PROPOSAL_WITH_PREDEFINED_PRICES_ONLY''' ► Restrict selection of products in supplier proposal to only those with a buying price defined for that supplier. ► (v6.0+)<br />
*'''SUPPLIER_ORDER_MORE_THAN_WISHED''' ► The supplier order status is set to "Totally received" even if there are more products received than ordered. ► (v15.0+)<br />
<br />
*'''DISPLAY_DISCOUNTED_SUPPLIER_PRICE''' ► Allow to display discounted supplier price when searching product in supplier documents ► (v10.0)<br />
<br />
*'''MAIN_CAN_EDIT_SUPPLIER_ON_SUPPLIER_ORDER''' ► Allow to change the supplier on a draft supplier order ► (v10.0)<br />
<br />
*'''SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD'''<br />
<br />
*'''SUPPLIER_ORDER_CAN_UPDATE_BUYINGPRICE_DURING_RECEIPT''' ► Allow to change price on receipt ► (v19.0)<br />
<br />
*'''SUPPLIER_HIDE_SUPPLIER_OBJECTLINES''' ► Hide the supplier information on objectlines (invoices, etc..) ► (v19.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Third Parties Module=<br />
<br />
*'''COMPANY_AQUARIUM_CLEAN_REGEX''' ► Add a REGEX rule on the third parties names. It applies a regex replacement pattern on generated code if COMPANY_AQUARIUM_CLEAN_REGEX is set. Value must be a regex with parenthesis. The part into parenthesis is kept, the rest removed. For example if COMPANY_AQUARIUM_CLEAN_REGEX = '<code>^..(..)..(.*)</code>' the first char and second char are removed and the char 5 and 6 too ► (>= 8.0.1)<br />
<br />
*'''MAIN_UNKNOWN_CUSTOMERS_ARE_COMPANIES''' ► See in Global options section.<br />
<br />
*'''MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL''' ► See in Global options section.<br />
<br />
*'''SOCIETE_EMAIL_MANDATORY''' ► E-mail is a mandatory field when creating a thirdparty<br />
<br />
*'''SOCIETE_DISABLE_CUSTOMERS''' ► Remove all menu and features related to customers<br />
<br />
*'''SOCIETE_DISABLE_PROSPECTS''' ► Remove all menu and features related to prospects<br />
*'''SOCIETE_DISABLE_PROSPECTSCUSTOMERS ►''' Remove the status "Customer/Prospect" when thirdparties creation or modification<br />
<br />
*'''SOCIETE_DISABLE_STATE''' ► Do not use field "state/province"<br />
<br />
*'''SOCIETE_SORT_ON_TYPEENT''' ► The combo list of "type of third party" is sorted on alphabetical order instead of the field "position" that appears into dictionary instead.<br />
<br />
*'''SOCIETE_ASK_FOR_SHIPPING_METHOD''' ► Shipping method can be predefined on customer card and will be used as default on order creation<br />
*'''SOCIETE_ADD_REF_IN_LIST''' ► Displays the code before the name in the lists ► Value 1 -> Code + name + alias ou Code + name if colone alias 2 -> Code + alias 3 -> Alias<br />
<br />
*'''THIRDPARTY_CAN_HAVE_CATEGORY_EVEN_IF_NOT_CUSTOMER_PROSPECT_SUPPLIER''' ► Possible to add Categories to third parties that are not customer, prospect or supplier.<br />
<br />
*'''THIRDPARTY_DEFAULT_USELOCALTAX1''' ► When creating a new third party, the field "Use second tax" is set to on or off depending on value of this parameter.<br />
<br />
*'''THIRDPARTY_DEFAULT_USELOCALTAX2''' ► When creating a new third party, the field "Use third tax" is set to on or off depending on value of this parameter.<br />
<br />
*'''THIRDPARTY_NOTCUSTOMERPROSPECT_BY_DEFAULT''' ► Do not set status "Customer/Prospect" to "on" when creating a new third party from menu "New third party".<br />
<br />
*'''THIRDPARTY_INCLUDE_PARENT_IN_LINKTO''' ► Search also for elements on parent third party when using the "link to" object feature.<br />
<br />
*'''THIRDPARTY_INCLUDE_PROJECT_THIRDPARY_IN_LINKTO''' ► Search also for elements on third party that own the project of the current element when using the "link to" object feature (if project is owned by a different thirdparty than current one).<br />
<br />
*'''THIRDPARTY_LOGO_ALLOW_EXTERNAL_DOWNLOAD''' ► When a logo is uploaded, a share key is automatically set so the file can be downloaded using the share key.<br />
<br />
*'''THIRDPARTY_SUGGEST_ALSO_ADDRESS_CREATION''' ► Enabled contact creation on third-party create card<br />
*'''THIRDPARTY_QUICKSEARCH_ON_FIELDS''' ► Personalized search criteria ► Example: $conf->global->THIRDPARTY_QUICKSEARCH_ON_FIELDS = 's.nom=ThirdPartyName;s.name_alias=AliasNameShort;s.code_client=CustomerCode'<br />
*'''MEMBER_CAN_CONVERT_CUSTOMERS_TO_MEMBERS''' ► Enabled member creation on third-party create card<br />
*'''SOCIETE_DISABLE_PARENTCOMPANY''' ► Disables attachment to a parent company.<br />
*'''THIRDPARTY_CUSTOMERPROSPECT_BY_DEFAULT''' ► Set the third party to customer by default<br />
*'''THIRDPARTY_SUPPLIER_BY_DEFAULT''' ► Set the third party to supplier by default<br />
*'''THIRDPARTY_CUSTOMERTYPE_BY_DEFAULT''' ► Set the third party type by default (3 = customer & prospect / 2 = prospect / 1 = customer )<br />
*'''CONTACT_DISABLE_PERSONALINFO''' ► Disable Personal data on contact page<br />
*'''SOCIETE_DISABLE_WORKFORCE''' ► Disable work force selector on society page<br />
*'''SOCIETE_SHOW_VAT_IN_LIST''' ► display VAT number in combo list of thirdparties ► (V15+)<br />
*'''THIRDPARTY_DEFAULT_CREATE_CONTACT''' ► When set, a contact is created at the creation of an individual third party ► (v14.0)<br />
<br />
*'''MAIN_SUPPORT_SHARED_CONTACT_BETWEEN_THIRDPARTIES''' ► Able to share contact between several third parties<br />
*'''THIRDPARTY_CUSTOMERCODE_EQUALS_MEMBERREF''' ► When creating third parties out of members, the customer code is set equal to the member Ref. ► (v22.0)<br />
*'''SOCIETE_NO_SYNC_LINKED_MEMBER''' ► If set, changes to a third party will not be synchronized to a linked member. ► (v23.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Ticket Module=<br />
<br />
*'''TICKET_SHOW_MESSAGES_ON_CARD''' ►Display all ticket related messages on the main ticket card. ► (>= 10.0)<br />
*'''TICKET_AUTO_ASSIGN_CONTRACT_CREATE''' ►Automatically create a contract linked to the ticket ► (>= 10.0)<br />
*'''TICKET_AUTO_CREATE_FICHINTER_CREATE''' ►Automatically create an intervention linked to the ticket ► (>= 10.0)<br />
*'''TICKET_AUTO_ASSIGN_USER_CREATE''' '''►''' (>= 21.0) 0=No auto assignement, 1=Auto assign current user if no user was set, 2=Auto assign current user even if another user was set.<br />
*'''TICKET_CHECK_NOTIFY_THIRDPARTY_AT_CREATION''' ►Automatically check "notify thirdparty at creation" ( >=16)<br />
*'''TICKETS_MESSAGE_FORCE_MAIL''' ► Pre check email sending on ticket message (>=15)<br />
*'''TICKET_SEND_PRIVATE_EMAIL ►''' Allow a private message to be sent by mail (>=17)<br />
*'''TICKET_LIMIT_VIEW_ASSIGNED_ONLY''' '''►''' Only display tickets assigned to the user<br />
*'''TICKET_ADD_AUTHOR_AS_CONTACT''' '''►''' If set to 1: Automatically adds the author as internal contact. If set to 2: Automatically adds the author as external contact if external user. (>=20)<br />
*'''TICKET_ASSIGN_CONTACT_TO_MESSAGE''' '''►''' If known, the external contact is assigned to the message. (>=19)<br />
*'''TICKET_ALLOW_CLASSIFICATION_MODIFICATION_EVEN_IF_CLOSED''' '''►'''Allow modify ticket classification even if closed. (>=19)<br />
*'''WORKFLOW_TICKET_CLOSE_INTERVENTION''' ►On ticket close, automatically close an intervention linked to the ticket<br />
*'''TICKET_INCLUDE_SUSPENDED_STATUS''' ► Use ticket suspended status (>=19)<br />
*'''TICKET_INCLUDE_LINK_TO_PUBLIC_INTERFACE_IN_MESSAGE''' ► Add a link in bottom of emails sent from ticket page with link to public ticket admin tool (>=22)<br />
<br />
=VAT Report=<br />
<br />
*'''MAIN_INCLUDE_ZERO_VAT_IN_REPORTS''' ► Include lines with VAT to 0% (for "auto-liquidation" in EEC) ► (v8.0.3+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Website Module=<br />
<br />
*'''WEBSITE_USE_WEBSITE_ACCOUNTS''' ► Add a table and a tab to manage some accounts for websites to a third party<br />
*'''WEBSITE_ALLOW_OVERWRITE_GIT_SOURCE''' ► Add a button to export a website over the GIT sources<br />
*'''WEBSITE_ADD_CSS_TO_BODY''' ► Add a CSS class to the body tag of websites<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=WYSIWYG Editor=<br />
<br />
*'''FCKEDITOR_ENABLE_DETAILS_FULL''' ► Can cut and paste external images (hosted on external server) into description of proposal, orders or invoices. WARNING: PDF generation is not guaranteed with this. Also if the image is removed or renamed by the image hosting service, your proposal, order or invoice will be broken.<br />
*'''FCKEDITOR_ALLOW_ANY_CONTENT''' ► Allow to enter any content. However, this will totally disable content filtering which is one of the most important CKEditor features. You can use this to keep all your tags and attributes in the html content.<br />
*'''FCKEDITOR_ENABLE_SCAYT_AUTOSTARTUP''' ► Allow to activate the SpellCheckAsYouType (SCAYT) plugins of CKEditor i.e an automatic spell checking. The value to activate this option is 1.<br />
*'''MAIN_ALLOW_WYSIWYG_LOCAL_MEDIAS_ON_PRIVATE_NETWORK''' ► By default, you can add medias links (img src or other) into the rich text content editor, but you can't add links like that use a local host like "https://localhost/file". If you set this option to 1, you can.<br />
*'''MAIN_ALLOW_WYSIWYG_EVEN_ON_UNSECURED_EXTERNAL_HTTP_URL''' ► By default, you can add medias links (img src or other) into the rich text content editor, but not if the link is a unsecure "http" url (not https) and your Dolibarr is http. If you set this option to 1, you can.<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=STRIPE Module=<br />
<br />
*'''STRIPE_FORCE_VERSION''' ► Force the STRIPE version. For Example: "2019-09-09" (v11+)<br />
*'''STRIPE_REUSE_EXISTING_INTENT_IF_FOUND''' ► With this, you will have idempotency key but the payment intention will be reuse and not Generate again (13+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=ClickToDial Module=<br />
<br />
*'''CLICKTODIAL_FORCENEWTARGET''' ► Open in new page.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=For SaaS / Cloud hosting integrators=<br />
<br />
The following options are useless for a common usage of Dolibarr. But they are usefull if you plan to host / provide Dolibarr instances as Software As A Service (SAAS) to your customers.<br />
<br />
*'''CRON_DISABLE_KEY_CHANGE''' ► When you provide an instance to a customer, you probably also add an entry in the cron of this user so Dolibarr batch and scheduler can work correctly. For security purpose, it may have a security key that is inside the command line into the cron entry and this entry must match the value defined into Dolibarr setup (setup of module 'Scheduled Jobs'). Because, a customer of a Saas platform will probably have no access to edit the cron file, it is also import that he has no way to edit the key into the Dolibarr setup, so the key in the cron command line will always match the key in Dolibarr setup, and the Dolibarr batches will executed without security errors. To be sure, the customer does not change the value, you can set this constant to 1 into the table [[Table_llx_const]].<br />
<br />
*'''CRON_DISABLE_TUTORIAL_CRON''' ► Disable the tutorial about how to install the cron script (on a SaaS hosting, this should be done by the web hosting provider)<br />
<br />
*'''CRON_WARNING_DELAY_HOURS''' ► Set this value to the frequency set for the cron script (so a warning will be shown to user to warn it about max frequency of its scheduled jobs)<br />
<br />
*'''MAILING_NO_USING_PHPMAIL''' ► To avoid bad use of the emailing module, it is recommended to set this option to 1 (This option is described previously). Also you can complete the message visible by customers when they try to setup the SMTP credentials of their Dolibarr by using the constant MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS (This option is described previously). For example, you can point to a FAQ on your website.<br />
<br />
*'''MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL''' ► If you have set a system limit on number of recipients on your system, you can set also this option to match the same value, so users will be informed: So '''MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL''' restricts sending of 1 email message to <code>x</code> recipients for the same email message (x for To: + CC: + BCC:). If not defined, value is <code>10</code>. Required to fight against spamming that include a ton of recipients in 1 message. Note that '''MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL''', '''MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL''' and '''MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL''' are also available. Note that this is not a hard limit; it is just the quantity that will be displayed on warnings on screen. For a real limit, this must be implemented into the system.<br />
<br />
*'''MAILING_LIMIT_SENDBYDAY''' ► This is a limit of number of emails, an instance can send. Note that this is not a hard limit; it is just the quantity that will be displayed on warnings on screen. For a real limit, this must be implemented into the system.<br />
<br />
*'''MAILING_LIMIT_WARNING_PHPMAIL''' ► Set this value to a translation key. Then add translation keys into the instance so user will see a message when into the email setup page. For example, you can set a message to say: ''Warning: To avoid abuse, when using default setup, you are restricted to 500 emails per day for all your application (account may be suspended in case of violation of this rule. You can setup application to use your own SMTP server for sending email so you want have no restriction at all (see menu Home-Setup-Emails)''<br />
<br />
*'''MAIN_ALWAYS_CREATE_LOCK_AFTER_LAST_UPGRADE''' ► If set, when you launch upgrades of your customer instances, you are sure that the upgrade process recreate automatically the file install.lock and remove the upgrade.unlock so the administration tools like install.php, upgrade.php and repair.php can't be used on your customer instance (until the install.lock file is deleted or the upgrade.unlock file is created).<br />
<br />
*'''MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS''' ► (A better name of this option should be MAIN_EXTERNAL_MAIL_CLIENT_IP_ADDRESS). Set here the list of IPs where your Dolibarr instances are hosted, separated by a comma. So, when your customer go into the Email setup area:<br />
**If he has chosen mail method, a message will explain him how to setup its SPF record for its email domain (showing the list of IP). This is to avoid to have its emails, sent from its Dolibarr instance, fails due to strict antispam rule of some emailing servers.<br />
**If he has chosen smtp method, a message will explain him the list of IP he can use if there is restriction on IP by the SMTP agent. If you also need to add a message to help SPF setup, see option '''MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD'''.<br />
<br />
You can also provide a list of URLs that return just an IP instead of a list of hardcoded IP. So you can for example set 1 url that contact a whoami service that return the public IP of server and another one doing the one on a IPv6 address, so on the setup page, the public IP adress of the server will always be uptodate for both ipv4 and ipv6 (Example: "https://ipv4.server.com/_service_showmyip.php,https://ipv6.server.com/_service_showmyip.php")<br />
<br />
*'''MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD''' ► Set here the string to add in the SPF record This string will be shown into a help message when the user in in the setup of email page and has choose a method using an external SMTP server.<br />
<br />
*'''MAIN_FIRST_PING_OK_ID''' ► Set this value to "disabled" to remove completely any ping after a complete setup.<br />
<br />
*'''MAIN_FILECHECK_LOCAL_SUFFIX''' and '''MAIN_FILECHECK_LOCAL_EXT''' ► If you offer a customized or patched version of Dolibarr, when the user will use the tool to check the integrity of files, the default xml file name used for signature checking will be the official file provided by the Dolibarr team, so it does not includes your own changes. To have the suggested signature file being your own file, you can set the constant MAIN_FILECHECK_LOCAL_SUFFIX to a suffix. For example, set this to "'''-mysaassolution'''". So, when the user will use the file integrity tool, the default file to check for signature will be "'''/install/filelist-10.0.2-mysaassolution.xml'''" instead of "'''/install/filelist-10.0.2.xml'''". All you have to do is generate the signature file '''mysaassolution''' using the tool '''build/generate_filelist_xml.php''' and put this file into the install directory of your customer instance. Doing this, your customer, and yourself, will be able to check if a file was modified without being disturbed by false alerts due to your customized files or patches (they will be included in the signature used for check). Also, if you want to zip the customized signature file into "'''/install/filelist-10.0.2-mysaassolution.xml.zip'''", you can set the constant MAIN_FILECHECK_LOCAL_EXT to '.zip'.<br />
<br />
*'''MAIN_HIDE_WARNING_TO_ENCOURAGE_SMTP_SETUP''' ► Set to 1 by default (so warning is hidden). You can set it to 0 to show a warning to encourage admin to set its own SMTP service.<br />
<br />
*'''MAIN_MAIL_SENDMODE_password''' ► To force the mode to send the email on the "password forgotten" page. So you can decide to use php mail or SMTP method for this specific use case.<br />
<br />
*'''MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING''' ► If set to N, the warning saying modules are not activated will be shown if number of activated module is < N (Having this variable not defined is same than having it set to 1). This may be usefull if you preinstall an application with some modules already loaded by default and you want to keep the warning to be sure the user will enable other modules he need, even if some modules are already enabed.<br />
*'''MAIN_SETUP_MODULES_DESC''' ► If your installation is already done with activated module, the help message to explain how to enable a module on the setup page is hidden. You can keep it visible by adding this option to 1.<br />
<br />
*'''MAIN_NO_UPGRADE_REDIRECT_ON_LEVEL_3_CHANGE''' ► The page to make the migration is not shown automatically when you deploy files of version X.Y.Z+delta over an installation with a database version X.Y.Z. The upgrade page will be shown automatically only if there is a change on value of X or Y in version.<br />
<br />
*'''SYSLOG_DISABLE_LOGHANDLER_SYSLOG''' ► Set this to 1 to disable usage of syslog (having all customer instances logging in the same system file is not a good idea).<br />
<br />
*'''WEBSITE_REPLACE_INFO_ABOUT_USAGE_WITH_WEBSERVER''' ► Put here a text or a translation key of a text to show when the user will use the feature "Deploy" when he want to deploy a website done with Dolibarr CMS. So you can, for example, show him a message that this feature is not part of its subscription and putting a website online may need a complementary subscription.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /></div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Setup_Other&diff=65980Setup Other2026-04-22T13:00:01Z<p>Sonikf: /* Shipments */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Paramétrage_Divers]]<br />
[[es:Configuración_Varios]]<br />
[[de:Erweiterte_Einstellungen]]<br />
[[zh:其他设置]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Admin]]<br />
{{TemplateDocUser}}<br />
<br />
'''Help About Screen''': Other setup<br />
<br />
'''Menu Path''': Home ► Setup ► Other<br />
<br />
<br />
<br />
'''Introduction'''<br />
<br />
Some options are not visible in the interface (often because they are deprecated or are beta features). In most cases you do not need these functions and their use may make the application unstable or may not work as expected.<br />
<br />
{{warning|32px}} This page contains the list of some advanced development parameters. In most cases, they are parameters for internal usage, development, external modules, features in development not stable or that may lead to security risk. For standard usage of Dolibarr, such parameters '''SHOULD NOT''' be used. All experimental options are NOT supported. They may be removed in a future, modified at any version and break stability of your application.<br />
<br />
To enable/override a parameter you have to define the constant name and set it to 1 (unless otherwise stated) in <code>Home ► Setup ► Other Setup</code><br />
<br />
<br />
The options here may not be documented since they are not stable and are unsupported (remember they are experimental or development options). The basic format of how the list is written is broken down in the example below:<br />
<br />
UNSTABLE_OR_DEV_OPTION ► ''Description of config and goal'' ► ''(specific version information) or values''<br />
<center><br />
__TOC__<br />
</center><br />
=Global Options=<br />
<br />
*'''ADD_UNSPLASH_LOGIN_BACKGROUND''' ► The background image will be refreshed on every login page refresh. Background image is pulled from the popular open source image website Unsplash. If an already saved static background image exists, then this code will override it (but not delete the saved image). Warning: Using this may allow this external website to steel your login credentials (the value to be put is the URL of the service, exemple<span> </span>: https://source.unsplash.com/random) ► (v10.0)<br />
*'''MAIN_HIDE_POWERED_BY''' ► Hide the "Powered by Dolibarr" picto on public pages<br />
*'''MAIN_APPLICATION_TITLE''' ► This will change the title of software (that appears on the login page by default). Warning: changing this may make Dolibarr version detection to fail by smartphone applications like [[Application Android - DoliDroid]], breaking some features when using Dolibarr from such application. If the text start with a "+", the text will be added to the standard "Dolibarr" label instead of replacing it.<br />
<br />
*'''MAIN_AUTOFILL_DATE''' ► If this constant is defined (to something other than <code>0</code>), the date of invoice, proposal, order or payment are auto-filled with the current date. It is highly recommended to NOT ENABLE this feature. This can create a lot of input errors with data not validated by users. This leads to incorrect values saved in the database causing confusion when you have to do your accountancy reports!<br />
*'''MAIN_AUTOFILL_DATE_PROPOSAL►'''If this constant is defined (to something other than 0), the date of proposal is auto-filled with the current date.<br />
<br />
*'''MAIN_AUTO_TIMESTAMP_IN_PUBLIC_NOTES''' ► Add a timestamp and user automatically when editing the ''public'' note.<br />
<br />
*'''MAIN_AUTO_TIMESTAMP_IN_PRIVATE_NOTES''' ► Add a timestamp and user automatically when editing the ''private'' note.<br />
<br />
*'''MAIN_DEFAULT_PAYMENT_TERM_ID''' ► With ID of a payment term, will use this as default payment term each time you create a new proposal, order, invoice (customer and supplier). Deprecated. Replaced with the default setup feature instead (see French page of wiki for some exemple<span> </span>: [[Paramétrage Valeurs par défaut]])<br />
*'''MAIN_DEFAULT_PAYMENT_TYPE_ID''' ► With ID of a payment type, will use this as default payment type each time you create a new proposal, order, invoice (customer and supplier). Deprecated. Replaced with the default setup feature instead (see French page of wiki for some exemple<span> </span>: [[Paramétrage Valeurs par défaut]])<br />
<br />
*'''MAIN_DEFAULT_LANGUAGE_FILTER''' ► Useful if you do not want to show <code>en_US</code> language option in combo boxes (other languages can easily be removed in <code>langs</code> directory but not <code>en_US</code>) ► (v10.0)<br />
<br />
*'''MAIN_LANGUAGES_ALLOWED''' ► Is a list of languages without spaces, example<span> </span>: <code>fr_FR,en_US,de_DE,it_IT</code> If defined, only those languages will appear in combos. ► (v11.0)<br />
<br />
*'''MAIN_DISABLE_NOTES_TAB''' ► Show or hide notes tab in the card page<br />
<br />
*'''MAIN_DISABLE_CONTACTS_TAB''' ► Show or hide contacts tab in the card page<br />
<br />
*'''MAIN_DISABLE_FULL_SCANLIST''' ► Disables the complete scan of tables to allow the pagination to show total number of pages. May be useful to activate on systems with a very high quantity of data (tables with more than 2 000 000 records).<br />
<br />
*'''MAIN_DISABLE_JQUERY_JNOTIFY''' ► Disable usage of <code>JNotify</code> to show confirm or error messages<br />
<br />
*'''MAIN_DISABLE_AJAX_COMBOX''' ► If you have a large number of third parties or products, you can disable the autocomplete feature on the third parties list by setting this constant to <code>1</code> ► (v3.6.0+)<br />
*'''MAIN_DISABLE_MULTIPLE_FILEUPLOAD''' ► Disable users to upload multiple files at once.<br />
*'''MAIN_DISABLE_TRUNC''' ► Disable all truncings in select list. ► (v7.0+)<br />
<br />
*'''MAIN_DISABLEDRAFTSTATUS''' ► Disable the status "Draft" for some objects (project, donation, ...) so the object is directly created with status "Validated"<br />
<br />
*'''MAIN_DOC_USE_OBJECT_THIRDPARTY_NAME''' ► Add name of thirdparty at begin of generated document.<br />
<br />
*'''MAIN_DOC_USE_TIMING''' ► Add a timestamp at end of generated document. Value must be format of timestamp. For example: <code>%Y%m%d%H%M</code> (only for ODT files)<br />
<br />
*'''MAIN_DOC_UPLOAD_NOT_RENAME_BY_DEFAULT''' ► Disable the auto renaming on upload file ► (v10.0)<br />
<br />
*'''MAIN_DOL_SCRIPTS_ROOT''' ► Define directory who contains 'scripts' directory (e.g. <code>/var/www/dolibarr</code>). Value of this variable may be requested by some external script or tools.<br />
<br />
*'''MAIN_ENABLE_LOG_TO_HTML''' ► If this constant is defined, it is possible to have logs inside pages by adding the parameter <code>&logtohtml=1</code> into URL.<br />
<br />
*'''MAIN_ENABLE_IMPORT_LINKED_OBJECT_LINES''' ► Allow to import lines into current document from "linked" compatible documents ► (v8.0+)<br />
<br />
*'''MAIN_FIRST_TO_UPPER''' ► Dolibarr add uppercase to Third Parties, contacts or members names if not done. Warning: with some languages (whose words with uppercase are not same words, or pagecode does not always have an uppercase, like Cyrillic languages), this feature may alter your data.<br />
<br />
*'''MAIN_ALL_TO_UPPER''' ► Dolibarr puts uppercase for Third Parties, contacts or members names if not done. Warning, with some languages (whose words with uppercase are not same words, or pagecode does not always have an uppercase, like Cyrillic languages), this feature may alter your data. ► (v11.0)<br />
<br />
*'''MAIN_ALL_TOWN_TO_UPPER''' ► Dolibarr puts uppercase for town names if not done. ► (v13.0)<br />
<br />
*'''MAIN_FILESYSTEM_ENCODING''' ► With some PHP versions, PHP is not able to detect the page code for filesystem of the server OS. To solve this, Dolibarr assumes your OS filesystem is <code>UTF-8</code> if on Linux or OSX system, and <code>ISO-8859-1</code> if on Windows. If not, for example on a Windows server with a NTFS <code>UTF-8</code> pagecode, you can set the variable <code>MAIN_FILESYSTEM_ENCODING</code> to "<code>utf-8</code>".<br />
<br />
*'''MAIN_FORCELANGDIR''' ► Relative path of the directory holding your custom <code>langs</code> folder.<br />
*'''MAIN_HTML_TITLE''' ► Can be used to control how the html page title is formatted. If value contains key '<code>noapp</code>', application name will not be output. If value contains '<code>thirdpartynameonly</code>', on tab for thirdparties, only name of thirdparties are output. Value can be list of tags: '<code>noapp;thirdpartynameonly</code>'<br />
<br />
*'''MAIN_HELPCENTER_LINKTOUSE''' ► Define the URL link to use as the target page for link "I need help" onto logon page<br />
<br />
*'''MAIN_LOGOUT_GOTO_URL''' ► URL to which the user will be redirected after LOGOUT<br />
<br />
*'''MAIN_MAXTABS_IN_CARD''' ► Maximum number of tabs visible. Others are grouped into a combo list.<br />
<br />
*'''MAIN_MAXLIST_OVERLOAD''' ► Maximum number of line in space's domain.<br />
<br />
*'''MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING''' ► A warning saying setup of modules is not complete is shown if the number of enabled modules is lower or equal than this value (<code>1</code> if not defined)<br />
<br />
*'''MAIN_NO_CONCAT_DESCRIPTION''' ► Allow to use only input custom description in lines (proposal, order, invoice) ► (v10.0) < v20.0. [ OSBOLETE since 20.0 | SEE Product module admin configuration to set the description behavior of products and services ]. This value is overwritten by PRODUCT_AUTOFILL_DESC, controled by the option in the product module admin configuration, and is no longer used. Kept in code to allow compatibility if custom modules are using it. Removed completely from v22.<br />
<br />
*'''MAIN_OPTIMIZE_SPEED''' ► Use some speed enhancements. See page [[FAQ Increase Performance]] for more information.<br />
*'''MAIN_PASSWORD_FORGOTLINK ►''' Change forgotten password link on login page. ► (v9.0)<br />
<br />
*'''MAIN_PROPAGATE_CONTACTS_FROM_ORIGIN''' ► When creating an order, contract, invoice from another object, specific contacts of objects are set as specific contact of the new object when possible. ► (v4.0+)<br />
<br />
*'''MAIN_PUBLIC_NOTE_IN_ADDRESS''' ► Show public note in address block ► (v4.0+)<br />
<br />
*'''MAIN_REMOVE_INSTALL_WARNING''' ► Remove all security warnings that appear to administrator users if URL <code>/install</code> is public. You should solve the problem if warning occurs, instead of removing the warning! For this, create a file called <code>install.lock</code> into Dolibarr root directory. This will stop the warning but also make the page <code>/install</code> not possible to use, to protect your installation.<br />
<br />
*'''MAIN_REPEATCONTACTONEACHTAB''' ► If added and set to <code>1</code>, this adds contacts on all tabs, not only main tab.<br />
<br />
*'''MAIN_REPLACE_TRANS_xx_XX''' ► Where <code>xx_XX</code> is language code. If value is <code>string1:newstring1;string2:newstring2</code> then replace <code>string1</code> with <code>newstring1</code> in all translation done for language <code>xx_XX</code>.<br />
<br />
*'''MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND''' ► Change way of rounding total including tax of lines, rounding first of after.<br />
<br />
*'''MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND_SUPPLIER'''► Change way of rounding total including tax of lines, rounding first of after.<br />
<br />
*'''MAIN_SERVER_TZ''' ► If you can't set the time zone of your PHP installation, set this constant. Better is to set it to UTC. In future, this constant will be forced to '<code>UTC</code>' so PHP server time zone will not have effect any more. Examples: <code>Europe/Paris</code>, <code>auto</code>. Dolibarr will apply the timezone before saving dates in the database. Meaning that if you remove the parameter the dates saved will not change back to UTC.<br />
<br />
*'''MAIN_SEARCH_FORM_ON_HOME_AREAS''' ► Show the search form on home page areas for core modules (Removed after v5 due to global search combo) ► (v6.0+)<br />
<br />
*'''MAIN_SEARCHFORM_SUPPLIER_INVOICE_DISABLED''' ► Disable the supplier invoice on the search form<br />
<br />
*'''MAIN_SEARCH_DIRECT_OPEN_IF_ONLY_ONE''' ► If only one result is found, then setting this value to <code>1</code> will take you direct to the item (default method). Setting the value to <code>0</code> will show the result in the list as a single result ► (v5.0+)<br />
<br />
*'''MAIN_SERVICES_ARE_ECOMMERCE_200238EC''' ► If seller and buyer are in Europe and buyer is not a company, use the VAT of buying country. It can have value '1' or '2'. If value 2, the VATs available to select only the ones of buying country. If '1', the VATs available to select mix the ones of selling country and the ones of buying country. ► (v18.0+)<br />
<br />
*'''MAIN_SHOW_TUNING_INFO''' ► Add tuning information into JavaScript console. Better when xdebug is enabled.<br />
<br />
*'''MAIN_SHOW_TECHNICAL_ID''' ► Show also technical IDs on elements cards or some lists (not supported everywhere).<br />
<br />
*'''MAIN_SHOWDATABASENAMEINHELPPAGESLINK''' ► Show database name in upper help menu ► (v8.0+)<br />
<br />
*'''MAIN_USE_ALTERNATE_TRANSLATION_FOR''' ► List of fields per object that need an alternate translation. Example: <code>MAIN_USE_ALTERNATE_TRANSLATION_FOR=societe:name,town;contact:firstname,lastname</code><br />
<br />
*'''MAIN_USE_HOURMIN_IN_DATE_RANGE''' ► On all entities lines (invoice, order, contract...), it is possible to add hour and minutes with date on fields "date start" and "date end".<br />
<br />
*'''MAIN_USE_JQUERY_JEDITABLE''' ► Allow to update from screen, directly into database, some properties of elements (invoices, proposals, ...) using Ajax. This make response time faster, but avoid using this feature, because it bypasses some business actions (updates on other data that should be done consistently) and ignores business controls on data you saved. Consequently this feature breaks consistency of data and possibly the stability of the software.<br />
<br />
*'''MAIN_USE_JQUERY_MULTISELECT''' ► Allow to use Ajax when a choice that require multiselect is used (for the moment only external modules uses select box with multiselect values). Set the value to the jQuery plugin name to use (multiselect, multiple-select, select2…). Setting it to any other value will result in unwanted side-effects and/or bugs.<br />
<br />
*'''MAIN_USE_OLD_SEARCH_FORM''' ► Display the old search form in left menu.<br />
<br />
*'''MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS''' ► Allow to force the VAT rate to a given value (instead of higher VAT rate of country) if the VAT rate of product was not defined.<br />
<br />
*'''MAIN_UNKNOWN_CUSTOMERS_ARE_COMPANIES''' ► If we can't guess if a thirdparty is a company or individual (not VAT ID fill, no Prof ID fill, no type of thirdparty fill), then we suppose it is a company (B2B business) if 1, we suppose it is an individual (B2C business) if 0.<br />
<br />
*'''MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL''' ► For intra CEE sales, we use by default, on proposal, order or invoice creation, a 0 VAT for customers that are companies (see MAIN_UNKNOWN_CUSTOMERS_ARE_COMPANIES to change behaviour to know if a thirdparty is a company or an individual). But if the option MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL is set, we will use the 0 VAT only if a VAT ID is defined for the customer.<br />
<br />
*'''MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC''' ► For to use the default VAT of product for individual customers that are out E.E.C. (European Economic Community) ► (v7.0+). ''There is no reason to use this.''<br />
<br />
*'''MAIN_VIEW_LINE_NUMBER''' ► Shows a line number for each line of products/services at documents like proposal / order / invoice. Only on screen, not on PDF.<br />
<br />
*'''MAIN_VIEW_LINE_NUMBER_IN_LIST''' ► Shows a line number in lists ► (v12.0)<br />
<br />
*'''MAIN_VOLUME_DEFAULT_ROUND''' ► Accuracy of volume (number of decimals)<br />
<br />
*'''MAIN_VOLUME_DEFAULT_UNIT''' ► Default unit for weight (<code>0=kg</code>, <code>-3=g</code>, ...)<br />
<br />
*'''MAIN_WEIGHT_DEFAULT_ROUND''' ► Accuracy of weight (number of decimals)<br />
<br />
*'''MAIN_WEIGHT_DEFAULT_UNIT''' ► Default unit for weight (<code>0=kg</code>, <code>-3=g</code>, ...)<br />
<br />
*'''USER_HIDE_INACTIVE_IN_COMBOBOX''' ► Disable display inactive users in combobox.<br />
<br />
*'''MAIN_DISABLE_PDF_THUMBS''' ► Disable thumbs PDF in case of imagick bug<br />
<br />
*'''MAIN_KEEP_REF_CUSTOMER_ON_CLONING''' ► Keep the Customer Reference on cloned object (Propal/Invoice)<br />
<br />
*'''MAIN_DONT_KEEP_NOTE_ON_CLONING''' ► Remove the object notes during cloning ► (v11.0)<br />
<br />
*'''MAIN_DOC_SORT_FIELD''' ► Set the default sorting field on document page (name by default) ► (v11.0)<br />
<br />
*'''MAIN_DOC_SORT_ORDER''' ► Set the default sorting order (ASC or DESC) on document page (ASC by default) ► (v11.0)<br />
<br />
*'''MAIN_USE_ZIPTOWN_DICTIONNARY''' ► Use dictionary ZIP for create card.<br />
<br />
*'''MAIN_USE_TOP_MENU_SEARCH_DROPDOWN''' ► Show search in top menu with theme eldy ► (v11.0)<br />
<br />
*'''MAIN_PHONE_SEPAR''' ► Separ phone number other space ► (v12.0)<br />
<br />
*'''GRAPH_USE_FISCAL_YEAR''' ► Widgets uses fiscal year<br />
<br />
*'''SHOW_SOCINFO_ON_PRINT''' ► Permit to add user company information on each printed document (when click on Dolibarr print button) ► (v12.0)<br />
<br />
*'''MAIN_FEATURES_LEVEL''' ► Level of features to show: <code>-1=stable+deprecated</code>, <code>0=stable only (default)</code>, <code>1=stable+experimental</code>, <code>2=stable+experimental+development</code><br />
<br />
*'''MAIN_SHOW_TECHNICAL_ID''' ► Show technical id for object.<br />
<br />
*'''MAIN_HTTP_CONTENT_SECURITY_POLICY''' ► Allows you to fill in the content security rules ► (v6.0)<br />
<br />
*'''SOCIETE_ON_SEARCH_AND_LIST_GO_ON_CUSTOMER_OR_SUPPLIER_CARD''' ► Allow to change the link of the third party to customer/supplier card instead of contact card on List.<br />
<br />
*'''MAIN_MODULE_SETUP_ON_LIST_BY_DEFAULT''' ► If set to "common" the setup module becomes list by defaut<br />
<br />
*'''MAIN_PAGESIZE_CHOICES''' ► Configure select field to choose number of lines displayed on listing (<code>10:10,15:15,20:20,30:30,40:40,50:50,100:100,250:250,500:500,1000:1000,5000:5000</code>).<br />
<br />
*'''MAIN_USE_TOP_MENU_QUICKADD_DROPDOWN''' ► Add a dropdown menu with shortcuts to create new objects ► (v13.0)<br />
<br />
*'''MAIN_EMAILCOLLECTOR_MAIL_WITHOUT_HEADER''' ► Remove the header stored by email collector ► (v13.0)<br />
<br />
*'''MAIN_USE_VAT_OF_PRODUCT_FOR_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID'''<br />
<br />
*'''MAIN_OPTIMIZEFORTEXTBROWSER''' ► Optimise interface for a text only browser. This variable is set to 1 automatically if your browser is lynx or links<br />
<br />
*'''MAIN_NB_OF_YEAR_IN_WIDGET_GRAPH''' ► Set the number of years visible on some graph of some widgets (2 is default value)<br />
<br />
*'''MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION'''<br />
<br />
*'''API_DISABLE_LOGIN_API''' ►(v14.0)<br />
<br />
*'''MAIN_LOGIN_BADCHARUNAUTHORIZED''' ► Add possibility to define bad character unauthorized into login name REGEX expression (Default value is @<>"\') ► (v16.0)<br />
*'''MAIN_SHOW_ALL_FILES_ON_DOCUMENT_TOOLTIP''' ► Add all files visible from the object to be visible from the list of object.<br />
*'''MAIN_LIST_ALLOW_PUBLIC_NOTES''' ► Display public notes on list<br />
*'''MAIN_LIST_ALLOW_PRIVATE_NOTES''' ► Display private notes on list<br />
<br />
*'''MAIN_CHECKBOX_LEFT_COLUMN''' ► Display private check boxes on the left ► (v17.0)<br />
*'''MAIN_STATS_GRAPHS_SHOW_N_YEARS''' ► Nb of years to shows in widget and graph ► (v14.0)<br />
*'''MAIN_HOOK_DEBUG''' ► if >=2 the hook in the logs are more verbose ► (v18.0)<br />
<br />
*'''MAIN_ENABLE_AJAX_TOOLTIP''' ► if 1 the tooltips are updated with AJAX request ► (v18.0)<br />
*'''MAIN_NO_INPUT_PRICE_WITH_TAX''' ► if 1 the TTC input field is removed from propal/invoices/... ► (v17.0)<br />
<br />
*'''MAIN_DISABLE_SELECT2_FOCUS_PROTECTION''' ► if 1 disable the focus protection ► (v17.0)<br />
*'''MAIN_USE_ADVANCED_PERMS ►''' Add advanced user permission<br />
<br />
*'''MAIN_FREE_PRODUCT_CHECKED_BY_DEFAULT ►''' Check "product" or "service" by default on order/invoices/propal cards (set value "product" or "service")<br />
*'''MAIN_LINK_BY_REF ►''' Allow to link documents by choosing the type and ref from the object linked option<br />
<br />
'''Official supported option'''<br />
<br />
The following options are not hidden option. They are available by default from the interface.<br />
<br />
*'''MAIN_ONLY_LOGIN_ALLOWED ►''' Activate maintenance mode and set user that is allowed to login. Value must be user login. Available into menu Home - Admin tools - User session, it is filled with admin user when clicking on button "Block other session".<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Security Options=<br />
<br />
*'''MAIN_SECURITY_ANTI_SSRF_SERVER_IP''' ► Can set a complete list of IPs of server.<br />
<br />
*'''MAIN_SECURITY_CSRF_WITH_TOKEN''' ► Activate a second anti-CSRF protection on POST (so a POST from another web site can't be done). Note there is also a default protection using test on referrer that is not reliable. This second protection uses TOKEN on forms and is more powerful. Value can be: 0=CSRF protection disabled; 1=CSRF protection is on POST URLs only (default from version Dolibarr 15.0+); 2=CSRF protection is required on POST + some GET URL that contains some white listed parameters like the parameter "action" used to request database change (default from version Dolibarr 16+), 3=CSRF protection is enabled on any POST and GET URLs (a valid CSRF token is expected whatever are the parameters, warning: can be enabled on Dolibarr but some external modules developped by thirdparty may not be ready yet with this option)<br />
<br />
*'''MAIN_MODULES_FOR_EXTERNAL''' ► Limit available modules for external users. By default value is '<code>facture,commande,contact,propal,projet,contrat,societe,ficheinter,expedition,agenda</code>'<br />
<br />
*'''MAIN_ALLOW_SVG_FILES_AS_IMAGES''' ► Allow to use SVG file as image files. Warning: This may introduce security vulnerability (javascript can be embedded into SVG file).<br />
<br />
*'''MAIN_RESTRICTHTML_ONLY_VALID_HTML''' ► Refused parameter if value is not a valid HTML content. The content is also sanitized with Tidy.<br />
<br />
*'''MAIN_RESTRICTHTML_ONLY_VALID_HTML_TIDY''' ► Refused parameter if value is not a HTML content validated by Tidy PHP library. The content is also sanitized with Tidy.<br />
<br />
*'''MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES''' ► Sanitize also non standard attributes on HTML content.<br />
*'''MAIN_SECURITY_SALT''' ► A salt string to base the hashing on. 8 strings length recommended.<br />
<br />
*'''MAIN_SECURITY_MAX_IMG_IN_HTML_CONTENT''' ► Maximum number of Images on the HTML content<br />
*'''MAIN_SECURITY_ALLOW_UNSECURED_LABELS_WITH_HTML''' ► Allow HTML tags into products label<br />
<br />
*'''MAIN_SECURITY_FORCERP''' = "strict-origin-when-cross-origin" (default) so browser doesn't send any referrer when going into another web site domain / "same-origin" / "strict-origin"<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Members Module=<br />
<br />
*'''MEMBER_NEWFORM_FORCEMORPHY''' ► Force nature of member set to "phy" for physical or to "mor" for moral ► (v12.0)<br />
*'''MEMBER_ALLOW_CHANGE_OF_TYPE''' ► Member can edit their type on public subscription page ► (v13.0)<br />
*'''ADHERENT_DEFAULT_CREATE_THIRDPARTY''' ► Thirdparty is created when creating a new member ► (v13.0)<br />
*'''MEMBER_SUBSCRIPTION_SUGGEST_END_OF_MONTH''' ► If set to 1, the member subscription end date will be suggested for the end of the month ► (v18.0)<br />
*'''MEMBER_SUBSCRIPTION_SUGGEST_END_OF_YEAR''' ► If set to 1, the member subscription end date will be suggested for the end of the year ► (v18.0)<br />
*'''MAIN_NB_OF_YEAR_IN_MEMBERSHIP_WIDGET_GRAPH''' ► If set, it limits the number of years visible on graph and widgets of membership (empty is default value to show all) ► (v18.0)<br />
*'''MEMBER_NO_SYNC_LINKED_THIRDPARTY ►''' If set, changes to a member will not be synchronized to a linked third party. ► (v23.0)<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Accounting Module=<br />
<br />
*'''ACCOUNTANCY_COMBO_FOR_AUX''' ► Add graphic option for ACCOUNTANCY_COMBO_FOR_AUX. Having this option on may slow down and even freeze the accounting features if you have a very large number of thirdparties ► (v10.0)<br />
*'''ACCOUNTING_DEFAULT_NOT_NOTIFIED_VALIDATION_DATE''' ► Avoid validating the lines with the accountancy export.(1= box unchecked by default / 0 = box checked by default) ► (v14.0)<br />
*'''ACCOUNTING_DEFAULT_NOT_NOTIFIED_EXPORT_DATE''' ► Avoid flagging the lines as exported with the accountancy export.(1= box unchecked by default / 0 = box checked by default) ► (v14.0)<br />
*'''ACCOUNTANCY_USE_PRODUCT_ACCOUNT_ON_THIRDPARTY ►''' Add 2 fields on thirdparty card which allow you to set an account for all sells products and an other for all buying products for this customer ► (v14.0)<br />
*'''ACCOUNTING_MANAGE_ZERO''' '''►''' Allow to manage char 0 in accounting account (if enabled 1 ≠ 10) ► (v14.0)<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Agenda Module=<br />
<br />
*'''AGENDA_ALL_CALENDARS''' ► Change the default view of calendar pages to see all the Agenda's (instead or yours only be default)<br />
<br />
*'''AGENDA_AUTOSET_END_DATE_WITH_DELTA_HOURS''' ► To automatically set end date of event to start date + delta on event creation page.<br />
<br />
*'''AGENDA_DISABLE_LOCATION''' ► Disable location field in action card ► (>=v5.0)<br />
<br />
*'''AGENDA_MAX_EVENTS_DAY_VIEW''' ► Define the maximum number of visible entries for each day in agenda. Default value is 3. Value 0 means no limit.<br />
<br />
*'''AGENDA_USE_EVENT_TYPE''' ► Add a mandatory field "Type" when creating an event ('''''deprecated''''').<br />
<br />
*'''MAIN_ADD_EVENT_ON_ELEMENT_CARD''' ► Allow to create an event from a document (proposal, order, invoice)<br />
<br />
*'''AGENDA_SUPPORT_PRIORITY_IN_EVENTS''' ► Allow to have priorities in events ► (>=v13.0)<br />
<br />
*'''AGENDA_ADDACTIONFORPHONE''' ► Allow you to create a event from phone number ► (=<v12.0) - Need to be fix for (=>v12.0) https://github.com/Dolibarr/dolibarr/issues/22720<br />
<br />
*'''AGENDA_ADDACTIONFOREMAIL''' ► Allow you to create a event from Email ► (=<v12.0) - Need to be fix for (=>v12.0) https://github.com/Dolibarr/dolibarr/issues/22720<br />
*'''MAIN_ACTIONCOM_CAN_ADD_ANY_CONTACT''' ► Allow you to add any contact on events if set at 1a https://github.com/Dolibarr/dolibarr/releases/tag/18.0.0<br />
<br />
<br />
[[#Top|(back to top)]]<br />
=Bank Module=<br />
<br />
*'''BANK_CAN_RECONCILIATE_CASHACCOUNT''' ► Can reconciliate cash accounts ► (v3.8)<br />
<br />
*'''BANK_DISABLE_CHECK_DEPOSIT''' ► Disable check deposit feature<br />
<br />
*'''BANK_ASK_PAYMENT_BANK_DURING_ORDER''' ► Ask bank account during creation of an order<br />
<br />
*'''BANK_ASK_PAYMENT_BANK_DURING_PROPOSAL''' ► Ask bank account during creation of a proposal<br />
<br />
*'''BANK_USE_OLD_VARIOUS_PAYMENT''' ► To allow to enter miscellaneous payments (not covered by other modules) using old method. '''''Deprecated'''''. Entering various payment is preferred ► (<=v12.0).<br />
*'''MAIN_IBAN_IS_NEVER_MANDATORY''' ► IBAN and BIC informations not mandatory. (V15)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=BOM and MO Module=<br />
<br />
*'''ALLOW_USE_KITS_INTO_BOM_AND_MO'''<br />
*'''BOM_SUB_BOM''' ►Allow to add a BOM in another BOM►(v16.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Bookmarks Module=<br />
<br />
*'''BOOKMARKS_SHOW_IN_MENU''' ► Numbers of bookmark entries to be displayed (10 by default)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Inalterable Log Module=<br />
<br />
*'''BLOCKEDLOG_ADD_ACTIONS_SUPPORTED''' ► Can complete list of triggered action that are logged<br />
*'''BLOCKEDLOG_USE_REMOTE_AUTHORITY''' ► URL of the remote authority for the blockchain<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Category-Tags Module=<br />
<br />
*'''CATEGORY_SHOW_COUNTS''' ► Shows nb of object by tags in tag tree<br />
*'''CATEGORY_EDIT_IN_MENU_NOT_IN_POPUP ►''' Display categories menu instead of managing it only from "Tools"<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Contracts=<br />
<br />
*'''CONTRACT_SUPPORT_PRODUCTS''' ► Products are also suggested into module contract.<br />
*'''CONTRACT_ALLOW_EXTERNAL_DOWNLOAD''' ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)<br />
*'''CONTRACT_HIDE_PLANNED_DATE_ON_PDF''' ► allows you to not display dates on pdf files.<br />
*'''CONTRACT_HIDE_REAL_DATE_ON_PDF''' ► allows you to not display dates on pdf files.<br />
*'''CONTRACT_HIDE_PRICE_ON_PDF''' ► allows you to not display price on pdf files.<br />
*'''CONTRACT_HIDE_QTY_ON_PDF''' ► allows you to not quantity dates on pdf files.<br />
*'''CONTRACT_SHOW_SIGNATURE_STATUS_WITH_SERVICE_STATUS''' ► Show signature status in contract card (Sign by all parties).► (v21.0+)<br />
<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Cron module=<br />
<br />
*'''CRON_DISABLE_KEY_CHANGE''' ► When you provide an instance to a customer, you probably also add an entry in the cron of this user so Dolibarr batch and scheduler can work correctly. For security purpose, it may have a security key that is inside the command line into the cron entry and this entry must match the value defined into Dolibarr setup (setup of module 'Scheduled Jobs'). Because, a customer of a Saas platform will probably have no access to edit the cron file, it is also import that he has no way to edit the key into the Dolibarr setup, so the key in the cron command line will always match the key in Dolibarr setup, and the Dolibarr batches will executed without security errors. To be sure, the customer does not change the value, you can set this constant to 1 into the table [[Table_llx_const]].<br />
<br />
*'''CRON_DISABLE_TUTORIAL_CRON''' ► Disable the tutorial about how to install the cron script (on a SaaS hosting, this should be done by the web hosting provider)<br />
<br />
*'''CRON_WARNING_DELAY_HOURS''' ► Set this value to the frequency set for the cron script (so a warning will be shown to user to warn it about max frequency of its scheduled jobs)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Direct Debit Orders=<br />
<br />
*'''WITHDRAWAL_ALLOW_ANY_INVOICE_STATUS''' ► If this option is set, all invoices status (even already paid) may appear on the list of invoices qualified for a direct debit payment. This is the list of invoices with a payment request done, and not linked to a direct debit payment. By default, only "unpayed" invoices are used to avoid to pay twice the same invoice.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br />
=Donation Module=<br />
<br />
*'''DONATION_USE_THIRDPARTIES''' ► If this option is set, a thirdparty field appear on donation forms.<br />
<br />
[[#Top|(back to top)]]<br />
=Email=<br />
<br />
*'''MAIN_COPY_FILE_IN_EVENT_AUTO''' ► Add attachment document on event auto generated by sending email from dolibarr. ► (v6.0+)<br />
<br />
*'''MAIN_EMAIL_USE_LAYOUT'''► Enable the use of predefined layout when writing an email.<br />
<br />
*'''MAIN_MAILFORM_DISABLE_ENTERKEY''' ► Activate JavaScript code to disable the enter key in the MAIL form. ► (>= 8.0.1)<br />
<br />
*'''MAIN_MAIL_DEBUG''' ► Write content with header of last mail into file <code>dolibarr_mail.log</code> into directory <code>dolibarr_main_data_root</code>.<br />
<br />
*'''MAIN_MAIL_DEBUG_ERR_WITH_DATE''' ► Use a different filename (by adding a prefix of date) for each email sent with error when MAIN_MAIL_DEBUG.<br />
<br />
*'''MAIN_MAIL_DEBUG_LOG_WITH_DATE''' ► Use a different filename (by adding a prefix of date) to log each email sent (whatever is result) when MAIN_MAIL_DEBUG.<br />
<br />
*'''MAIN_MAIL_FORCE_FROM''' ► (v19+) Can force the value into the From field of the SMTP header. Note that email sender is always saved into the "Reply-To".<br />
<br />
*'''MAIN_MAIL_ALLOW_SENDMAIL_F''' ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some cases, the sender email must be provided on command line of sendmail with option <code>-f</code>. This option is here to ask Dolibarr to call the function mail of PHP by adding value for the option <code>-f</code>. Note that in most cases, even with sendmail, sender email is correctly managed as it is added in the email technical header. This option is here only for setup or version of sendmail that ask the -f option to be mandatory or for sendmail setup that does not use by default the From of the header email to define the sender (with this option, the from can be forced on command line to avoid to have the from lost by sendmail).<br />
<br />
*'''MAIN_MAIL_SENDMAIL_FORCE_BA''' ► On Linux or BSD system, PHP email function use the command sendmail local to server. In some case, we want to recipient to be provided to sendmail into the email content instead of its command line parameter. For this we must add the -ba parameter to sendmail. This option asks PHP to provide this parameter when sending a mail. Note that another solution is to edit the mail.force_extra_parameters=-ba into <code>php.ini</code> file.<br />
<br />
*'''MAIN_MAIL_NO_FULL_EMAIL''' ► Recipient email and sender are cleaned to be on form "<email>" instead of "Name <email>". This might solve problem of compatibility with very old mailers.<br />
<br />
*'''MAIN_FIX_FOR_BUGGED_MTA''' ► Some MTA agent are bugged and add some CR chars each time they saw a LF. Because Dolibarr emails are forged to be already cleaned, if MTA agent do that, you will send an email with two CR chars. This may result in having recipient not able to read your email. To fix this, add this constant to 1. Dolibarr will then create an email that is not RFC compliant, but because the MTA agent is bugged, the email will be modified and become correct during sending, solving the problem of bad email received. Add this constant to 1 if your recipient experience problems when opening email for example users using webmail of <code>orange.fr</code> or <code>hotmail.com</code>. Note that some users have reported that when using Exim (Exim 4), you must set this parameter to 0. Default value is 1 but may be changed to 0 in future.<br />
<br />
*'''MAIN_MAIL_DO_NOT_USE_SIGN''' ► Do not add user signature at end of suggested pre-defined email<br />
<br />
*'''MAIN_MAIL_FORCE_NOT_SENDING_TO''' ► If en email is defined into this variable, emails will never be sent to this email.<br />
<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_INVOICE''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Invoice'' module.<br />
<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_ORDER''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Order'' module.<br />
<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_PROPAL''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Customer Proposal'' module.<br />
*'''MAIL_FORCE_DELIVERY_RECEIPT_SUPPLIER_PROPOSAL''' ► Set default as "Yes" on requesting delivery receipt when sending email through the ''Supplier Proposal'' module.<br />
<br />
*'''MAIN_EMAIL_SUPPORT_ACK ►''' Restore email acknowledgment checkbox on sending emails. This feature is commonly abandoned by mailers. Active from Dolibarr V17 - see [https://github.com/Dolibarr/dolibarr/blob/33744f74da1a5c20f8aa9950018ab4e549e00205/ChangeLog#L53 changelog]<br />
*'''MAIN_EMAIL_USECCC''' ► 1 = Shows field BCC into email forms, If value is an email = Shows the BCC pre filled with the email value.<br />
<br />
*'''MAIN_MAIL_AUTOCOPY_PROPOSAL_TO''', '''MAIN_MAIL_AUTOCOPY_ORDER_TO''', '''MAIN_MAIL_AUTOCOPY_INVOICE_TO''', '''MAIN_MAIL_AUTOCOPY_SHIPMENT_TO''', '''MAIN_MAIL_AUTOCOPY_..._TO''' ► Email to use as a BCC recipient when sending email for proposal, order or invoice. You can make this value visible by setting MAIN_EMAIL_USECCC (to 1 or to another email, see previous point)<br />
<br />
*'''MAIN_EMAIL_ADD_TRACK_ID''' ► When value is 1 (this is also default value if option is not set): The record "Message-id" added into smtp header includes a tracking id to define where the email was sent from. When value is 2: you send an email from third party card, the sender email is completed with the email source tracking string "+thiXXX" on email (your email will be sent with the "From" that is myname+thi123@mycompany.com). So when user receiving email will make "Answer", email will be sent to myname@mycompany.com but with the tracking id included (into header or into target email), allowing you to know to which third party or object, the email exchange is related to.<br />
<br />
*'''MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL''' ► Restrict sending of 1 email message to <code>x</code> recipients for same email message (x for To: + CC: + BCC:). If not defined, value is <code>10</code>. Required to fight against spamming that include 1000 recipients in 1 message. Note that '''MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL''', '''MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL''' and '''MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL''' are also available.<br />
<br />
*'''MAIN_MAIL_FORCE_CONTENT_TYPE_TO_HTML''' ► Force to send all email (event with text only content) as HTML formatted email.<br />
<br />
*'''MAIN_MAIL_USE_MULTI_PART''' ► Forge email content using an alternate text part ► (for 5.0.2+). By default with 6.0+<br />
*'''MAIN_INFO_SOCIETE_MAIL_ALIASES''' ► add address aliases for the from field on mail. Set his value with "Firstname Name <firstname.lastname@mydomain.tld, Otherfirstname OtherlastName <othermail@mydomain.tld>,..." ► (v5.0.0+)<br />
<br />
*'''MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS''' ► If images were stored into the medias directory from CKEditor, then images into emails are replaced with "inline content". This may increase seriously risk of being detected as SPAM.<br />
<br />
*'''MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS''' ► (A better name of this option should be MAIN_EXTERNAL_MAIL_CLIENT_IP_ADDRESS). Set here the list of IPs where your Dolibarr instances are hosted. You can also set the URLs where to get the IP addresses, for exemple: "https://ipv4.urltoshowip.com/_service_showmyip.php,https://ipv6.urltoshowup.com/_service_showmyip.php. So when your customer go into the setup area of email:<br />
**If he chose mail method, a message will explain him how to setup its SPF record for its email domain (showing the list of IP). This is to avoid to have its emails, sent from its Dolibarr instance, fails due to strict antispam rule of some emailing servers.<br />
**If he chose smtp method, a message will explain him the list of IP he can use if there is restriction on IP by the SMTP agent. If you also need to add a message to help SPF setup, see option '''MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD'''.<br />
<br />
*'''MAIN_IMAP_USE_PHPIMAP''' ► Use embedded PHP-imap library (not using the native php imap) instead of native php imap extension ► (v17.0+, available as official option in setup of emailcollector by default from v19)<br />
<br />
*'''MAIN_MAIL_ENABLED_USER_DEST_SELECT''' ► Show also internal users into list of recipients of email in email sending form ► (v8.0+)<br />
<br />
*'''MAIL_PREFIX_FOR_EMAIL_ID''' ► Prefix for the mails ID. Default value is <code>$_SERVER["SERVER_NAME"]</code> ► (>= 8.0.1)<br />
*'''MAIL_MASS_ACTION_SEARCH_MOST_RECENT_FILE_IF_NOT_FOUND''' ► When sending an email from a mass action. If the path saved in DB does not point to an existing file, then search for the most recent file and use it as an attahcment.► (>= 24.0.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=SMS= <br />
<br />
*'''MAIN_SMS_DEBUG''' ► Write content of SMS sent into file <code>dolibarr_sms.log</code> into directory <code>dolibarr_main_data_root</code>.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Emailing Module=<br />
<br />
*'''MAILING_PREFIX_FOR_EMAIL_ID''' ► Set the value that will be used to compose the "Email ID" into email headers. If you set this value to '<code>SERVER_NAME</code>', the virtual host of web server will be used. By default, this is not defined, so a hash key, unique to each instance, is used.<br />
<br />
*'''MAILING_NO_USING_PHPMAIL''' ► If set, the module emailing can't be used with mail setup of "phpmail". Using a thirdparty SMTP server is required. You can complete warning message by adding an email to contact for setup help with constant <code>'''MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS'''</code>.<br />
<br />
*'''MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS''' ► Contains the email of contact to show into the message visible to a user when he try to use emailing module without SMTP server and if option '''MAILING_NO_USING_PHPMAIL''' is set to on.<br />
<br />
*'''MAILING_LIMIT_WARNING_PHPMAIL''' ► Show a warning message (var contains the '''message to show''', or '''translation key''') on emailing send form if setup is on "phpmail". Note: The application always try to translate the message considering the message is a translation key, before showing the translation or message if translation was not found.<br />
<br />
*'''MAILING_LIMIT_WARNING_NOPHPMAIL''' ► Show a warning message (var contains the '''message to show''', or '''translation key''') on emailing send form if setup is something else than "phpmail". Note: The application always try to translation the message considering the message is a translation key, before showing the translation or message if translation was not found.<br />
*'''EMAILING_USE_ADVANCED_SELECTOR''' ► Enable the advanced selector for recipients.<br />
<br />
*'''MAILING_LIMIT_SENDBYWEB''' ► Restrict number of emails you can send in same sending session with emailing module from GUI. The value "<code>dolibarr_mailing_limit_sendbyweb</code>" if defined into config file is used in priority for this limit. A negative value means, sending by web is forbidden.<br />
<br />
*'''MAILING_LIMIT_SENDBYCLI''' ► Restrict number of emails you can send in same sending session with emailing module from CLI script. The value "<code>dolibarr_mailing_limit_sendbycli</code>" if defined into config file is used in priority for this limit.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Expense Report=<br />
<br />
*'''EXPENSEREPORT_ALLOW_OVERLAPPING_PERIODS''' ► Can enter several expense reports on same or overlapping date periods. ► (v7.0+)<br />
<br />
*'''EXPENSEREPORT_OVERRIDE_VAT''' ► Setting this constant to 1 will allow expense reports to show VAT even if the global VAT setting is off ► (v10.0)<br />
<br />
*'''EXPENSEREPORT_USE_OLD_NUMBERING_RULE''' ► The module Expense Report use numbering rules that you can setup (like other modules do). If you need to keep the hard-coded numbering rule of expenses report used in v6.0 set this constant to 1 ► (>=v7.0+)<br />
<br />
*'''MAIN_USE_EXPENSE_IK''' ► This feature allows you to set index kilometres against a mileage index for different types of vehicles. ► (v7.0+)<br />
<br />
*'''MAIN_USE_EXPENSE_RULE''' ► This feature allows you to set a variety of rules per user/group/all so they can only create reports within their limits. ► (v7.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Export Module=<br />
<br />
*'''EXPORT_CSV_SEPARATOR_TO_USE''' ► String value to use as default separator to delimit fields of exported files (by default Dolibarr uses "<code>,</code>"). Example: EXPORT_CSV_SEPARATOR_TO_USE=<code>;</code><br />
<br />
*'''EXPORT_CSV_FORCE_CHARSET''' ► Choose the charset used in the output file built by the CSV exporter. By default it is ISO-8859-1. Example: EXPORT_CSV_FORCE_CHARSET= <code>utf-8</code><br />
<br />
*'''EXPORTTOOL_CATEGORIES''' ► Can export categories (several lines) into one column with the "product export profile"<br />
<br />
*'''USE_STRICT_CSV_RULES''' ► Use strict/real CSV format for export. Do not clean/replace CR+LF with '\n' but quote them using the escaping CSV char (<code>"</code>).<br />
*'''EXPORTS_SHARE_MODELS''' ► Share export models between users.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br />
=Foundation Module=<br />
<br />
*'''MEMBER_URL_REDIRECT_SUBSCRIPTION''' ► Link called and shown when a member account is autocreated in member module by a guest user.<br />
<br />
*'''MEMBER_EXT_URL_SUBSCRIPTION_INFO''' ► Link of external page pointed by the "Show here" link added in front of payment cell, into the page to make online subscription.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
=Holiday Module=<br />
<br />
*'''HOLIDAY_HIDE_BALANCE''' ► Hide the user's vacation balance on the vacation request page<br />
<br />
[https://wiki.dolibarr.org/Setup_Other#Top (back to top)]<br />
=Interventions Module=<br />
<br />
*'''FICHINTER_CLASSIFY_BILLED'''► Allow to classify an intervention card as "Billed". This add also trigger <code>FICHINTER_CLASSIFY_BILLED</code> into list of possible automatic event into agenda.<br />
<br />
*'''FICHINTER_DISABLE_DETAILS'''► Disable entry of detail lines on intervention. Can validate with no line. Only one line will be shown per intervention on list.<br />
**If set to <code>2</code> details are disabled only on intervention list ► (v21.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Invoice Module=<br />
<br />
*'''MAIN_DEPOSIT_MULTI_TVA''' ► In deposits invoice, creates one line per VAT rate from the origin document ► (6.0)<br />
*'''PDF_INVOICE_SHOW_PRICE_INCL_TAX''' ► In customer's invoice, add a column with the total including all taxes ►<br />
<br />
*'''INVOICE_ALLOW_REUSE_OF_CREDIT_WHEN_PARTIALLY_REFUNDED''' ► If a credit note was partially refunded (a refund was sent to the customer), with common situation, we wait to have the remain refunded too. With this option, it is possible to convert the remain of invoice into a discount to reuse it into another invoice.<br />
<br />
*'''SUPPLIER_INVOICE_ALLOW_REUSE_OF_CREDIT_WHEN_PARTIALLY_REFUNDED''' ► See INVOICE_ALLOW_REUSE_OF_CREDIT_WHEN_PARTIALLY_REFUNDED, but for supplier credit notes.<br />
<br />
*'''INVOICE_CAN_BE_EDITED_EVEN_IF_PAYMENT_DONE''' ► Allow to edit invoices even if payment was started. Note: If the module "BlockedLog" is active (required in some countries for legal reasons), this will not change content of archived logs tracked by this module. By definition there is no way to change or remove archived records. It will just update data in your application and a new record to track your change will be recorded into the archive log.<br />
<br />
*'''INVOICE_CAN_ALWAYS_BE_REMOVED''' ► Allow to always delete invoices (even if invoice is not last one). Note: If the module "BlockedLog" is active (required by some countries for legal reason), this will not change content of archived logs tracked by this module. By definition there is no way to change or remove archived records. It will just update data in your application and a new record to track your change into the read-only archive log.<br />
<br />
*'''INVOICE_CAN_NEVER_BE_EDITED''' ► Never allow to edit invoices (except draft invoices with ref like (PROV%)). See also INVOICE_CAN_NEVER_BE_REMOVED.<br />
<br />
*'''INVOICE_CAN_NEVER_BE_REMOVED''' ► Never allow to delete invoices (except draft invoices with ref like (PROV%)). See also INVOICE_CAN_NEVER_BE_EDITED<br />
<br />
*'''INVOICE_POSITIVE_CREDIT_NOTE''' ► All amounts on PDF credit notes are positive.<br />
<br />
*'''FACTURE_DEPOSITS_ARE_JUST_PAYMENTS''' ► An old way to create initial payment. This treats deposit invoices as a special case and not as legal deposit invoice. Deposit invoices don't get counted on turnover. They are then applied as a payment, like a discount, on the final invoice. By default, when you include the deposit into draft of final invoice, the amount of final invoice is reduced. With this option, final amount is not reduced but a payment is registered. WARNING: In a lot of european countries, using this option is not allowed.<br />
<br />
*'''FACTURE_SENDBYEMAIL_FOR_ALL_STATUS''' ► Can send invoice by email to customer even if invoice has status "draft".<br />
<br />
*'''INVOICE_CREDIT_NOTE_STANDALONE''' ► Start implementation to allow a credit note even without invoice (dangerous) ► (v3.9)<br />
<br />
*'''INVOICE_USE_SITUATION''' ► 1=Enable the "situation invoice" feature. Warning, this feature is bugged and may not be compatible with the final version of the feature once the bug will be solved. Also, using the double-entry accountancy module is not possible when this option is on (due to the same design problem). 2=Enable the "situation invoice" feature with a rewrite. This mode should be better to become a future stable feature.<br />
<br />
*'''INVOICE_USE_SITUATION_CREDIT_NOTE''' ► Enable the "situation credit note" feature (need <code>INVOICE_USE_SITUATION</code>) ► (v8.0)<br />
*'''INVOICE_USE_RETAINED_WARRANTY''' ► Enable the retained warranty on invoice ► (v14.0)<br />
<br />
*'''INVOICE_DISABLE_DEPOSIT''' ► Disable deposit invoices<br />
<br />
*'''INVOICE_DISABLE_REPLACEMENT''' ► Disable replacement invoices<br />
<br />
*'''INVOICE_DISABLE_CREDIT_NOTE''' ► Disable credit notes<br />
<br />
*<bdi>'''INVOICE_ADD_EXTRAFIELD_IN_NOTE''' ► Add extrafields in note for canelle template ► (v17.0+)</bdi><br />
<br />
*'''INVOICE_DEFAULT_NOTE_PUBLIC''' <bdi>► Default text in public note</bdi><br />
<br />
Note: To decode a QR image of a ZATCA code: https://www.onlinebarcodereader.com/. You can also use the mobile application https://play.google.com/store/apps/details?id=com.posbankbh.einvoiceqrreader&gl=FR<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT''' ► See PDF option<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT_COLUMN''' ► See PDF options<br />
<br />
*'''WORKFLOW_BILL_ON_SHIPMENT''' ► Change label of button with suitable label when you need to create invoice on shipments<br />
<br />
*'''INVOICE_ALLOW_EXTERNAL_DOWNLOAD''' ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. Use the tag __DIRECTDOWNLOAD_URL_INVOICE__ in email template to insert it. ► (v7.0+)<br />
<br />
*'''INVOICE_POINTOFTAX_DATE''' ► Add Point of Tax Date on invoices for country-specific legality reasons ► (v4.0+)<br />
*'''FACTURE_ENABLE_NEGATIVE''' ► Can validate an invoice when amount is negative<br />
<br />
*'''FACTURE_ENABLE_NEGATIVE_LINES''' ► Allows to add negative lines to an invoice ► (v8.0.2+)<br />
*'''SUPPLIER_INVOICE_ENABLE_NEGATIVE''' ► Can validate an supplier invoice when amount is negative ► (V21 ?)<br />
*'''SUPPLIER_INVOICE_ENABLE_NEGATIVE_LINES''' ► Allows to add negative lines to an supplier invoice ► (V21 ?)<br />
<br />
*'''INVOICE_USE_DEFAULT_DOCUMENT''' ► Allow user to select a default invoice documents models according to invoice type. On invoice create page, the model is dynamically changed on invoice type selection. ► (v9.0+)<br />
<br />
*'''FACTURE_REUSE_NOTES_ON_CREATE_FROM''' ► Reuse the Public Note and Private note of the previous object (Proposal,...) when creating the bill.<br />
*'''FACTUREFOURN_REUSE_NOTES_ON_CREATE_FROM''' ► Reuse the Public Note and Private note of the previous object when creating the supplier bill ► (V13.0)<br />
*'''MAIN_SHOW_FACNUMBER_IN_DISCOUNT_LIST''' ► Display the reference of credit notes in discount list when creating the bill.<br />
*'''INVOICE_ALLOW_FREE_REF''' ► Capability to change reference of an invoice. This will be possible as long as the invoice has the status “Draft” and only if your country is not in Europe(V11)<br />
<br />
*'''INVOICE_DISALLOW_REOPEN'''<br />
<br />
*'''INVOICE_MAX_FUTURE_DELAY''' ► Numbers of seconds allowed for billing in the future ► (V14.0)<br />
*'''INVOICE_AUTO_NEXT_MONTH_ON_LINES''' ► Increase start date and end date by one month, if an invoice line is a clone of a time based service AND if this services started on the first day of month and ended on the last day of month ► (V13.0.1)<br />
*'''INVOICE_KEEP_DISCOUNT_LINES_AS_IN_ORIGIN''' ► Does not change a line with a negative price into an absolute discount when creating an invoice ► (V16 ?)<br />
*'''INVOICEREC_SET_AUTOFILL_DATE_START''' and '''INVOICEREC_SET_AUTOFILL_DATE_END ►''' Set start and end date to yes for lines of template invoice when created from a draft invoice ► (V16)<br />
*'''INVOICE_REC_DATE_TO_YES''' '''►''' Set start and end date to yes by default in add line form for template invoice ► (V16)<br />
*'''INVOICE_SUBTYPE_ENABLED''' ► Extends Dolibarr standard invoice with more invoice types used in some countries. A combo box in the new invoice creation card allows the selection of "subtypes" with values from dictionary "Invoice Subtypes" ► (v19.0+)<br />
*'''LIST_OF_QUALIFIED_INVOICES_LIMIT_DEFINED''' '''►''' Perf options to limit list of invoices for "credit note" source (on form "create a credit note"), usable for big quantities of invoices for one customer like you can have with TakePos ► (V22+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Leave=<br />
<br />
*'''MAIN_NON_WORKING_DAYS_INCLUDE_SATURDAY''' ► Set this value to 0 if you want to have the Saturday as a working day<br />
*'''MAIN_NON_WORKING_DAYS_INCLUDE_SUNDAY''' ► Set this value to 0 if you want to have the Sunday as a working day<br />
<br />
=Look or Theme=<br />
<br />
*'''MAIN_FAVICON_URL''' ► favicon url<br />
<br />
*'''MAIN_EASTER_EGG_COMMITSTRIP''' ► Show a comic image from the CommitStrip website. Images are refreshed daily. ► (v6.0+)<br />
<br />
*'''MAIN_INCLUDE_GLOBAL_STATS_IN_OPENED_DASHBOARD''' ► This conf will auto remove global stats box item if there are already in the new dashboard of opened elements and keep displayed stats on the opened item box (not only on mouse over) ► (v11.0+)<br />
<br />
*'''MAIN_USE_TOP_MENU_SEARCH_DROPDOWN''' ► Actually only for eldy theme, this conf move search input to top menu and use new design too ► (v11.0+)<br />
<br />
*'''THEME_AGRESSIVENESS_RATIO''' ► This conf can be used to increase/decrease aggressiveness of colors. Value 0 is medium, value is between -100 (light grey colors) to +100 (very flashy colors) ► (v11.0+)<br />
<br />
*'''THEME_SHOW_BORDER_ON_INPUT'''<br />
*'''MAIN_DISABLE_GLOBAL_WORKBOARD''' ► Hide the work board of the main page ► (v13.0+)<br />
*'''MAIN_DISABLE_GLOBAL_BOXSTATS''' ► Hide the Statistic Box of the main page<br />
*'''ALLOW_THEME_JS ►''' Allow JS file in theme folder (same name as theme folder)<br />
<br />
<br /><br />
<br />
=Manifest (Progressive Web App)=<br />
<br />
*'''MAIN_MANIFEST_APPLI_THEME_COLOR ►''' Theme color for manifest<br />
*'''MAIN_MANIFEST_APPLI_BG_COLOR ►''' Background color for manifest<br />
*'''MAIN_MANIFEST_APPLI_LOGO_URL ►''' Logo for manifest<br />
*'''MAIN_MANIFEST_APPLI_LOGO_URL_SIZE ►''' Logo url size for app (150, 192, 512px) missing 3 configurations<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Order Module=<br />
<br />
*'''MAIN_MASSACTION_CREATEBILLS_REDIRECT_IF_ONE''' ► If set 1, redirects to the one bill created from massaction create bills from order list ► (v20.0)<br />
<br />
*'''MAIN_MASSACTION_CREATEBILLS_REDIRECT_IF_MANY''' ► If set to 1, redirects to the invoice list after plural invoices where generated from tho massaction create bills from order list ► (v20.0)<br />
<br />
*'''MAIN_ORDERLIST_CREATEBILLS_ONEBYTHIRD''' ► Allow defining value for option "one by thirdparty" in massaction create bills from orders list page (no by default, yes if set to 'yes' or 1) ► (v20.0)<br />
<br />
*'''MAIN_USE_PROPAL_REFCLIENT_FOR_ORDER''' => Copy customer reference from proposal to order. ► (v7.0+)<br />
<br />
*'''ORDER_REQUIRE_SOURCE''' => Make the input field "Source of order" mandatory.<br />
<br />
*'''ORDER_VALID_AFTER_CLOSE_PROPAL''' => When an order is created on a proposal close, the order is directly defined with status "Validated".<br />
<br />
*'''ORDER_ALLOW_EXTERNAL_DOWNLOAD''' => When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)<br />
<br />
*'''ORDER_ENABLE_NEGATIVE''' => Can validate an order when amount is negative<br />
<br />
*'''THIRDPARTY_PROPAGATE_EXTRAFIELDS_TO_ORDER''' => Copy also extrafields from thirdparty to order (if name match). ► (v11.0+)<br />
*'''ORDER_DEFAULT_NOTE_PUBLIC''' ► Default text in public note<br />
*'''MAIN_REMOVE_DROPDOWN_CREATE_BUTTONS_ON_ORDER''' => Remove the create dropdown button on order card (introduce on v19) to come back with old buttons. '''►''' (v20.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=PDF Options=<br />
<br />
*'''MAIN_ADD_PDF_BACKGROUND''' ► Define this constant with short name of a PDF file (example "<code>mypdf.pdf</code>") that must be saved into directory "<code>documents/mycompany</code>". This will add PDF as a background of some of your generated PDF files (proposals,invoices,orders). If you need to concat PDF, see instead [[Module Concat PDF]].<br />
<br />
*'''MAIN_DISABLE_FORCE_SAVEAS''' ► If your browser always asks to save downloaded files on disk (like PDF), try this this option. File may be displayed directly in your browser. Values<span> </span>: 0= Default (file is auto downloaded), 1= For to output the file into the browser tab, 2= For to output the file into a browser tab open with target_blank<br />
<br />
*'''MAIN_DISABLE_PDF_AUTOUPDATE''' ► Disable automatic generation of PDF each time we add/update/delete a product line (we can still build document by clicking on "Generate"). This option may increase interface speed on servers with low CPU.<br />
<br />
*'''MAIN_DISABLE_PDF_COMPRESSION''' ► Disable PDF compression.<br />
<br />
*'''MAIN_DOCUMENTS_WITH_PICTURE_WIDTH''' ► Can change size of picture when hidden option <code>MAIN_GENERATE_PROPOSALS_WITH_PICTURE</code> is used. By default value is <code>20</code>.<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS''' ► Adding the company address at the bottom of the page. Disabled by default<br />
<br />
*'''MAIN_GENERATE_PROPOSALS_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for customer proposals.<br />
*'''MAIN_GENERATE_ORDERS_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for customer orders.<br />
<br />
*'''MAIN_GENERATE_INVOICES_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for customer invoices.<br />
<br />
*'''MAIN_GENERATE_SUPPLIER_PROPOSAL_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for supplier proposals ► (v5.0.3+)<br />
*'''MAIN_GENERATE_SUPPLIER_ORDER_WITH_PICTURE''' ► Include the first image of the product into the line of the generated PDF for supplier orders<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT''' ► Disable VAT on generated documents. like for an association. (Works with crabe template)<br />
<br />
*'''MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT_COLUMN''' ► Hide column with VAT information but only column not total.<br />
<br />
*'''MAIN_INVERT_SENDER_RECIPIENT''' ► Invert sender and recipient in some PDF. Note: This option is set automatically if country if Germany.<br />
<br />
*'''MAIN_ODT_AS_PDF''' ► Activate ODT to PDF conversion. Value can be "libreoffice" or "unoconv". Do not use value '''<nowiki/>'jodconverter'<nowiki/>''' any more, as it is declared deprecated and partly not functional, use value '''<nowiki/>'libreoffice'''' instead, it requires only '''soffice''' (OpenOffice or LibreOffice) installed on server (use '''apt install soffice libreoffice-common libreoffice-writer''').<br />
<br />
If you got this error: javaldx failed! Warning: failed to read path from javaldx with no return to prompt when running soffice --headless -env:UserInstallation=file:"/tmp" --convert-to pdf --outdir xxx ./yyy.odt, check that directory defined into env:UserInstallation parameters exists and is writeable.<br />
<br />
You may also have a look at this page if your server is on Windows: [[Générer automatiquement des documents PDF à partir de fichier ODT avec Doliwamp]]<br />
<br />
*'''MAIN_ODT_AS_PDF_DEL_SOURCE''' ► For ODT generation. If set, then initial behaviour is conserved but ODT file is removed when option to convert it as PDF (see previous) is on. Disabled by default<br />
<br />
*'''MAIN_PDF_FORCE_FONT''' ► To ignore font defined into language file and force usage of a particular font. For example "<code>DejaVuSans</code>".<br />
<br />
*'''MAIN_PDF_FORCE_FONT_SIZE''' ► To force size of font (by default 10). For example "<code>12</code>" ► (v11.0)<br />
<br />
*'''MAIN_PDF_FREETEXT_HEIGHT''' ► Change height of space reserved to output the free text.<br />
<br />
*'''MAIN_PDF_TITLE_BACKGROUND_COLOR''' ► Can define a background color onto title line. Example: <code>220,220,200</code><br />
<br />
*'''MAIN_PDF_USE_LARGE_LOGO''' ► Use the original logo with its higher resolution into the PDF instead of the small thumb. This may lead to very very large PDF !<br />
<br />
*'''MAIN_USE_BACKGROUND_ON_PDF''' ► Define this constant with short name of an image (example "<code>myimage.jpg</code>") that must be saved into directory "<code>documents/mycompany/logos</code>". This will add this background image into your generated PDF files.<br />
<br />
*'''MAIN_USE_COMPANY_NAME_OF_CONTACT''' ► Use contact name and information rather than company<br />
<br />
*'''MAIN_PDF_ADDALSOTARGETDETAILS''' ► If 1, add details of recipient on generated PDFs (email, fax, url and phone). Can be useful in cases where a printed order/invoice etc is given to a delivery driver/courier etc.<br />
<br />
*'''MAIN_TVAINTRA_IN_SOURCE_ADDRESS''' ► Show VAT N° in source address of PDF to comply with legalities in certain countries. Note that VAT number should be already visible in footer of page ► (v8.0.1+)<br />
<br />
*'''MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING''' ► Add optional esign field in pdf propal ► (v8.0+)<br />
<br />
*'''MAIN_PROFID1_IN_SOURCE_ADDRESS''' ► Show Professional ID 1 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID2_IN_SOURCE_ADDRESS''' ► Show Professional ID 2 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID3_IN_SOURCE_ADDRESS''' ► Show Professional ID 3 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID4_IN_SOURCE_ADDRESS''' ► Show Professional ID 4 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID5_IN_SOURCE_ADDRESS''' ► Show Professional ID 5 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''MAIN_PROFID6_IN_SOURCE_ADDRESS''' ► Show Professional ID 6 in source address of PDF to comply with legalities in certain countries ► (v8.0.1+)<br />
<br />
*'''PDF_BANK_HIDE_NUMBER_SHOW_ONLY_BICIBAN''' ► Hide bank number ("code banque/guichet/compte" for France, "sort code/account number" for GB, ...) and keep only BIC/IBAN on PDF.<br />
<br />
*'''PDF_BOLD_PRODUCT_REF_AND_PERIOD''' ► Add more visibility (bold) on product ref and period of service in desc. ► (v12.0)<br />
<br />
*'''PDF_HIDE_PRODUCT_REF_IN_SUPPLIER_LINES''' ► Modify the use/position of Supplier Ref/Internal Ref with the item Label (name) on PDF documents.<br />
<br />
Default (constant not set or Value <code>0</code>): Internal ref followed by supplier ref in brackets."COMPANY-REF-001 (Vendor SKU SUPPLIER-REF-001) - LABEL...".<br />
<br />
Value <code>1</code>: Supplier ref only eg."SUPPLIER-REF-001 - LABEL...".<br />
<br />
Value <code>2</code>: Supplier ref followed by internal ref in brackets. eg."SUPPLIER-REF-001 (InternalRef COMPANY-REF-001) - LABEL...".<br />
<br />
*'''PDF_INCLUDE_ALIAS_IN_THIRDPARTY_NAME''' ► Include alternative/alias name into name on PDF.<br />
<br />
*'''PDF_SECURITY_ENCRYPTION''' ► Encrypt PDF produced by dolibarr. See additional parameters<span> </span>:PDF_SECURITY_ENCRYPTION_RIGHTS (block 'modify' or 'copy') - '''PDF_SECURITY_ENCRYPTION_USERPASS''' - '''PDF_SECURITY_ENCRYPTION_OWNERPASS''' (random if not specified) - '''PDF_SECURITY_ENCRYPTION_STRENGTH''' (0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit) - '''PDF_SECURITY_ENCRYPTION_PUBKEYS''' Array of recipients containing public-key certificates ('c') and permissions ('p') - For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print'))). WARNING: if an 'encrypted PDF' provides a protection against manual change done by mistake, it does NOT provide any protection against modification of your PDF in a security point of view: A protected PDF can still be modified by any advanced PDF editors. Don't forget this: If a software can read the PDF, this software can also rebuild it differently !<br />
<br />
*'''PDF_SHOW_PROJECT''' ► Show project onto PDF (supported on supplier order only for the moment)<br />
<br />
*'''PDF_USE_ALSO_LANGUAGE_CODE''' ► The value of this constant must be a language code ('fr_FR', 'en_US', 'sa_SA', ...). If set, the PDF document will contains both language (default and the one defined by the constant).<br />
*'''DOC_SHOW_FIRST_SALES_REP''' ► Show the sales representant on header (at least on propal azur and rubis template)<br />
*'''MAIN_PDF_DASH_BETWEEN_LINES'''<br />
*<br />
*'''SHOW_SUBPRODUCT_REF_IN_PDF'''<br />
*'''PDF_HIDE_PRODUCT_LABEL_IN_SUPPLIER_LINES''' ► hide product label in supplier order lines (V15+)<br />
*'''SHIPPING_PDF_DISPLAY_AMOUNT_HT''' ► Show HT unit price and HT total price for lines of PDF shipment<br />
<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_FACTURE''' ► To Hide product description in Customer Invoice<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_COMMANDE''' ► To Hide product description in Sales Order<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_ORDER_SUPPLIER''' ► To Hide product description in Purchase Order<br />
*'''MAIN_DOCUMENTS_HIDE_DESCRIPTION_FOR_INVOICE_SUPPLIER''' ► To Hide product description in Vendor Invoice<br />
<br />
*'''PDF_PROPAL_SHOW_PRICE_INCL_TAX''' ► Display price with tax on Proposal(cyan template) (V17+)<br />
*'''PDF_ORDER_SHOW_PRICE_INCL_TAX''' ► Display price with tax on Order(eratosthene template) (V17+)<br />
*'''PDF_INVOICE_SHOW_PRICE_INCL_TAX''' ► Display price with tax on Invoice(sponge template) (V17+)<br />
<br />
*'''PDF_USE_GETALIASNBPAGE_FOR_TOTAL''' ► Display the page number alias<br />
*'''MAIN_PDF_NO_SENDER_FRAME''' ► Do not display the "sender" mention<br />
*'''MAIN_PDF_HIDE_SENDER_NAME''' ► Do not display the sender name<br />
*'''MAIN_PDF_NO_RECIPENT_FRAME''' ► Do not display BillTo<br />
<br />
*'''MULTICURRENCY_SHOW_ALSO_MAIN_CURRENCY_ON_PDF''' ► Show the amount in the 2 currencies on PDF when using the MultiCurrency module<br />
*'''MAIN_PDF_DONOTREPEAT_HEAD ►''' Do not repeat the header of document<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Point of Sale (POS)=<br />
<br />
*'''CASHDESK_SHOW_KEYPAD''' ► Show a mouse key pad into the 'Simple Point of Sale' module.<br />
<br />
*'''POS_ADDON''' ► Set this value to an existing numbering module rule (for example '<code>mod_facture_terre</code>', '<code>mod_facture_mars</code>', ...) to force the numbering module to use for invoice ref definition when invoice is created by the POS. For example setting value <code>POS_ADDON</code> to '<code>mod_facture_terre</code>' will use the numbering module '<code>terre</code>' for invoice generated from POS, whatever is the numbering rule defined into invoice module setup (you can also use POS_NUMBERING_TERRE_FORCE_PREFIX and POS_NUMBERING_MARS_FORCE_PREFIX variable to change the prefix used).<br />
<br />
*'''TAKEPOS_ENABLE_SUMUP''' ► Enable the compatibility of TakePOS with the card reader terminal [https://SumUp.fr SumUp]<br />
*'''TAKEPOS_CAN_FORCE_BANK_ACCOUNT_DURING_PAYMENT''' ► Possibility to force the bank account during the payment in TakePOS ► (v13.0)<br />
*'''TAKEPOS_CONTROL_CASH_OPENING''' ► Control the cash opening<br />
*'''TAKEPOS_NUMPAD_FORCE_PAYMENT_ICONS_LABELS'''<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Products Module=<br />
<br />
*'''CATEGORY_GRAPHSTATS_ON_PRODUCTS''' ► Show graph of products with categories and totals in Products Area screen<br />
<br />
*'''MAIN_PRODUCT_DISABLE_CUSTOMCOUNTRYCODE''' ► Avoid customs code and country of origin to be set as product description when added to Propal/Order/Invoice<br />
<br />
*'''PRODUCT_ADD_TYPE_IN_DOCUMENTS''' ► Add text "Product" or "Service" at beginning of details lines on built PDF documents.<br />
<br />
*'''PRODUCT_DONOTSEARCH_ANYWHERE''' ► When Ajax search is enabled, search is done on criteria anywhere in label of product. By adding this option, search is done only on start of label. This is really faster when you have a huge number of products.<br />
<br />
*'''MAIN_DIRECT_STATUS_UPDATE''' ► Allows you to change the status of the product (''for sale/not for sale for purchase/not for purchase'') directly on the product page via a ''on/off'' switch button. This can be convenient for those who need to quickly disable certain statuses of products without having to go through the editing product page individually. Also can be very useful if used as a filter on the product and product search list. This option doesn't generate a MODIFY trigger, so be careful with external modules. ► (v4.0+)<br />
<br />
*'''MAIN_SEARCH_PRODUCT_BY_FOURN_REF''' ► Allow to search a product by supplier ref in document's add line form. ► (>= 8.0)<br />
<br />
*'''MAIN_DISABLE_FREE_LINES''' ► Disallow using free lines to add line in documents ► (>= 8.0)<br />
<br />
*'''MAIN_SHOW_PRODUCT_ACTIVITY_TRIM''' ► Show Product and Services turnover before for all four quarters tax over recent years recent years on the product area ► (v5.0+)<br />
<br />
*'''PRODUIT_DESC_IN_LIST''' ► Show long description of product/service into lists.<br />
<br />
*'''PRODUCT_DISABLE_PROPAGATE_CUSTOMER_PRICES_ON_CHILD_COMPANIES''' ► Disable propagation of prices per customer from a customer to its child company.<br />
<br />
*'''PRODUCT_DISABLE_PUBLIC_URL''' ► Disable public url in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_STOCK_LEVELS''' ► Disable properties of stock limits and desired optimal value on product ► (v14.0+)<br />
*'''PRODUCT_DISABLE_NATURE''' ► Disable nature in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_WEIGHT''' ► Disable weight in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_PRICES''' ► Disable prices in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_ACCOUNTING''' ► Disable accounting in product card ► (v14.0+)<br />
*'''PRODUCT_DISABLE_SIZE''' ► Disable size in product card.<br />
<br />
*'''PRODUCT_DISABLE_LENGTH''' ► Disable length in product card ► (v4.0+)<br />
<br />
*'''PRODUCT_DISABLE_SURFACE''' ► Disable surface in product card. ► (v4.0+)<br />
<br />
*'''PRODUCT_DISABLE_VOLUME''' ► Disable volume in product card.<br />
<br />
*'''PRODUCT_DISABLE_CUSTOM_INFO''' ► Disable custom info (custom code and country origin) in product/service card.<br />
<br />
*'''PRODUIT_MULTIPRICES_USE_VAT_PER_LEVEL''' ► When option to use price per level/segment is on, this allows to also set a dedicated vat for each price level.<br />
<br />
*'''PRODUIT_CUSTOMER_PRICES_BY_QTY''' ► If price per quantity ► ''Experimental''<br />
*'''PRODUIT_CUSTOMER_PRICES_BY_QTY_MULTIPRICES''' ► If price per quantity and customer ► ''Experimental''<br />
<br />
*'''PRODUCT_LOT_ENABLE_QUALITY_CONTROL''' ► Enable feature (Display fields for life time and quality control duration) for quality control on product and lot<br />
<br />
*'''PRODUCT_MAX_LENGTH_COMBO''' ► Limit the length of the label displayed when adding lines in proposals/invoices/orders<br />
<br />
*'''PRODUCT_MAX_VISIBLE_PHOTO''' ► Show a maximum number of product photos (as thumbnails) on the product main card. Example, setting this constant to '<code>5</code>' will show the first five product photos found on the product card.<br />
<br />
*'''PRODUIT_PDF_MERGE_PROPAL''' ► Enable module Propal merge product PDF<br />
<br />
*'''PRODUCT_USE_OLD_PATH_FOR_PHOTO''' ► Ask dolibarr to check also old path (before 3.7) where photos were stored.<br />
<br />
*'''PRODUCT_USE_UNITS''' ► Add other units on products (Use same dictionary as default unit feature) and propagate this unit on line of documents.<br />
*'''MAIN_EDIT_LINE_ALLOW_ALL_UNIT_TYPE ►''' Allow the selection of other unit types when editing the document line<br />
<br />
*'''RESOURCE_ON_PRODUCTS''' ► Allow to affect resources on products/services ► (v10.0+)<br />
*'''RESOURCE_ON_SERVICES''' ► Allow to affect resources on products/services ► (v10.0+)<br />
*'''PRODUCT_SHOW_ORIGIN_IN_COMBO''' ► Show origin of products when adding lines in proposals/invoices/orders ► (v12.0+)<br />
*'''PRODUIT_ATTRIBUTES_HIDECHILD''' ► Add option hide child if variantes<br />
<br />
*'''PRODUCT_ADD_FORM_ADD_TO''' ► Add a product to a draft proposal/order/invoice, from the product card.<br />
*'''PRODUCT_DISABLE_SELLBY''' ► Hide the Sell by date ► (v13.0+)<br />
*'''PRODUCT_DISABLE_EATBY''' ► Hide the Eat by date ► (v13.0+)<br />
<br />
*'''PRODUCT_DENY_CHANGE_PRODUCT_TYPE''' ► Forbid to change the product type<br />
<br />
*'''PRODUCT_SORT_BY_CATEGORY''' ► Sort the product by categories instead of by ID<br />
*'''PRODUCT_ADD_NET_MEASURE''' ► Support Net Measure in product's card.php (For real weight, volume or piece; needed for some business ie fruits, vegetables....). Note brut value is already available natively, use this option only if you need 2 weights, 2 volumes, ...for each product) ► (v11.0.1+)<br />
*'''PRODUCT_PRICE_BASE_TYPE''' ► value 'TTC' / 'HT' specify the default value of the price (with or without taxes) ► (v16.0.0+)<br />
<br />
*'''PRODUCT_LOAD_EXTRAFIELD_INTO_OBJECTLINES''' ► Load product extrafiled on object lines<br />
<br />
*'''PRODUCT_USE_SUB_COST_PRICES_IF_COST_PRICE_EMPTY'''<span> </span>: Calculate the parent product production price by child prices.<br />
*'''PRODUCT_SEARCH_AUTO_SELECT_IF_ONLY_ONE'''<span> </span>: Set to 0 to disable or 1 to enable (by default) the auto select product behavior in combobox when there is only one result.(v21.0+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Projects Module=<br />
<br />
*'''PROJECT_ALLOW_TO_LINK_FROM_OTHER_COMPANY''' ► Option related to the combo list Project on elements. It is a list of thirdparty IDs. If set, you can link an object to a project owned by one of this thirdparty in the list.<br />
<br />
*'''PROJECT_ALLOW_COMMENT_ON_PROJECT''' ► Add comment feature on a project<br />
<br />
*'''PROJECT_ALLOW_COMMENT_ON_TASK''' ► Add comment feature on project task<br />
*'''PROJECT_ALWAYS_DISCARD_CLOSED_PROJECTS_IN_SELECT''' ► Discards closed projects in every select field. A closed project can't be associated to an object ► (v20.0+)<br />
<br />
*'''PROJECT_CAN_ALWAYS_LINK_TO_ALL_SUPPLIERS''' ► Option related to the combo list Project on elements. Can link a supplier element (vendor proposal, purchase order, vendor invoice, reception, ...) to any project even if object has a different supplier than the one of the project to link to. See also PROJECT_ALLOW_TO_LINK_FROM_OTHER_COMPANY that is different because it allows to define some given thirdparty ID to allow.<br />
<br />
*'''PROJECT_CAN_ALWAYS_LINK_TO_ALL_CUSTOMERS''' ► Option related to the combo list Project on elements. Can link a custom element (proposal, sale order, vendor invoice, shipment, ...) to any project even if object has a different customer than the one of the project to link to.<br />
<br />
*'''PROJECT_CREATE_ON_OVERVIEW_DISABLED''' ► Hide the "create ..." button on the overview pagec<br />
<br />
*'''PROJECT_DISABLE_UNLINK_FROM_OVERVIEW''' ► Enable removing the button from a link in the project overview. ► (>= v8.0.1)<br />
<br />
*'''PROJECT_HIDE_UNSELECTABLES''' ► Hide into select list, all project that we can't select (closed or draft)<br />
<br />
*'''PROJECT_HIDE_TASKS''' ► Hide tasks. For user using project only as an analytics key and not using tasks.<br />
<br />
*'''PROJECT_LIST_SHOW_STARTDATE''' ► Shows start date of projects in project lists.<br />
<br />
*'''PROJECT_LINK_ON_OVERWIEW_DISABLED''' ► Hide the "link to" form on the overview page ► (v4.0)<br />
<br />
*'''PROJECT_SHOW_REF_INTO_LISTS''' ► Add column with project ref into list (with 3.7 list of supplier invoices only, will be expanded to other lists)<br />
<br />
*'''PROJECT_TIME_ON_ALL_TASKS_MY_PROJECTS''' ► Can add time spent on tasks, even if i am not assigned to task (however, task must be a project i am a contact).<br />
<br />
*'''PROJECT_OPEN_ALWAYS_ON_TAB''' ► Set to value 'task', or 'preview' to always open the project on the given tab instead of main tab.<br />
<br />
*'''PROJECT_ELEMENTS_FOR_MINUS_MARGIN'''<br />
<br />
*'''TIMESPENT_ALWAYS_UPDATE_THM''' ► when it's on always check current time of user to update it in task time line ► (v17.0)<br />
<br />
*'''PROJECT_CREATE_NO_DRAFT''' ► when you create project status will be validate ► (v19.0)<br />
<br />
*'''PROJECT_ENABLE_SUB_PROJECT''' ► Add support for parent projects ► (v19.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Proposals Module=<br />
<br />
*'''MAIN_GENERATE_PROPOSALS_WITH_PICTURE''' ► Add a picture of the product (the first one found if there are several) into the generated PDF of proposals. Note that using this will reduce the available width for the product description.<br />
<br />
*'''MAIN_PROPAL_CHOOSE_ODT_DOCUMENT''' ► On setup page, you'll be able to select which ODT document to use when close or cancel proposals.<br />
<br />
*'''MAIN_PDF_PROPAL_USE_ELECTRONIC_SIGNING''' ► add optional esign field in pdf propal ► (v8.0+)<br />
<br />
*'''PROPAL_CLONE_ON_CREATE_PAGE''' ► On the create proposal page, ask if we want to create the proposal by cloning an already existing one. You should use instead the "Clone" button available on existing proposals.<br />
<br />
*'''PROPAL_DISABLE_SIGNATURE''' ► Do no show the box for signature.<br />
*'''PROPAL_SIGNATURE_ON_SPECIFIC_PAGE ►''' Will show the signature on which page you wanted . Set to 1 will show on first page , set to -1 will show on last second page . ( If '''PROPAL_SIGNATURE_ON_ALL_PAGES''' is enabled, the '''PROPAL_SIGNATURE_ON_SPECIFIC_PAGE''' setting will be ignored.)<br />
*'''PROPAL_SIGNATURE_ON_ALL_PAGES ►''' Will show the signature on every pages .<br />
<br />
*'''PRODUIT_PDF_MERGE_PROPAL''' ► When generating the proposal PDF, all PDFs linked to products linked to proposal are also included into final PDF<br />
<br />
*'''PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD''' ► When a PDF is generated, a share key is automatically set so the file can be downloaded using the share key. ► (v7.0+)<br />
<br />
*'''PROPOSAL_AUTO_ADD_AUTHOR_AS_CONTACT''' ► Add Proposal Author as user contact follow proposal<br />
<br />
*'''PROPOSAL_PDF_HIDE_PAYMENTTERM''' ► Do not show the payment term on proposal ► (v11.0+)<br />
<br />
*'''PROPOSAL_PDF_HIDE_PAYMENTMODE''' ► Do not show the payment mode on proposal ► (v11.0+)<br />
<br />
*'''WORKFLOW_PROPAL_CAN_CLASSIFY_BILLED_WITHOUT_INVOICES''' ► Button "Classified Billed" is visible on proposal even if there is no invoice linked to proposal.<br />
*'''PROPAL_REOPEN_UNSIGNED_ONLY''' ► Do not allow reopening of signed (or billed) proposals. (V15)<br />
*'''PROPOSAL_ARE_NOT_BILLABLE''' ► Disable billing button on proposals (V15)<br />
*'''PROPAL_DEFAULT_NOTE_PUBLIC''' ► Default text in public note<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=Services Module=<br />
<br />
*'''SERVICE_ARE_ECOMMERCE_200238EC''' ► If seller and buyer are in Europe and buyer is not a company, use the VAT of buying country. For french speaking people, see also the page [[Loi_européenne_TVA_Vente_à_Distance_VAD_et_e-commerce_BtoC]].<br />
<br />
*'''MAIN_FILL_SERVICE_DATES_FROM_LAST_SERVICE_LINE''' ► (v13.0) On add line form add a button to fill service dates from the last service line<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Shipments=<br />
<br />
*'''STOCK_WAREHOUSE_NOT_REQUIRED_FOR_SHIPMENTS''' ► If set, you can add a shipment line, with no stock source defined. ► (>= 8.0.1)<br />
<br />
*'''SHIPMENT_GETS_ALL_ORDER_PRODUCTS''' ► Add all order lines in shipment, including the one with 0 in quantity<br />
*'''SHIPPING_PDF_HIDE_ORDERED''' ►Hide column quantity ordered on shipment pdf (>=15.0)<br />
*'''STOCK_SUPPORTS_SERVICES''' ►Allow to manage services into warehouse and allow to ship services<br />
*'''SHIPMENT_SUPPORTS_SERVICES''' ►Allow to ship services without stock (>=19.0)<br />
*'''SHIPPING_DISPLAY_STOCK_ENTRY_DATE''' ►Display date entry stock exped and sort in date order (>=19.0)<br />
*'''SHIPMENT_STANDALONE ►'''Create a simple shipment not connected to sales order, stock e.t.c. (>=23.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Stocks=<br />
<br />
*'''SUPPLIER_ORDER_DISABLE_STOCK_DISPATCH_WHEN_TOTAL_REACHED''' ► Disable stock dispatch when total expected was already received<br />
<br />
*'''STOCK_EXCLUDE_VIRTUAL_PRODUCTS''' ► If product is a virtual product, we do not manage stock for it.<br />
*'''STOCK_ALLOW_DELETE_OF_MOVEMENT''' ► Enable massaction option to delete in movements list (be carefull !!).<br />
<br />
*'''ENTREPOT_EXTRA_STATUS''' ► Instead of the 2 status (Closed, Open), a Warehouse has 3 status: Closed, Open (for all movements), Open (for internal movement only). Internal movement only means you can't use the warehouse to make shipment or receptions.<br />
<br />
*'''SUPPLIER_ORDER_STATUS_FOR_VIRTUAL_STOCK''' ► For the calculation of virtual stocks, by default supplier orders with the status 3 (ordered) and 4 (partially received) are used. You can enter the list of statuses to be taken into account separated by commas for this calculation (example: 0,1,2,3)<br />
<br />
*'''STOCK_MOVEMENT_LIST_HIDE_UNIT_PRICE''' ► to hide unit price on some pages (V15+)<br />
<br />
*'''DISABLE_QTY_OVERWRITE''' ► Disable quantity overwrites on inventories ► (v19.0)<br />
*'''MAIN_WAREHOUSE_LIST_DISPLAY_MODE''' ► Change warehouse select list display mode ► (v21.0) (see github pull request [https://github.com/Dolibarr/dolibarr/pull/31013 #31013] for more info)<br />
**0<span> </span>: Default behavior, display parents of warehouse<br />
**1<span> </span>: Display only current warehouse label only<br />
**2<span> </span>: Display last parent warehouse label<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Suppliers Module=<br />
<br />
*'''FOURN_PRODUCT_AVAILABILITY''' ► On the Suppliers price page of the products, activate the supplier product availability. ''This is duplicate feature with delivery_delay introduced with 3.8.''<br />
<br />
*'''RELOAD_PAGE_ON_SUPPLIER_CHANGE''' ► On creation of a supplier order/invoice, reload form with supplier-specific details when supplier is selected from drop-down list.<br />
<br />
*'''SUPPLIER_INVOICE_WITH_PREDEFINED_PRICES_ONLY''' ► Restrict selection of products in supplier invoice to only those with a buying price defined for that supplier. ► (v6.0+)<br />
<br />
*'''SUPPLIER_ORDER_AUTOADD_USER_CONTACT''' ► Add user approving supplier order as a contact automatically.<br />
<br />
*'''SUPPLIER_ORDER_DEFAULT_PAYMENT_MODE_ID''' ► Set the default payment method for suppliers (<code>rowid</code> in table <code>llx_c_paiement</code>).<br />
<br />
*'''SUPPLIER_ORDER_USE_DISPATCH_STATUS''' ► Add a status on each dispatch order line when receiving products from suppliers ► (v4.0+)<br />
<br />
*'''SUPPLIER_ORDER_NO_DIRECT_APPROVE''' ► No button "Validate and Approve". Always do step "Validate" and "Approve" in 2 steps.<br />
<br />
*'''SUPPLIER_ORDER_WITH_PREDEFINED_PRICES_ONLY''' ► Restrict selection of products in supplier order to only those with a buying price defined for that supplier. ► (v6.0+)<br />
<br />
*'''SUPPLIER_ORDER_EDIT_BUYINGPRICE_DURING_RECEIPT''' ► Can modify the buying price used for PMP calculation when making a stock reception on a supplier order. ► (v6.0+)<br />
*'''SUPPLIER_PROPOSAL_WITH_PREDEFINED_PRICES_ONLY''' ► Restrict selection of products in supplier proposal to only those with a buying price defined for that supplier. ► (v6.0+)<br />
*'''SUPPLIER_ORDER_MORE_THAN_WISHED''' ► The supplier order status is set to "Totally received" even if there are more products received than ordered. ► (v15.0+)<br />
<br />
*'''DISPLAY_DISCOUNTED_SUPPLIER_PRICE''' ► Allow to display discounted supplier price when searching product in supplier documents ► (v10.0)<br />
<br />
*'''MAIN_CAN_EDIT_SUPPLIER_ON_SUPPLIER_ORDER''' ► Allow to change the supplier on a draft supplier order ► (v10.0)<br />
<br />
*'''SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD'''<br />
<br />
*'''SUPPLIER_ORDER_CAN_UPDATE_BUYINGPRICE_DURING_RECEIPT''' ► Allow to change price on receipt ► (v19.0)<br />
<br />
*'''SUPPLIER_HIDE_SUPPLIER_OBJECTLINES''' ► Hide the supplier information on objectlines (invoices, etc..) ► (v19.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Third Parties Module=<br />
<br />
*'''COMPANY_AQUARIUM_CLEAN_REGEX''' ► Add a REGEX rule on the third parties names. It applies a regex replacement pattern on generated code if COMPANY_AQUARIUM_CLEAN_REGEX is set. Value must be a regex with parenthesis. The part into parenthesis is kept, the rest removed. For example if COMPANY_AQUARIUM_CLEAN_REGEX = '<code>^..(..)..(.*)</code>' the first char and second char are removed and the char 5 and 6 too ► (>= 8.0.1)<br />
<br />
*'''MAIN_UNKNOWN_CUSTOMERS_ARE_COMPANIES''' ► See in Global options section.<br />
<br />
*'''MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL''' ► See in Global options section.<br />
<br />
*'''SOCIETE_EMAIL_MANDATORY''' ► E-mail is a mandatory field when creating a thirdparty<br />
<br />
*'''SOCIETE_DISABLE_CUSTOMERS''' ► Remove all menu and features related to customers<br />
<br />
*'''SOCIETE_DISABLE_PROSPECTS''' ► Remove all menu and features related to prospects<br />
*'''SOCIETE_DISABLE_PROSPECTSCUSTOMERS ►''' Remove the status "Customer/Prospect" when thirdparties creation or modification<br />
<br />
*'''SOCIETE_DISABLE_STATE''' ► Do not use field "state/province"<br />
<br />
*'''SOCIETE_SORT_ON_TYPEENT''' ► The combo list of "type of third party" is sorted on alphabetical order instead of the field "position" that appears into dictionary instead.<br />
<br />
*'''SOCIETE_ASK_FOR_SHIPPING_METHOD''' ► Shipping method can be predefined on customer card and will be used as default on order creation<br />
*'''SOCIETE_ADD_REF_IN_LIST''' ► Displays the code before the name in the lists ► Value 1 -> Code + name + alias ou Code + name if colone alias 2 -> Code + alias 3 -> Alias<br />
<br />
*'''THIRDPARTY_CAN_HAVE_CATEGORY_EVEN_IF_NOT_CUSTOMER_PROSPECT_SUPPLIER''' ► Possible to add Categories to third parties that are not customer, prospect or supplier.<br />
<br />
*'''THIRDPARTY_DEFAULT_USELOCALTAX1''' ► When creating a new third party, the field "Use second tax" is set to on or off depending on value of this parameter.<br />
<br />
*'''THIRDPARTY_DEFAULT_USELOCALTAX2''' ► When creating a new third party, the field "Use third tax" is set to on or off depending on value of this parameter.<br />
<br />
*'''THIRDPARTY_NOTCUSTOMERPROSPECT_BY_DEFAULT''' ► Do not set status "Customer/Prospect" to "on" when creating a new third party from menu "New third party".<br />
<br />
*'''THIRDPARTY_INCLUDE_PARENT_IN_LINKTO''' ► Search also for elements on parent third party when using the "link to" object feature.<br />
<br />
*'''THIRDPARTY_INCLUDE_PROJECT_THIRDPARY_IN_LINKTO''' ► Search also for elements on third party that own the project of the current element when using the "link to" object feature (if project is owned by a different thirdparty than current one).<br />
<br />
*'''THIRDPARTY_LOGO_ALLOW_EXTERNAL_DOWNLOAD''' ► When a logo is uploaded, a share key is automatically set so the file can be downloaded using the share key.<br />
<br />
*'''THIRDPARTY_SUGGEST_ALSO_ADDRESS_CREATION''' ► Enabled contact creation on third-party create card<br />
*'''THIRDPARTY_QUICKSEARCH_ON_FIELDS''' ► Personalized search criteria ► Example: $conf->global->THIRDPARTY_QUICKSEARCH_ON_FIELDS = 's.nom=ThirdPartyName;s.name_alias=AliasNameShort;s.code_client=CustomerCode'<br />
*'''MEMBER_CAN_CONVERT_CUSTOMERS_TO_MEMBERS''' ► Enabled member creation on third-party create card<br />
*'''SOCIETE_DISABLE_PARENTCOMPANY''' ► Disables attachment to a parent company.<br />
*'''THIRDPARTY_CUSTOMERPROSPECT_BY_DEFAULT''' ► Set the third party to customer by default<br />
*'''THIRDPARTY_SUPPLIER_BY_DEFAULT''' ► Set the third party to supplier by default<br />
*'''THIRDPARTY_CUSTOMERTYPE_BY_DEFAULT''' ► Set the third party type by default (3 = customer & prospect / 2 = prospect / 1 = customer )<br />
*'''CONTACT_DISABLE_PERSONALINFO''' ► Disable Personal data on contact page<br />
*'''SOCIETE_DISABLE_WORKFORCE''' ► Disable work force selector on society page<br />
*'''SOCIETE_SHOW_VAT_IN_LIST''' ► display VAT number in combo list of thirdparties ► (V15+)<br />
*'''THIRDPARTY_DEFAULT_CREATE_CONTACT''' ► When set, a contact is created at the creation of an individual third party ► (v14.0)<br />
<br />
*'''MAIN_SUPPORT_SHARED_CONTACT_BETWEEN_THIRDPARTIES''' ► Able to share contact between several third parties<br />
*'''THIRDPARTY_CUSTOMERCODE_EQUALS_MEMBERREF''' ► When creating third parties out of members, the customer code is set equal to the member Ref. ► (v22.0)<br />
*'''SOCIETE_NO_SYNC_LINKED_MEMBER''' ► If set, changes to a third party will not be synchronized to a linked member. ► (v23.0)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Ticket Module=<br />
<br />
*'''TICKET_SHOW_MESSAGES_ON_CARD''' ►Display all ticket related messages on the main ticket card. ► (>= 10.0)<br />
*'''TICKET_AUTO_ASSIGN_CONTRACT_CREATE''' ►Automatically create a contract linked to the ticket ► (>= 10.0)<br />
*'''TICKET_AUTO_CREATE_FICHINTER_CREATE''' ►Automatically create an intervention linked to the ticket ► (>= 10.0)<br />
*'''TICKET_AUTO_ASSIGN_USER_CREATE''' '''►''' (>= 21.0) 0=No auto assignement, 1=Auto assign current user if no user was set, 2=Auto assign current user even if another user was set.<br />
*'''TICKET_CHECK_NOTIFY_THIRDPARTY_AT_CREATION''' ►Automatically check "notify thirdparty at creation" ( >=16)<br />
*'''TICKETS_MESSAGE_FORCE_MAIL''' ► Pre check email sending on ticket message (>=15)<br />
*'''TICKET_SEND_PRIVATE_EMAIL ►''' Allow a private message to be sent by mail (>=17)<br />
*'''TICKET_LIMIT_VIEW_ASSIGNED_ONLY''' '''►''' Only display tickets assigned to the user<br />
*'''TICKET_ADD_AUTHOR_AS_CONTACT''' '''►''' If set to 1: Automatically adds the author as internal contact. If set to 2: Automatically adds the author as external contact if external user. (>=20)<br />
*'''TICKET_ASSIGN_CONTACT_TO_MESSAGE''' '''►''' If known, the external contact is assigned to the message. (>=19)<br />
*'''TICKET_ALLOW_CLASSIFICATION_MODIFICATION_EVEN_IF_CLOSED''' '''►'''Allow modify ticket classification even if closed. (>=19)<br />
*'''WORKFLOW_TICKET_CLOSE_INTERVENTION''' ►On ticket close, automatically close an intervention linked to the ticket<br />
*'''TICKET_INCLUDE_SUSPENDED_STATUS''' ► Use ticket suspended status (>=19)<br />
*'''TICKET_INCLUDE_LINK_TO_PUBLIC_INTERFACE_IN_MESSAGE''' ► Add a link in bottom of emails sent from ticket page with link to public ticket admin tool (>=22)<br />
<br />
=VAT Report=<br />
<br />
*'''MAIN_INCLUDE_ZERO_VAT_IN_REPORTS''' ► Include lines with VAT to 0% (for "auto-liquidation" in EEC) ► (v8.0.3+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=Website Module=<br />
<br />
*'''WEBSITE_USE_WEBSITE_ACCOUNTS''' ► Add a table and a tab to manage some accounts for websites to a third party<br />
*'''WEBSITE_ALLOW_OVERWRITE_GIT_SOURCE''' ► Add a button to export a website over the GIT sources<br />
*'''WEBSITE_ADD_CSS_TO_BODY''' ► Add a CSS class to the body tag of websites<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=WYSIWYG Editor=<br />
<br />
*'''FCKEDITOR_ENABLE_DETAILS_FULL''' ► Can cut and paste external images (hosted on external server) into description of proposal, orders or invoices. WARNING: PDF generation is not guaranteed with this. Also if the image is removed or renamed by the image hosting service, your proposal, order or invoice will be broken.<br />
*'''FCKEDITOR_ALLOW_ANY_CONTENT''' ► Allow to enter any content. However, this will totally disable content filtering which is one of the most important CKEditor features. You can use this to keep all your tags and attributes in the html content.<br />
*'''FCKEDITOR_ENABLE_SCAYT_AUTOSTARTUP''' ► Allow to activate the SpellCheckAsYouType (SCAYT) plugins of CKEditor i.e an automatic spell checking. The value to activate this option is 1.<br />
*'''MAIN_ALLOW_WYSIWYG_LOCAL_MEDIAS_ON_PRIVATE_NETWORK''' ► By default, you can add medias links (img src or other) into the rich text content editor, but you can't add links like that use a local host like "https://localhost/file". If you set this option to 1, you can.<br />
*'''MAIN_ALLOW_WYSIWYG_EVEN_ON_UNSECURED_EXTERNAL_HTTP_URL''' ► By default, you can add medias links (img src or other) into the rich text content editor, but not if the link is a unsecure "http" url (not https) and your Dolibarr is http. If you set this option to 1, you can.<br />
<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=STRIPE Module=<br />
<br />
*'''STRIPE_FORCE_VERSION''' ► Force the STRIPE version. For Example: "2019-09-09" (v11+)<br />
*'''STRIPE_REUSE_EXISTING_INTENT_IF_FOUND''' ► With this, you will have idempotency key but the payment intention will be reuse and not Generate again (13+)<br />
<br />
[[#Top|(back to top)]]<br />
<br />
=ClickToDial Module=<br />
<br />
*'''CLICKTODIAL_FORCENEWTARGET''' ► Open in new page.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /><br />
<br />
=For SaaS / Cloud hosting integrators=<br />
<br />
The following options are useless for a common usage of Dolibarr. But they are usefull if you plan to host / provide Dolibarr instances as Software As A Service (SAAS) to your customers.<br />
<br />
*'''CRON_DISABLE_KEY_CHANGE''' ► When you provide an instance to a customer, you probably also add an entry in the cron of this user so Dolibarr batch and scheduler can work correctly. For security purpose, it may have a security key that is inside the command line into the cron entry and this entry must match the value defined into Dolibarr setup (setup of module 'Scheduled Jobs'). Because, a customer of a Saas platform will probably have no access to edit the cron file, it is also import that he has no way to edit the key into the Dolibarr setup, so the key in the cron command line will always match the key in Dolibarr setup, and the Dolibarr batches will executed without security errors. To be sure, the customer does not change the value, you can set this constant to 1 into the table [[Table_llx_const]].<br />
<br />
*'''CRON_DISABLE_TUTORIAL_CRON''' ► Disable the tutorial about how to install the cron script (on a SaaS hosting, this should be done by the web hosting provider)<br />
<br />
*'''CRON_WARNING_DELAY_HOURS''' ► Set this value to the frequency set for the cron script (so a warning will be shown to user to warn it about max frequency of its scheduled jobs)<br />
<br />
*'''MAILING_NO_USING_PHPMAIL''' ► To avoid bad use of the emailing module, it is recommended to set this option to 1 (This option is described previously). Also you can complete the message visible by customers when they try to setup the SMTP credentials of their Dolibarr by using the constant MAILING_SMTP_SETUP_EMAILS_FOR_QUESTIONS (This option is described previously). For example, you can point to a FAQ on your website.<br />
<br />
*'''MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL''' ► If you have set a system limit on number of recipients on your system, you can set also this option to match the same value, so users will be informed: So '''MAIL_MAX_NB_OF_RECIPIENTS_IN_SAME_EMAIL''' restricts sending of 1 email message to <code>x</code> recipients for the same email message (x for To: + CC: + BCC:). If not defined, value is <code>10</code>. Required to fight against spamming that include a ton of recipients in 1 message. Note that '''MAIL_MAX_NB_OF_RECIPIENTS_TO_IN_SAME_EMAIL''', '''MAIL_MAX_NB_OF_RECIPIENTS_CC_IN_SAME_EMAIL''' and '''MAIL_MAX_NB_OF_RECIPIENTS_BCC_IN_SAME_EMAIL''' are also available. Note that this is not a hard limit; it is just the quantity that will be displayed on warnings on screen. For a real limit, this must be implemented into the system.<br />
<br />
*'''MAILING_LIMIT_SENDBYDAY''' ► This is a limit of number of emails, an instance can send. Note that this is not a hard limit; it is just the quantity that will be displayed on warnings on screen. For a real limit, this must be implemented into the system.<br />
<br />
*'''MAILING_LIMIT_WARNING_PHPMAIL''' ► Set this value to a translation key. Then add translation keys into the instance so user will see a message when into the email setup page. For example, you can set a message to say: ''Warning: To avoid abuse, when using default setup, you are restricted to 500 emails per day for all your application (account may be suspended in case of violation of this rule. You can setup application to use your own SMTP server for sending email so you want have no restriction at all (see menu Home-Setup-Emails)''<br />
<br />
*'''MAIN_ALWAYS_CREATE_LOCK_AFTER_LAST_UPGRADE''' ► If set, when you launch upgrades of your customer instances, you are sure that the upgrade process recreate automatically the file install.lock and remove the upgrade.unlock so the administration tools like install.php, upgrade.php and repair.php can't be used on your customer instance (until the install.lock file is deleted or the upgrade.unlock file is created).<br />
<br />
*'''MAIN_EXTERNAL_SMTP_CLIENT_IP_ADDRESS''' ► (A better name of this option should be MAIN_EXTERNAL_MAIL_CLIENT_IP_ADDRESS). Set here the list of IPs where your Dolibarr instances are hosted, separated by a comma. So, when your customer go into the Email setup area:<br />
**If he has chosen mail method, a message will explain him how to setup its SPF record for its email domain (showing the list of IP). This is to avoid to have its emails, sent from its Dolibarr instance, fails due to strict antispam rule of some emailing servers.<br />
**If he has chosen smtp method, a message will explain him the list of IP he can use if there is restriction on IP by the SMTP agent. If you also need to add a message to help SPF setup, see option '''MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD'''.<br />
<br />
You can also provide a list of URLs that return just an IP instead of a list of hardcoded IP. So you can for example set 1 url that contact a whoami service that return the public IP of server and another one doing the one on a IPv6 address, so on the setup page, the public IP adress of the server will always be uptodate for both ipv4 and ipv6 (Example: "https://ipv4.server.com/_service_showmyip.php,https://ipv6.server.com/_service_showmyip.php")<br />
<br />
*'''MAIN_EXTERNAL_SMTP_SPF_STRING_TO_ADD''' ► Set here the string to add in the SPF record This string will be shown into a help message when the user in in the setup of email page and has choose a method using an external SMTP server.<br />
<br />
*'''MAIN_FIRST_PING_OK_ID''' ► Set this value to "disabled" to remove completely any ping after a complete setup.<br />
<br />
*'''MAIN_FILECHECK_LOCAL_SUFFIX''' and '''MAIN_FILECHECK_LOCAL_EXT''' ► If you offer a customized or patched version of Dolibarr, when the user will use the tool to check the integrity of files, the default xml file name used for signature checking will be the official file provided by the Dolibarr team, so it does not includes your own changes. To have the suggested signature file being your own file, you can set the constant MAIN_FILECHECK_LOCAL_SUFFIX to a suffix. For example, set this to "'''-mysaassolution'''". So, when the user will use the file integrity tool, the default file to check for signature will be "'''/install/filelist-10.0.2-mysaassolution.xml'''" instead of "'''/install/filelist-10.0.2.xml'''". All you have to do is generate the signature file '''mysaassolution''' using the tool '''build/generate_filelist_xml.php''' and put this file into the install directory of your customer instance. Doing this, your customer, and yourself, will be able to check if a file was modified without being disturbed by false alerts due to your customized files or patches (they will be included in the signature used for check). Also, if you want to zip the customized signature file into "'''/install/filelist-10.0.2-mysaassolution.xml.zip'''", you can set the constant MAIN_FILECHECK_LOCAL_EXT to '.zip'.<br />
<br />
*'''MAIN_HIDE_WARNING_TO_ENCOURAGE_SMTP_SETUP''' ► Set to 1 by default (so warning is hidden). You can set it to 0 to show a warning to encourage admin to set its own SMTP service.<br />
<br />
*'''MAIN_MAIL_SENDMODE_password''' ► To force the mode to send the email on the "password forgotten" page. So you can decide to use php mail or SMTP method for this specific use case.<br />
<br />
*'''MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING''' ► If set to N, the warning saying modules are not activated will be shown if number of activated module is < N (Having this variable not defined is same than having it set to 1). This may be usefull if you preinstall an application with some modules already loaded by default and you want to keep the warning to be sure the user will enable other modules he need, even if some modules are already enabed.<br />
*'''MAIN_SETUP_MODULES_DESC''' ► If your installation is already done with activated module, the help message to explain how to enable a module on the setup page is hidden. You can keep it visible by adding this option to 1.<br />
<br />
*'''MAIN_NO_UPGRADE_REDIRECT_ON_LEVEL_3_CHANGE''' ► The page to make the migration is not shown automatically when you deploy files of version X.Y.Z+delta over an installation with a database version X.Y.Z. The upgrade page will be shown automatically only if there is a change on value of X or Y in version.<br />
<br />
*'''SYSLOG_DISABLE_LOGHANDLER_SYSLOG''' ► Set this to 1 to disable usage of syslog (having all customer instances logging in the same system file is not a good idea).<br />
<br />
*'''WEBSITE_REPLACE_INFO_ABOUT_USAGE_WITH_WEBSERVER''' ► Put here a text or a translation key of a text to show when the user will use the feature "Deploy" when he want to deploy a website done with Dolibarr CMS. So you can, for example, show him a message that this feature is not part of its subscription and putting a website online may need a complementary subscription.<br />
<br />
[[#Top|(back to top)]]<br />
<br />
<br /></div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=65735Electronic Billing2026-03-28T19:14:20Z<p>Sonikf: /* Legislation and current status */</p>
<hr />
<div>{{TemplateDocUser}}<br />
{{#metamaster:keywords|einvoice,ebilling,ereporting,facturx,e-invoice,e-reporting,e-billing,ubl,peppol,e-factura,efactura}}<br />
<br />
This page presents a description of the rules and solutions for Electronic Invoicing ('''e-invoicing, e-billing''') and Invoice and VAT reporting ('''e-reporting''').<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, feel free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an alternative of an existing solution if a module already exists and does not match your need...<br />
<br />
Note that for European country, europe maintain a resoure page that may contains complementary generic information ([https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467108874/eInvoicing+Country+Factsheets+for+each+Member+State+and+other+countries on this page]):<br />
<br />
<br />
<br />
<br />
=Argentina=<br />
==Legislation and current status==<br />
Need AFIP/ARCA e-invoicing<br />
Automatic CAE, credit/debit notes, digital VAT book and electronic delivery notes.<br />
TODO Need more reference...<br />
<br />
==Dolibarr support==<br />
You can use the following module:<br />
https://www.dolistore.com/product.php?id=2580&title=facturacion-electronica-argentina-afip-arca-takepos&l=fr<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
<br />
==Dolibarr support==<br />
'''Manual support'''<br />
<br />
There is several platforms and services in Belgium that you can use to send manually classic invoices. They will be converted and transfer to Peppol network by these services. You will also find on their website sites, the invoices sent by your suppliers. For example the non-profit service [https://letspeppol.org LetsPeppol]. You can also prefer [https://bosa.belgium.be/fr/services/mercurius Mercurius], or the more popular [https://doccle.be/ Doccle]. If you have a low number of invoice, using such platforms may be a good choice. If the platform can't work with a simple PDF and need a UBL xml file, you can use [https://www.dolistore.com/product.php?id=884&title=peppol-xml-ubl-facture-electronique-multi-ap&l=fr this module] whose goal is to convert your own Dolibarr PDF into the XML format to push them on such platforms.<br />
<br />
'''Integrated support'''<br />
<br />
If you need a more integrated solution, to just generate invoices in the Peppol format from the application, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
If you want to both generate the Peppol invoices and also send or retrieve them on the Peppol network, this is a list of possible modules (note that you may need to subscribe a subscription to the network gateway service used by this modules): <br />
<br />
*https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client<br />
*https://www.dolistore.com/product.php?id=2537&title=wiwitrouter-invoice-facturation-electronique-peppol&l=fr<br />
*https://www.dolistore.com/product.php?id=2635&title=dolifalco&l=fr<br />
*https://www.dolistore.com/product.php?id=884&title=peppol-xml-ubl-facture-electronique-multi-ap&l=fr (Multi-AP, experimental)<br />
<br />
More modules may exists, see [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers some platforms, for example LetsPeppol, Mercurius, or Doccle, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A Peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a Peppol file has been published on the peppol network, you should find a report page on your Access Point (StoreCove, Mercurial, Doccle, LetsPeppol, ...).<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
==Dolibarr support==<br />
<br />
<br />
New, robust DIAN electronic invoicing for Dolibarr (UBL 2.1). Covers Invoice, Credit/Debit Notes, Support Document, and optional e-Payroll. Actively maintained with support and updates. https://www.dolistore.com/product.php?id=2376&title=facturacion-electronica-dian-colombia-ilimitada&l=es<br />
<br />
A old module is available here: [https://www.dolistore.com/product.php?id=1153&title=colombian-electronic-invoice&l=fr https://www.dolistore.com/product.php?id=2376&title=unlimited-dian-colombia-electronic-billing&l=fr]<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: Starting from 2/2/2026 with a grace period of gradual implementation until 31/3/2026 all companies with an annual turnover exceeding 1000000,00 euros.<br />
<br />
Starting from 1/10/2026 with a grace period of gradual implementation until 31/12/2026 for all entities/companies.<br />
==Dolibarr support==<br />
E-reporting is implemented through Independent Authority for Public Revenue (IAPR) MyDATA platform with constant API changes<br />
<br />
*<s>For Dolibarr versions 13.0.0 - 18.0.x download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8</s><br />
*<s>For Dolibarr versions 19.0.0 -21.0.0 use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19</s><br />
*For Dolibarr version 22.0.x download from [https://www.dolibarr.gr/foroum/mydata-diathesimo-module/page-50.html#4245 here]<br />
*For Dolibarr version 23.0.0+ we move to e-invoicing module still under heavy development<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
*Digital delivery note: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland (KSeF)=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
<br />
==Dolibarr support==<br />
You may try to use one of the module to synchronise Dolibarr invoices with Peppol [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol available on DoliStore]:<br />
<br />
You can also have a look at this KSeF dedicated modue: https://github.com/InPoint-Automation/Dolibarr-KSeF-Module<br />
<br />
==Legislation and current status==<br />
<br />
More information on page: https://ksef.mf.gov.pl/<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania (e-Factura)=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
<br />
==Dolibarr support==<br />
A dedicated module called QInvoice exists here: https://www.dolistore.com/product.php?id=2494<br />
<br />
It integrates Dolibarr with SPV/ANAF for e-Invoice, covering the full flow—authorization, submission, vendor download, statuses, and logs. It follows UBL 2.1 / CIUS-RO rules, including proper storno mapping (negative quantity, positive unit price).<br />
<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module LeyAntiFraude y VeriFactu'''<br />
<br />
To be compliant with the Faturae y VeryFactu system, you need to install an external module.<br />
<br />
See the following page for the liste of available modules: [[Law SIF for the AEAT In Spain]]<br />
<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a swiss QR invoice section on your PDF:<br />
<br />
*If you know how to download a module from a git repository, you can also install the module provided here https://github.com/sinabe/dolibarr-swissqr (More information: https://sinabe.ch/facture-qr-suisse-dans-dolibarr/). It is a free module with the development repository available publicly.<br />
*You can also install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html (as a paying module, you may also benefit a support from author)<br />
*The last option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=Tunisia (TEIF - El Fatoora)=<br />
==Format==<br />
<br />
TTN (Tunisie TradeNet) and standard UBL 2.1 / TEIF.<br />
<br />
==Timeline==<br />
To complete...<br />
<br />
==Dolibarr support==<br />
A module exists to generate the XML file for tunisia e-invoicing.<br />
See https://github.com/kambac80/tunisiaelinv<br />
<br />
You must then sign the file using TTN and your certificat TunTrust (Digigo ou clé USB) to send it to the portal El Fatoora.<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=65734Electronic Billing2026-03-28T19:12:10Z<p>Sonikf: /* Legislation and current status */</p>
<hr />
<div>{{TemplateDocUser}}<br />
{{#metamaster:keywords|einvoice,ebilling,ereporting,facturx,e-invoice,e-reporting,e-billing,ubl,peppol,e-factura,efactura}}<br />
<br />
This page presents a description of the rules and solutions for Electronic Invoicing ('''e-invoicing, e-billing''') and Invoice and VAT reporting ('''e-reporting''').<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, feel free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an alternative of an existing solution if a module already exists and does not match your need...<br />
<br />
Note that for European country, europe maintain a resoure page that may contains complementary generic information ([https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467108874/eInvoicing+Country+Factsheets+for+each+Member+State+and+other+countries on this page]):<br />
<br />
<br />
<br />
<br />
=Argentina=<br />
==Legislation and current status==<br />
Need AFIP/ARCA e-invoicing<br />
Automatic CAE, credit/debit notes, digital VAT book and electronic delivery notes.<br />
TODO Need more reference...<br />
<br />
==Dolibarr support==<br />
You can use the following module:<br />
https://www.dolistore.com/product.php?id=2580&title=facturacion-electronica-argentina-afip-arca-takepos&l=fr<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
<br />
==Dolibarr support==<br />
'''Manual support'''<br />
<br />
There is several platforms and services in Belgium that you can use to send manually classic invoices. They will be converted and transfer to Peppol network by these services. You will also find on their website sites, the invoices sent by your suppliers. For example the non-profit service [https://letspeppol.org LetsPeppol]. You can also prefer [https://bosa.belgium.be/fr/services/mercurius Mercurius], or the more popular [https://doccle.be/ Doccle]. If you have a low number of invoice, using such platforms may be a good choice. If the platform can't work with a simple PDF and need a UBL xml file, you can use [https://www.dolistore.com/product.php?id=884&title=peppol-xml-ubl-facture-electronique-multi-ap&l=fr this module] whose goal is to convert your own Dolibarr PDF into the XML format to push them on such platforms.<br />
<br />
'''Integrated support'''<br />
<br />
If you need a more integrated solution, to just generate invoices in the Peppol format from the application, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
If you want to both generate the Peppol invoices and also send or retrieve them on the Peppol network, this is a list of possible modules (note that you may need to subscribe a subscription to the network gateway service used by this modules): <br />
<br />
*https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client<br />
*https://www.dolistore.com/product.php?id=2537&title=wiwitrouter-invoice-facturation-electronique-peppol&l=fr<br />
*https://www.dolistore.com/product.php?id=2635&title=dolifalco&l=fr<br />
*https://www.dolistore.com/product.php?id=884&title=peppol-xml-ubl-facture-electronique-multi-ap&l=fr (Multi-AP, experimental)<br />
<br />
More modules may exists, see [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers some platforms, for example LetsPeppol, Mercurius, or Doccle, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A Peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a Peppol file has been published on the peppol network, you should find a report page on your Access Point (StoreCove, Mercurial, Doccle, LetsPeppol, ...).<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
==Dolibarr support==<br />
<br />
<br />
New, robust DIAN electronic invoicing for Dolibarr (UBL 2.1). Covers Invoice, Credit/Debit Notes, Support Document, and optional e-Payroll. Actively maintained with support and updates. https://www.dolistore.com/product.php?id=2376&title=facturacion-electronica-dian-colombia-ilimitada&l=es<br />
<br />
A old module is available here: [https://www.dolistore.com/product.php?id=1153&title=colombian-electronic-invoice&l=fr https://www.dolistore.com/product.php?id=2376&title=unlimited-dian-colombia-electronic-billing&l=fr]<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: Starting from 2/2/2026 with a grace period of gradual implementation until 31/3/2026 all companies with an annual turnover exceeding 1000000,00 euros.<br />
<br />
Starting from 1/10/2026 with a grace period of gradual implementation until 31/12/2026 for all entities/companies.<br />
<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented through Independent Authority for Public Revenue (IAPR) MyDATA platform with constant API changes<br />
<br />
*<s>For Dolibarr versions 13.0.0 - 18.0.x download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8</s><br />
*<s>For Dolibarr versions 19.0.0 -21.0.0 use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19</s><br />
*For Dolibarr version 22.0.x download from [https://www.dolibarr.gr/foroum/mydata-diathesimo-module/page-50.html#4245 here]<br />
*For Dolibarr version 23.0.0+ we move to e-invoicing module still under heavy development<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland (KSeF)=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
<br />
==Dolibarr support==<br />
You may try to use one of the module to synchronise Dolibarr invoices with Peppol [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol available on DoliStore]:<br />
<br />
You can also have a look at this KSeF dedicated modue: https://github.com/InPoint-Automation/Dolibarr-KSeF-Module<br />
<br />
==Legislation and current status==<br />
<br />
More information on page: https://ksef.mf.gov.pl/<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania (e-Factura)=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
<br />
==Dolibarr support==<br />
A dedicated module called QInvoice exists here: https://www.dolistore.com/product.php?id=2494<br />
<br />
It integrates Dolibarr with SPV/ANAF for e-Invoice, covering the full flow—authorization, submission, vendor download, statuses, and logs. It follows UBL 2.1 / CIUS-RO rules, including proper storno mapping (negative quantity, positive unit price).<br />
<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module LeyAntiFraude y VeriFactu'''<br />
<br />
To be compliant with the Faturae y VeryFactu system, you need to install an external module.<br />
<br />
See the following page for the liste of available modules: [[Law SIF for the AEAT In Spain]]<br />
<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a swiss QR invoice section on your PDF:<br />
<br />
*If you know how to download a module from a git repository, you can also install the module provided here https://github.com/sinabe/dolibarr-swissqr (More information: https://sinabe.ch/facture-qr-suisse-dans-dolibarr/). It is a free module with the development repository available publicly.<br />
*You can also install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html (as a paying module, you may also benefit a support from author)<br />
*The last option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=Tunisia (TEIF - El Fatoora)=<br />
==Format==<br />
<br />
TTN (Tunisie TradeNet) and standard UBL 2.1 / TEIF.<br />
<br />
==Timeline==<br />
To complete...<br />
<br />
==Dolibarr support==<br />
A module exists to generate the XML file for tunisia e-invoicing.<br />
See https://github.com/kambac80/tunisiaelinv<br />
<br />
You must then sign the file using TTN and your certificat TunTrust (Digigo ou clé USB) to send it to the portal El Fatoora.<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following modules may also able to generate invoices and send the invoice on the Peppol Network. See [https://www.dolistore.com/index.php?controller=search&orderby=position&orderway=desc&website=marketplace&search_query=peppol full list available on DoliStore]<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=64228Electronic Billing2025-09-16T13:16:44Z<p>Sonikf: /* Timeline */</p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for Electronic Invoicing ('''e-invoicing, e-billing''') and Invoice and VAT reporting ('''e-reporting''').<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, feel free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an alternative of an existing solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial:<br />
https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: <nowiki>https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client</nowiki> (to be confirmed)<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: Starting from 2/2/2026 with a grace period of gradual implementation until 31/3/2026 all companies with an annual turnover exceeding 1000000,00 euros.<br />
<br />
Starting from 1/10/2026 with a grace period of gradual implementation until 31/12/2026 for all entities/companies.<br />
<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63815Electronic Billing2025-08-05T19:23:10Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''VAT Real-Time Reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depends on your country...so you must you MUST check with your Accountant / book keeper or your laywer that following solutions comply with local laws and business needs.<br />
<br />
If your country is not in this list feel free to <br />
<br />
*add relevant information<br />
*test or ask for support from following module developers<br />
<br />
*develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com or<br />
<br />
*fork any of the free solutions and develop your own interface<br />
<br />
===Dolibarr support===<br />
{| class="wikitable sortable mw-collapsible"<br />
!Country<br />
!Format<br />
!Module<br />
!Peppol access point providers or country specific platforms<br />
!Notes<br />
|-<br />
|Eu countries<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?title=Peppol-XML---facture-electronique&extid=1585# Peppol XML / UBL]<br />
|[https://e-invoice.be/ e-invoice]<code>[https://www.scrada.be/en/ Scrada](Belgium), [https://www.iopole.com/ IOPOLE](France)</code><br />
|Module generates Peppol XML / BIS Billing format invoices <br />
valid in Europe<br />
|-<br />
|Belgium, France *<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client Peppol Storecove]<br />
|[https://www.storecove.com Storecove]<br />
|*Citation needed for supported countries <br />
except France and Belgium<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|[https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en Factura Electronica Colombia DIAN]<br />
|<br />
|Not enough feedback to know it this module is still valid.<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|https://nortserver.com/dolibarr.php<br />
|<br />
|<br />
|-<br />
|France, Germany<br />
|FacturX<br />
|[https://www.dolistore.com/product.php?title=FacturX---Facture---lectronique--Chorus----&extid=1511# FacturX]<br />
|<br />
|This module, or a modified or Dolibarrized version of the module<br />
will be integrated as standard in a future version of Dolibarr.<br />
|-<br />
|France<br />
|<br />
|[https://www.dolistore.com/product.php?title=Chorus-Pro&extid=1184# Demat 4 Dolibarr]<br />
|Chorus-Pro<br />
|The module requires a subscription to be operational<br />
|-<br />
|Greece<br />
|<br />
|[https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19 Dolibarr-mydata]<br />
|myDATA<br />
|VAT Real-Time Reporting only<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html Fatturazione elettronica & Professionisti Smart]<br />
|<br />
|<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://doliplatform.com/fatturazione-elettronica/ Fatture Elettroniche ITA]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://github.com/avadnc/cfdixml cfdixml]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://www.dolistore.com/product.php?id=354&title=mexico-cfdi# Mexico CFDI]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|FacturaE<br />
|[https://www.2byte.es/index.php/productos/modulo-2facturae 2FacturaE]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|<br />
|[https://dolifactu.es/producto/modulo-antifraude-dolibarr/ VeriFactu]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|-<br />
|Spain<br />
|<br />
|[https://www.dolistore.com/product.php?title=Ley-antifraude-y-VeriFactu&extid=2259# Ley antifraude]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|}<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Colombia=<br />
==Format==<br />
UBL V2.1<br />
<br />
<br />
Legislation and current status<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: N/A<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factum-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
<br />
<br /><br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63814Electronic Billing2025-08-05T17:57:18Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''VAT Real-Time Reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depends on your country...so you must you MUST check with your Accountant / book keeper or your laywer that following solutions comply with local laws and business needs.<br />
<br />
If your country is not in this list feel free to <br />
<br />
*add relevant information<br />
*test or ask for support from following module developers<br />
<br />
*develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com or<br />
<br />
*clone any of the free solutions and develop your own interface<br />
<br />
===Dolibarr support===<br />
{| class="wikitable sortable mw-collapsible"<br />
!Country<br />
!Format<br />
!Module<br />
!Peppol access point providers or country specific platforms<br />
!Notes<br />
|-<br />
|Eu countries<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?title=Peppol-XML---facture-electronique&extid=1585# Peppol XML / UBL]<br />
|[https://e-invoice.be/ e-invoice]<code>[https://www.scrada.be/en/ Scrada](Belgium), [https://www.iopole.com/ IOPOLE](France)</code><br />
|Module generates Peppol XML / BIS Billing format invoices <br />
valid in Europe<br />
|-<br />
|Belgium, France *<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client Peppol Storecove]<br />
|[https://www.storecove.com Storecove]<br />
|*Citation needed for supported countries <br />
except France and Belgium<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|[https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en Factura Electronica Colombia DIAN]<br />
|<br />
|Not enough feedback to know it this module is still valid.<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|https://nortserver.com/dolibarr.php<br />
|<br />
|<br />
|-<br />
|France, Germany<br />
|FacturX<br />
|[https://www.dolistore.com/product.php?title=FacturX---Facture---lectronique--Chorus----&extid=1511# FacturX]<br />
|<br />
|This module, or a modified or Dolibarrized version of the module<br />
will be integrated as standard in a future version of Dolibarr.<br />
|-<br />
|France<br />
|<br />
|[https://www.dolistore.com/product.php?title=Chorus-Pro&extid=1184# Demat 4 Dolibarr]<br />
|Chorus-Pro<br />
|The module requires a subscription to be operational<br />
|-<br />
|Greece<br />
|<br />
|[https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19 Dolibarr-mydata]<br />
|myDATA<br />
|VAT Real-Time Reporting only<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html Fatturazione elettronica & Professionisti Smart]<br />
|<br />
|<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://doliplatform.com/fatturazione-elettronica/ Fatture Elettroniche ITA]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://github.com/avadnc/cfdixml cfdixml]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://www.dolistore.com/product.php?id=354&title=mexico-cfdi# Mexico CFDI]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|FacturaE<br />
|[https://www.2byte.es/index.php/productos/modulo-2facturae 2FacturaE]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|<br />
|[https://dolifactu.es/producto/modulo-antifraude-dolibarr/ VeriFactu]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|-<br />
|Spain<br />
|<br />
|[https://www.dolistore.com/product.php?title=Ley-antifraude-y-VeriFactu&extid=2259# Ley antifraude]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|}<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Colombia=<br />
==Format==<br />
UBL V2.1<br />
<br />
<br />
Legislation and current status<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: N/A<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factum-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
<br />
<br /><br />
<br />
== Legislation and current status ==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63813Electronic Billing2025-08-05T17:54:38Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''VAT Real-Time Reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depends on your country...so you must you MUST check with your Accountant / book keeper or your laywer that following solutions comply with local laws and business needs.<br />
<br />
If your country is not in this list feel free to <br />
<br />
*add relevant information<br />
*test or ask for support from following module developers<br />
<br />
*develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com or<br />
<br />
*clone any of the free solutions and develop your own interface<br />
<br />
===Dolibarr support===<br />
{| class="wikitable sortable mw-collapsible"<br />
!Country<br />
!Format<br />
!Module<br />
!Peppol access point providers or country specific platforms<br />
!Notes<br />
|-<br />
|Eu countries<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?title=Peppol-XML---facture-electronique&extid=1585# Peppol XML / UBL]<br />
|[https://e-invoice.be/ e-invoice]<code>[https://www.scrada.be/en/ Scrada](Belgium), [https://www.iopole.com/ IOPOLE](France)</code><br />
|Module generates Peppol XML / BIS Billing format invoices <br />
valid in Europe<br />
|-<br />
|Belgium, France *<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client Peppol Storecove]<br />
|[https://www.storecove.com Storecove]<br />
|*Citation needed for supported countries <br />
except France and Belgium<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|[https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en Factura Electronica Colombia DIAN]<br />
|<br />
|Not enough feedback to know it this module is still valid.<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|https://nortserver.com/dolibarr.php<br />
|<br />
|<br />
|-<br />
|France, Germany<br />
|FacturX<br />
|[https://www.dolistore.com/product.php?title=FacturX---Facture---lectronique--Chorus----&extid=1511# FacturX]<br />
|<br />
|This module, or a modified or Dolibarrized version of the module<br />
will be integrated as standard in a future version of Dolibarr.<br />
|-<br />
|France<br />
|<br />
|[https://www.dolistore.com/product.php?title=Chorus-Pro&extid=1184# Demat 4 Dolibarr]<br />
|Chorus-Pro<br />
|The module requires a subscription to be operational<br />
|-<br />
|Greece<br />
|<br />
|[https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19 Dolibarr-mydata]<br />
|myDATA<br />
|VAT Real-Time Reporting only<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html Fatturazione elettronica & Professionisti Smart]<br />
|<br />
|<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://doliplatform.com/fatturazione-elettronica/ Fatture Elettroniche ITA]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://github.com/avadnc/cfdixml cfdixml]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://www.dolistore.com/product.php?id=354&title=mexico-cfdi# Mexico CFDI]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|FacturaE<br />
|[https://www.2byte.es/index.php/productos/modulo-2facturae 2FacturaE]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|<br />
|[https://dolifactu.es/producto/modulo-antifraude-dolibarr/ VeriFactu]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|-<br />
|Spain<br />
|<br />
|[https://www.dolistore.com/product.php?title=Ley-antifraude-y-VeriFactu&extid=2259# Ley antifraude]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|}<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Colombia=<br />
==Format==<br />
UBL V2.1<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factum-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63812Electronic Billing2025-08-05T17:53:17Z<p>Sonikf: /* Dolibarr support */</p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''VAT Real-Time Reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depends on your country...so you must you MUST check with your Accountant / book keeper or your laywer that following solutions comply with local laws and business needs.<br />
<br />
If your country is not in this list feel free to <br />
<br />
*add relevant information<br />
*test or ask for support from following module developers<br />
<br />
*develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com or<br />
<br />
*clone any of the free solutions develop your own interface<br />
<br />
===Dolibarr support===<br />
{| class="wikitable sortable mw-collapsible"<br />
!Country<br />
!Format<br />
!Module<br />
!Peppol access point providers or country specific platforms<br />
!Notes<br />
|-<br />
|Eu countries<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?title=Peppol-XML---facture-electronique&extid=1585# Peppol XML / UBL]<br />
|[https://e-invoice.be/ e-invoice]<code>[https://www.scrada.be/en/ Scrada](Belgium), [https://www.iopole.com/ IOPOLE](France)</code><br />
|Module generates Peppol XML / BIS Billing format invoices <br />
valid in Europe<br />
|-<br />
|Belgium, France *<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client Peppol Storecove]<br />
|[https://www.storecove.com Storecove]<br />
|*Citation needed for supported countries <br />
except France and Belgium<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|[https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en Factura Electronica Colombia DIAN]<br />
|<br />
|Not enough feedback to know it this module is still valid.<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|https://nortserver.com/dolibarr.php<br />
|<br />
|<br />
|-<br />
|France, Germany<br />
|FacturX<br />
|[https://www.dolistore.com/product.php?title=FacturX---Facture---lectronique--Chorus----&extid=1511# FacturX]<br />
|<br />
|This module, or a modified or Dolibarrized version of the module<br />
will be integrated as standard in a future version of Dolibarr.<br />
|-<br />
|France<br />
|<br />
|[https://www.dolistore.com/product.php?title=Chorus-Pro&extid=1184# Demat 4 Dolibarr]<br />
|Chorus-Pro<br />
|The module requires a subscription to be operational<br />
|-<br />
|Greece<br />
|<br />
|[https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19 Dolibarr-mydata]<br />
|myDATA<br />
|VAT Real-Time Reporting only<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html Fatturazione elettronica & Professionisti Smart]<br />
|<br />
|<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://doliplatform.com/fatturazione-elettronica/ Fatture Elettroniche ITA]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://github.com/avadnc/cfdixml cfdixml]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://www.dolistore.com/product.php?id=354&title=mexico-cfdi# Mexico CFDI]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|FacturaE<br />
|[https://www.2byte.es/index.php/productos/modulo-2facturae 2FacturaE]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|<br />
|[https://dolifactu.es/producto/modulo-antifraude-dolibarr/ VeriFactu]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|-<br />
|Spain<br />
|<br />
|[https://www.dolistore.com/product.php?title=Ley-antifraude-y-VeriFactu&extid=2259# Ley antifraude]<br />
|VeriFactu<br />
|For compliance with the Spanish Anti fraud Law<br />
|}<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Colombia=<br />
==Format==<br />
UBL V2.1<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factum-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63811Electronic Billing2025-08-05T17:51:19Z<p>Sonikf: /* Dolibarr support */</p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''VAT Real-Time Reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depends on your country...so you must you MUST check with your Accountant / book keeper or your laywer that following solutions comply with local laws and business needs.<br />
<br />
If your country is not in this list feel free to <br />
<br />
*add relevant information<br />
*test or ask for support from following module developers<br />
<br />
*develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com or<br />
<br />
*clone any of the free solutions develop your own interface<br />
<br />
===Dolibarr support===<br />
{| class="wikitable sortable mw-collapsible"<br />
!Country<br />
!Format<br />
!Module<br />
!Peppol access point providers or country specific platforms<br />
!Notes<br />
|-<br />
|Eu countries<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?title=Peppol-XML---facture-electronique&extid=1585# Peppol XML / UBL]<br />
|[https://e-invoice.be/ e-invoice]<code>[https://www.scrada.be/en/ Scrada](Belgium), [https://www.iopole.com/ IOPOLE](France)</code><br />
|Module generates Peppol XML / BIS Billing format invoices <br />
valid in Europe<br />
|-<br />
|Belgium, France *<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client Peppol Storecove]<br />
|[https://www.storecove.com Storecove]<br />
|*Citation needed for supported countries <br />
except France and Belgium<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|[https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en Factura Electronica Colombia DIAN]<br />
|<br />
|Not got enough feedback to know it this module is still valid.<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|https://nortserver.com/dolibarr.php<br />
|<br />
|<br />
|-<br />
|France, Germany<br />
|FacturX<br />
|[https://www.dolistore.com/product.php?title=FacturX---Facture---lectronique--Chorus----&extid=1511# FacturX]<br />
|<br />
|This module, or a modified or Dolibarrized version of the module<br />
will be integrated as standard in a future version of Dolibarr.<br />
|-<br />
|France<br />
|<br />
|[https://www.dolistore.com/product.php?title=Chorus-Pro&extid=1184# Demat 4 Dolibarr]<br />
|Chorus-Pro<br />
|The module requires a subscription to be operational<br />
|-<br />
|Greece<br />
|<br />
|[https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19 Dolibarr-mydata]<br />
|myDATA<br />
|VAT Real-Time Reporting only<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html Fatturazione elettronica & Professionisti Smart]<br />
|<br />
|<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://doliplatform.com/fatturazione-elettronica/ Fatture Elettroniche ITA]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://github.com/avadnc/cfdixml cfdixml]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://www.dolistore.com/product.php?id=354&title=mexico-cfdi# Mexico CFDI]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|FacturaE<br />
|[https://www.2byte.es/index.php/productos/modulo-2facturae 2FacturaE]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|<br />
|[https://dolifactu.es/producto/modulo-antifraude-dolibarr/ VeriFactu]<br />
|VeriFactu<br />
|compliance with the Spanish Antifraud Law<br />
|-<br />
|Spain<br />
|<br />
|[https://www.dolistore.com/product.php?title=Ley-antifraude-y-VeriFactu&extid=2259# Ley antifraude]<br />
|VeriFactu<br />
|compliance with the Spanish Antifraud Law<br />
|}<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Colombia=<br />
==Format==<br />
UBL V2.1<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factum-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63810Electronic Billing2025-08-05T17:46:41Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''VAT Real-Time Reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depends on your country...so you must you MUST check with your Accountant / book keeper or your laywer that following solutions comply with local laws and business needs.<br />
<br />
If your country is not in this list feel free to <br />
<br />
* add relevant information <br />
* test or ask for support from following module developers<br />
<br />
* develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com or<br />
<br />
* clone any of the free solutions develop your own interface<br />
<br />
=== Dolibarr support ===<br />
{| class="wikitable sortable mw-collapsible"<br />
!Country<br />
!Format<br />
!Module<br />
!Peppol access point providers or country specific platforms<br />
!Notes<br />
|-<br />
|<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?title=Peppol-XML---facture-electronique&extid=1585# Peppol XML / UBL]<br />
|[https://e-invoice.be/ e-invoice]<code>[https://www.scrada.be/en/ Scrada](Belgium), [https://www.iopole.com/ IOPOLE](France)</code><br />
|Module generates Peppol XML / BIS Billing format invoices <br />
valid in Europe<br />
|-<br />
|France, Belgium *<br />
|Peppol<br />
|[https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client Peppol Storecove]<br />
|[https://www.storecove.com Storecove] <br />
|*Citation needed for supported countries <br />
except France and Belgium<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|[https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en Factura Electronica Colombia DIAN]<br />
|<br />
|Not got enough feedback to know it this module is still valid.<br />
|-<br />
|Colombia<br />
|UBL 2.1<br />
|https://nortserver.com/dolibarr.php<br />
|<br />
|<br />
|-<br />
|France, Germany<br />
|FacturX<br />
|[https://www.dolistore.com/product.php?title=FacturX---Facture---lectronique--Chorus----&extid=1511# FacturX]<br />
|<br />
|This module, or a modified or Dolibarrized version of the module<br />
will be integrated as standard in a future version of Dolibarr.<br />
|-<br />
|France<br />
|<br />
|[https://www.dolistore.com/product.php?title=Chorus-Pro&extid=1184# Demat 4 Dolibarr]<br />
|Chorus-Pro<br />
|The module requires a subscription to be operational<br />
|-<br />
|Greece<br />
|<br />
|[https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19 Dolibarr-mydata]<br />
|myDATA<br />
|VAT Real-Time Reporting only<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html Fatturazione elettronica & Professionisti Smart]<br />
|<br />
|<br />
|-<br />
|Italy<br />
|FatturaPA<br />
|[https://doliplatform.com/fatturazione-elettronica/ Fatture Elettroniche ITA]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://github.com/avadnc/cfdixml cfdixml]<br />
|<br />
|<br />
|-<br />
|Mexico<br />
|CFDI XML<br />
|[https://www.dolistore.com/product.php?id=354&title=mexico-cfdi# Mexico CFDI]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|FacturaE<br />
|[https://www.2byte.es/index.php/productos/modulo-2facturae 2FacturaE]<br />
|<br />
|<br />
|-<br />
|Spain<br />
|<br />
|[https://dolifactu.es/producto/modulo-antifraude-dolibarr/ VeriFactu]<br />
|VeriFactu<br />
|compliance with the Spanish Antifraud Law<br />
|-<br />
|Spain<br />
|<br />
|[https://www.dolistore.com/product.php?title=Ley-antifraude-y-VeriFactu&extid=2259# Ley antifraude]<br />
|VeriFactu<br />
|compliance with the Spanish Antifraud Law<br />
|}<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Colombia=<br />
==Format==<br />
UBL V2.1<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factum-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63809Electronic Billing2025-08-05T13:45:48Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, feel free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an alternative of an existing solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial:<br />
https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: <nowiki>https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client</nowiki> (to be confirmed)<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63808Electronic Billing2025-08-05T13:42:23Z<p>Sonikf: /* Format */</p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial:<br />
https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: <nowiki>https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client</nowiki> (to be confirmed)<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63807Electronic Billing2025-08-05T13:41:41Z<p>Sonikf: /* Format */</p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial:<br />
https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: <nowiki>https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client</nowiki> (to be confirmed)<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet.<br />
<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63806Electronic Billing2025-08-05T13:40:54Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial:<br />
https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: <nowiki>https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client</nowiki> (to be confirmed)<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
EHF/Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Norway<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Poland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
Poland plans to make business-to-business (B2B) e-Invoicing mandatory from 2026.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Poland<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Portugal=<br />
==Format==<br />
OASIS UBL CIUS-PT and CEFACT CII CIUS-PT<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Portugal<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Romania=<br />
==Format==<br />
RO_CIUS ensuring alignment with the broader European e-invoicing standard EN 16931.<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Romania<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Slovakia=<br />
==Format==<br />
Peppol BIS 3<br />
==Timeline==<br />
Slovakia intends to introduce the mandatory B2B e-invoicing. Based on the mandatory e-invoicing, there will be on-line electronic reporting from January 2027, for domestic transactions (transactions with the place of supply within the territory of the Slovakia) and for taxable persons established in Slovakia. Cross-border B2B reporting (for intra EU transactions), based on e-invoicing, is going to be introduced from 1 July 2030.<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovakia<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Slovenia=<br />
==Format==<br />
The national e-SLOG standard (version 2.0) is compliant with the EN 16931.<br />
==Timeline==<br />
<br />
==Dolibarr support==<br />
You may try to use the following module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Slovenia<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
B2B: The Law 18/2022 amendment mandates that all B2B transactions must be conducted using eInvoices. Businesses with annual revenues of EUR 8 million or more must comply within one year, while others have a two-year compliance period but it has not been officially issued yet<br />
Effective on 1 January 2026, the VERIFACTU system will become mandatory for all companies that are not subject to the SII Reporting mandate. This will require these companies to use certified accounting software and obtain invoice clearance for all their transactions.<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: N/A<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
Peppol BIS Billing 3.0<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Sweden<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63805Electronic Billing2025-08-05T12:55:28Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial:<br />
https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Estonia=<br />
<br />
===Format===<br />
Peppol <br />
<br />
===Timeline===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
===Dolibarr support===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: <nowiki>https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client</nowiki> (to be confirmed)<br />
<br />
===Legislation and current status===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
*B2G: Yes<br />
*B2B: Partial<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Latvia=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
eInvoicing starting from 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Latvia*<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Lithuania=<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
mandatory eInvoicing targeted for 1 January 2028.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Lithuania<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Norway=<br />
==Format==<br />
The electronic invoice format must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Poland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
=Romania=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63804Electronic Billing2025-08-04T23:00:03Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial: https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Croatia=<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Croatia<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
= Estonia =<br />
<br />
=== Format ===<br />
Peppol <br />
<br />
=== Timeline ===<br />
Since 1 July 2025 all accounting entities registered as e-invoice recipients in the commercial register are entitled to receive e-invoices by default.<br />
<br />
=== Dolibarr support ===<br />
To generate invoices in this format, you may need to install the module: <nowiki>https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html</nowiki><br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: <nowiki>https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client</nowiki> (to be confirmed)<br />
<br />
=== Legislation and current status ===<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Estonia<br />
<br />
* B2G: Yes<br />
* B2B: Yes<br />
* B2C: No<br />
* VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
UBL 2.1 and Cross-Industry Invoice (CII)<sup>[3]</sup> or national formats such as Finvoice 3.0 and TEAPPSXML 3.0 (provided their compliance with the European Standard) or Peppol BIS Billing 3.0.<br />
==Timeline==<br />
There is no business-to-business (B2B) mandate.<br />
<br />
However, under the eInvoicing Act 241/2019, companies with an annual turnover exceeding EUR 10,000 are entitled to request EN-compliant eInvoices from their suppliers.<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
<br />
Legislation and current status<br />
<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Finland<br />
<br />
* B2G: Yes<br />
* B2B: Partial<br />
* B2C: No<br />
* VAT Real-Time Reporting: No<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
* B2B: Not yet<br />
* B2C: No<br />
* VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: No<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2C: No<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Ireland=<br />
==Format==<br />
PEPPOL BIS Billing 3.0.<br />
==Timeline==<br />
No Business-to-Government (B2G) eInvoicing mandate exists, but since June 2019, all public sector entities are required to receive and process structured eInvoices compliant with the European standard (EN 16931)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
== Legislation and current status ==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Ireland<br />
*B2G: Yes<br />
*B2B: No<br />
*B2C: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*VAT Real-Time Reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
<br />
=Norway=<br />
==Format==<br />
The electronic invoice format must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Poland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
=Romania=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63803Electronic Billing2025-08-04T22:34:35Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2B: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial: https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
= Croatia =<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2B: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2B: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Ireland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*VAT Real-Time Reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
<br />
=Norway=<br />
==Format==<br />
The electronic invoice format must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Poland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
=Romania=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63802Electronic Billing2025-08-04T22:33:44Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2B: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial: https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
== Croatia ==<br />
<br />
==Format==<br />
Compliant with the European standard (EN 16931)<br />
==Timeline==<br />
There are no current Business-to-Business (B2B) or Business-to-Consumer (B2C) eInvoicing mandates. However, a B2B mandate is under public consultation and is expected to take effect on 1 January 2026. Near real-time reporting is expected to begin in 2026.<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2B: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Denmark=<br />
==Format==<br />
Peppol BIS 3.0 and OIOUBL 3.0<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2B: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Ireland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*VAT Real-Time Reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
<br />
=Norway=<br />
==Format==<br />
The electronic invoice format must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Poland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
=Romania=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63801Electronic Billing2025-08-04T22:18:19Z<p>Sonikf: /* Format */</p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2B: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial: https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Colombia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not got enough feedback to know it this module is still valid.<br />
<br />
<br />
=Denmark=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
No mandate for B2B einvoicing yet, but under the 2022 Bookkeeping Act, businesses must ensure their systems are capable of sending and receiving eInvoices, including through Peppol and NemHandel<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
== Legislation and current status ==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Denmark<br />
<br />
*B2G: Yes<br />
*B2B: No<br />
*B2B: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Finland=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Ireland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*VAT Real-Time Reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
<br />
=Norway=<br />
==Format==<br />
The electronic invoice format must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Poland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
=Romania=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63800Electronic Billing2025-08-04T21:44:54Z<p>Sonikf: </p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Austria=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Austria<br />
<br />
*B2G: No<br />
*B2B: No<br />
*VAT Real-Time Reporting: No<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*B2B: No<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial: https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Columbia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not enought feedback to know it this module is still valid.<br />
<br />
<br />
=Danemark=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Finland=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*VAT Real-Time Reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*VAT Real-Time Reporting: Yes<br />
<br />
=Ireland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*VAT Real-Time Reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
<br />
=Norway=<br />
==Format==<br />
The electronic invoice format must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Poland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
=Romania=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*VAT Real-Time Reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=63799Electronic Billing2025-08-04T16:27:01Z<p>Sonikf: /* Legislation and current status */</p>
<hr />
<div>{{TemplateDocUser}}<br />
<seo metak="einvoice, ereporting" /><br />
<br />
This page presents a description of the rules and solutions for electronic invoicing ('''e-invoicing, e-billing''') and '''e-reporting'''.<br />
<br />
The laws, rules, and solutions to read, generate and/or send e-invoice depend on your country...<br />
<br />
If your country is not in this list, fee free to develop your own interface module and publish it on any git source repository or packaged as a zip (for the price of your choice) on dolistore.com. But you can also do it as an laternative of an exsiting solution if a module already exists and does not match your need...<br />
<br />
<br />
=Austria=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
== Legislation and current status ==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Austria<br />
<br />
*B2G: No<br />
*B2B: No<br />
*E-reporting: No<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the peppol network, you can follow this tutorial: https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=Columbia=<br />
==Format==<br />
Factura Electronica Colombia DIAN<br />
<br />
...To complete...<br />
<br />
==Dolibarr support==<br />
An old module is available here: https://www.dolistore.com/product.php?id=1205&title=factura-electronica-colombia-dian&l=en<br />
We have not enought feedback to know it this module is still valid.<br />
<br />
<br />
=Danemark=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Finland=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The [[Module Chorus|Chorus Pro Module]] - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
*To develop your own code to interface with Chorus, there is a small tuto on the french forum: https://www.dolibarr.fr/forum/t/connexion-api-chorus-pro-environnement-de-test-qualif/46738<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*Digital delivery note: Yes<br />
<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2019, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://doliplatform.com/fatturazione-elettronica/ (Italian Dolibarr Preferred Partner Diciannove Soc. Coop. )<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*https://www.fatturapa.gov.it/en/index.html<br />
*B2G: Yes<br />
*B2B: Yes<br />
*B2C: Yes<br />
*E-reporting: Yes<br />
<br />
=Ireland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*E-reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
CFDI XML<br />
<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install a CFDI XML module.<br />
<br />
*Sources of such a module are available here: https://github.com/avadnc/cfdixml<br />
<br />
*You can find a ready to deploy module file here: https://www.dolistore.com/product.php?id=354&title=mexico-cfdi&l=fr<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
<br />
=Norway=<br />
==Format==<br />
The electronic invoice format must follow Peppol.<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Poland=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
=Romania=<br />
==Format==<br />
The electronic invoice format in Romania must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Already required (to be confirmed)<br />
==Dolibarr support==<br />
You may try to use the follwing module to transfer your invoice on Peppol: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Sweden=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed)<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed)<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Spain (FacturaE - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called FacturaE (European standard EN 16931). VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
One of the following module is required:<br />
<br />
*'''Module DoliFactu'''<br />
<br />
A module called 2FacturaE exists to generated invoices using the invoice in the format expected (https://www.2byte.es/index.php/productos/modulo-2facturae). It was enough for spain.<br />
<br />
But this is no more true: In 2025, you must also now have a software that keep tracking of recording payment and invoices into an unalterable way.<br />
For this you need now the module DoliFactu (https://dolifactu.es/producto/modulo-antifraude-dolibarr/).<br />
<br />
Note also that there is also a ready to use hosting service called DoliFactu.es that includes this module by default in its offer.<br />
<br />
*'''Module LeyAntiFraudeYVeriFactu'''<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install the external module called "Ley antifraude y VeriFactu"<br />
<br />
You can get the module here: https://www.dolistore.com/fr/modules/2259-Ley-antifraude-y-VeriFactu.html?search_query=verifactu&results=1<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The "red payment slip" (called BV) and an "orange payment slip" (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but the installation of an external PHP library will be requested at the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
<br />
<br />
=United Kingdom=<br />
==Format==<br />
The electronic invoice format must follow Peppol (to be confirmed).<br />
==Timeline==<br />
Using Peppol is mandatory for invoices sent to administration (to be confirmed).<br />
==Dolibarr support==<br />
To generate invoices in this format, you may need to install the module: https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
The following module may also able to generate invoices but may also be able to send the invoice on the Peppol Network: https://www.dolistore.com/product.php?id=2427&title=peppol-full-integration-client (to be confirmed)<br />
<br />
<br />
=Other / Resources=<br />
More resources can be found: https://www.tx2.fr/en/2024/01/15/electronic-invoicing-europe-regulations-obligations/</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62275Create a PDF document template2025-01-23T23:55:14Z<p>Sonikf: /* Library for PDF manipulation */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
<br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelMycompanyblueDescription');'.<br />
#Save file.<br />
<br />
*Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:<br />
<br />
#'models' => 0 to 'models' => 1<br />
#Save file.<br />
<br />
*Activate your new module<br />
<br />
Now the template will be available in the list of models in the admin settings of proposal.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
==For a new module==<br />
Just use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] AGAIN to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php. This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the TCPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62274Create a PDF document template2025-01-23T23:52:46Z<p>Sonikf: /* Customize content of your new template */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
<br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelMycompanyblueDescription');'.<br />
#Save file.<br />
<br />
*Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:<br />
<br />
#'models' => 0 to 'models' => 1<br />
#Save file.<br />
<br />
*Activate your new module<br />
<br />
Now the template will be available in the list of models in the admin settings of proposal.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
==For a new module==<br />
Just use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] AGAIN to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62273Create a PDF document template2025-01-23T23:45:00Z<p>Sonikf: /* Create a new template */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
<br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelMycompanyblueDescription');'.<br />
#Save file.<br />
<br />
*Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:<br />
<br />
#'models' => 0 to 'models' => 1<br />
#Save file.<br />
<br />
*Activate your new module<br />
<br />
Now the template will be available in the list of models in the admin settings of proposal.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
==For a new module==<br />
Just use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] AGAIN to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62272Create a PDF document template2025-01-23T23:43:42Z<p>Sonikf: /* For an existing core module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
<br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelMycompanyblueDescription');'.<br />
#Save file.<br />
<br />
*Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:<br />
<br />
#'models' => 0 to 'models' => 1<br />
#Save file.<br />
<br />
*Activate your new module<br />
<br />
Now the template will be available in the list of models in the admin settings of proposal.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62271Create a PDF document template2025-01-23T23:40:28Z<p>Sonikf: /* For an existing core module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
<br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.<br />
#Save file.<br />
<br />
* Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:<br />
<br />
# 'models' => 0 to 'models' => 1<br />
# Save file.<br />
* Activate your new module<br />
<br />
Now the template will be available in the list of models in the admin settings of proposal.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62270Create a PDF document template2025-01-23T23:30:20Z<p>Sonikf: /* For an existing core module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
<br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#from <nowiki><syntaxhighlight lang="PHP">Class pdf_cyan</syntaxhighlight></nowiki> to <nowiki><syntaxhighlight lang="PHP">Class pdf_mycompanyblue</syntaxhighlight></nowiki><br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.<br />
#Save file.<br />
<br />
* Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:<br />
<br />
# 'models' => 0 to 'models' => 1<br />
# Save file.<br />
<br />
<br />
Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62269Create a PDF document template2025-01-23T23:18:10Z<p>Sonikf: /* For an existing core module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
<br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'Class pdf_cyan' to 'Class pdf_mycompanyblue'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.<br />
#Save file.<br />
<br />
Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62268Create a PDF document template2025-01-23T23:15:49Z<p>Sonikf: /* For an existing core module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder |Module Builder]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'Class pdf_cyan' to 'Class pdf_mycompanyblue'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.<br />
#Save file. <br />
Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62267Create a PDF document template2025-01-23T23:06:35Z<p>Sonikf: /* Create a new template */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing core module==<br />
Do not directly modify an existing template. <br />
Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).<br />
<br />
Instead use the the Module Builder [[Module development]] available from v12.0 to create your own module even for just a new template.<br />
<br />
For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
<br />
*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit the file and make the following changes in the code:<br />
<br />
#'Class pdf_cyan' to 'Class pdf_mycompanyblue'<br />
#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.<br />
#Save file. <br />
Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Module_development&diff=62266Module development2025-01-23T23:01:03Z<p>Sonikf: /* Module creation with the module builder */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Développement_module]]<br />
[[es:Desarrollo_de_un_módulo]]<br />
[[de:Modul_Entwicklung]]<br />
[[zh:模块开发]]<br />
[[ja:モジュール_開発]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Core]]<br />
{{TemplateDocDevEn}}<br />
<br />
To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :<br />
<br />
*Add new tables in database.<br />
*Add your own menu entries.<br />
*Add new screens to edit new tables.<br />
*Add or remove tabs on object view (invoice, product, order, event, ...).<br />
*Add predefined exports for the internal export tool.<br />
*Add new information widget in the home page.<br />
*Add new substitutions variables.<br />
*Define new permissions.<br />
*Execute code automatically triggered by a particular Dolibarr action.<br />
*Insert your code inside Dolibarr hooks positions.<br />
*Add your numbering rule to generate the reference of objects<br />
*Add a new document template.<br />
*Add a new skin.<br />
<br />
etc...<br />
<br />
Following chapters presents how to do all of this manually with an easy way.<br />
<br />
=Module creation with the module builder=<br />
From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:<br />
<br />
Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png|alt=Module Builder|thumb|none]]<br />
<br />
<br />
Then click on the "bug" image in the top right of screen.[[File:Module Builder icon.png|alt=Module Builder icon|left|thumb]]<br />
<br /><br />
=Template of an External Module=<br />
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]<br />
<br />
=Create your module=<br />
==Create a Module descriptor for your Module (required)==<br />
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).<br />
<br />
'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''<br />
<br />
===Create your module descriptor===<br />
The first step is to create a file descriptor for the module. <br />
<br />
*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').<br />
<br />
Next modify the contents of this file as follows:<br />
<br />
*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").<br />
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].<br />
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).<br />
<br />
Your file descriptor for your module is ready. See the next step to activate it.<br />
<br />
===Test your descriptor===<br />
<br />
Launch Dolibarr and go to page '''Setup->module'''? <br />
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.<br />
<br />
==Tree of path for new module files (required)==<br />
This is how your files must be organized when building a new module (the zip file must also match this rule).<br />
Note: Only the second line is mandatory.<br />
<br />
{{TemplateModuleTreeSimple}}<br />
<br />
==Create your SQL tables and the PHP DAO class (optional)==<br />
'''When''': If your module needs to manage data of its own<br />
<br />
===Create your .sql file===<br />
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.<br />
<br />
Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).<br />
<br />
Then check into your descriptor file, into function '''init''' that the line<br />
<br />
<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight><br />
<br />
is not commented.<br />
<br />
''Rules to follow:''<br />
<br />
*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).<br />
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].<br />
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.<br />
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL<br />
<br />
Example of content of a file data.sql<br />
<syntaxhighlight lang="sql"><br />
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';<br />
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');<br />
</syntaxhighlight><br />
<br />
Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.<br />
<br />
===Test your .sql files===<br />
<br />
Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.<br />
<br />
===Generate the PHP DAO class===<br />
The DAO PHP files should have been generated by ModuleBuilder after creating an object.<br />
<br />
You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''<br />
<br />
In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.<br />
<br />
==The tab management (optional)==<br />
<br />
===Add or remove your own tabs on object sheets===<br />
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)<br />
<br />
To do this go into the file descriptor of module previously created and edit the $this->tabs array:<br />
<br />
<syntaxhighlight lang="PHP"><br />
// Array to add new pages in new tabs or remove existing one<br />
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1<br />
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2<br />
'objecttype:-tabname'); // To remove an existing tab identified by code tabname<br />
</syntaxhighlight><br />
<br />
The table should contain a list of strings, each string representing a new tab. <br />
The format of the string consisting of 5 parts separated by ":"<br />
<br />
*Part 1: The element type (object type) where the tab should appear is a value from the following:<br />
{{TemplateModuleTabs}}<br />
<br />
*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)<br />
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .<br />
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang<br />
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.<br />
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.<br />
<br />
To feed the contents of the tab with data from the database, see the next chapter.<br />
<br />
In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.<br />
<br />
===Show tabs navigation into your own pages===<br />
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.<br />
<br />
You must follow these steps :<br />
<br />
'''1. Include files you need into your file'''<br />
<br />
For each object type, there are two files to include with line<br />
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight><br />
<br />
This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :<br />
<br />
*Object thirdparty (thirdparty) :<br />
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php<br />
*Object product (product) :<br />
**DOL_DOCUMENT_ROOT/product/class/product.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php<br />
*Object invoice (invoice) :<br />
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php<br />
<br />
...<br />
<br />
'''2. Create and load the object to show into your tab'''<br />
<br />
Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$id=GETPOST('id','int');<br />
$ref=GETPOST('ref','alpha');<br />
$product = new Product($db) ;<br />
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok<br />
</syntaxhighlight><br />
<br />
'''3. Get a list of all tabs to show for your object type'''<br />
<br />
Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.<br />
<br />
The resulting array has the following structure<br />
<syntaxhighlight lang="PHP"><br />
$head // Array of tabs<br />
$head[$h] // Element to describe one tab.<br />
$head[$h][0] // Url of page to show when you click on tab<br />
$head[$h][1] // Title of tab<br />
$head[$h][2] // Code name to identify the tab<br />
</syntaxhighlight><br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly<br />
</syntaxhighlight><br />
<br />
'''4. show tabs into your page'''<br />
<br />
Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().<br />
<br />
<syntaxhighlight lang="PHP"><br />
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')<br />
//$links // Tableau des onglets, appelé $head plus haut.<br />
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance<br />
//$title // Title to show (shown into a special tab that you can't click)<br />
//$notab<br />
//$picto // Name of image to show into title. Possible values are:<br />
// product<br />
// service<br />
// company<br />
</syntaxhighlight><br />
<br />
This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.<br />
<br />
==Create or modify PHP screens (optional)==<br />
'''When''': If the purpose of your module is to add features that require new or modified screens.<br />
<br />
===Create a new PHP screen===<br />
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).<br />
<br />
To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.<br />
<br />
Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.<br />
Edit the file to have a correct relative path to the main.inc.php file. <br />
<syntaxhighlight lang="PHP"><br />
// Load Dolibarr environment<br />
$res=0;<br />
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)<br />
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");<br />
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME<br />
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;<br />
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }<br />
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");<br />
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");<br />
// Try main.inc.php using relative path<br />
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");<br />
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");<br />
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");<br />
if (! $res) die("Include of main fails");<br />
</syntaxhighlight><br />
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.<br />
<br />
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.<br />
<br />
It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:<br />
<br />
*$user Object that contains the characteristics of the user + his permissions.<br />
*$conf Object that contains Dolibarr configuration.<br />
*$db Object that contains an opened connection handler to the database.<br />
*$langs Object that contains the user's language.<br />
<br />
Then enter your code to display the page.<br />
<br />
*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');<br />
</syntaxhighlight><br />
<br />
*To include classes provided with Dolibarr, use the following syntax:<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';<br />
</syntaxhighlight><br />
<br />
===Add some fields into existing forms===<br />
You may want to provide a module that adds more fields into forms (input and view) of some elements. <br />
<br />
A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page). <br />
<br />
We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...<br />
<br />
*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].<br />
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.<br />
<br />
If you follow this tutorial, to be able to add fields into category forms, you must do:<br />
{{ToComplete}}<br />
<br />
===Add/replace part of fields supported by hooks===<br />
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.<br />
<br />
===Database access===<br />
If you need to edit some data in the database inside your own table, use the PHP class generated before.<br />
<br />
If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:<br />
<br />
To make an insert, update or delete:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$db->begin(); // Start transaction<br />
$db->query("My SQL request insert, update or delete");<br />
$db->commit(); // Validate transaction<br />
or $db->rollback() // Cancel transaction<br />
</syntaxhighlight><br />
<br />
To read:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$resql=$db->query("My select request");<br />
if ($resql)<br />
{<br />
$num = $db->num_rows($resql);<br />
$i = 0;<br />
if ($num)<br />
{<br />
while ($i < $num)<br />
{<br />
$obj = $db->fetch_object($resql);<br />
if ($obj)<br />
{<br />
// You can use here results<br />
print $obj->field1;<br />
print $obj->field2;<br />
}<br />
$i++;<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
===Define style of your pages===<br />
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.<br />
<br />
You can use for example:<br />
<br />
*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.<br />
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.<br />
*class="'''flat'''" on all input fields (''input, select, textarea''...).<br />
*class="'''button'''" on HTML fields with type ''input type="submit"''.<br />
<br />
===Use the Dolibarr date picker===<br />
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:<br />
<syntaxhighlight lang="PHP"><br />
$form=new Form($db);<br />
$form->select_date('','mykey',0,0,0,"myform");<br />
</syntaxhighlight><br />
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.<br />
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).<br />
This means a date selector must be included necessarily into an html FORM.<br />
<br />
To get value after the POST of your form, the command is:<br />
<syntaxhighlight lang="PHP"><br />
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));<br />
print strftime('%A %d %B %Y', $mydate);<br />
</syntaxhighlight><br />
<br />
===Overwrite template file (tpl)===<br />
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :<br />
<syntaxhighlight lang="PHP"><br />
'tpl' => 1,<br />
</syntaxhighlight><br />
Then you can put any tpl file on '''mymodule/core/tpl'''<br />
as soon as the module is activate, the tpl will be overwrited<br />
<br />
==Add your own setup page (optional)==<br />
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.<br />
<br />
===Create your page to edit parameters===<br />
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).<br />
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.<br />
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.<br />
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).<br />
<br />
===Modify the descriptor file of your module===<br />
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.<br />
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php");<br />
</syntaxhighlight><br />
If the page is in the directory '''mymodule/admin/''', then like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php@mymodule");<br />
</syntaxhighlight><br />
<br />
===Test your page===<br />
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.<br />
<br />
==Define your entries in menu (optional)==<br />
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.<br />
<br />
===Define your menu entries===<br />
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.<br />
This array contains entries that will appear once your module is activated.<br />
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.<br />
<br />
This is the example of code to declare your own menu entries in a module descriptor file:<br />
<syntaxhighlight lang="PHP"><br />
// Main menu entries<br />
$this->menu = array(); // List of menus to add<br />
$r=0;<br />
<br />
// Add here entries to declare new menus<br />
// Example to declare the Top Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu<br />
'type'=>'top', // This is a Top menu entry<br />
'titre'=>'MyModule top menu',<br />
'mainmenu'=>'mymodule',<br />
'leftmenu'=>'mymodule',<br />
'url'=>'/mymodule/pagetop.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both<br />
$r++;<br />
<br />
// Example to declare a Left Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu<br />
'type'=>'left', // This is a Left menu entry<br />
'titre'=>'MyModule left menu 1',<br />
'mainmenu'=>'xxx',<br />
'leftmenu'=>'yyy',<br />
'url'=>'/mymodule/pagelevel1.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users,1=external users, 2=both<br />
$r++;<br />
</syntaxhighlight><br />
<br />
To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.<br />
<br />
===Test your menu entries===<br />
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).<br />
<br />
==Add your own permissions (optional)==<br />
'''When''': If you want to add new permissions.<br />
<br />
The way to define permissions that will manage your module is done inside the module descriptor created previously.<br />
Modify line <br />
<syntaxhighlight lang="PHP"><br />
$this->rights_class = 'mymodule'<br />
</syntaxhighlight><br />
with correct value for mymodule.<br />
<br />
Then you must fill the array $this->rights with as many entries than different permissions you need to manage.<br />
<br />
<syntaxhighlight lang="PHP"><br />
$this->rights[$r][0] = 10001;<br />
$this->rights[$r][1] = 'Label by default of permission';<br />
$this->rights[$r][2] = 'r';<br />
$this->rights[$r][3] = 1;<br />
$this->rights[$r][4] = 'action';<br />
$this->rights[$r][5] = 'subaction';<br />
$r++;<br />
</syntaxhighlight><br />
<br />
Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.<br />
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").<br />
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.<br />
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.<br />
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:<br />
<br />
<syntaxhighlight lang="PHP"><br />
if ($user->rights->mymodule->action->subaction) ...<br />
</syntaxhighlight><br />
<br />
==Define your own box (optional)==<br />
'''When''': If your module needs to provide one or several new boxes to show on home page.<br />
<br />
===Define your box===<br />
For this, modify the array $this->boxes into the module descriptor file.<br />
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''<br />
<br />
''Example:''<br />
<syntaxhighlight lang="PHP"><br />
$this->boxes[0]['file']='mybox0.php@mymodule'<br />
$this->boxes[0]['note']='My box 0'<br />
...<br />
$this->boxes[n]['file']='myboxn.php@mymodule'<br />
$this->boxes[n]['note']='My box n'<br />
</syntaxhighlight><br />
<br />
Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').<br />
<br />
===Test if your box is detected by Dolibarr===<br />
Disable and enabled module.<br />
<br />
Go into menu '''Home - Setup - Boxes'''.<br />
<br />
Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.<br />
<br />
==Define your own export (optional)==<br />
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).<br />
<br />
===Define export===<br />
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.<br />
<br />
===Test your export===<br />
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).<br />
Choose it, you must see a list of all possible fields defined in the export arrays.<br />
Choose on field and try to build an export file. If ok, try again with all fields.<br />
<br />
==Define your CSS styles (optional)==<br />
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).<br />
<br />
===Create and declare your style sheet===<br />
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.<br />
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.<br />
<br />
Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.<br />
Value to put here must be an array of relative URLs to your CSS files.<br />
For example<br />
<syntaxhighlight lang="PHP"><br />
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));<br />
</syntaxhighlight><br />
<br />
===Test your style sheet===<br />
Disable and enable your module.<br />
<br />
Go on the home page (index.php). Show the HTML source of the page.<br />
<br />
You should see into the HTML header, a line that declares your style sheet.<br />
<br />
==Add your Javascript functions (optional)==<br />
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)<br />
<br />
If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.<br />
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.<br />
<br />
Example for page /htdocs/mymodule/mypage.php :<br />
<syntaxhighlight lang="PHP"><br />
$morejs=array("/mymodule/js/mymodule.js");<br />
llxHeader('','Titre','','','','',$morejs,'',0,0); <br />
</syntaxhighlight><br />
<br />
==Run your own code on any Dolibarr event (optional)==<br />
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.<br />
<br />
See also [[Interfaces_Dolibarr_toward_foreign_systems]]<br />
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]<br />
<br />
==Insert your code inside Dolibarr hooks positions (optional)==<br />
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).<br />
<br />
See page [[Hooks_system]].<br />
<br />
<br />
==Add your own numbering rules==<br />
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.<br />
<br />
See page [[Create numbering module]].<br />
<br />
==Add your document template (optional)==<br />
'''When''': When you want to personalized your own generated PDF or ODT documents.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].<br />
<br />
==Add your skin (optional)==<br />
'''When''': When you want to personalized your colors/fonts/images.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
To add your own skin, read page [[Skins]].<br />
<br />
=Some coding rules and predefined functions=<br />
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".<br />
<br />
A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".<br />
<br />
=Create a package to distribute and install your module=<br />
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.<br />
But you can use it to have a package easy to distribute on your own network.<br />
<br />
*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).<br />
<br />
Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)<br />
<br />
*Run the script via Perl (need the Perl version 5.0 or later):<br />
<br />
<syntaxhighlight lang="bash"><br />
perl makepack-dolibarrmodule.pl<br />
</syntaxhighlight><br />
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.<br />
<br />
*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:<br />
<br />
<syntaxhighlight lang="bash"><br />
tar -xvf mymodule.zip<br />
</syntaxhighlight><br />
<br />
*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").<br />
**If your module was built correctly, the file will be validated later.<br />
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).<br />
<br />
=Enabling/activation condition of external module on DoliStore=<br />
<br />
See [[Module_Dolistore_Validation_Rules|Validation Rules]]<br />
[[Category:Development]]</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Module_development&diff=62265Module development2025-01-23T23:00:18Z<p>Sonikf: </p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Développement_module]]<br />
[[es:Desarrollo_de_un_módulo]]<br />
[[de:Modul_Entwicklung]]<br />
[[zh:模块开发]]<br />
[[ja:モジュール_開発]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Core]]<br />
{{TemplateDocDevEn}}<br />
<br />
To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :<br />
<br />
*Add new tables in database.<br />
*Add your own menu entries.<br />
*Add new screens to edit new tables.<br />
*Add or remove tabs on object view (invoice, product, order, event, ...).<br />
*Add predefined exports for the internal export tool.<br />
*Add new information widget in the home page.<br />
*Add new substitutions variables.<br />
*Define new permissions.<br />
*Execute code automatically triggered by a particular Dolibarr action.<br />
*Insert your code inside Dolibarr hooks positions.<br />
*Add your numbering rule to generate the reference of objects<br />
*Add a new document template.<br />
*Add a new skin.<br />
<br />
etc...<br />
<br />
Following chapters presents how to do all of this manually with an easy way.<br />
<br />
=Module creation with the module builder=<br />
From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:<br />
<br />
Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png|alt=Module Builder|thumb|left]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Then click on the "bug" image in the top right of screen.<br />
<br />
[[File:Module Builder icon.png|alt=Module Builder icon|left|thumb]]<br />
<br /><br />
=Template of an External Module=<br />
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]<br />
<br />
=Create your module=<br />
==Create a Module descriptor for your Module (required)==<br />
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).<br />
<br />
'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''<br />
<br />
===Create your module descriptor===<br />
The first step is to create a file descriptor for the module. <br />
<br />
*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').<br />
<br />
Next modify the contents of this file as follows:<br />
<br />
*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").<br />
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].<br />
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).<br />
<br />
Your file descriptor for your module is ready. See the next step to activate it.<br />
<br />
===Test your descriptor===<br />
<br />
Launch Dolibarr and go to page '''Setup->module'''? <br />
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.<br />
<br />
==Tree of path for new module files (required)==<br />
This is how your files must be organized when building a new module (the zip file must also match this rule).<br />
Note: Only the second line is mandatory.<br />
<br />
{{TemplateModuleTreeSimple}}<br />
<br />
==Create your SQL tables and the PHP DAO class (optional)==<br />
'''When''': If your module needs to manage data of its own<br />
<br />
===Create your .sql file===<br />
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.<br />
<br />
Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).<br />
<br />
Then check into your descriptor file, into function '''init''' that the line<br />
<br />
<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight><br />
<br />
is not commented.<br />
<br />
''Rules to follow:''<br />
<br />
*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).<br />
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].<br />
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.<br />
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL<br />
<br />
Example of content of a file data.sql<br />
<syntaxhighlight lang="sql"><br />
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';<br />
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');<br />
</syntaxhighlight><br />
<br />
Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.<br />
<br />
===Test your .sql files===<br />
<br />
Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.<br />
<br />
===Generate the PHP DAO class===<br />
The DAO PHP files should have been generated by ModuleBuilder after creating an object.<br />
<br />
You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''<br />
<br />
In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.<br />
<br />
==The tab management (optional)==<br />
<br />
===Add or remove your own tabs on object sheets===<br />
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)<br />
<br />
To do this go into the file descriptor of module previously created and edit the $this->tabs array:<br />
<br />
<syntaxhighlight lang="PHP"><br />
// Array to add new pages in new tabs or remove existing one<br />
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1<br />
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2<br />
'objecttype:-tabname'); // To remove an existing tab identified by code tabname<br />
</syntaxhighlight><br />
<br />
The table should contain a list of strings, each string representing a new tab. <br />
The format of the string consisting of 5 parts separated by ":"<br />
<br />
*Part 1: The element type (object type) where the tab should appear is a value from the following:<br />
{{TemplateModuleTabs}}<br />
<br />
*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)<br />
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .<br />
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang<br />
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.<br />
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.<br />
<br />
To feed the contents of the tab with data from the database, see the next chapter.<br />
<br />
In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.<br />
<br />
===Show tabs navigation into your own pages===<br />
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.<br />
<br />
You must follow these steps :<br />
<br />
'''1. Include files you need into your file'''<br />
<br />
For each object type, there are two files to include with line<br />
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight><br />
<br />
This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :<br />
<br />
*Object thirdparty (thirdparty) :<br />
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php<br />
*Object product (product) :<br />
**DOL_DOCUMENT_ROOT/product/class/product.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php<br />
*Object invoice (invoice) :<br />
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php<br />
<br />
...<br />
<br />
'''2. Create and load the object to show into your tab'''<br />
<br />
Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$id=GETPOST('id','int');<br />
$ref=GETPOST('ref','alpha');<br />
$product = new Product($db) ;<br />
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok<br />
</syntaxhighlight><br />
<br />
'''3. Get a list of all tabs to show for your object type'''<br />
<br />
Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.<br />
<br />
The resulting array has the following structure<br />
<syntaxhighlight lang="PHP"><br />
$head // Array of tabs<br />
$head[$h] // Element to describe one tab.<br />
$head[$h][0] // Url of page to show when you click on tab<br />
$head[$h][1] // Title of tab<br />
$head[$h][2] // Code name to identify the tab<br />
</syntaxhighlight><br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly<br />
</syntaxhighlight><br />
<br />
'''4. show tabs into your page'''<br />
<br />
Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().<br />
<br />
<syntaxhighlight lang="PHP"><br />
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')<br />
//$links // Tableau des onglets, appelé $head plus haut.<br />
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance<br />
//$title // Title to show (shown into a special tab that you can't click)<br />
//$notab<br />
//$picto // Name of image to show into title. Possible values are:<br />
// product<br />
// service<br />
// company<br />
</syntaxhighlight><br />
<br />
This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.<br />
<br />
==Create or modify PHP screens (optional)==<br />
'''When''': If the purpose of your module is to add features that require new or modified screens.<br />
<br />
===Create a new PHP screen===<br />
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).<br />
<br />
To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.<br />
<br />
Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.<br />
Edit the file to have a correct relative path to the main.inc.php file. <br />
<syntaxhighlight lang="PHP"><br />
// Load Dolibarr environment<br />
$res=0;<br />
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)<br />
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");<br />
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME<br />
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;<br />
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }<br />
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");<br />
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");<br />
// Try main.inc.php using relative path<br />
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");<br />
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");<br />
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");<br />
if (! $res) die("Include of main fails");<br />
</syntaxhighlight><br />
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.<br />
<br />
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.<br />
<br />
It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:<br />
<br />
*$user Object that contains the characteristics of the user + his permissions.<br />
*$conf Object that contains Dolibarr configuration.<br />
*$db Object that contains an opened connection handler to the database.<br />
*$langs Object that contains the user's language.<br />
<br />
Then enter your code to display the page.<br />
<br />
*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');<br />
</syntaxhighlight><br />
<br />
*To include classes provided with Dolibarr, use the following syntax:<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';<br />
</syntaxhighlight><br />
<br />
===Add some fields into existing forms===<br />
You may want to provide a module that adds more fields into forms (input and view) of some elements. <br />
<br />
A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page). <br />
<br />
We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...<br />
<br />
*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].<br />
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.<br />
<br />
If you follow this tutorial, to be able to add fields into category forms, you must do:<br />
{{ToComplete}}<br />
<br />
===Add/replace part of fields supported by hooks===<br />
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.<br />
<br />
===Database access===<br />
If you need to edit some data in the database inside your own table, use the PHP class generated before.<br />
<br />
If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:<br />
<br />
To make an insert, update or delete:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$db->begin(); // Start transaction<br />
$db->query("My SQL request insert, update or delete");<br />
$db->commit(); // Validate transaction<br />
or $db->rollback() // Cancel transaction<br />
</syntaxhighlight><br />
<br />
To read:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$resql=$db->query("My select request");<br />
if ($resql)<br />
{<br />
$num = $db->num_rows($resql);<br />
$i = 0;<br />
if ($num)<br />
{<br />
while ($i < $num)<br />
{<br />
$obj = $db->fetch_object($resql);<br />
if ($obj)<br />
{<br />
// You can use here results<br />
print $obj->field1;<br />
print $obj->field2;<br />
}<br />
$i++;<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
===Define style of your pages===<br />
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.<br />
<br />
You can use for example:<br />
<br />
*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.<br />
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.<br />
*class="'''flat'''" on all input fields (''input, select, textarea''...).<br />
*class="'''button'''" on HTML fields with type ''input type="submit"''.<br />
<br />
===Use the Dolibarr date picker===<br />
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:<br />
<syntaxhighlight lang="PHP"><br />
$form=new Form($db);<br />
$form->select_date('','mykey',0,0,0,"myform");<br />
</syntaxhighlight><br />
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.<br />
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).<br />
This means a date selector must be included necessarily into an html FORM.<br />
<br />
To get value after the POST of your form, the command is:<br />
<syntaxhighlight lang="PHP"><br />
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));<br />
print strftime('%A %d %B %Y', $mydate);<br />
</syntaxhighlight><br />
<br />
===Overwrite template file (tpl)===<br />
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :<br />
<syntaxhighlight lang="PHP"><br />
'tpl' => 1,<br />
</syntaxhighlight><br />
Then you can put any tpl file on '''mymodule/core/tpl'''<br />
as soon as the module is activate, the tpl will be overwrited<br />
<br />
==Add your own setup page (optional)==<br />
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.<br />
<br />
===Create your page to edit parameters===<br />
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).<br />
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.<br />
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.<br />
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).<br />
<br />
===Modify the descriptor file of your module===<br />
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.<br />
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php");<br />
</syntaxhighlight><br />
If the page is in the directory '''mymodule/admin/''', then like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php@mymodule");<br />
</syntaxhighlight><br />
<br />
===Test your page===<br />
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.<br />
<br />
==Define your entries in menu (optional)==<br />
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.<br />
<br />
===Define your menu entries===<br />
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.<br />
This array contains entries that will appear once your module is activated.<br />
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.<br />
<br />
This is the example of code to declare your own menu entries in a module descriptor file:<br />
<syntaxhighlight lang="PHP"><br />
// Main menu entries<br />
$this->menu = array(); // List of menus to add<br />
$r=0;<br />
<br />
// Add here entries to declare new menus<br />
// Example to declare the Top Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu<br />
'type'=>'top', // This is a Top menu entry<br />
'titre'=>'MyModule top menu',<br />
'mainmenu'=>'mymodule',<br />
'leftmenu'=>'mymodule',<br />
'url'=>'/mymodule/pagetop.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both<br />
$r++;<br />
<br />
// Example to declare a Left Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu<br />
'type'=>'left', // This is a Left menu entry<br />
'titre'=>'MyModule left menu 1',<br />
'mainmenu'=>'xxx',<br />
'leftmenu'=>'yyy',<br />
'url'=>'/mymodule/pagelevel1.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users,1=external users, 2=both<br />
$r++;<br />
</syntaxhighlight><br />
<br />
To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.<br />
<br />
===Test your menu entries===<br />
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).<br />
<br />
==Add your own permissions (optional)==<br />
'''When''': If you want to add new permissions.<br />
<br />
The way to define permissions that will manage your module is done inside the module descriptor created previously.<br />
Modify line <br />
<syntaxhighlight lang="PHP"><br />
$this->rights_class = 'mymodule'<br />
</syntaxhighlight><br />
with correct value for mymodule.<br />
<br />
Then you must fill the array $this->rights with as many entries than different permissions you need to manage.<br />
<br />
<syntaxhighlight lang="PHP"><br />
$this->rights[$r][0] = 10001;<br />
$this->rights[$r][1] = 'Label by default of permission';<br />
$this->rights[$r][2] = 'r';<br />
$this->rights[$r][3] = 1;<br />
$this->rights[$r][4] = 'action';<br />
$this->rights[$r][5] = 'subaction';<br />
$r++;<br />
</syntaxhighlight><br />
<br />
Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.<br />
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").<br />
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.<br />
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.<br />
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:<br />
<br />
<syntaxhighlight lang="PHP"><br />
if ($user->rights->mymodule->action->subaction) ...<br />
</syntaxhighlight><br />
<br />
==Define your own box (optional)==<br />
'''When''': If your module needs to provide one or several new boxes to show on home page.<br />
<br />
===Define your box===<br />
For this, modify the array $this->boxes into the module descriptor file.<br />
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''<br />
<br />
''Example:''<br />
<syntaxhighlight lang="PHP"><br />
$this->boxes[0]['file']='mybox0.php@mymodule'<br />
$this->boxes[0]['note']='My box 0'<br />
...<br />
$this->boxes[n]['file']='myboxn.php@mymodule'<br />
$this->boxes[n]['note']='My box n'<br />
</syntaxhighlight><br />
<br />
Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').<br />
<br />
===Test if your box is detected by Dolibarr===<br />
Disable and enabled module.<br />
<br />
Go into menu '''Home - Setup - Boxes'''.<br />
<br />
Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.<br />
<br />
==Define your own export (optional)==<br />
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).<br />
<br />
===Define export===<br />
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.<br />
<br />
===Test your export===<br />
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).<br />
Choose it, you must see a list of all possible fields defined in the export arrays.<br />
Choose on field and try to build an export file. If ok, try again with all fields.<br />
<br />
==Define your CSS styles (optional)==<br />
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).<br />
<br />
===Create and declare your style sheet===<br />
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.<br />
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.<br />
<br />
Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.<br />
Value to put here must be an array of relative URLs to your CSS files.<br />
For example<br />
<syntaxhighlight lang="PHP"><br />
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));<br />
</syntaxhighlight><br />
<br />
===Test your style sheet===<br />
Disable and enable your module.<br />
<br />
Go on the home page (index.php). Show the HTML source of the page.<br />
<br />
You should see into the HTML header, a line that declares your style sheet.<br />
<br />
==Add your Javascript functions (optional)==<br />
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)<br />
<br />
If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.<br />
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.<br />
<br />
Example for page /htdocs/mymodule/mypage.php :<br />
<syntaxhighlight lang="PHP"><br />
$morejs=array("/mymodule/js/mymodule.js");<br />
llxHeader('','Titre','','','','',$morejs,'',0,0); <br />
</syntaxhighlight><br />
<br />
==Run your own code on any Dolibarr event (optional)==<br />
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.<br />
<br />
See also [[Interfaces_Dolibarr_toward_foreign_systems]]<br />
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]<br />
<br />
==Insert your code inside Dolibarr hooks positions (optional)==<br />
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).<br />
<br />
See page [[Hooks_system]].<br />
<br />
<br />
==Add your own numbering rules==<br />
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.<br />
<br />
See page [[Create numbering module]].<br />
<br />
==Add your document template (optional)==<br />
'''When''': When you want to personalized your own generated PDF or ODT documents.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].<br />
<br />
==Add your skin (optional)==<br />
'''When''': When you want to personalized your colors/fonts/images.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
To add your own skin, read page [[Skins]].<br />
<br />
=Some coding rules and predefined functions=<br />
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".<br />
<br />
A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".<br />
<br />
=Create a package to distribute and install your module=<br />
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.<br />
But you can use it to have a package easy to distribute on your own network.<br />
<br />
*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).<br />
<br />
Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)<br />
<br />
*Run the script via Perl (need the Perl version 5.0 or later):<br />
<br />
<syntaxhighlight lang="bash"><br />
perl makepack-dolibarrmodule.pl<br />
</syntaxhighlight><br />
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.<br />
<br />
*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:<br />
<br />
<syntaxhighlight lang="bash"><br />
tar -xvf mymodule.zip<br />
</syntaxhighlight><br />
<br />
*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").<br />
**If your module was built correctly, the file will be validated later.<br />
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).<br />
<br />
=Enabling/activation condition of external module on DoliStore=<br />
<br />
See [[Module_Dolistore_Validation_Rules|Validation Rules]]<br />
[[Category:Development]]</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Module_development&diff=62264Module development2025-01-23T22:59:16Z<p>Sonikf: /* Module creation with the module builder */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Développement_module]]<br />
[[es:Desarrollo_de_un_módulo]]<br />
[[de:Modul_Entwicklung]]<br />
[[zh:模块开发]]<br />
[[ja:モジュール_開発]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Core]]<br />
{{TemplateDocDevEn}}<br />
<br />
To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :<br />
<br />
*Add new tables in database.<br />
*Add your own menu entries.<br />
*Add new screens to edit new tables.<br />
*Add or remove tabs on object view (invoice, product, order, event, ...).<br />
*Add predefined exports for the internal export tool.<br />
*Add new information widget in the home page.<br />
*Add new substitutions variables.<br />
*Define new permissions.<br />
*Execute code automatically triggered by a particular Dolibarr action.<br />
*Insert your code inside Dolibarr hooks positions.<br />
*Add your numbering rule to generate the reference of objects<br />
*Add a new document template.<br />
*Add a new skin.<br />
<br />
etc...<br />
<br />
Following chapters presents how to do all of this manually with an easy way.<br />
<br />
=Module creation with the module builder=<br />
From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:<br />
<br />
Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png|alt=Module Builder|thumb|left]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Then click on the "bug" image in the top right of screen.<br />
[[File:Module Builder icon.png|alt=Module Builder icon|left|thumb]]<br />
<br /><br />
=Template of an External Module=<br />
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]<br />
<br />
=Create your module=<br />
==Create a Module descriptor for your Module (required)==<br />
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).<br />
<br />
'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''<br />
<br />
===Create your module descriptor===<br />
The first step is to create a file descriptor for the module. <br />
<br />
*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').<br />
<br />
Next modify the contents of this file as follows:<br />
<br />
*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").<br />
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].<br />
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).<br />
<br />
Your file descriptor for your module is ready. See the next step to activate it.<br />
<br />
===Test your descriptor===<br />
<br />
Launch Dolibarr and go to page '''Setup->module'''? <br />
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.<br />
<br />
==Tree of path for new module files (required)==<br />
This is how your files must be organized when building a new module (the zip file must also match this rule).<br />
Note: Only the second line is mandatory.<br />
<br />
{{TemplateModuleTreeSimple}}<br />
<br />
==Create your SQL tables and the PHP DAO class (optional)==<br />
'''When''': If your module needs to manage data of its own<br />
<br />
===Create your .sql file===<br />
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.<br />
<br />
Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).<br />
<br />
Then check into your descriptor file, into function '''init''' that the line<br />
<br />
<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight><br />
<br />
is not commented.<br />
<br />
''Rules to follow:''<br />
<br />
*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).<br />
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].<br />
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.<br />
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL<br />
<br />
Example of content of a file data.sql<br />
<syntaxhighlight lang="sql"><br />
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';<br />
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');<br />
</syntaxhighlight><br />
<br />
Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.<br />
<br />
===Test your .sql files===<br />
<br />
Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.<br />
<br />
===Generate the PHP DAO class===<br />
The DAO PHP files should have been generated by ModuleBuilder after creating an object.<br />
<br />
You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''<br />
<br />
In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.<br />
<br />
==The tab management (optional)==<br />
<br />
===Add or remove your own tabs on object sheets===<br />
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)<br />
<br />
To do this go into the file descriptor of module previously created and edit the $this->tabs array:<br />
<br />
<syntaxhighlight lang="PHP"><br />
// Array to add new pages in new tabs or remove existing one<br />
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1<br />
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2<br />
'objecttype:-tabname'); // To remove an existing tab identified by code tabname<br />
</syntaxhighlight><br />
<br />
The table should contain a list of strings, each string representing a new tab. <br />
The format of the string consisting of 5 parts separated by ":"<br />
<br />
*Part 1: The element type (object type) where the tab should appear is a value from the following:<br />
{{TemplateModuleTabs}}<br />
<br />
*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)<br />
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .<br />
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang<br />
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.<br />
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.<br />
<br />
To feed the contents of the tab with data from the database, see the next chapter.<br />
<br />
In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.<br />
<br />
===Show tabs navigation into your own pages===<br />
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.<br />
<br />
You must follow these steps :<br />
<br />
'''1. Include files you need into your file'''<br />
<br />
For each object type, there are two files to include with line<br />
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight><br />
<br />
This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :<br />
<br />
*Object thirdparty (thirdparty) :<br />
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php<br />
*Object product (product) :<br />
**DOL_DOCUMENT_ROOT/product/class/product.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php<br />
*Object invoice (invoice) :<br />
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php<br />
<br />
...<br />
<br />
'''2. Create and load the object to show into your tab'''<br />
<br />
Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$id=GETPOST('id','int');<br />
$ref=GETPOST('ref','alpha');<br />
$product = new Product($db) ;<br />
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok<br />
</syntaxhighlight><br />
<br />
'''3. Get a list of all tabs to show for your object type'''<br />
<br />
Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.<br />
<br />
The resulting array has the following structure<br />
<syntaxhighlight lang="PHP"><br />
$head // Array of tabs<br />
$head[$h] // Element to describe one tab.<br />
$head[$h][0] // Url of page to show when you click on tab<br />
$head[$h][1] // Title of tab<br />
$head[$h][2] // Code name to identify the tab<br />
</syntaxhighlight><br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly<br />
</syntaxhighlight><br />
<br />
'''4. show tabs into your page'''<br />
<br />
Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().<br />
<br />
<syntaxhighlight lang="PHP"><br />
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')<br />
//$links // Tableau des onglets, appelé $head plus haut.<br />
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance<br />
//$title // Title to show (shown into a special tab that you can't click)<br />
//$notab<br />
//$picto // Name of image to show into title. Possible values are:<br />
// product<br />
// service<br />
// company<br />
</syntaxhighlight><br />
<br />
This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.<br />
<br />
==Create or modify PHP screens (optional)==<br />
'''When''': If the purpose of your module is to add features that require new or modified screens.<br />
<br />
===Create a new PHP screen===<br />
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).<br />
<br />
To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.<br />
<br />
Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.<br />
Edit the file to have a correct relative path to the main.inc.php file. <br />
<syntaxhighlight lang="PHP"><br />
// Load Dolibarr environment<br />
$res=0;<br />
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)<br />
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");<br />
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME<br />
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;<br />
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }<br />
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");<br />
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");<br />
// Try main.inc.php using relative path<br />
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");<br />
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");<br />
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");<br />
if (! $res) die("Include of main fails");<br />
</syntaxhighlight><br />
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.<br />
<br />
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.<br />
<br />
It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:<br />
<br />
*$user Object that contains the characteristics of the user + his permissions.<br />
*$conf Object that contains Dolibarr configuration.<br />
*$db Object that contains an opened connection handler to the database.<br />
*$langs Object that contains the user's language.<br />
<br />
Then enter your code to display the page.<br />
<br />
*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');<br />
</syntaxhighlight><br />
<br />
*To include classes provided with Dolibarr, use the following syntax:<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';<br />
</syntaxhighlight><br />
<br />
===Add some fields into existing forms===<br />
You may want to provide a module that adds more fields into forms (input and view) of some elements. <br />
<br />
A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page). <br />
<br />
We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...<br />
<br />
*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].<br />
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.<br />
<br />
If you follow this tutorial, to be able to add fields into category forms, you must do:<br />
{{ToComplete}}<br />
<br />
===Add/replace part of fields supported by hooks===<br />
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.<br />
<br />
===Database access===<br />
If you need to edit some data in the database inside your own table, use the PHP class generated before.<br />
<br />
If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:<br />
<br />
To make an insert, update or delete:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$db->begin(); // Start transaction<br />
$db->query("My SQL request insert, update or delete");<br />
$db->commit(); // Validate transaction<br />
or $db->rollback() // Cancel transaction<br />
</syntaxhighlight><br />
<br />
To read:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$resql=$db->query("My select request");<br />
if ($resql)<br />
{<br />
$num = $db->num_rows($resql);<br />
$i = 0;<br />
if ($num)<br />
{<br />
while ($i < $num)<br />
{<br />
$obj = $db->fetch_object($resql);<br />
if ($obj)<br />
{<br />
// You can use here results<br />
print $obj->field1;<br />
print $obj->field2;<br />
}<br />
$i++;<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
===Define style of your pages===<br />
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.<br />
<br />
You can use for example:<br />
<br />
*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.<br />
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.<br />
*class="'''flat'''" on all input fields (''input, select, textarea''...).<br />
*class="'''button'''" on HTML fields with type ''input type="submit"''.<br />
<br />
===Use the Dolibarr date picker===<br />
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:<br />
<syntaxhighlight lang="PHP"><br />
$form=new Form($db);<br />
$form->select_date('','mykey',0,0,0,"myform");<br />
</syntaxhighlight><br />
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.<br />
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).<br />
This means a date selector must be included necessarily into an html FORM.<br />
<br />
To get value after the POST of your form, the command is:<br />
<syntaxhighlight lang="PHP"><br />
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));<br />
print strftime('%A %d %B %Y', $mydate);<br />
</syntaxhighlight><br />
<br />
===Overwrite template file (tpl)===<br />
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :<br />
<syntaxhighlight lang="PHP"><br />
'tpl' => 1,<br />
</syntaxhighlight><br />
Then you can put any tpl file on '''mymodule/core/tpl'''<br />
as soon as the module is activate, the tpl will be overwrited<br />
<br />
==Add your own setup page (optional)==<br />
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.<br />
<br />
===Create your page to edit parameters===<br />
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).<br />
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.<br />
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.<br />
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).<br />
<br />
===Modify the descriptor file of your module===<br />
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.<br />
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php");<br />
</syntaxhighlight><br />
If the page is in the directory '''mymodule/admin/''', then like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php@mymodule");<br />
</syntaxhighlight><br />
<br />
===Test your page===<br />
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.<br />
<br />
==Define your entries in menu (optional)==<br />
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.<br />
<br />
===Define your menu entries===<br />
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.<br />
This array contains entries that will appear once your module is activated.<br />
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.<br />
<br />
This is the example of code to declare your own menu entries in a module descriptor file:<br />
<syntaxhighlight lang="PHP"><br />
// Main menu entries<br />
$this->menu = array(); // List of menus to add<br />
$r=0;<br />
<br />
// Add here entries to declare new menus<br />
// Example to declare the Top Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu<br />
'type'=>'top', // This is a Top menu entry<br />
'titre'=>'MyModule top menu',<br />
'mainmenu'=>'mymodule',<br />
'leftmenu'=>'mymodule',<br />
'url'=>'/mymodule/pagetop.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both<br />
$r++;<br />
<br />
// Example to declare a Left Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu<br />
'type'=>'left', // This is a Left menu entry<br />
'titre'=>'MyModule left menu 1',<br />
'mainmenu'=>'xxx',<br />
'leftmenu'=>'yyy',<br />
'url'=>'/mymodule/pagelevel1.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users,1=external users, 2=both<br />
$r++;<br />
</syntaxhighlight><br />
<br />
To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.<br />
<br />
===Test your menu entries===<br />
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).<br />
<br />
==Add your own permissions (optional)==<br />
'''When''': If you want to add new permissions.<br />
<br />
The way to define permissions that will manage your module is done inside the module descriptor created previously.<br />
Modify line <br />
<syntaxhighlight lang="PHP"><br />
$this->rights_class = 'mymodule'<br />
</syntaxhighlight><br />
with correct value for mymodule.<br />
<br />
Then you must fill the array $this->rights with as many entries than different permissions you need to manage.<br />
<br />
<syntaxhighlight lang="PHP"><br />
$this->rights[$r][0] = 10001;<br />
$this->rights[$r][1] = 'Label by default of permission';<br />
$this->rights[$r][2] = 'r';<br />
$this->rights[$r][3] = 1;<br />
$this->rights[$r][4] = 'action';<br />
$this->rights[$r][5] = 'subaction';<br />
$r++;<br />
</syntaxhighlight><br />
<br />
Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.<br />
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").<br />
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.<br />
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.<br />
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:<br />
<br />
<syntaxhighlight lang="PHP"><br />
if ($user->rights->mymodule->action->subaction) ...<br />
</syntaxhighlight><br />
<br />
==Define your own box (optional)==<br />
'''When''': If your module needs to provide one or several new boxes to show on home page.<br />
<br />
===Define your box===<br />
For this, modify the array $this->boxes into the module descriptor file.<br />
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''<br />
<br />
''Example:''<br />
<syntaxhighlight lang="PHP"><br />
$this->boxes[0]['file']='mybox0.php@mymodule'<br />
$this->boxes[0]['note']='My box 0'<br />
...<br />
$this->boxes[n]['file']='myboxn.php@mymodule'<br />
$this->boxes[n]['note']='My box n'<br />
</syntaxhighlight><br />
<br />
Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').<br />
<br />
===Test if your box is detected by Dolibarr===<br />
Disable and enabled module.<br />
<br />
Go into menu '''Home - Setup - Boxes'''.<br />
<br />
Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.<br />
<br />
==Define your own export (optional)==<br />
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).<br />
<br />
===Define export===<br />
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.<br />
<br />
===Test your export===<br />
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).<br />
Choose it, you must see a list of all possible fields defined in the export arrays.<br />
Choose on field and try to build an export file. If ok, try again with all fields.<br />
<br />
==Define your CSS styles (optional)==<br />
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).<br />
<br />
===Create and declare your style sheet===<br />
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.<br />
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.<br />
<br />
Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.<br />
Value to put here must be an array of relative URLs to your CSS files.<br />
For example<br />
<syntaxhighlight lang="PHP"><br />
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));<br />
</syntaxhighlight><br />
<br />
===Test your style sheet===<br />
Disable and enable your module.<br />
<br />
Go on the home page (index.php). Show the HTML source of the page.<br />
<br />
You should see into the HTML header, a line that declares your style sheet.<br />
<br />
==Add your Javascript functions (optional)==<br />
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)<br />
<br />
If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.<br />
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.<br />
<br />
Example for page /htdocs/mymodule/mypage.php :<br />
<syntaxhighlight lang="PHP"><br />
$morejs=array("/mymodule/js/mymodule.js");<br />
llxHeader('','Titre','','','','',$morejs,'',0,0); <br />
</syntaxhighlight><br />
<br />
==Run your own code on any Dolibarr event (optional)==<br />
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.<br />
<br />
See also [[Interfaces_Dolibarr_toward_foreign_systems]]<br />
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]<br />
<br />
==Insert your code inside Dolibarr hooks positions (optional)==<br />
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).<br />
<br />
See page [[Hooks_system]].<br />
<br />
<br />
==Add your own numbering rules==<br />
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.<br />
<br />
See page [[Create numbering module]].<br />
<br />
==Add your document template (optional)==<br />
'''When''': When you want to personalized your own generated PDF or ODT documents.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].<br />
<br />
==Add your skin (optional)==<br />
'''When''': When you want to personalized your colors/fonts/images.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
To add your own skin, read page [[Skins]].<br />
<br />
=Some coding rules and predefined functions=<br />
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".<br />
<br />
A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".<br />
<br />
=Create a package to distribute and install your module=<br />
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.<br />
But you can use it to have a package easy to distribute on your own network.<br />
<br />
*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).<br />
<br />
Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)<br />
<br />
*Run the script via Perl (need the Perl version 5.0 or later):<br />
<br />
<syntaxhighlight lang="bash"><br />
perl makepack-dolibarrmodule.pl<br />
</syntaxhighlight><br />
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.<br />
<br />
*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:<br />
<br />
<syntaxhighlight lang="bash"><br />
tar -xvf mymodule.zip<br />
</syntaxhighlight><br />
<br />
*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").<br />
**If your module was built correctly, the file will be validated later.<br />
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).<br />
<br />
=Enabling/activation condition of external module on DoliStore=<br />
<br />
See [[Module_Dolistore_Validation_Rules|Validation Rules]]<br />
[[Category:Development]]</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Module_development&diff=62263Module development2025-01-23T22:58:53Z<p>Sonikf: </p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Développement_module]]<br />
[[es:Desarrollo_de_un_módulo]]<br />
[[de:Modul_Entwicklung]]<br />
[[zh:模块开发]]<br />
[[ja:モジュール_開発]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Core]]<br />
{{TemplateDocDevEn}}<br />
<br />
To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :<br />
<br />
*Add new tables in database.<br />
*Add your own menu entries.<br />
*Add new screens to edit new tables.<br />
*Add or remove tabs on object view (invoice, product, order, event, ...).<br />
*Add predefined exports for the internal export tool.<br />
*Add new information widget in the home page.<br />
*Add new substitutions variables.<br />
*Define new permissions.<br />
*Execute code automatically triggered by a particular Dolibarr action.<br />
*Insert your code inside Dolibarr hooks positions.<br />
*Add your numbering rule to generate the reference of objects<br />
*Add a new document template.<br />
*Add a new skin.<br />
<br />
etc...<br />
<br />
Following chapters presents how to do all of this manually with an easy way.<br />
<br />
=Module creation with the module builder=<br />
From Dolibarr v. 12.0 it is possible to create the main pages of your module with the Module Builder. To activate it:<br />
<br />
Go into the list of module and enable the module "Module Builder"[[File:Module Builder.png|alt=Module Builder|thumb|left]]<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Then click on the "bug" image in the top right of screen.<br />
[[File:Module Builder icon.png|alt=Module Builder icon|left|thumb]]<br />
<br /><br />
=Template of an External Module=<br />
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]<br />
<br />
=Create your module=<br />
==Create a Module descriptor for your Module (required)==<br />
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).<br />
<br />
'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''<br />
<br />
===Create your module descriptor===<br />
The first step is to create a file descriptor for the module. <br />
<br />
*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').<br />
<br />
Next modify the contents of this file as follows:<br />
<br />
*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").<br />
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].<br />
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).<br />
<br />
Your file descriptor for your module is ready. See the next step to activate it.<br />
<br />
===Test your descriptor===<br />
<br />
Launch Dolibarr and go to page '''Setup->module'''? <br />
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.<br />
<br />
==Tree of path for new module files (required)==<br />
This is how your files must be organized when building a new module (the zip file must also match this rule).<br />
Note: Only the second line is mandatory.<br />
<br />
{{TemplateModuleTreeSimple}}<br />
<br />
==Create your SQL tables and the PHP DAO class (optional)==<br />
'''When''': If your module needs to manage data of its own<br />
<br />
===Create your .sql file===<br />
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.<br />
<br />
Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).<br />
<br />
Then check into your descriptor file, into function '''init''' that the line<br />
<br />
<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight><br />
<br />
is not commented.<br />
<br />
''Rules to follow:''<br />
<br />
*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).<br />
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].<br />
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.<br />
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL<br />
<br />
Example of content of a file data.sql<br />
<syntaxhighlight lang="sql"><br />
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';<br />
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');<br />
</syntaxhighlight><br />
<br />
Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.<br />
<br />
===Test your .sql files===<br />
<br />
Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.<br />
<br />
===Generate the PHP DAO class===<br />
The DAO PHP files should have been generated by ModuleBuilder after creating an object.<br />
<br />
You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''<br />
<br />
In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.<br />
<br />
==The tab management (optional)==<br />
<br />
===Add or remove your own tabs on object sheets===<br />
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)<br />
<br />
To do this go into the file descriptor of module previously created and edit the $this->tabs array:<br />
<br />
<syntaxhighlight lang="PHP"><br />
// Array to add new pages in new tabs or remove existing one<br />
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1<br />
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2<br />
'objecttype:-tabname'); // To remove an existing tab identified by code tabname<br />
</syntaxhighlight><br />
<br />
The table should contain a list of strings, each string representing a new tab. <br />
The format of the string consisting of 5 parts separated by ":"<br />
<br />
*Part 1: The element type (object type) where the tab should appear is a value from the following:<br />
{{TemplateModuleTabs}}<br />
<br />
*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)<br />
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .<br />
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang<br />
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.<br />
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.<br />
<br />
To feed the contents of the tab with data from the database, see the next chapter.<br />
<br />
In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.<br />
<br />
===Show tabs navigation into your own pages===<br />
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.<br />
<br />
You must follow these steps :<br />
<br />
'''1. Include files you need into your file'''<br />
<br />
For each object type, there are two files to include with line<br />
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight><br />
<br />
This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :<br />
<br />
*Object thirdparty (thirdparty) :<br />
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php<br />
*Object product (product) :<br />
**DOL_DOCUMENT_ROOT/product/class/product.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php<br />
*Object invoice (invoice) :<br />
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php<br />
<br />
...<br />
<br />
'''2. Create and load the object to show into your tab'''<br />
<br />
Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$id=GETPOST('id','int');<br />
$ref=GETPOST('ref','alpha');<br />
$product = new Product($db) ;<br />
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok<br />
</syntaxhighlight><br />
<br />
'''3. Get a list of all tabs to show for your object type'''<br />
<br />
Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.<br />
<br />
The resulting array has the following structure<br />
<syntaxhighlight lang="PHP"><br />
$head // Array of tabs<br />
$head[$h] // Element to describe one tab.<br />
$head[$h][0] // Url of page to show when you click on tab<br />
$head[$h][1] // Title of tab<br />
$head[$h][2] // Code name to identify the tab<br />
</syntaxhighlight><br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly<br />
</syntaxhighlight><br />
<br />
'''4. show tabs into your page'''<br />
<br />
Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().<br />
<br />
<syntaxhighlight lang="PHP"><br />
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')<br />
//$links // Tableau des onglets, appelé $head plus haut.<br />
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance<br />
//$title // Title to show (shown into a special tab that you can't click)<br />
//$notab<br />
//$picto // Name of image to show into title. Possible values are:<br />
// product<br />
// service<br />
// company<br />
</syntaxhighlight><br />
<br />
This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.<br />
<br />
==Create or modify PHP screens (optional)==<br />
'''When''': If the purpose of your module is to add features that require new or modified screens.<br />
<br />
===Create a new PHP screen===<br />
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).<br />
<br />
To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.<br />
<br />
Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.<br />
Edit the file to have a correct relative path to the main.inc.php file. <br />
<syntaxhighlight lang="PHP"><br />
// Load Dolibarr environment<br />
$res=0;<br />
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)<br />
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");<br />
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME<br />
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;<br />
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }<br />
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");<br />
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");<br />
// Try main.inc.php using relative path<br />
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");<br />
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");<br />
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");<br />
if (! $res) die("Include of main fails");<br />
</syntaxhighlight><br />
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.<br />
<br />
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.<br />
<br />
It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:<br />
<br />
*$user Object that contains the characteristics of the user + his permissions.<br />
*$conf Object that contains Dolibarr configuration.<br />
*$db Object that contains an opened connection handler to the database.<br />
*$langs Object that contains the user's language.<br />
<br />
Then enter your code to display the page.<br />
<br />
*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');<br />
</syntaxhighlight><br />
<br />
*To include classes provided with Dolibarr, use the following syntax:<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';<br />
</syntaxhighlight><br />
<br />
===Add some fields into existing forms===<br />
You may want to provide a module that adds more fields into forms (input and view) of some elements. <br />
<br />
A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page). <br />
<br />
We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...<br />
<br />
*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].<br />
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.<br />
<br />
If you follow this tutorial, to be able to add fields into category forms, you must do:<br />
{{ToComplete}}<br />
<br />
===Add/replace part of fields supported by hooks===<br />
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.<br />
<br />
===Database access===<br />
If you need to edit some data in the database inside your own table, use the PHP class generated before.<br />
<br />
If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:<br />
<br />
To make an insert, update or delete:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$db->begin(); // Start transaction<br />
$db->query("My SQL request insert, update or delete");<br />
$db->commit(); // Validate transaction<br />
or $db->rollback() // Cancel transaction<br />
</syntaxhighlight><br />
<br />
To read:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$resql=$db->query("My select request");<br />
if ($resql)<br />
{<br />
$num = $db->num_rows($resql);<br />
$i = 0;<br />
if ($num)<br />
{<br />
while ($i < $num)<br />
{<br />
$obj = $db->fetch_object($resql);<br />
if ($obj)<br />
{<br />
// You can use here results<br />
print $obj->field1;<br />
print $obj->field2;<br />
}<br />
$i++;<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
===Define style of your pages===<br />
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.<br />
<br />
You can use for example:<br />
<br />
*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.<br />
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.<br />
*class="'''flat'''" on all input fields (''input, select, textarea''...).<br />
*class="'''button'''" on HTML fields with type ''input type="submit"''.<br />
<br />
===Use the Dolibarr date picker===<br />
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:<br />
<syntaxhighlight lang="PHP"><br />
$form=new Form($db);<br />
$form->select_date('','mykey',0,0,0,"myform");<br />
</syntaxhighlight><br />
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.<br />
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).<br />
This means a date selector must be included necessarily into an html FORM.<br />
<br />
To get value after the POST of your form, the command is:<br />
<syntaxhighlight lang="PHP"><br />
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));<br />
print strftime('%A %d %B %Y', $mydate);<br />
</syntaxhighlight><br />
<br />
===Overwrite template file (tpl)===<br />
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :<br />
<syntaxhighlight lang="PHP"><br />
'tpl' => 1,<br />
</syntaxhighlight><br />
Then you can put any tpl file on '''mymodule/core/tpl'''<br />
as soon as the module is activate, the tpl will be overwrited<br />
<br />
==Add your own setup page (optional)==<br />
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.<br />
<br />
===Create your page to edit parameters===<br />
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).<br />
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.<br />
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.<br />
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).<br />
<br />
===Modify the descriptor file of your module===<br />
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.<br />
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php");<br />
</syntaxhighlight><br />
If the page is in the directory '''mymodule/admin/''', then like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php@mymodule");<br />
</syntaxhighlight><br />
<br />
===Test your page===<br />
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.<br />
<br />
==Define your entries in menu (optional)==<br />
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.<br />
<br />
===Define your menu entries===<br />
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.<br />
This array contains entries that will appear once your module is activated.<br />
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.<br />
<br />
This is the example of code to declare your own menu entries in a module descriptor file:<br />
<syntaxhighlight lang="PHP"><br />
// Main menu entries<br />
$this->menu = array(); // List of menus to add<br />
$r=0;<br />
<br />
// Add here entries to declare new menus<br />
// Example to declare the Top Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu<br />
'type'=>'top', // This is a Top menu entry<br />
'titre'=>'MyModule top menu',<br />
'mainmenu'=>'mymodule',<br />
'leftmenu'=>'mymodule',<br />
'url'=>'/mymodule/pagetop.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both<br />
$r++;<br />
<br />
// Example to declare a Left Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu<br />
'type'=>'left', // This is a Left menu entry<br />
'titre'=>'MyModule left menu 1',<br />
'mainmenu'=>'xxx',<br />
'leftmenu'=>'yyy',<br />
'url'=>'/mymodule/pagelevel1.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users,1=external users, 2=both<br />
$r++;<br />
</syntaxhighlight><br />
<br />
To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.<br />
<br />
===Test your menu entries===<br />
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).<br />
<br />
==Add your own permissions (optional)==<br />
'''When''': If you want to add new permissions.<br />
<br />
The way to define permissions that will manage your module is done inside the module descriptor created previously.<br />
Modify line <br />
<syntaxhighlight lang="PHP"><br />
$this->rights_class = 'mymodule'<br />
</syntaxhighlight><br />
with correct value for mymodule.<br />
<br />
Then you must fill the array $this->rights with as many entries than different permissions you need to manage.<br />
<br />
<syntaxhighlight lang="PHP"><br />
$this->rights[$r][0] = 10001;<br />
$this->rights[$r][1] = 'Label by default of permission';<br />
$this->rights[$r][2] = 'r';<br />
$this->rights[$r][3] = 1;<br />
$this->rights[$r][4] = 'action';<br />
$this->rights[$r][5] = 'subaction';<br />
$r++;<br />
</syntaxhighlight><br />
<br />
Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.<br />
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").<br />
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.<br />
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.<br />
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:<br />
<br />
<syntaxhighlight lang="PHP"><br />
if ($user->rights->mymodule->action->subaction) ...<br />
</syntaxhighlight><br />
<br />
==Define your own box (optional)==<br />
'''When''': If your module needs to provide one or several new boxes to show on home page.<br />
<br />
===Define your box===<br />
For this, modify the array $this->boxes into the module descriptor file.<br />
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''<br />
<br />
''Example:''<br />
<syntaxhighlight lang="PHP"><br />
$this->boxes[0]['file']='mybox0.php@mymodule'<br />
$this->boxes[0]['note']='My box 0'<br />
...<br />
$this->boxes[n]['file']='myboxn.php@mymodule'<br />
$this->boxes[n]['note']='My box n'<br />
</syntaxhighlight><br />
<br />
Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').<br />
<br />
===Test if your box is detected by Dolibarr===<br />
Disable and enabled module.<br />
<br />
Go into menu '''Home - Setup - Boxes'''.<br />
<br />
Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.<br />
<br />
==Define your own export (optional)==<br />
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).<br />
<br />
===Define export===<br />
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.<br />
<br />
===Test your export===<br />
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).<br />
Choose it, you must see a list of all possible fields defined in the export arrays.<br />
Choose on field and try to build an export file. If ok, try again with all fields.<br />
<br />
==Define your CSS styles (optional)==<br />
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).<br />
<br />
===Create and declare your style sheet===<br />
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.<br />
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.<br />
<br />
Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.<br />
Value to put here must be an array of relative URLs to your CSS files.<br />
For example<br />
<syntaxhighlight lang="PHP"><br />
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));<br />
</syntaxhighlight><br />
<br />
===Test your style sheet===<br />
Disable and enable your module.<br />
<br />
Go on the home page (index.php). Show the HTML source of the page.<br />
<br />
You should see into the HTML header, a line that declares your style sheet.<br />
<br />
==Add your Javascript functions (optional)==<br />
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)<br />
<br />
If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.<br />
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.<br />
<br />
Example for page /htdocs/mymodule/mypage.php :<br />
<syntaxhighlight lang="PHP"><br />
$morejs=array("/mymodule/js/mymodule.js");<br />
llxHeader('','Titre','','','','',$morejs,'',0,0); <br />
</syntaxhighlight><br />
<br />
==Run your own code on any Dolibarr event (optional)==<br />
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.<br />
<br />
See also [[Interfaces_Dolibarr_toward_foreign_systems]]<br />
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]<br />
<br />
==Insert your code inside Dolibarr hooks positions (optional)==<br />
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).<br />
<br />
See page [[Hooks_system]].<br />
<br />
<br />
==Add your own numbering rules==<br />
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.<br />
<br />
See page [[Create numbering module]].<br />
<br />
==Add your document template (optional)==<br />
'''When''': When you want to personalized your own generated PDF or ODT documents.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].<br />
<br />
==Add your skin (optional)==<br />
'''When''': When you want to personalized your colors/fonts/images.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
To add your own skin, read page [[Skins]].<br />
<br />
=Some coding rules and predefined functions=<br />
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".<br />
<br />
A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".<br />
<br />
=Create a package to distribute and install your module=<br />
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.<br />
But you can use it to have a package easy to distribute on your own network.<br />
<br />
*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).<br />
<br />
Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)<br />
<br />
*Run the script via Perl (need the Perl version 5.0 or later):<br />
<br />
<syntaxhighlight lang="bash"><br />
perl makepack-dolibarrmodule.pl<br />
</syntaxhighlight><br />
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.<br />
<br />
*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:<br />
<br />
<syntaxhighlight lang="bash"><br />
tar -xvf mymodule.zip<br />
</syntaxhighlight><br />
<br />
*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").<br />
**If your module was built correctly, the file will be validated later.<br />
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).<br />
<br />
=Enabling/activation condition of external module on DoliStore=<br />
<br />
See [[Module_Dolistore_Validation_Rules|Validation Rules]]<br />
[[Category:Development]]</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=File:Module_Builder_icon.png&diff=62262File:Module Builder icon.png2025-01-23T22:57:39Z<p>Sonikf: </p>
<hr />
<div>Module Builder icon</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Module_development&diff=62261Module development2025-01-23T22:53:34Z<p>Sonikf: /* Module creation with the module builder */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Développement_module]]<br />
[[es:Desarrollo_de_un_módulo]]<br />
[[de:Modul_Entwicklung]]<br />
[[zh:模块开发]]<br />
[[ja:モジュール_開発]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Core]]<br />
{{TemplateDocDevEn}}<br />
<br />
To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :<br />
<br />
*Add new tables in database.<br />
*Add your own menu entries.<br />
*Add new screens to edit new tables.<br />
*Add or remove tabs on object view (invoice, product, order, event, ...).<br />
*Add predefined exports for the internal export tool.<br />
*Add new information widget in the home page.<br />
*Add new substitutions variables.<br />
*Define new permissions.<br />
*Execute code automatically triggered by a particular Dolibarr action.<br />
*Insert your code inside Dolibarr hooks positions.<br />
*Add your numbering rule to generate the reference of objects<br />
*Add a new document template.<br />
*Add a new skin.<br />
<br />
etc...<br />
<br />
Following chapters presents how to do all of this manually with an easy way.<br />
<br />
=Module creation with the module builder=<br />
From Dolibarr 9.0 it is possible to create the main pages of your module with the Module Builder. To activate it:<br />
<br />
*Go into the list of module and enable the module "Module Builder",<br />
<br />
[[File:Module Builder.png|alt=Module Builder|thumb]]<br />
<br />
*Then click on the "bug" image in the top right of screen.<br />
<br />
[[File:Module Builder.png|alt=Module Builder|thumb]]<br />
<br />
=Template of an External Module=<br />
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]<br />
<br />
=Create your module=<br />
==Create a Module descriptor for your Module (required)==<br />
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).<br />
<br />
'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''<br />
<br />
===Create your module descriptor===<br />
The first step is to create a file descriptor for the module. <br />
<br />
*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').<br />
<br />
Next modify the contents of this file as follows:<br />
<br />
*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").<br />
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].<br />
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).<br />
<br />
Your file descriptor for your module is ready. See the next step to activate it.<br />
<br />
===Test your descriptor===<br />
<br />
Launch Dolibarr and go to page '''Setup->module'''? <br />
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.<br />
<br />
==Tree of path for new module files (required)==<br />
This is how your files must be organized when building a new module (the zip file must also match this rule).<br />
Note: Only the second line is mandatory.<br />
<br />
{{TemplateModuleTreeSimple}}<br />
<br />
==Create your SQL tables and the PHP DAO class (optional)==<br />
'''When''': If your module needs to manage data of its own<br />
<br />
===Create your .sql file===<br />
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.<br />
<br />
Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).<br />
<br />
Then check into your descriptor file, into function '''init''' that the line<br />
<br />
<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight><br />
<br />
is not commented.<br />
<br />
''Rules to follow:''<br />
<br />
*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).<br />
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].<br />
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.<br />
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL<br />
<br />
Example of content of a file data.sql<br />
<syntaxhighlight lang="sql"><br />
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';<br />
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');<br />
</syntaxhighlight><br />
<br />
Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.<br />
<br />
===Test your .sql files===<br />
<br />
Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.<br />
<br />
===Generate the PHP DAO class===<br />
The DAO PHP files should have been generated by ModuleBuilder after creating an object.<br />
<br />
You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''<br />
<br />
In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.<br />
<br />
==The tab management (optional)==<br />
<br />
===Add or remove your own tabs on object sheets===<br />
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)<br />
<br />
To do this go into the file descriptor of module previously created and edit the $this->tabs array:<br />
<br />
<syntaxhighlight lang="PHP"><br />
// Array to add new pages in new tabs or remove existing one<br />
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1<br />
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2<br />
'objecttype:-tabname'); // To remove an existing tab identified by code tabname<br />
</syntaxhighlight><br />
<br />
The table should contain a list of strings, each string representing a new tab. <br />
The format of the string consisting of 5 parts separated by ":"<br />
<br />
*Part 1: The element type (object type) where the tab should appear is a value from the following:<br />
{{TemplateModuleTabs}}<br />
<br />
*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)<br />
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .<br />
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang<br />
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.<br />
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.<br />
<br />
To feed the contents of the tab with data from the database, see the next chapter.<br />
<br />
In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.<br />
<br />
===Show tabs navigation into your own pages===<br />
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.<br />
<br />
You must follow these steps :<br />
<br />
'''1. Include files you need into your file'''<br />
<br />
For each object type, there are two files to include with line<br />
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight><br />
<br />
This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :<br />
<br />
*Object thirdparty (thirdparty) :<br />
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php<br />
*Object product (product) :<br />
**DOL_DOCUMENT_ROOT/product/class/product.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php<br />
*Object invoice (invoice) :<br />
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php<br />
<br />
...<br />
<br />
'''2. Create and load the object to show into your tab'''<br />
<br />
Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$id=GETPOST('id','int');<br />
$ref=GETPOST('ref','alpha');<br />
$product = new Product($db) ;<br />
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok<br />
</syntaxhighlight><br />
<br />
'''3. Get a list of all tabs to show for your object type'''<br />
<br />
Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.<br />
<br />
The resulting array has the following structure<br />
<syntaxhighlight lang="PHP"><br />
$head // Array of tabs<br />
$head[$h] // Element to describe one tab.<br />
$head[$h][0] // Url of page to show when you click on tab<br />
$head[$h][1] // Title of tab<br />
$head[$h][2] // Code name to identify the tab<br />
</syntaxhighlight><br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly<br />
</syntaxhighlight><br />
<br />
'''4. show tabs into your page'''<br />
<br />
Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().<br />
<br />
<syntaxhighlight lang="PHP"><br />
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')<br />
//$links // Tableau des onglets, appelé $head plus haut.<br />
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance<br />
//$title // Title to show (shown into a special tab that you can't click)<br />
//$notab<br />
//$picto // Name of image to show into title. Possible values are:<br />
// product<br />
// service<br />
// company<br />
</syntaxhighlight><br />
<br />
This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.<br />
<br />
==Create or modify PHP screens (optional)==<br />
'''When''': If the purpose of your module is to add features that require new or modified screens.<br />
<br />
===Create a new PHP screen===<br />
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).<br />
<br />
To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.<br />
<br />
Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.<br />
Edit the file to have a correct relative path to the main.inc.php file. <br />
<syntaxhighlight lang="PHP"><br />
// Load Dolibarr environment<br />
$res=0;<br />
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)<br />
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");<br />
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME<br />
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;<br />
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }<br />
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");<br />
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");<br />
// Try main.inc.php using relative path<br />
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");<br />
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");<br />
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");<br />
if (! $res) die("Include of main fails");<br />
</syntaxhighlight><br />
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.<br />
<br />
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.<br />
<br />
It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:<br />
<br />
*$user Object that contains the characteristics of the user + his permissions.<br />
*$conf Object that contains Dolibarr configuration.<br />
*$db Object that contains an opened connection handler to the database.<br />
*$langs Object that contains the user's language.<br />
<br />
Then enter your code to display the page.<br />
<br />
*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');<br />
</syntaxhighlight><br />
<br />
*To include classes provided with Dolibarr, use the following syntax:<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';<br />
</syntaxhighlight><br />
<br />
===Add some fields into existing forms===<br />
You may want to provide a module that adds more fields into forms (input and view) of some elements. <br />
<br />
A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page). <br />
<br />
We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...<br />
<br />
*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].<br />
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.<br />
<br />
If you follow this tutorial, to be able to add fields into category forms, you must do:<br />
{{ToComplete}}<br />
<br />
===Add/replace part of fields supported by hooks===<br />
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.<br />
<br />
===Database access===<br />
If you need to edit some data in the database inside your own table, use the PHP class generated before.<br />
<br />
If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:<br />
<br />
To make an insert, update or delete:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$db->begin(); // Start transaction<br />
$db->query("My SQL request insert, update or delete");<br />
$db->commit(); // Validate transaction<br />
or $db->rollback() // Cancel transaction<br />
</syntaxhighlight><br />
<br />
To read:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$resql=$db->query("My select request");<br />
if ($resql)<br />
{<br />
$num = $db->num_rows($resql);<br />
$i = 0;<br />
if ($num)<br />
{<br />
while ($i < $num)<br />
{<br />
$obj = $db->fetch_object($resql);<br />
if ($obj)<br />
{<br />
// You can use here results<br />
print $obj->field1;<br />
print $obj->field2;<br />
}<br />
$i++;<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
===Define style of your pages===<br />
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.<br />
<br />
You can use for example:<br />
<br />
*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.<br />
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.<br />
*class="'''flat'''" on all input fields (''input, select, textarea''...).<br />
*class="'''button'''" on HTML fields with type ''input type="submit"''.<br />
<br />
===Use the Dolibarr date picker===<br />
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:<br />
<syntaxhighlight lang="PHP"><br />
$form=new Form($db);<br />
$form->select_date('','mykey',0,0,0,"myform");<br />
</syntaxhighlight><br />
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.<br />
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).<br />
This means a date selector must be included necessarily into an html FORM.<br />
<br />
To get value after the POST of your form, the command is:<br />
<syntaxhighlight lang="PHP"><br />
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));<br />
print strftime('%A %d %B %Y', $mydate);<br />
</syntaxhighlight><br />
<br />
===Overwrite template file (tpl)===<br />
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :<br />
<syntaxhighlight lang="PHP"><br />
'tpl' => 1,<br />
</syntaxhighlight><br />
Then you can put any tpl file on '''mymodule/core/tpl'''<br />
as soon as the module is activate, the tpl will be overwrited<br />
<br />
==Add your own setup page (optional)==<br />
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.<br />
<br />
===Create your page to edit parameters===<br />
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).<br />
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.<br />
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.<br />
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).<br />
<br />
===Modify the descriptor file of your module===<br />
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.<br />
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php");<br />
</syntaxhighlight><br />
If the page is in the directory '''mymodule/admin/''', then like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php@mymodule");<br />
</syntaxhighlight><br />
<br />
===Test your page===<br />
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.<br />
<br />
==Define your entries in menu (optional)==<br />
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.<br />
<br />
===Define your menu entries===<br />
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.<br />
This array contains entries that will appear once your module is activated.<br />
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.<br />
<br />
This is the example of code to declare your own menu entries in a module descriptor file:<br />
<syntaxhighlight lang="PHP"><br />
// Main menu entries<br />
$this->menu = array(); // List of menus to add<br />
$r=0;<br />
<br />
// Add here entries to declare new menus<br />
// Example to declare the Top Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu<br />
'type'=>'top', // This is a Top menu entry<br />
'titre'=>'MyModule top menu',<br />
'mainmenu'=>'mymodule',<br />
'leftmenu'=>'mymodule',<br />
'url'=>'/mymodule/pagetop.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both<br />
$r++;<br />
<br />
// Example to declare a Left Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu<br />
'type'=>'left', // This is a Left menu entry<br />
'titre'=>'MyModule left menu 1',<br />
'mainmenu'=>'xxx',<br />
'leftmenu'=>'yyy',<br />
'url'=>'/mymodule/pagelevel1.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users,1=external users, 2=both<br />
$r++;<br />
</syntaxhighlight><br />
<br />
To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.<br />
<br />
===Test your menu entries===<br />
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).<br />
<br />
==Add your own permissions (optional)==<br />
'''When''': If you want to add new permissions.<br />
<br />
The way to define permissions that will manage your module is done inside the module descriptor created previously.<br />
Modify line <br />
<syntaxhighlight lang="PHP"><br />
$this->rights_class = 'mymodule'<br />
</syntaxhighlight><br />
with correct value for mymodule.<br />
<br />
Then you must fill the array $this->rights with as many entries than different permissions you need to manage.<br />
<br />
<syntaxhighlight lang="PHP"><br />
$this->rights[$r][0] = 10001;<br />
$this->rights[$r][1] = 'Label by default of permission';<br />
$this->rights[$r][2] = 'r';<br />
$this->rights[$r][3] = 1;<br />
$this->rights[$r][4] = 'action';<br />
$this->rights[$r][5] = 'subaction';<br />
$r++;<br />
</syntaxhighlight><br />
<br />
Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.<br />
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").<br />
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.<br />
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.<br />
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:<br />
<br />
<syntaxhighlight lang="PHP"><br />
if ($user->rights->mymodule->action->subaction) ...<br />
</syntaxhighlight><br />
<br />
==Define your own box (optional)==<br />
'''When''': If your module needs to provide one or several new boxes to show on home page.<br />
<br />
===Define your box===<br />
For this, modify the array $this->boxes into the module descriptor file.<br />
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''<br />
<br />
''Example:''<br />
<syntaxhighlight lang="PHP"><br />
$this->boxes[0]['file']='mybox0.php@mymodule'<br />
$this->boxes[0]['note']='My box 0'<br />
...<br />
$this->boxes[n]['file']='myboxn.php@mymodule'<br />
$this->boxes[n]['note']='My box n'<br />
</syntaxhighlight><br />
<br />
Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').<br />
<br />
===Test if your box is detected by Dolibarr===<br />
Disable and enabled module.<br />
<br />
Go into menu '''Home - Setup - Boxes'''.<br />
<br />
Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.<br />
<br />
==Define your own export (optional)==<br />
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).<br />
<br />
===Define export===<br />
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.<br />
<br />
===Test your export===<br />
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).<br />
Choose it, you must see a list of all possible fields defined in the export arrays.<br />
Choose on field and try to build an export file. If ok, try again with all fields.<br />
<br />
==Define your CSS styles (optional)==<br />
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).<br />
<br />
===Create and declare your style sheet===<br />
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.<br />
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.<br />
<br />
Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.<br />
Value to put here must be an array of relative URLs to your CSS files.<br />
For example<br />
<syntaxhighlight lang="PHP"><br />
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));<br />
</syntaxhighlight><br />
<br />
===Test your style sheet===<br />
Disable and enable your module.<br />
<br />
Go on the home page (index.php). Show the HTML source of the page.<br />
<br />
You should see into the HTML header, a line that declares your style sheet.<br />
<br />
==Add your Javascript functions (optional)==<br />
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)<br />
<br />
If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.<br />
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.<br />
<br />
Example for page /htdocs/mymodule/mypage.php :<br />
<syntaxhighlight lang="PHP"><br />
$morejs=array("/mymodule/js/mymodule.js");<br />
llxHeader('','Titre','','','','',$morejs,'',0,0); <br />
</syntaxhighlight><br />
<br />
==Run your own code on any Dolibarr event (optional)==<br />
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.<br />
<br />
See also [[Interfaces_Dolibarr_toward_foreign_systems]]<br />
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]<br />
<br />
==Insert your code inside Dolibarr hooks positions (optional)==<br />
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).<br />
<br />
See page [[Hooks_system]].<br />
<br />
<br />
==Add your own numbering rules==<br />
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.<br />
<br />
See page [[Create numbering module]].<br />
<br />
==Add your document template (optional)==<br />
'''When''': When you want to personalized your own generated PDF or ODT documents.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].<br />
<br />
==Add your skin (optional)==<br />
'''When''': When you want to personalized your colors/fonts/images.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
To add your own skin, read page [[Skins]].<br />
<br />
=Some coding rules and predefined functions=<br />
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".<br />
<br />
A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".<br />
<br />
=Create a package to distribute and install your module=<br />
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.<br />
But you can use it to have a package easy to distribute on your own network.<br />
<br />
*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).<br />
<br />
Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)<br />
<br />
*Run the script via Perl (need the Perl version 5.0 or later):<br />
<br />
<syntaxhighlight lang="bash"><br />
perl makepack-dolibarrmodule.pl<br />
</syntaxhighlight><br />
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.<br />
<br />
*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:<br />
<br />
<syntaxhighlight lang="bash"><br />
tar -xvf mymodule.zip<br />
</syntaxhighlight><br />
<br />
*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").<br />
**If your module was built correctly, the file will be validated later.<br />
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).<br />
<br />
=Enabling/activation condition of external module on DoliStore=<br />
<br />
See [[Module_Dolistore_Validation_Rules|Validation Rules]]<br />
[[Category:Development]]</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Module_development&diff=62260Module development2025-01-23T22:52:17Z<p>Sonikf: </p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Développement_module]]<br />
[[es:Desarrollo_de_un_módulo]]<br />
[[de:Modul_Entwicklung]]<br />
[[zh:模块开发]]<br />
[[ja:モジュール_開発]]<br />
<!-- END interlang links --><br />
<br />
[[Category:Core]]<br />
{{TemplateDocDevEn}}<br />
<br />
To create a new module/addon for Dolibarr, there is several steps. This tutorial will describe you each of them to build a module to extend Dolibarr features, like one or several of the following :<br />
<br />
*Add new tables in database.<br />
*Add your own menu entries.<br />
*Add new screens to edit new tables.<br />
*Add or remove tabs on object view (invoice, product, order, event, ...).<br />
*Add predefined exports for the internal export tool.<br />
*Add new information widget in the home page.<br />
*Add new substitutions variables.<br />
*Define new permissions.<br />
*Execute code automatically triggered by a particular Dolibarr action.<br />
*Insert your code inside Dolibarr hooks positions.<br />
*Add your numbering rule to generate the reference of objects<br />
*Add a new document template.<br />
*Add a new skin.<br />
<br />
etc...<br />
<br />
Following chapters presents how to do all of this manually with an easy way.<br />
<br />
=Module creation with the module builder=<br />
From Dolibarr 9.0 it is possible to create the main pages of your module with the Module Builder. To activate it:<br />
<br />
*Go into the list of module and enable the module "Module Builder",<br />
<br />
[[File:Mod_builder_2.png|400px]]<br />
<br />
*Then click on the "bug" image in the top right of screen.<br />
<br />
[[File:Module Builder.png|alt=Module Builder|thumb]]<br />
<br />
=Template of an External Module=<br />
A good model to start development of external module can be found here : [https://github.com/Dolibarr/dolibarr/tree/develop/htdocs/modulebuilder/template GitHub Dolibarr Module Modèle]<br />
<br />
=Create your module=<br />
==Create a Module descriptor for your Module (required)==<br />
'''When it is required''': Required as soon as an addon is developed, whatever its goal is (except for adding a skin).<br />
<br />
'''Since Dolibarr 9.0, you should use the ModuleBuilder module provided as a standard module to generate the module descriptor'''<br />
<br />
===Create your module descriptor===<br />
The first step is to create a file descriptor for the module. <br />
<br />
*Create directory '''/htdocs/custom/''mymodule''/core/modules''' (for an external module) or '''/htdocs/''mymodule''/core/modules''' if you plan to have this module an official core module of Dolibarr. Then copy the file modMyModule.class.php from the directory '''htdocs/modulebuilder/template''' into this directory. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to this file, then the name should be 'modNewName.class.php').<br />
<br />
Next modify the contents of this file as follows:<br />
<br />
*Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName").<br />
*Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult the page that lists already reserved id numbers: [[List of modules id|List of modules id]].<br />
*Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning).<br />
<br />
Your file descriptor for your module is ready. See the next step to activate it.<br />
<br />
===Test your descriptor===<br />
<br />
Launch Dolibarr and go to page '''Setup->module'''? <br />
If you set the property version in the module description you should see a new line with your new module and the possibility to activate it or not. If you set the property version to "develop" or "experiental", to see your module, you must first go into '''Setup-Others''' and set MAIN_FEATURES_LEVEL to 1 to see "experimental" modules or 2 to see "development" modules.<br />
<br />
==Tree of path for new module files (required)==<br />
This is how your files must be organized when building a new module (the zip file must also match this rule).<br />
Note: Only the second line is mandatory.<br />
<br />
{{TemplateModuleTreeSimple}}<br />
<br />
==Create your SQL tables and the PHP DAO class (optional)==<br />
'''When''': If your module needs to manage data of its own<br />
<br />
===Create your .sql file===<br />
If your module is designed to manage data of its own, which are not available in the standard version of Dolibarr, it is necessary to define SQL tables to store the data.<br />
<br />
Scripts for creating tables and loading data by your own module are saved into a subdirectory sql ('''"mymodule/sql"''') of your module. (With ModuleBuilder, the directory and all sql files will be created automatically when you will create a new Object from tab Object).<br />
<br />
Then check into your descriptor file, into function '''init''' that the line<br />
<br />
<syntaxhighlight lang="PHP">$this->_load_tables('/mymodule/sql/');</syntaxhighlight><br />
<br />
is not commented.<br />
<br />
''Rules to follow:''<br />
<br />
*Add the files about creating tables commands on the principle of an '''llx_mytable.sql''' file per table, with an optional '''llx_mytable.key.sql''' file (see existing files in '''install/mysql/tables''' for examples).<br />
*The recommended type and name for SQL fields are defined into page [[Language_and_development_rules#Table_and_fields_structures]].<br />
*To manage data, you must create a file called '''data.sql''' inside directory '''/mymodule/sql/''' that contains SQL command to add/edit/delete data.<br />
*Don't use the double quote for strings (eg 'chaine' not "chaine") because the double quote have a specific meaning in PostGreSQL<br />
<br />
Example of content of a file data.sql<br />
<syntaxhighlight lang="sql"><br />
delete from llx_const where name='MYMODULE_IT_WORKS' and entity='__ENTITY__';<br />
insert into llx_const (name, value, type, note, visible, entity) values ('MYMODULE_IT_WORKS','1','chaine','A constant vor my module',1,'__ENTITY__');<br />
</syntaxhighlight><br />
<br />
Files must be operational for the database mysql. Rem: The files of other databases are not maintained. They will be read and converted on the fly by the driver of the other database.<br />
<br />
===Test your .sql files===<br />
<br />
Once the files ready, you can return to the page to enable Dolibarr modules and disable the module, drop those tables in the database (if they already exists) and reactivate the module. The tables should be recreated by the activation of the module. If this is not the case, check your scripts by passing them by hand, or check the Dolibarr logs.<br />
<br />
===Generate the PHP DAO class===<br />
The DAO PHP files should have been generated by ModuleBuilder after creating an object.<br />
<br />
You can however create them manually by copying existing object however using ModuleBuilder is highly recommended. You should find examples into '''htdocs/modulebuilder/templates/class/myobject.class.php'''<br />
<br />
In this class, there are already operational CRUD (Create/Read/Update/Delete) methods to perform an insert, a fetch (select), an update, a delete of a table row. Edit the file to use the correct module name, tables and place this file in the class subdirectory of the module. The Module Builder allows you to do this with just a few mouse clicks.<br />
<br />
==The tab management (optional)==<br />
<br />
===Add or remove your own tabs on object sheets===<br />
'''When''': To add a tab on an object (invoices, orders, proposals, member ...)<br />
<br />
To do this go into the file descriptor of module previously created and edit the $this->tabs array:<br />
<br />
<syntaxhighlight lang="PHP"><br />
// Array to add new pages in new tabs or remove existing one<br />
$this->tabs = array('objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab1.php?id=__ID__' // To add a new tab identified by code tabname1<br />
'objecttype:+tabname2:Title2:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mypagetab2.php?id=__ID__', // To add a new tab identified by code tabname2<br />
'objecttype:-tabname'); // To remove an existing tab identified by code tabname<br />
</syntaxhighlight><br />
<br />
The table should contain a list of strings, each string representing a new tab. <br />
The format of the string consisting of 5 parts separated by ":"<br />
<br />
*Part 1: The element type (object type) where the tab should appear is a value from the following:<br />
{{TemplateModuleTabs}}<br />
<br />
*Part 2: A code to identify tab to add (start with +tabname1) or to remove (start with -tabname1)<br />
*Part 3: The title of the tab(Title1). This can be a hardcoded read or better a code translation in module lang file .<br />
*Part 4: The name of the file "*.lang" (mylangfile@mymodule) which contains correspondence between the code translation and language to display. If this name is followed with @mymodule, Dolibarr will search translation file "*.lang" within the module in htdocs/custom/mymodule/langs/code_CODE/mylangfile.lang, otherwise Dolibarr will look for file in htdocs/langs/code_CODE/mylangfile.lang<br />
*Part 5: A condition to test if tab must be visible($user->rights->mymodule->read) '''or''' put 1 to be always visible.<br />
*Part 6: The URL of the page to display when you click on the tab (/mymodule/mypagetab1.php). The __ID__ string will be replaced automatically by the Id of the element concerned.<br />
<br />
To feed the contents of the tab with data from the database, see the next chapter.<br />
<br />
In order to get the names 'tabname' of existing tabs, you have to check the names used in the function 'product_prepare_head' of the file 'core/lib/module.lib.php' corresponding to section '$head[$h][2]'.<br />
<br />
===Show tabs navigation into your own pages===<br />
'''When''': To show all standard tabs of an object (product, tiers, etc.) on your page.<br />
<br />
You must follow these steps :<br />
<br />
'''1. Include files you need into your file'''<br />
<br />
For each object type, there are two files to include with line<br />
<syntaxhighlight lang="PHP">require_once($url_fichier) ;</syntaxhighlight><br />
<br />
This is example of files to include (DOL_DOCUMENT_ROOT is often dolibarr/htdocs/) :<br />
<br />
*Object thirdparty (thirdparty) :<br />
**DOL_DOCUMENT_ROOT/societe/class/societe.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/company.lib.php<br />
*Object product (product) :<br />
**DOL_DOCUMENT_ROOT/product/class/product.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/product.lib.php<br />
*Object invoice (invoice) :<br />
**DOL_DOCUMENT_ROOT/compta/facture/class/facture.class.php<br />
**DOL_DOCUMENT_ROOT/core/lib/invoice.lib.php<br />
<br />
...<br />
<br />
'''2. Create and load the object to show into your tab'''<br />
<br />
Create an instance of an object of the correct class and load object from the database by using the fetch method of an object in providing to this method the id you get from URL (ie : /mytab.php?id=1).<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$id=GETPOST('id','int');<br />
$ref=GETPOST('ref','alpha');<br />
$product = new Product($db) ;<br />
$result = $product->fetch($id,$ref) ; // Test $result to check the database read is ok<br />
</syntaxhighlight><br />
<br />
'''3. Get a list of all tabs to show for your object type'''<br />
<br />
Use function XXX_prepare_head($obj), where XXX is name of object. This will return an array with all definition of tab entries to show. The parameter to put into this method is the instance of an object you want tabs.<br />
<br />
The resulting array has the following structure<br />
<syntaxhighlight lang="PHP"><br />
$head // Array of tabs<br />
$head[$h] // Element to describe one tab.<br />
$head[$h][0] // Url of page to show when you click on tab<br />
$head[$h][1] // Title of tab<br />
$head[$h][2] // Code name to identify the tab<br />
</syntaxhighlight><br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
$head = product_prepare_head($product, $user) ; // parameter $user is present for some function anly<br />
</syntaxhighlight><br />
<br />
'''4. show tabs into your page'''<br />
<br />
Use function dol_fiche_head() to show all tabs defined into array $head returned by XX_prepare_head().<br />
<br />
<syntaxhighlight lang="PHP"><br />
dol_fiche_head($links, $active='0', $title='', $notab=0, $picto='')<br />
//$links // Tableau des onglets, appelé $head plus haut.<br />
//$active // Onglet actif (mettre le nom de l'onglet défini dans votre fichier de module, ou un nom contenu dans $head[$h][2]). Cet onglet sera mis en surbrillance<br />
//$title // Title to show (shown into a special tab that you can't click)<br />
//$notab<br />
//$picto // Name of image to show into title. Possible values are:<br />
// product<br />
// service<br />
// company<br />
</syntaxhighlight><br />
<br />
This function will show required tabs and open an html element ''< div class="" >'' that correspond to the area under the tabs. To close area of a tab, just use ''< /div >'' into your PHP page.<br />
<br />
==Create or modify PHP screens (optional)==<br />
'''When''': If the purpose of your module is to add features that require new or modified screens.<br />
<br />
===Create a new PHP screen===<br />
You must then create your PHP pages that will show/edit data from tables using the skeleton templates provided as an example in the directory '''modulebuilder/myobject_page.php''' (For the development of a script from the command line, see [[Script development]]).<br />
<br />
To create a new user screen, create a subdirectory of '''htdocs''' (if not already done) for your module (in '''htdocs/mymodule''' for example) to store the pages you will create.<br />
<br />
Copy, into that directory, the file '''myobject_page.php''' that will serve as a starting point for your page file.<br />
Edit the file to have a correct relative path to the main.inc.php file. <br />
<syntaxhighlight lang="PHP"><br />
// Load Dolibarr environment<br />
$res=0;<br />
// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)<br />
if (! $res && ! empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) $res=@include($_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php");<br />
// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME<br />
$tmp=empty($_SERVER['SCRIPT_FILENAME'])?'':$_SERVER['SCRIPT_FILENAME'];$tmp2=realpath(__FILE__); $i=strlen($tmp)-1; $j=strlen($tmp2)-1;<br />
while($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i]==$tmp2[$j]) { $i--; $j--; }<br />
if (! $res && $i > 0 && file_exists(substr($tmp, 0, ($i+1))."/main.inc.php")) $res=@include(substr($tmp, 0, ($i+1))."/main.inc.php");<br />
if (! $res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php")) $res=@include(dirname(substr($tmp, 0, ($i+1)))."/main.inc.php");<br />
// Try main.inc.php using relative path<br />
if (! $res && file_exists("../main.inc.php")) $res=@include("../main.inc.php");<br />
if (! $res && file_exists("../../main.inc.php")) $res=@include("../../main.inc.php");<br />
if (! $res && file_exists("../../../main.inc.php")) $res=@include("../../../main.inc.php");<br />
if (! $res) die("Include of main fails");<br />
</syntaxhighlight><br />
As you can see, there are several tries to load the main.inc.php (or master.inc.php). The goal is to succeed in the most cases as possible. The minimum is 2 lines: one to try to load the master/main.inc.php into the dolibarr root directory and another one to try to load the file to support the case when the module is deployed into the "custom" directory. But you can have more to deal more situation. The provided example should be able to load the file main/master.inc.php in nearly all situation/setups.<br />
<br />
Note that you may add more "../" depending on the depth of the file relative to your module directory tree.<br />
<br />
It's in the main.inc.php file that is loaded technical environment variables and permissions. The following variables are objects positioned in this file:<br />
<br />
*$user Object that contains the characteristics of the user + his permissions.<br />
*$conf Object that contains Dolibarr configuration.<br />
*$db Object that contains an opened connection handler to the database.<br />
*$langs Object that contains the user's language.<br />
<br />
Then enter your code to display the page.<br />
<br />
*To include a class or library dedicated to the module is done using a Dolibarr function (and not using directly include_once):<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
dol_include_once('/mymodule/class/myclass.class.php', 'MyClass');<br />
</syntaxhighlight><br />
<br />
*To include classes provided with Dolibarr, use the following syntax:<br />
<br />
''Example :''<br />
<syntaxhighlight lang="PHP"><br />
require_once DOL_DOCUMENT_ROOT.'/core/class/doli.class.php';<br />
</syntaxhighlight><br />
<br />
===Add some fields into existing forms===<br />
You may want to provide a module that adds more fields into forms (input and view) of some elements. <br />
<br />
A heavy solution (but not so bad) may be to replace all pages used to create element (this means to disable the "New element" menu entry and adding yours, and disable tab that shows element to replace with a tab that is your own full page (copied/pasted from original) to do same than original page but modified to add your fields and stored added data into your own table). Go to menu [[#Define your entries in the menu (optional)]] and [[#The tab management (optional)]] if this solution suits you (this solution is more powerful since you can change everything you want into the page). <br />
<br />
We will describe here another solution, that works only to "add fields" at end of existing fields, using the element "category" as an example but you can convert this tutorial for invoice, proposal ...<br />
<br />
*First thing is to add a table, owned by your module, to store the value of new fields. This table will have only one column called "rowid" (will contain the same value than field rowid of element table) + one column for each new field you want to add. Then create a class with CRUD (Create/Read/Update/Delete) methods for this new table. For this two tasks, go back to previous chapter [[#Create your SQL tables and the PHP DAO class]].<br />
*Next step is to add a hook into your module to add the new fields into the form. See chapter [[Hooks_system#Implement_the_Hook]] for generic documentation to use hooks.<br />
<br />
If you follow this tutorial, to be able to add fields into category forms, you must do:<br />
{{ToComplete}}<br />
<br />
===Add/replace part of fields supported by hooks===<br />
See chapter [[Hooks_system#Implement_the_Hook]] to know how to use Dolibarr existing hooks to add/replace code at Dolibarr hooks place.<br />
<br />
===Database access===<br />
If you need to edit some data in the database inside your own table, use the PHP class generated before.<br />
<br />
If you to make access to tables with no dedicated PHP class available, this is always possible (for example if you want to get a list of records with a particular join or filter). In this case, this is a code samples to follow:<br />
<br />
To make an insert, update or delete:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$db->begin(); // Start transaction<br />
$db->query("My SQL request insert, update or delete");<br />
$db->commit(); // Validate transaction<br />
or $db->rollback() // Cancel transaction<br />
</syntaxhighlight><br />
<br />
To read:<br />
<br />
<syntaxhighlight lang="PHP"><br />
$resql=$db->query("My select request");<br />
if ($resql)<br />
{<br />
$num = $db->num_rows($resql);<br />
$i = 0;<br />
if ($num)<br />
{<br />
while ($i < $num)<br />
{<br />
$obj = $db->fetch_object($resql);<br />
if ($obj)<br />
{<br />
// You can use here results<br />
print $obj->field1;<br />
print $obj->field2;<br />
}<br />
$i++;<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
===Define style of your pages===<br />
To have the look of your own pages to match the Dolibarr theme, it is necessary to use the Dolibarr CSS styles.<br />
<br />
You can use for example:<br />
<br />
*class="'''liste_titre'''" on tags ''tr'' and ''td'' for the head row of a table.<br />
*class="'''pair'''" or class="'''impair'''" on tags ''tr'' and ''td'' of other rows of a table.<br />
*class="'''flat'''" on all input fields (''input, select, textarea''...).<br />
*class="'''button'''" on HTML fields with type ''input type="submit"''.<br />
<br />
===Use the Dolibarr date picker===<br />
If you want to use the Dolibarr date selector (with its calendar popup) into your pages, use the following line:<br />
<syntaxhighlight lang="PHP"><br />
$form=new Form($db);<br />
$form->select_date('','mykey',0,0,0,"myform");<br />
</syntaxhighlight><br />
The string mykey will identify the date selector in the form. You must use different values if you use several date selectors in same page.<br />
The string myform is the name of the FORM in which the selector is included (value found in the form name="myform" in HTML page).<br />
This means a date selector must be included necessarily into an html FORM.<br />
<br />
To get value after the POST of your form, the command is:<br />
<syntaxhighlight lang="PHP"><br />
$mydate = dol_mktime(12, 0 , 0, $GETPOST('mykeymonth', 'int'), GETPOST('mykeyday', 'int'), GETPOST('mykeyyear', 'int'));<br />
print strftime('%A %d %B %Y', $mydate);<br />
</syntaxhighlight><br />
<br />
===Overwrite template file (tpl)===<br />
If you want to overwrite tpl file on your module, you need to declare it on the module_parts :<br />
<syntaxhighlight lang="PHP"><br />
'tpl' => 1,<br />
</syntaxhighlight><br />
Then you can put any tpl file on '''mymodule/core/tpl'''<br />
as soon as the module is activate, the tpl will be overwrited<br />
<br />
==Add your own setup page (optional)==<br />
'''When''': If your module needs parameters, which are to be provided by the user, for proper setting up of the module.<br />
<br />
===Create your page to edit parameters===<br />
If your module needs several parameters to be setup, you must create a page to edit options (these options will be saved in the [[Table llx_const|table '''llx_const''']]).<br />
Create a page named '''mymodule_setuppage.php''' that shows a form for possible options to update them into the above-mentioned table.<br />
It is necessary to take an example from a page of the directory '''/admin''' that will show you the way to read/save your parameters.<br />
Put this PHP page into the directory '''/admin''' of your module (e.g. mymodule/admin/mymodule_setuppage.php).<br />
<br />
===Modify the descriptor file of your module===<br />
Then, within the descriptor file of your module, modify the variable '''config_page_url''' to set the name of this PHP page.<br />
If the page is in the directory '''admin/''', then the path is not required, e.g. like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php");<br />
</syntaxhighlight><br />
If the page is in the directory '''mymodule/admin/''', then like this:<br />
<syntaxhighlight lang="PHP"><br />
$this->config_page_url = array("mymodule_setuppage.php@mymodule");<br />
</syntaxhighlight><br />
<br />
===Test your page===<br />
Go into page '''Home->Setup->Modules''', you should see a picture at the end of the line of your module to reach your setup page. Click on it, you should be able to view/edit parameters from your page.<br />
<br />
==Define your entries in menu (optional)==<br />
'''When''': If you have created PHP pages, it is necessary that those pages can be reached from menu entries in Dolibarr menu.<br />
<br />
===Define your menu entries===<br />
For this, you must define into the module descriptor, the array this->menu that declares all menus added by your module.<br />
This array contains entries that will appear once your module is activated.<br />
The example module descriptor file '''modMyModule.class.php''' contains an example to declare a top menu and also its left menu entries.<br />
<br />
This is the example of code to declare your own menu entries in a module descriptor file:<br />
<syntaxhighlight lang="PHP"><br />
// Main menu entries<br />
$this->menu = array(); // List of menus to add<br />
$r=0;<br />
<br />
// Add here entries to declare new menus<br />
// Example to declare the Top Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu<br />
'type'=>'top', // This is a Top menu entry<br />
'titre'=>'MyModule top menu',<br />
'mainmenu'=>'mymodule',<br />
'leftmenu'=>'mymodule',<br />
'url'=>'/mymodule/pagetop.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users, 1=external users, 2=both<br />
$r++;<br />
<br />
// Example to declare a Left Menu entry:<br />
$this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=xxx', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode of parent menu<br />
'type'=>'left', // This is a Left menu entry<br />
'titre'=>'MyModule left menu 1',<br />
'mainmenu'=>'xxx',<br />
'leftmenu'=>'yyy',<br />
'url'=>'/mymodule/pagelevel1.php',<br />
'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.<br />
'position'=>100,<br />
'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.<br />
'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules<br />
'target'=>'',<br />
'user'=>2); // 0=Menu for internal users,1=external users, 2=both<br />
$r++;<br />
</syntaxhighlight><br />
<br />
To show the menu or not depending on a permission, modify property '''perms''' in the array. See chapter on permissions later to see how to add permissions.<br />
<br />
===Test your menu entries===<br />
Disable and re-enable your module under the Dolibarr module setup page, menus entries must appear (if property 'enabled' is declaration array is ok).<br />
<br />
==Add your own permissions (optional)==<br />
'''When''': If you want to add new permissions.<br />
<br />
The way to define permissions that will manage your module is done inside the module descriptor created previously.<br />
Modify line <br />
<syntaxhighlight lang="PHP"><br />
$this->rights_class = 'mymodule'<br />
</syntaxhighlight><br />
with correct value for mymodule.<br />
<br />
Then you must fill the array $this->rights with as many entries than different permissions you need to manage.<br />
<br />
<syntaxhighlight lang="PHP"><br />
$this->rights[$r][0] = 10001;<br />
$this->rights[$r][1] = 'Label by default of permission';<br />
$this->rights[$r][2] = 'r';<br />
$this->rights[$r][3] = 1;<br />
$this->rights[$r][4] = 'action';<br />
$this->rights[$r][5] = 'subaction';<br />
$r++;<br />
</syntaxhighlight><br />
<br />
Into $this->rights[$r][0], put a permission id not already used (See into menu '''System info''' on a working installation of Dolibarr to know list of id already used by standard modules.<br />
Into $this->rights[$r][1], put a label by default for permission (This label will be used if no translation can be found into the file '''admin.lang''' Translation key should be "Permission10001=My permission Label").<br />
Into $this->rights[$r][2], types of the permission. There are three type of permission, 'r' for read, list or expert permission, 'w' for write or update permission and 'd' for delete permission.<br />
Into $this->rights[$r][3], put 1 if this permission must be granted automatically by default to any newly created user.<br />
Into $this->rights[$r][4] and $this->rights[$r][5], put an action and subaction string without spaces. You will be able to test if a user has the permission in your PHP source code with the sequence:<br />
<br />
<syntaxhighlight lang="PHP"><br />
if ($user->rights->mymodule->action->subaction) ...<br />
</syntaxhighlight><br />
<br />
==Define your own box (optional)==<br />
'''When''': If your module needs to provide one or several new boxes to show on home page.<br />
<br />
===Define your box===<br />
For this, modify the array $this->boxes into the module descriptor file.<br />
All you have to do is to add 2 lines for each box file you will create into directory '''htdocs/mymodule/core/boxes'''<br />
<br />
''Example:''<br />
<syntaxhighlight lang="PHP"><br />
$this->boxes[0]['file']='mybox0.php@mymodule'<br />
$this->boxes[0]['note']='My box 0'<br />
...<br />
$this->boxes[n]['file']='myboxn.php@mymodule'<br />
$this->boxes[n]['note']='My box n'<br />
</syntaxhighlight><br />
<br />
Then create files '''htdocs/mymodule/core/boxes/mybox0.php''', '''htdocs/mymodule/core/boxes/mybox1.php'''... by copying an example from an existing box file (found into directory '''htdocs/core/boxes''').<br />
<br />
===Test if your box is detected by Dolibarr===<br />
Disable and enabled module.<br />
<br />
Go into menu '''Home - Setup - Boxes'''.<br />
<br />
Your boxes must appear in the list of boxes you can activate. Activate the box and go on the home page to see if the box is showing correctly.<br />
<br />
==Define your own export (optional)==<br />
'''When''': If your module provides new predefined database export profiles (for its own tables or for already existing tables of another module).<br />
<br />
===Define export===<br />
For this uncomment and modify arrays $this->export_xxx in your module descriptor file.<br />
<br />
===Test your export===<br />
Go into menu Tools -> Export. Your export will appear in the list of available predefined exports (if your module is enabled).<br />
Choose it, you must see a list of all possible fields defined in the export arrays.<br />
Choose on field and try to build an export file. If ok, try again with all fields.<br />
<br />
==Define your CSS styles (optional)==<br />
'''When''': If in your PHP pages, you use class styles that are not defined inside Dolibarr themes CSS (not recommanded).<br />
<br />
===Create and declare your style sheet===<br />
Create a style sheet CSS named '''mymodule.css''' or '''mymodule.css.php''' and put it into directory '''htdocs/mymodule'''. You can have several CSS files per module.<br />
Remember it's better to use existing styles already available by default into Dolibarr (The CSS file used by Dolibarr is file '''themes/mytheme/''themename''.css.php'''. Create your own CSS files only if you need absolutely to add not already existing styles.<br />
<br />
Once your style sheets are ready, declare them into your module descriptor file by modifying the property '''$this->modules_parts'''.<br />
Value to put here must be an array of relative URLs to your CSS files.<br />
For example<br />
<syntaxhighlight lang="PHP"><br />
$this->module_parts = array('css' => array('/mymodule/css/mymodule.css.php','/mymodule/css/myother.css'));<br />
</syntaxhighlight><br />
<br />
===Test your style sheet===<br />
Disable and enable your module.<br />
<br />
Go on the home page (index.php). Show the HTML source of the page.<br />
<br />
You should see into the HTML header, a line that declares your style sheet.<br />
<br />
==Add your Javascript functions (optional)==<br />
'''When''': If in your PHP pages, you use javascript functions not available in Dolibarr (in file lib_head.js)<br />
<br />
If you need to use your own javascript functions inside your PHP pages, it is necessary to have your functions, defined into your javascript file '''htdocs/mymodule/js/mymodule.js''', included into the HTML HEAD section.<br />
To ask Dolibarr that forge this header to include your own javascript file, you must just provide it to the llxHeader() function called by your page.<br />
<br />
Example for page /htdocs/mymodule/mypage.php :<br />
<syntaxhighlight lang="PHP"><br />
$morejs=array("/mymodule/js/mymodule.js");<br />
llxHeader('','Titre','','','','',$morejs,'',0,0); <br />
</syntaxhighlight><br />
<br />
==Run your own code on any Dolibarr event (optional)==<br />
'''When''': If you want to execute your own code once a common Dolibarr event has occurred (example: I want to update a table in my module when an invoice is created into Dolibarr), you must create a '''triggers'''.<br />
<br />
See also [[Interfaces_Dolibarr_toward_foreign_systems]]<br />
and [[Interfaces_from_foreign_systems_toward_Dolibarr]]<br />
<br />
==Insert your code inside Dolibarr hooks positions (optional)==<br />
'''When''': When you want to add code or replace Dolibarr code into another situation than a business event (See the previous chapter for adding code during a business event).<br />
<br />
See page [[Hooks_system]].<br />
<br />
<br />
==Add your own numbering rules==<br />
'''When''': When you need a new rule for generated ref of elements that are not covered by existing rules.<br />
<br />
See page [[Create numbering module]].<br />
<br />
==Add your document template (optional)==<br />
'''When''': When you want to personalized your own generated PDF or ODT documents.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
Documentation to add your own template is available on page [[Create_a_PDF_document_template]] or [[Create_an_ODT_document_template]].<br />
<br />
==Add your skin (optional)==<br />
'''When''': When you want to personalized your colors/fonts/images.<br />
<br />
Note: To add this feature you don't need to create a module descriptor.<br />
<br />
To add your own skin, read page [[Skins]].<br />
<br />
=Some coding rules and predefined functions=<br />
The coding rules to be followed are defined in the [[Developer documentation]], under section "General Information - Language and standards development".<br />
<br />
A lot of predefined features for developers are also available and described into page [[Developer documentation]] under section "Technical components of Dolibarr".<br />
<br />
=Create a package to distribute and install your module=<br />
This process must be used to generate a package to submit it on the http://www.dolistore.com marketplace.<br />
But you can use it to have a package easy to distribute on your own network.<br />
<br />
*Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).<br />
<br />
Edit this file to add a list of file names for all new files you created for your module (module descriptor, new sql tables files, php page, images, etc...)<br />
<br />
*Run the script via Perl (need the Perl version 5.0 or later):<br />
<br />
<syntaxhighlight lang="bash"><br />
perl makepack-dolibarrmodule.pl<br />
</syntaxhighlight><br />
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.<br />
<br />
*The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:<br />
<br />
<syntaxhighlight lang="bash"><br />
tar -xvf mymodule.zip<br />
</syntaxhighlight><br />
<br />
*If you want your module to be public, you can submit it (the zip file) on Dolibarr marketplace website: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a module/product").<br />
**If your module was built correctly, the file will be validated later.<br />
**If quality is enough and license permits it, the code might be added inside main Dolibarr sources (except if you disagree for that).<br />
<br />
=Enabling/activation condition of external module on DoliStore=<br />
<br />
See [[Module_Dolistore_Validation_Rules|Validation Rules]]<br />
[[Category:Development]]</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=File:Module_Builder.png&diff=62259File:Module Builder.png2025-01-23T22:47:02Z<p>Sonikf: </p>
<hr />
<div>Module Builder</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62258Create a PDF document template2025-01-23T22:02:35Z<p>Sonikf: /* For an existing module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing module==<br />
Do not directly modify an existing template. Copy the file of the template used as example into a new name in same directory and edit it to change content.<br />
For this example, we will call our new template 'mycompanyblue', based on the existing template 'cyan':<br />
<br />
*Copy and paste file pdf_cyan.modules.php<br />
*Rename the copy as pdf_mycompanyblue.modules.php<br />
*Edit and make the following changes in the code:<br />
<br />
#Rename 'Class pdf_cyan { ' to 'Class pdf_mycompanyblue { '<br />
#Rename constant $this->name to match your new template name. For example for 'cyan' template, change line '$this->name = "cyan";' to '$this->name = "mycompanyblue";'.<br />
#Save file. Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62257Create a PDF document template2025-01-23T21:50:49Z<p>Sonikf: /* Find a document template that is the closest to your requirements */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Proposal/Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing module==<br />
Do not directly modify an existing template. Copy the file of the template used as example into a new name in same directory and edit it to change content.<br />
For this example, we will call our new template 'mycompanyblue', based on the existing template 'azur':<br />
<br />
*Copy and paste file pdf_propale_azur.modules.php<br />
*Rename the copy as pdf_propale_mycompanyblue.modules.php<br />
*Edit and make the following changes in the code:<br />
<br />
#Rename 'Class pdf_propale_azur { ' to 'Class pdf_propale_mycompanyblue { '<br />
#Rename constant $this->name to match your new template name. For example for 'azur' template, change line '$this->name = "azur";' to '$this->name = "mycompanyblue";'.<br />
#Save file. Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62256Create a PDF document template2025-01-23T21:50:04Z<p>Sonikf: /* Find a document template that is the closest to your requirements */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
The list of recommended PDF Models :<br />
{| class="wikitable"<br />
!Module<br />
!PDF Model name<br />
!Dolibarr min version<br />
|-<br />
|Shipping<br />
|espadon<br />
|V12<br />
|-<br />
|Order<br />
|eratosthene<br />
|V12<br />
|-<br />
|Invoice<br />
|sponge<br />
|V12<br />
|-<br />
|Quotation<br />
|cyan<br />
|V12<br />
|-<br />
|Supplier order<br />
|cornas<br />
|V12<br />
|-<br />
|Delivery<br />
|storm<br />
|V13<br />
|}<br />
<br />
=Create a new template=<br />
==For an existing module==<br />
Do not directly modify an existing template. Copy the file of the template used as example into a new name in same directory and edit it to change content.<br />
For this example, we will call our new template 'mycompanyblue', based on the existing template 'azur':<br />
<br />
*Copy and paste file pdf_propale_azur.modules.php<br />
*Rename the copy as pdf_propale_mycompanyblue.modules.php<br />
*Edit and make the following changes in the code:<br />
<br />
#Rename 'Class pdf_propale_azur { ' to 'Class pdf_propale_mycompanyblue { '<br />
#Rename constant $this->name to match your new template name. For example for 'azur' template, change line '$this->name = "azur";' to '$this->name = "mycompanyblue";'.<br />
#Save file. Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62255Create a PDF document template2025-01-23T21:48:37Z<p>Sonikf: /* For an existing module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisites=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commande for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
=Create a new template=<br />
==For an existing module==<br />
Do not directly modify an existing template. Copy the file of the template used as example into a new name in same directory and edit it to change content.<br />
For this example, we will call our new template 'mycompanyblue', based on the existing template 'azur':<br />
<br />
*Copy and paste file pdf_propale_azur.modules.php<br />
*Rename the copy as pdf_propale_mycompanyblue.modules.php<br />
*Edit and make the following changes in the code:<br />
<br />
#Rename 'Class pdf_propale_azur { ' to 'Class pdf_propale_mycompanyblue { '<br />
#Rename constant $this->name to match your new template name. For example for 'azur' template, change line '$this->name = "azur";' to '$this->name = "mycompanyblue";'.<br />
#Save file. Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62254Create a PDF document template2025-01-23T20:36:19Z<p>Sonikf: /* For an existing module */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisite=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commandes for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
=Create a new template=<br />
==For an existing module==<br />
Do not modify an existing template. Copy the file of the template used as example into a new name in same directory than your example and edit it to change content.<br />
For this example, we will call our new template 'mycompanyblue', based on the existing template 'azur':<br />
<br />
*Copy and paste file pdf_propale_azur.modules.php<br />
*Rename the copy as pdf_propale_mycompanyblue.modules.php<br />
*Edit and make the following changes in the code:<br />
<br />
#Rename 'Class pdf_propale_azur { ' to 'Class pdf_propale_mycompanyblue { '<br />
#Rename constant $this->name to match your new template name. For example for 'azur' template, change line '$this->name = "azur";' to '$this->name = "mycompanyblue";'.<br />
#Save file. Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
<br /><br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called FPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Create_a_PDF_document_template&diff=62253Create a PDF document template2025-01-23T20:21:11Z<p>Sonikf: /* Find a document template that is the closest to your requirements */</p>
<hr />
<div><!-- BEGIN origin interlang links --><br />
<!-- You can edit this section but do NOT remove these comments<br />
Links below will be automatically replicated on translated pages by PolyglotBot --><br />
[[fr:Créer_un_modèle_de_document_PDF]]<br />
[[es:Crear_un_modelo_de_documento_PDF]]<br />
[[zh:创建PDF模板]]<br />
<!-- END interlang links --><br />
<br />
{{TemplateDocDevEn}}<br />
<br />
This page describes how to create your own document-generation module (for proposals, invoices, etc...)<br />
The tutorial uses Commercial Proposals as an example but the same process is used for any type of document.<br />
<br />
Building a PDF template requires some PHP knowledge.<br />
An ODT template does not require PHP knowledge. To build an ODT template, see this page [[Create an ODT document template]]. <br />
<br />
=Prerequisite=<br />
<br />
*Dolibarr: 3.0+<br />
*Knowledge in PHP development<br />
<br />
<br />
=Find a document template that is the closest to your requirements=<br />
You may review the existing templates by going to the module setup area, the Commercial Proposals setup in this case, and then clicking on the "preview" logo.<br />
Choose one that is the best match to your needs. In this example, we will use the template "azur" that corresponds to the file<br />
pdf_propale_azur.modules.php<br />
<br />
All document models are in '''htdocs/core/modules''', in subdirectories, for example<br />
propale for commercial proposals<br />
facture for invoices<br />
commandes for orders, etc... <br />
and finally '''doc''' or '''pdf'''.<br />
For instance, proposal templates will be located in '''...core/modules/propale/doc/'''<br />
<br />
=Create a new template=<br />
==For an existing module==<br />
Do not modify an existing template. Copy the file of the template used as example into a new name in same directory than your example and edit it to change content.<br />
For this example, we will call our new template 'mycompanyblue', based on the existing template 'azur':<br />
<br />
*Copy and paste file pdf_propale_azur.modules.php<br />
*Rename the copy as pdf_propale_mycompanyblue.modules.php<br />
*Edit and make the following changes in the code:<br />
<br />
#Rename 'Class pdf_propale_azur { ' to 'Class pdf_propale_mycompanyblue { '<br />
#Rename constant $this->name to match your new template name. For example for 'azur' template, change line '$this->name = "azur";' to '$this->name = "mycompanyblue";'.<br />
#Save file. Now the template will be available in the list of models in Dolibarr.<br />
<br />
Test this model (see previous section) before going further.<br />
<br />
Add into table '''llx_document_model''' the new document template that you have created.<br />
<br />
==For a new module==<br />
Just use the [[Module Builder]] from v12.0 to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).<br />
<br />
The templates will be generated with path:<br />
<br />
*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php<br />
*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php<br />
<br />
=Customize content of your new template=<br />
Customize the new template:<br />
<br />
In file pdf_propale_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.<br />
<br />
Look for the '_pagefooter()' function. It is the function that manages the display of the footer.<br />
<br />
Look for the 'write_file()' function. It is the function that manages the display of the body of PDF.<br />
<br />
<br />
==Library for PDF manipulation==<br />
The library used to create PDF documents in PHP is called FPDF and can be found in htdocs/includes/tcpdf/tcpdf.class.php (or htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.<br />
<br />
Templates instantiate the FPDF class and use its methods combined with the specific data of the invoice, order etc.<br />
<br />
We can generally find the following calls into templates that generate PDF documents:<br />
<br />
*$pdf->SetFont() - ''Define the font to use for the text''<br />
*$pdf->SetXY() - ''Define position (X,Y) for next text that will be output onto page''<br />
*$pdf->MultiCell() - ''Draw a box containing text. Used to output any text''<br />
*$pdf->GetY() - ''Return current Y position''<br />
*$pdf->SetDrawColor() - ''Set the color to use for new text to write - ie black (0,0,0) or white (255,255,255)''<br />
*$pdf->Rect() - ''Draw a rectangle whose top left corner coordinates are defined by two first parameters and bottom right corner is defined by two following parameters that are relative values''<br />
<br />
<br />
==Frame of scripts==<br />
The PHP script used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:<br />
<br />
*pdf_crabe() - ''Creator of the object pdf''<br />
*write_pdf_file() - ''General method for generating the file. This method calls all the following ones after initializing some variables''<br />
*_pagehead() - ''Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document''<br />
*_tableau() - ''Method for drawing the details table (products, services,...)''<br />
*_tableau_info() - ''Method for drawing the table containing information list present in the bill''<br />
*_tableau_tot() - ''Method for drawing table of Totals''<br />
*_tableau_versement() - ''Method for drawing table of payment rules''<br />
*_pagefoot() - ''Method for drawing bottom of the page''<br />
<br />
==Examples of customization==<br />
===Insert a logo===<br />
<br />
*Add following instructions<br />
<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);<br />
</syntaxhighlight><br />
With this example: 10=abscissa, 5=ordinate, 60=width of logo<br />
<br />
*If the logo is on or outside existing text, remove existing text by commenting the code that outputs the text or by changing its position.<br />
<br />
===Insert text===<br />
Most common function to use<br />
<syntaxhighlight lang="PHP"><br />
$pdf->setX(float a); // set current x position<br />
$pdf->setY(float b); // set current y position<br />
$pdf->setXY(float a,float b); // fixe les positions x et y courantes<br />
$pdf->SetTextColor(0,0,200); // fixe la couleur du texte<br />
$pdf->SetFont('Arial','B',14); // fixe la police, le type ( 'B' pour gras, 'I' pour italique, '' pour normal,...)<br />
$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne<br />
</syntaxhighlight><br />
Note: Origin for setXY functions are the top left corner of page.<br />
<br />
===Add a PDF Annotation (comment)===<br />
''Left side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
''Right side of the page around the middle:''<br />
<syntaxhighlight lang="PHP"><br />
$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));<br />
</syntaxhighlight><br />
<br />
===Add Complementary Attribute (extrafiled)===<br />
A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]<br />
<br />
==More information==<br />
<br />
*http://www.fpdf.org/?lang=en<br />
*List of TCPDF's methods: tcpdf.org/doc/code/classTCPDF.html<br />
<br />
=Activate your new model=<br />
In page Home => Setup => Modules =><br />
<br />
*activate your module<br />
*eventually, set it as the default model.<br />
<br />
<br />
=Troubleshooting=<br />
<br />
==Q: My PDF template doesn't understand foreign characters, it outputs them as ???==<br />
<br />
This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another font.<br />
<br />
You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder.../includes/tecnickcom/tcpdf/fonts/<br />
<br />
To change the font used for generating PDF, you need to edit the 'main.lang' file of the language you are using (you'll find the file in your Dolibarr.../langs/en_US/main.lang for instance if you use English)<br />
<br />
*Edit the main.lang file<br />
*Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF=dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.<br />
*Save the file and try again to generate your PDF.<br />
<br />
If you are unlucky, you can try with more fonts, just go to the TCPDF website sourceforge.net/projects/tcpdf/files/ and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation .../includes/tecnickcom/tcpdf/fonts/ so you will get more fonts to play with.<br />
<br />
Also, please make a backup of your files modification.<br />
<br />
Alternative if this doesn't work: make sure the Translation class is correctly instantiated and loaded with the correct language inside your PDF templates (stored inside the $langs or $outputlangs variable).<br />
<br />
Thanks to Humphrey for the tip.</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=61978Electronic Billing2024-12-08T18:21:01Z<p>Sonikf: /* Timeline */</p>
<hr />
<div>This page presents a description of the rules and solutions for electronic invoicing (e-invoicing, e-billing) and e reporting.<br />
<br />
The laws, rules, and solutions to read, generate and send e-invoice depend on your country...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the module:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
To know if a peppol file has been published on the oeppol network, you can follow this tutorial: https://openpeppol.atlassian.net/wiki/spaces/Belgium/pages/624689399/Ma+facture+a-t-elle+t+bien+re+ue+par+le+client+Quel+est+son+statut<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually onto this platform, or to use a third-party service for submission directly from Dolibarr, for example by using:<br />
<br />
*The Chorus Pro Module - Subscription from EasyaSolution.<br />
*The EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/4/2025 for companies with a turnover exceeding 200000€ and from 1/10/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*Digital delivery note: Yes<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2024, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://www.dolibarr.it<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Yes<br />
*E-reporting: Yes<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*E-reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install the CFDIXML module:<br />
<br />
*https://github.com/avadnc/cfdixml<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Spain (Facturae - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain is called Facturae. VeriFactu is the system and network to send and validate invoices.<br />
<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
The following module is required:<br />
<br />
*https://www.2byte.es/index.php/productos/modulo-2facturae<br />
<br />
With the 2Facturae module you can create the XML in billura format through your ERP & CRM Dolibarr, in order to be able to digitally sign the XML (through digital signature portals or your own digital signature software), and once signed, to be able to import at the entry point of the corresponding administration.<br />
<br />
Another solution to be ready and compliant with the VeryFactu system is to install an external module called "Ley antifraude y VeriFactu".<br />
<br />
Note: As the law is evolving frequently and may depends on your business, you MUST check with your book keeper or your laywer that this suits completely the law and the need of your own business.<br />
<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The a red payment slip (called BV) and an orange payment slip (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but an external PHP library will be required for the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=61758Electronic Billing2024-10-27T17:04:11Z<p>Sonikf: /* Greece (Peppol BIS Billing CIUS 3.0) */</p>
<hr />
<div>This page presents a description of the rules and solutions for electronic invoicing (e-invoicing, e-billing) and e reporting.<br />
<br />
The laws, rules, and solutions depend on your country...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the module:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually or use a third-party service for submission directly from Dolibarr. For example, using:<br />
<br />
*Chorus Pro Module - Subscription from EasyaSolution.<br />
*EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: From 1/7/2025 all companies are required to issue and receive their invoices in electronic format<br />
<br />
Digital delivery note: From 1/12/2024 for companies with a turnover exceeding 200000€ and from 1/4/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*Digital delivery note: Yes<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2024, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://www.dolibarr.it<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Yes<br />
*E-reporting: Yes<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*E-reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install the CFDIXML module:<br />
<br />
*https://github.com/avadnc/cfdixml<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Spain (Facturae - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain IS Facturae<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
The following module is required:<br />
<br />
*https://www.2byte.es/index.php/productos/modulo-2facturae<br />
<br />
With the 2Facturae module you can create the XML in billura format through your ERP & CRM Dolibarr, in order to be able to digitally sign the XML (through digital signature portals or your own digital signature software), and once signed, to be able to import at the entry point of the corresponding administration.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The a red payment slip (called BV) and an orange payment slip (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but an external PHP library will be required for the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=61743Electronic Billing2024-10-25T23:06:00Z<p>Sonikf: </p>
<hr />
<div>This page presents a description of the rules and solutions for electronic invoicing (e-invoicing, e-billing) and e reporting.<br />
<br />
The laws, rules, and solutions depend on your country...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the module:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
Note: Belgium already offers a platform called Mercurius, where you can send manually classic invoice to get a Peppol invoice.<br />
<br />
A peppol file can be validated here: https://ecosio.com/en/peppol-and-xml-document-validator/#<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually or use a third-party service for submission directly from Dolibarr. For example, using:<br />
<br />
*Chorus Pro Module - Subscription from EasyaSolution.<br />
*EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
<br />
*Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
*Mandatory issue of eInvoice for every B2B transaction in 2028<br />
<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Not yet<br />
*E-reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
eInvoicing: Probably from 1/7/2025, announcement pending<br />
<br />
Digital delivery note: From 1/12/2024 for companies with a turnover exceeding 200000€ and from 1/4/2025 compulsory for all legal entities<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
*B2G: Yes<br />
*B2B: Only for companies with B2G transactions<br />
*E-reporting: Yes<br />
*Digital delivery note: Yes<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2024, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://www.dolibarr.it<br />
<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Yes<br />
*E-reporting: Yes<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*E-reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install the CFDIXML module:<br />
<br />
*https://github.com/avadnc/cfdixml<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:<br />
*E-reporting:<br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Spain (Facturae - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain IS Facturae<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
The following module is required:<br />
<br />
*https://www.2byte.es/index.php/productos/modulo-2facturae<br />
<br />
With the 2Facturae module you can create the XML in billura format through your ERP & CRM Dolibarr, in order to be able to digitally sign the XML (through digital signature portals or your own digital signature software), and once signed, to be able to import at the entry point of the corresponding administration.<br />
==Legislation and current status==<br />
<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
<br />
*E-reporting:<br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The a red payment slip (called BV) and an orange payment slip (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but an external PHP library will be required for the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
*B2G:<br />
*B2B:</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=61470Electronic Billing2024-09-19T18:46:32Z<p>Sonikf: /* Legislation and current status */</p>
<hr />
<div>This page presents a description of the rules and solutions for electronic invoicing (e-invoicing) and e reporting.<br />
<br />
The laws, rules, and solutions depend on your country...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the module:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
* B2G: Yes<br />
* B2B: Not yet<br />
* E-reporting: Not yet<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually or use a third-party service for submission directly from Dolibarr. For example, using:<br />
<br />
*Chorus Pro Module - Subscription from EasyaSolution.<br />
*EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
* B2G: Yes<br />
* B2B: Not yet<br />
* E-reporting: Not yet<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
* Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
* Mandatory issue of eInvoice for every B2B transaction in 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
* B2G: Yes<br />
* B2B: Not yet<br />
* E-reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
* B2G: Yes<br />
* B2B: Only for companies with B2G transactions<br />
* E-reporting: Yes<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2024, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://www.dolibarr.it<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Yes<br />
*E-reporting: Yes<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*E-reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install the CFDIXML module:<br />
<br />
*https://github.com/avadnc/cfdixml<br />
==Legislation and current status==<br />
<br />
* B2G: <br />
* B2B: <br />
* E-reporting: <br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
* B2G: N/A<br />
* B2B: N/A<br />
* E-reporting: N/A<br />
<br />
=Spain (Facturae - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain IS Facturae<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
The following module is required:<br />
<br />
*https://www.2byte.es/index.php/productos/modulo-2facturae<br />
With the 2Facturae module you can create the XML in billura format through your ERP & CRM Dolibarr, in order to be able to digitally sign the XML (through digital signature portals or your own digital signature software), and once signed, to be able to import at the entry point of the corresponding administration.<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
* E-reporting: <br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
==Timeline==<br />
The a red payment slip (called BV) and an orange payment slip (called BVR) is no more required after 2022.<br />
<br />
QR-Bill is expected for PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer since the 20th june 2020.<br />
<br />
==Dolibarr support==<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but an external PHP library will be required for the first generation of the PDF.<br />
<br />
==Legislation and current status==<br />
<br />
* B2G: <br />
* B2B:</div>Sonikfhttps://wiki.dolibarr.org/index.php?title=Electronic_Billing&diff=61450Electronic Billing2024-09-16T21:15:50Z<p>Sonikf: /* Spain (Facturae - VeriFactu) */</p>
<hr />
<div>This page presents a description of the rules and solutions for electronic invoicing (e-invoicing) and e reporting.<br />
<br />
The laws, rules, and solutions depend on your country...<br />
<br />
<br />
=Belgium (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Belgium is Peppol BIS Billing 3.0, which uses the UBL structure defined by the OASIS organization: https://docs.oasis-open.org/ubl/<br />
<br />
Here are some links about this format:<br />
<br />
*https://peppol.eu/<br />
*https://docs.peppol.eu/poacc/billing/3.0/<br />
==Timeline==<br />
The Belgian parliament approved the law implementing mandatory domestic B2B eInvoicing in Belgium as from 1 January 2026<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the module:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Belgium<br />
* B2G: Yes<br />
* B2B: Not yet<br />
* E-reporting: Not yet<br />
<br />
=France (Factur-X, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The government has specified three types of electronic invoice formats:<br />
<br />
*Factur-X, sometimes incorrectly written as FactureX (Hybrid Format PDF A/3 + Structured Data in XML included in the PDF)<br />
*CIUS for Chorus Pro (Cross Industry Invoice (CII))<br />
*Peppol BIS Billing 3.0 (Universal Business Language (UBL) format)<br />
<br />
Any of these formats can be used in France. The Dolibarr software has chosen the first format. It is already compatible (see below).<br />
<br />
==Timeline==<br />
Initially, the first deadline was set for January 1, 2024. The schedule was modified at the end of 2023 by the government. It is now as follows:<br />
<br />
*From September 1, 2026: Obligation to receive electronic invoices for all businesses.<br />
<br />
All companies are required to receive their invoices in electronic format. Only large companies (employing at least 5,000 employees or with a turnover exceeding 1.5 billion euros) and medium-sized companies (employing between 250 and 4,999 employees or with a turnover not exceeding 1.5 billion euros) are required to issue invoices in electronic format.<br />
<br />
*From September 1, 2027: All SMEs and micro-enterprises will be required to issue electronic invoices (postponable until December 1, 2027).<br />
<br />
==Dolibarr support==<br />
To generate invoices in the Factur-X format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
<br />
This module, or a modified or Dolibarrized version of the module, will be integrated as standard in a future version of Dolibarr.<br />
<br />
Once the document is generated, it must be transmitted to a centralized platform. Sending the invoice directly to your client via email will no longer be possible.<br />
<br />
Dolibarr, like any invoicing software, will therefore need to interface with a PDP (private intermediary operator) or the PPF (the state's centralized platform for submitting invoices). This point has not yet been developed because the government platform and specifications for such automatic invoice transfer are not yet ready. The development will be carried out as soon as they are available. See the page [[GIFF Facture électronique]].<br />
<br />
Note: France already offers a platform called Chorus-Pro, where it is mandatory to submit invoices in certain cases (e.g., invoices intended for the administration). To interface your Dolibarr with this platform, you need to either submit invoices manually or use a third-party service for submission directly from Dolibarr. For example, using:<br />
<br />
*Chorus Pro Module - Subscription from EasyaSolution.<br />
*EDI Chorus Module<br />
*The platform [[HeyBilly]] which interfaces with the Chorus APIs and Dolibarr APIs.<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+France<br />
* B2G: Yes<br />
* B2B: Not yet<br />
* E-reporting: Not yet<br />
<br />
=Germany (Factur-X / ZUGFeRD, Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Germany is Factur-X, which is the same as in France. However, its German name, ZUGFeRD, can also be used.<br />
This standard involves integrating structured invoice data into an XML file embedded within the PDF A/3 of the invoice.<br />
All authorities at federal and national level are mandated to always offer a Peppol transmission if an automated data exchange is provided for the delivery of eInvoices. The XRechnung format being specific to Germany, economic operators should select a provider that is accredited by the German Peppol Authority. This ensures that the service provider conducts Peppol transactions in Germany.<br />
==Timeline==<br />
* Mandatory issuance of eInvoices for companies with an annual turnover exceeding 800 000, 00 EUR. In 2027<br />
* Mandatory issue of eInvoice for every B2B transaction in 2028<br />
==Dolibarr support==<br />
To generate invoices in this format, you need to install the FacturX module available on Dolistore:<br />
<br />
*https://www.dolistore.com/fr/crm-gestion-relation-client/1511-FacturX---Facture---lectronique--Chorus----.html<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Germany (NO VERIFICATION)<br />
* B2G: Yes<br />
* B2B: Not yet<br />
* E-reporting: Not yet<br />
<br />
<br />
=Greece (Peppol BIS Billing CIUS 3.0)=<br />
==Format==<br />
The electronic invoice format in Greece is Peppol BIS Billing CIUS 3.0<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
E-reporting is implemented by Independent Authority for Public Revenue (IAPR) MyDATA platform<br />
*For Dolibarr versions 13.0.0 - 18.0.4 download *https://github.com/evansgl/dolibarr-mydata/releases/tag/1.8<br />
*For Dolibarr versions 19.0.0+ use "dolibarr-19 branch" *https://github.com/evansgl/dolibarr-mydata/tree/dolibarr-19<br />
<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Greece<br />
* B2G: Yes<br />
* B2B: Not yet<br />
* E-reporting: Yes<br />
<br />
<br />
=Italy (FatturaPA)=<br />
==Format==<br />
The electronic invoice format in Italy is FatturaPA (national XML standard)<br />
==Timeline==<br />
As of January 2024, eInvoicing is mandatory for B2B and B2C for all Italian operators<br />
<br />
==Dolibarr support==<br />
There are two solutions:<br />
<br />
*The "Fatturazione elettronica & Professionisti Smart" module: https://www.dolistore.com/en/modules/1054-Fatturazione-elettronica---Professionisti-Smart.html<br />
*The "Fatture Elettroniche ITA" module available from the site https://www.dolibarr.it<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Italy (NO VERIFICATION)<br />
*B2G: Yes<br />
*B2B: Yes<br />
*E-reporting: Yes<br />
<br />
=Luxembourg (Peppol BIS Billing 3.0)=<br />
==Format==<br />
The electronic invoice format in Luxembourg is Peppol BIS Billing 3.0, which must comply with European standard EN 16931-1:2017. Two syntaxes are permitted:<br />
<br />
*XML UBL (Universal Business Language) defined in standard ISO/IEC 19845:2015<br />
*XML UN/CEFACT CII (Cross Industry Invoice)<br />
<br />
==Timeline==<br />
The obligation for economic operators to invoice electronically is staggered:<br />
<br />
*Large economic operators: from 18 May 2022<br />
*Medium-sized economic operators: from 18 October 2022<br />
*Small and newly established economic operators: from 18 March 2023<br />
<br />
==Dolibarr support==<br />
While there's no specific mention of Dolibarr support for Luxembourg e-invoicing, users can likely use the Peppol XML module available for other countries:<br />
<br />
*https://www.dolistore.com/fr/modules/1585-Peppol-XML---facture-electronique.html<br />
<br />
==Legislation and current status==<br />
https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Luxembourg<br />
<br />
https://mindigital.gouvernement.lu/en/dossiers/2021/facturation-electronique.html<br />
<br />
*B2G: Yes (mandatory since 18 April 2019 or 18 April 2020 for sub-central contracting authorities)<br />
*B2B: Yes (mandatory as per the timeline above)<br />
*E-reporting: Not specifically mentioned<br />
<br />
The legal framework is based on:<br />
<br />
*Law of 13 December 2021 amending the Law of 16 May 2019 on electronic invoicing in public procurement and concession contracts<br />
*Grand-Ducal Regulation of 13 December 2021 determining the common delivery network and alternative technical solutions for electronic invoicing<br />
<br />
Luxembourg has chosen the Peppol network as the common delivery network for automated receipt of electronic invoices. For economic operators unable to use Peppol, alternative non-automated solutions (online forms) are available through Guichet.lu.<br />
<br />
=Mexico (CFDIXML)=<br />
==Format==<br />
==Timeline==<br />
==Dolibarr support==<br />
To generate invoices in the Mexican electronic format, you need to install the CFDIXML module:<br />
<br />
*https://github.com/avadnc/cfdixml<br />
==Legislation and current status==<br />
<br />
* B2G: <br />
* B2B: <br />
* E-reporting: <br />
<br />
=Netherlands (Peppol BIS Billing 3.0, NLCIUS)=<br />
==Format==<br />
The electronic invoice format in The Netherlands are NLCIUS (Dutch CIUS) and Peppol BIS Billing 3.0 with country-specific rules equal to NL CIUS.<br />
Peppol BIS Billing 3.0 is now the preferred format but not mandatory.<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
N/A<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+The+Netherlands (NO VERIFICATION)<br />
* B2G: N/A<br />
* B2B: N/A<br />
* E-reporting: N/A<br />
<br />
=Spain (Facturae - VeriFactu)=<br />
==Format==<br />
The electronic invoice format in Spain IS Facturae<br />
==Timeline==<br />
N/A<br />
==Dolibarr support==<br />
The following module is required:<br />
<br />
*https://www.2byte.es/index.php/productos/modulo-2facturae<br />
With the 2Facturae module you can create the XML in billura format through your ERP & CRM Dolibarr, in order to be able to digitally sign the XML (through digital signature portals or your own digital signature software), and once signed, to be able to import at the entry point of the corresponding administration.<br />
==Legislation and current status==<br />
*https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/eInvoicing+in+Spain (NO VERIFICATION)<br />
*B2G: N/A<br />
*B2B: N/A<br />
*E-reporting: N/A<br />
<br />
=Switzerland (QR-Bill)=<br />
==Format==<br />
==Timeline==<br />
==Dolibarr support==<br />
==Legislation and current status==<br />
<br />
* B2G: <br />
* B2B: <br />
* E-reporting: <br />
<br />
Until 2022, Switzerland required invoices to be accompanied by a red payment slip (called BV) and an orange payment slip (called BVR). This is no longer the case. Instead, PDF invoices in Euro or Swiss Francs, which can or must be paid by bank transfer, must include, at the bottom of the page for example, a section containing all the information required for payment by transfer. This is called the QR-Bill or QR-Invoice.<br />
<br />
*Complete PDF standard: https://www.six-group.com/dam/download/banking-services/standardization/qr-bill/ig-qr-bill-v2.2-fr.pdf<br />
*More info: https://www.six-group.com/fr/products-services/banking-services/payment-standardization.html<br />
*FAQ: https://www.six-group.com/fr/products-services/banking-services/payment-standardization/downloads-faq/faq.html<br />
<br />
To obtain such a section:<br />
<br />
*You can install the following module: https://www.dolistore.com/fr/modules/286-SwissBanking.html<br />
*The other option is to activate the experimental option INVOICE_ADD_SWISS_QR_CODE:<br />
**Setting the value to '1' will generate and print the QR code only.<br />
**If the option is set to 'bottom', the entire section at the bottom of the invoice will be displayed, but an external PHP library will be required for the first generation of the PDF.</div>Sonikf