Difference between revisions of "Module Customers Invoices (developer)"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Visual
(New page: Category:Facture {{ToTranslate}} {{BasculeDevUserEn| name=Invoice| devdoc=This page| userdoc=Customers Invoices|}} {{TemplateDocDevEn}} == Fonction du module == Le module Factur...)
 
m (Import interlang links (links to translated versions of this page in other languages) from Multi Language Manager table.)
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:Facture]]
+
<!-- BEGIN origin interlang links -->
−
{{ToTranslate}}
+
<!-- You can edit this section but do NOT remove these comments
 +
    Links below will be automatically replicated on translated pages by PolyglotBot -->
 +
[[fr:Module_Factures_Clients_(développeur)]]
 +
[[es:Módulo_Facturas_a_clientes_(desarrollador)]]
 +
<!-- END interlang links -->
 +
 
 +
[[Category:Invoices]]
 +
{{TemplateDocDevEn}}
 +
{{TemplateModEN Developer}}
 
{{BasculeDevUserEn|
 
{{BasculeDevUserEn|
−
name=Invoice|  
+
name=Invoice|
 +
num=30|
 
devdoc=This page|
 
devdoc=This page|
−
userdoc=[[Customers Invoices]]|}}
+
userdoc=[[Module Customers Invoices]]|}}
−
{{TemplateDocDevEn}}
 
  
−
== Fonction du module ==
+
= Feature =
 +
The invoice module is to manage the following entities:
 +
* Customer invoices
 +
* Lines of customer invoices
 +
* Predefined invoices
 +
The suppliers invoices are managed by the [[Module Suppliers (developer)]].
  
−
Le module Facture permet de gérer dans Dolibarr les entités suivantes:
+
Rounding of VAT lines is done by the rule "the nearest".
−
* Factures clients
 
−
* Lignes de factures
 
−
Les factures fournisseurs sont gérées par le module Fournisseur.
 
  
−
Les arrondis de calcul de TVA doivent se faire "au plus près".
+
Example:
  
−
Exemple:
+
for 0,0000 to 0,0049 --> 0,00
  
−
de 0,0000 à 0,0049 --> 0,00
+
for 0,0050 to 0,0099 --> 0,01
  
−
de 0,0050 à 0,0099 --> 0,01
+
= Entity Invoice =
 +
{{TemplateDocDevEntityEn|
 +
class=htdocs/compta/facture/class/facture.class.php}}
  
−
''Numéro : 30''
+
'''Business rules''':
 +
* An invoice has several invoice lines
 +
* You can attach 1 to n contacts to an invoice
 +
* To complete...
  
−
== Entité Facture ==
+
'''Life cycle''':
  
−
La classe PHP pour manipuler cette entité est le fichier ''htdocs/facture.class.php''.
+
* An invoice can be created as a draft (This calls trigger BILL_CREATE)
−
Elle contient principalement une methode fecth, insert, update, et delete.
+
* An invoice can be modified (This calls trigger BILL_UPDATE)
 +
* An invoice can be validated (This calls trigger BILL_VALIDATE)
 +
* An invoice can receive one or more payments
 +
* An invoice can be closed by status Abandoned or Payed (This calls trigger BILL_CANCEL or BILL_UPDATE)
  
−
* Une facture a plusieurs lignes de factures
+
= Entity Invoice line =
−
* Il est possible de rattacher 1 à n contacts à une facture
+
{{TemplateDocDevEntityEn|
−
* A compléter...
+
class=htdocs/compta/facture/class/facture.class.php}}
  
−
'''Cycle de vie''':
+
* An invoice line has type product or service (you have to choose if both module [[Products]] and [[ServicesEn|Services]] are activated).
 +
* An invoice line represents a product/service in an invoice (with a unit price, a qty, a vat and a discount)
 +
* Each invoice has between 1 and n invoice lines
  
−
* Une facture peut être créée en mode brouillon (Provoque appel du trigger BILL_CREATE)
+
= Entity Predefined invoice =
−
* Une facture peut être modifiée (Provoque appel du trigger BILL_UPDATE)
+
{{TemplateDocDevEntityEn|
−
* Une facture peut être validée (Provoque appel du trigger BILL_VALIDATE)
+
class=htdocs/compta/facture/class/facture-rec.class.php}}
−
* Une facture peut recevoir un paiement
 
−
* Une facture peut être classée abandonnée ou payée (Provoque appel du trigger BILL_CANCEL ou BILL_UPDATE)
 
  
−
== Entité Ligne de Facture ==
+
= Permissions =
−
 
 
−
* Une ligne de facture représente un produit dans une facture
 
−
* Chaque facture a 1 à n lignes de produits
 
−
 
 
−
== Permissions ==
 
 
*->facture->lire
 
*->facture->lire
 
*->facture->creer
 
*->facture->creer
Line 56: Line 69:
 
*->facture->facture->export
 
*->facture->facture->export
  
−
== Tables SQL ==
+
= Tables SQL =
 
* [[Table llx facture|llx_facture]]  
 
* [[Table llx facture|llx_facture]]  
 
* [[Table llx facturedet|llx_facturedet]]  
 
* [[Table llx facturedet|llx_facturedet]]  
 
* [[Table llx facture_rec|llx_facture_rec]]
 
* [[Table llx facture_rec|llx_facture_rec]]
 
* [[Facturedet_rec_(Table_SQL)|llx_facturedet_rec]]
 
* [[Facturedet_rec_(Table_SQL)|llx_facturedet_rec]]
 +
 +
= Constants =
 +
* FACTURE_ADDON_PDF
 +
* FACTURE_ADDON
 +
* FAC_FORCE_DATE_VALIDATION
 +
 +
= Scripts =
 +
* [[Script rebuild_merge_pdf.php|rebuild_merge_pdf.php]]
 +
* [[Script email_unpaid_invoices_to_representatives.php|email_unpaid_invoices_to_representatives.php]]

Latest revision as of 13:21, 23 July 2019

Return to developer
documentation index

File Doc dev.png

Return to
list of modules index
Art.png

Invoice
Numero/ID of module 30
User doc. of module Module Customers Invoices
Developer doc. of module This page

Feature

The invoice module is to manage the following entities:

  • Customer invoices
  • Lines of customer invoices
  • Predefined invoices

The suppliers invoices are managed by the Module Suppliers (developer).

Rounding of VAT lines is done by the rule "the nearest".

Example:

for 0,0000 to 0,0049 --> 0,00

for 0,0050 to 0,0099 --> 0,01

Entity Invoice

The PHP class to use to manipulate such object is file htdocs/compta/facture/class/facture.class.php.

It contains CRUD methods to create (C), read (R), update (U) and delete (D) this object.

Business rules:

  • An invoice has several invoice lines
  • You can attach 1 to n contacts to an invoice
  • To complete...

Life cycle:

  • An invoice can be created as a draft (This calls trigger BILL_CREATE)
  • An invoice can be modified (This calls trigger BILL_UPDATE)
  • An invoice can be validated (This calls trigger BILL_VALIDATE)
  • An invoice can receive one or more payments
  • An invoice can be closed by status Abandoned or Payed (This calls trigger BILL_CANCEL or BILL_UPDATE)

Entity Invoice line

The PHP class to use to manipulate such object is file htdocs/compta/facture/class/facture.class.php.

It contains CRUD methods to create (C), read (R), update (U) and delete (D) this object.

  • An invoice line has type product or service (you have to choose if both module Products and Services are activated).
  • An invoice line represents a product/service in an invoice (with a unit price, a qty, a vat and a discount)
  • Each invoice has between 1 and n invoice lines

Entity Predefined invoice

The PHP class to use to manipulate such object is file htdocs/compta/facture/class/facture-rec.class.php.

It contains CRUD methods to create (C), read (R), update (U) and delete (D) this object.

Permissions

  • ->facture->lire
  • ->facture->creer
  • ->facture->modifier
  • ->facture->valider
  • ->facture->envoyer
  • ->facture->paiment
  • ->facture->supprimer
  • ->facture->facture->export

Tables SQL

Constants

  • FACTURE_ADDON_PDF
  • FACTURE_ADDON
  • FAC_FORCE_DATE_VALIDATION

Scripts

Retrieved from "https://wiki.dolibarr.org/index.php?title=Module_Customers_Invoices_(developer)&oldid=42342"