dolibarr  9.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
Facture Class Reference

Class to manage invoices. More...

+ Inheritance diagram for Facture:
+ Collaboration diagram for Facture:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create (User $user, $notrigger=0, $forceduedate=0)
 Create invoice in database. More...
 
 createFromCurrent (User $user, $invertdetail=0)
 Create a new invoice in database from current invoice. More...
 
 createFromClone ($socid=0)
 Load an object from its id and create a new one in database. More...
 
 createFromOrder ($object, User $user)
 Load an object from an order and create a new invoice into database. More...
 
 getDirectExternalLink ($withpicto=0)
 Return link to download file from a direct external access. More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $addlinktonotes=0, $save_lastsearch_value=-1)
 Return clicable link of object (with eventually picto) More...
 
 fetch ($rowid, $ref='', $ref_ext='', $ref_int='', $fetch_situation=false)
 Get object and lines from database. More...
 
 fetch_lines ()
 Load all detailed lines into this->lines. More...
 
 fetchPreviousNextSituationInvoice ()
 Fetch previous and next situations invoices. More...
 
 update (User $user, $notrigger=0)
 Update database. More...
 
 insert_discount ($idremise)
 Add a discount line into an invoice (as an invoice line) using an existing absolute discount (Consume the discount) More...
 
 set_ref_client ($ref_client, $notrigger=0)
 Set customer ref. More...
 
 delete ($user, $notrigger=0, $idwarehouse=-1)
 Delete invoice. More...
 
 set_paid ($user, $close_code='', $close_note='')
 Tag la facture comme paye completement (si close_code non renseigne) => this->fk_statut=2, this->paye=1 ou partiellement (si close_code renseigne) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0. More...
 
 set_unpaid ($user)
 Tag la facture comme non payee completement + appel trigger BILL_UNPAYED Fonction utilisee quand un paiement prelevement est refuse, ou quand une facture annulee et reouverte. More...
 
 set_canceled ($user, $close_code='', $close_note='')
 Tag invoice as canceled, with no payment on it (example for replacement invoice or payment never received) + call trigger BILL_CANCEL Warning, if option to decrease stock on invoice was set, this function does not change stock (it might be a cancel because of no payment even if merchandises were sent). More...
 
 validate ($user, $force_number='', $idwarehouse=0, $notrigger=0)
 Tag invoice as validated + call trigger BILL_VALIDATE Object must have lines loaded with fetch_lines. More...
 
 updatePriceNextInvoice (&$langs)
 Update price of next invoice. More...
 
 set_draft ($user, $idwarehouse=-1)
 Set draft status. More...
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $date_start='', $date_end='', $ventil=0, $info_bits=0, $fk_remise_except='', $price_base_type='HT', $pu_ttc=0, $type=self::TYPE_STANDARD, $rang=-1, $special_code=0, $origin='', $origin_id=0, $fk_parent_line=0, $fk_fournprice=null, $pa_ht=0, $label='', $array_options=0, $situation_percent=100, $fk_prev_id=0, $fk_unit=null, $pu_ht_devise=0)
 Add an invoice line into database (linked to product/service or not). More...
 
 updateline ($rowid, $desc, $pu, $qty, $remise_percent, $date_start, $date_end, $txtva, $txlocaltax1=0, $txlocaltax2=0, $price_base_type='HT', $info_bits=0, $type=self::TYPE_STANDARD, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=null, $pa_ht=0, $label='', $special_code=0, $array_options=0, $situation_percent=100, $fk_unit=null, $pu_ht_devise=0, $notrigger=0)
 Update a detail line. More...
 
 checkProgressLine ($idline, $situation_percent)
 Check if the percent edited is lower of next invoice line. More...
 
 update_percent ($line, $percent)
 Update invoice line with percentage. More...
 
 deleteline ($rowid)
 Delete line in database. More...
 
 set_remise ($user, $remise, $notrigger=0)
 Set percent discount. More...
 
 set_remise_absolue ($user, $remise, $notrigger=0)
 Set absolute discount. More...
 
 getNextNumRef ($soc, $mode='next')
 Return next reference of customer invoice not already used (or last reference) according to numbering module defined into constant FACTURE_ADDON. More...
 
 info ($id)
 Load miscellaneous information for tab "Info". More...
 
 liste_array ($shortlist=0, $draft=0, $excluser='', $socid=0, $limit=0, $offset=0, $sortfield='f.datef, f.rowid', $sortorder='DESC')
 Return list of invoices (eventually filtered on a user) into an array. More...
 
 list_replacable_invoices ($socid=0)
 Return list of invoices qualified to be replaced by another invoice. More...
 
 list_qualified_avoir_invoices ($socid=0)
 Return list of invoices qualified to be corrected by a credit note. More...
 
 demande_prelevement ($fuser, $amount=0)
 Create a withdrawal request for a standing order. More...
 
 demande_prelevement_delete ($fuser, $did)
 Supprime une demande de prelevement. More...
 
 load_board ($user)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getIdBillingContact ()
 Retourne id des contacts clients de facturation. More...
 
 getIdShippingContact ()
 Retourne id des contacts clients de livraison. More...
 
 initAsSpecimen ($option='')
 Initialise an instance with random values. More...
 
 load_state_board ()
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getLinesArray ()
 Create an array of invoice lines. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
 newCycle ()
 Gets the smallest reference available for a new cycle. More...
 
 is_first ()
 Checks if the invoice is the first of a cycle. More...
 
 get_prev_sits ()
 Returns an array containing the previous situations as Facture objects. More...
 
 setFinal (User $user, $notrigger=0)
 Sets the invoice as a final situation. More...
 
 is_last_in_cycle ()
 Checks if the invoice is the last in its cycle. More...
 
 hasDelay ()
 Is the customer invoice delayed? More...
 
- Public Member Functions inherited from CommonInvoice
 getRemainToPay ($multicurrency=0)
 Return remain amount to pay. More...
 
 getSommePaiement ($multicurrency=0)
 Return amount of payments already done. More...
 
 getSumDepositsUsed ($multicurrency=0)
 Return amount (with tax) of all deposits invoices used by invoice. More...
 
 getSumCreditNotesUsed ($multicurrency=0)
 Return amount (with tax) of all credit notes invoices + excess received used by invoice. More...
 
 getListIdAvoirFromInvoice ()
 Renvoie tableau des ids de facture avoir issus de la facture. More...
 
 getIdReplacingInvoice ($option='')
 Renvoie l'id de la facture qui la remplace. More...
 
 getListOfPayments ($filtertype='')
 Return list of payments. More...
 
 is_erasable ()
 Return if an invoice can be deleted Rule is: If invoice is draft and has a temporary ref -> yes (1) If hidden option INVOICE_CAN_NEVER_BE_REMOVED is on -> no (0) If invoice is dispatched in bookkeeping -> no (-1) If invoice has a definitive ref, is not last and INVOICE_CAN_ALWAYS_BE_REMOVED off -> no (-2) If invoice not last in a cycle -> no (-3) If there is payment -> no (-4) Otherwise -> yes (2) More...
 
 getVentilExportCompta ()
 Return if an invoice was dispatched into bookkeeping. More...
 
 getLibType ()
 Return label of type of invoice. More...
 
 getLibStatut ($mode=0, $alreadypaid=-1)
 Return label of object status. More...
 
 LibStatut ($paye, $status, $mode=0, $alreadypaid=-1, $type=0)
 Return label of a status. More...
 
 calculate_date_lim_reglement ($cond_reglement=0)
 Renvoi une date limite de reglement de facture en fonction des conditions de reglements de la facture et date de facturation. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source='external')
 Return list of id of contacts of object. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=false, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only). More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 

Static Public Member Functions

static replaceThirdparty (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
static commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Public Attributes

 $close_code
 Fermeture apres paiement partiel: discount_vat, badcustomer, abandon Fermeture alors que aucun paiement: replaced (si remplace), abandon.
 
 $close_note
 Commentaire si mis a paye sans paiement complet.
 
 $paye
 1 if invoice paid COMPLETELY, 0 otherwise (do not use it anymore, use statut and close_code)
 
 $module_source
 key of module source when invoice generated from a dedicated module ('cashdesk', 'takepos', ...)
 
 $pos_source
 key of pos source ('0', '1', ...)
 
 $fk_fac_rec_source
 id of template invoice when generated from a template invoice
 
 $fk_facture_source
 id of source invoice if replacement invoice or credit note
 
 $products =array()
 
const TYPE_STANDARD = 0
 Standard invoice.
 
const TYPE_REPLACEMENT = 1
 Replacement invoice.
 
const TYPE_CREDIT_NOTE = 2
 Credit note invoice.
 
const TYPE_DEPOSIT = 3
 Deposit invoice.
 
const TYPE_PROFORMA = 4
 Proforma invoice (should not be used. More...
 
const TYPE_SITUATION = 5
 Situation invoice.
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated (need to be paid)
 
const STATUS_CLOSED = 2
 Classified paid. More...
 
const STATUS_ABANDONED = 3
 Classified abandoned and no payment done. More...
 
- Public Attributes inherited from CommonInvoice
const TYPE_STANDARD = 0
 Standard invoice.
 
const TYPE_REPLACEMENT = 1
 Replacement invoice.
 
const TYPE_CREDIT_NOTE = 2
 Credit note invoice.
 
const TYPE_DEPOSIT = 3
 Deposit invoice.
 
const TYPE_PROFORMA = 4
 Proforma invoice. More...
 
const TYPE_SITUATION = 5
 Situation invoice.
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated (need to be paid)
 
const STATUS_CLOSED = 2
 Classified paid. More...
 
const STATUS_ABANDONED = 3
 Classified abandoned and no payment done. More...
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Protected Attributes

 $table_ref_field = 'facnumber'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage invoices.

Definition at line 54 of file facture.class.php.

Constructor & Destructor Documentation

◆ __construct()

Facture::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 277 of file facture.class.php.

Member Function Documentation

◆ addline()

Facture::addline (   $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $fk_product = 0,
  $remise_percent = 0,
  $date_start = '',
  $date_end = '',
  $ventil = 0,
  $info_bits = 0,
  $fk_remise_except = '',
  $price_base_type = 'HT',
  $pu_ttc = 0,
  $type = self::TYPE_STANDARD,
  $rang = -1,
  $special_code = 0,
  $origin = '',
  $origin_id = 0,
  $fk_parent_line = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $label = '',
  $array_options = 0,
  $situation_percent = 100,
  $fk_prev_id = 0,
  $fk_unit = null,
  $pu_ht_devise = 0 
)

Add an invoice line into database (linked to product/service or not).

Les parametres sont deja cense etre juste et avec valeurs finales a l'appel de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,produit) et le desc doit deja avoir la bonne valeur (a l'appelant de gerer le multilangue)

Parameters
string$descDescription of line
double$pu_htUnit price without tax (> 0 even for credit note)
double$qtyQuantity
double$txtvaForce Vat rate, -1 for auto (Can contain the vat_src_code too with syntax '9.9 (CODE)')
double$txlocaltax1Local tax 1 rate (deprecated, use instead txtva with code inside)
double$txlocaltax2Local tax 2 rate (deprecated, use instead txtva with code inside)
int$fk_productId of predefined product/service
double$remise_percentPercent of discount on line
int$date_startDate start of service
int$date_endDate end of service
int$ventilCode of dispatching into accountancy
int$info_bitsBits de type de lignes
int$fk_remise_exceptId discount used
string$price_base_type'HT' or 'TTC'
double$pu_ttcUnit price with tax (> 0 even for credit note)
int$typeType of line (0=product, 1=service). Not used if fk_product is defined, the type of product is used.
int$rangPosition of line
int$special_codeSpecial code (also used by externals modules!)
string$origin'order', ...
int$origin_idId of origin object
int$fk_parent_lineId of parent line
int$fk_fournpriceSupplier price id (to calculate margin) or ''
int$pa_htBuying price of line (to calculate margin) or ''
string$labelLabel of the line (deprecated, do not use)
array$array_optionsextrafields array
int$situation_percentSituation advance percentage
int$fk_prev_idPrevious situation line id reference
string$fk_unitCode of the unit to use. Null to use the default one
double$pu_ht_deviseUnit price in currency
Returns
int <0 if KO, Id of line if OK

Definition at line 2652 of file facture.class.php.

◆ checkProgressLine()

Facture::checkProgressLine (   $idline,
  $situation_percent 
)

Check if the percent edited is lower of next invoice line.

Parameters
int$idlineid of line to check
float$situation_percentprogress percentage need to be test
Returns
false if KO, true if OK

Definition at line 3073 of file facture.class.php.

◆ create()

Facture::create ( User  $user,
  $notrigger = 0,
  $forceduedate = 0 
)

Create invoice in database.

Note: this->ref can be set or empty. If empty, we will use "(PROV999)" Note: this->fac_rec must be set to create invoice from a recurring invoice

Parameters
User$userObject user that create
int$notrigger1=Does not execute triggers, 0 otherwise
int$forceduedate1=Do not recalculate due date from payment condition but force it with value
Returns
int <0 if KO, >0 if OK

Definition at line 292 of file facture.class.php.

◆ createFromClone()

Facture::createFromClone (   $socid = 0)

Load an object from its id and create a new one in database.

Parameters
int$socidId of thirdparty
Returns
int New id of clone

Definition at line 948 of file facture.class.php.

◆ createFromCurrent()

Facture::createFromCurrent ( User  $user,
  $invertdetail = 0 
)

Create a new invoice in database from current invoice.

Parameters
User$userObject user that ask creation
int$invertdetailReverse sign of amounts for lines
Returns
int <0 if KO, >0 if OK

Definition at line 857 of file facture.class.php.

◆ createFromOrder()

Facture::createFromOrder (   $object,
User  $user 
)

Load an object from an order and create a new invoice into database.

Parameters
Object$objectObject source
User$userObject user
Returns
int <0 if KO, 0 if nothing done, 1 if OK

Definition at line 1057 of file facture.class.php.

◆ delete()

Facture::delete (   $user,
  $notrigger = 0,
  $idwarehouse = -1 
)

Delete invoice.

Parameters
User$userUser making the deletion.
int$notrigger1=Does not execute triggers, 0= execute triggers
int$idwarehouseId warehouse to use for stock change.
Returns
int <0 if KO, 0=Refused, >0 if OK

Definition at line 1887 of file facture.class.php.

◆ deleteline()

Facture::deleteline (   $rowid)

Delete line in database.

Parameters
int$rowidId of line to delete
Returns
int <0 if KO, >0 if OK

Definition at line 3131 of file facture.class.php.

◆ demande_prelevement()

Facture::demande_prelevement (   $fuser,
  $amount = 0 
)

Create a withdrawal request for a standing order.

Use the remain to pay excluding all existing open direct debit requests.

Parameters
User$fuserUser asking the direct debit transfer
float$amountAmount we request direct debit for
Returns
int <0 if KO, >0 if OK

Definition at line 3669 of file facture.class.php.

◆ demande_prelevement_delete()

Facture::demande_prelevement_delete (   $fuser,
  $did 
)

Supprime une demande de prelevement.

Parameters
User$fuserUser making delete
int$didid de la demande a supprimer
Returns
int <0 if OK, >0 if KO

Definition at line 3780 of file facture.class.php.

◆ fetch()

Facture::fetch (   $rowid,
  $ref = '',
  $ref_ext = '',
  $ref_int = '',
  $fetch_situation = false 
)

Get object and lines from database.

Parameters
int$rowidId of object to load
string$refReference of invoice
string$ref_extExternal reference of invoice
int$ref_intInternal reference of other object
bool$fetch_situationFetch the previous and next situation in $tab_previous_situation_invoice and $tab_next_situation_invoice
Returns
int >0 if OK, <0 if KO, 0 if not found

Definition at line 1304 of file facture.class.php.

◆ fetch_lines()

Facture::fetch_lines ( )

Load all detailed lines into this->lines.

Returns
int 1 if OK, < 0 if KO

Definition at line 1457 of file facture.class.php.

Referenced by getLinesArray().

◆ fetchPreviousNextSituationInvoice()

Facture::fetchPreviousNextSituationInvoice ( )

Fetch previous and next situations invoices.

Returns
void

Definition at line 1567 of file facture.class.php.

◆ generateDocument()

Facture::generateDocument (   $modele,
  $outputlangs,
  $hidedetails = 0,
  $hidedesc = 0,
  $hideref = 0,
  $moreparams = null 
)

Create a document onto disk according to template module.

Parameters
string$modeleGenerator to use. Caller must set it to obj->modelpdf or GETPOST('modelpdf') for example.
Translate$outputlangsobjet lang a utiliser pour traduction
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int <0 if KO, >0 if OK

Definition at line 4111 of file facture.class.php.

◆ get_prev_sits()

Facture::get_prev_sits ( )

Returns an array containing the previous situations as Facture objects.

Returns
mixed -1 if error, array of previous situations

Definition at line 4182 of file facture.class.php.

◆ getDirectExternalLink()

Facture::getDirectExternalLink (   $withpicto = 0)

Return link to download file from a direct external access.

Parameters
int$withpictoAdd download picto into link
Returns
string HTML link to file

Definition at line 1165 of file facture.class.php.

◆ getIdBillingContact()

Facture::getIdBillingContact ( )

Retourne id des contacts clients de facturation.

Returns
array Liste des id contacts facturation

Definition at line 3871 of file facture.class.php.

References CommonObject\getIdContact().

◆ getIdShippingContact()

Facture::getIdShippingContact ( )

Retourne id des contacts clients de livraison.

Returns
array Liste des id contacts livraison

Definition at line 3881 of file facture.class.php.

References CommonObject\getIdContact().

◆ getLinesArray()

Facture::getLinesArray ( )

Create an array of invoice lines.

Returns
int >0 if OK, <0 if KO

Definition at line 4095 of file facture.class.php.

References fetch_lines().

◆ getNextNumRef()

Facture::getNextNumRef (   $soc,
  $mode = 'next' 
)

Return next reference of customer invoice not already used (or last reference) according to numbering module defined into constant FACTURE_ADDON.

Parameters
Societe$socobject company
string$mode'next' for next value or 'last' for last value
Returns
string free ref or last ref

$numref can be empty in case we ask for the last value because if there is no invoice created with the set up mask.

Definition at line 3333 of file facture.class.php.

◆ getNomUrl()

Facture::getNomUrl (   $withpicto = 0,
  $option = '',
  $max = 0,
  $short = 0,
  $moretitle = '',
  $notooltip = 0,
  $addlinktonotes = 0,
  $save_lastsearch_value = -1 
)

Return clicable link of object (with eventually picto)

Parameters
int$withpictoAdd picto into link
string$optionWhere point the link
int$maxMaxlength of ref
int$short1=Return just URL
string$moretitleAdd more text to title tooltip
int$notooltip1=Disable tooltip
int$addlinktonotes1=Add link to notes
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
Returns
string String with URL

Definition at line 1196 of file facture.class.php.

◆ hasDelay()

Facture::hasDelay ( )

Is the customer invoice delayed?

Returns
bool

Definition at line 4310 of file facture.class.php.

◆ info()

Facture::info (   $id)

Load miscellaneous information for tab "Info".

Parameters
int$idId of object to load
Returns
void

Definition at line 3420 of file facture.class.php.

◆ initAsSpecimen()

Facture::initAsSpecimen (   $option = '')

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Parameters
string$option''=Create a specimen invoice with lines, 'nolines'=No lines
Returns
void

Definition at line 3895 of file facture.class.php.

◆ insert_discount()

Facture::insert_discount (   $idremise)

Add a discount line into an invoice (as an invoice line) using an existing absolute discount (Consume the discount)

Parameters
int$idremiseId of absolute discount
Returns
int >0 if OK, <0 if KO

Definition at line 1719 of file facture.class.php.

◆ is_first()

Facture::is_first ( )

Checks if the invoice is the first of a cycle.

Returns
boolean

Definition at line 4170 of file facture.class.php.

◆ is_last_in_cycle()

Facture::is_last_in_cycle ( )

Checks if the invoice is the last in its cycle.

Returns
bool Last of the cycle status

Definition at line 4264 of file facture.class.php.

◆ list_qualified_avoir_invoices()

Facture::list_qualified_avoir_invoices (   $socid = 0)

Return list of invoices qualified to be corrected by a credit note.

Invoices matching the following rules are returned: (validated + payment on process) or classified (payed completely or payed partiely) + not already replaced + not already a credit note

Parameters
int$socidId thirdparty
Returns
array Array of invoices ($id => array('ref'=>,'paymentornot'=>,'status'=>,'paye'=>)

Definition at line 3594 of file facture.class.php.

◆ list_replacable_invoices()

Facture::list_replacable_invoices (   $socid = 0)

Return list of invoices qualified to be replaced by another invoice.

Invoices matching the following rules are returned: (Status validated or abandonned for a reason 'other') + not payed + no payment at all + not already replaced

Parameters
int$socidId thirdparty
Returns
array Array of invoices ('id'=>id, 'ref'=>ref, 'status'=>status, 'paymentornot'=>0/1)

Definition at line 3544 of file facture.class.php.

◆ liste_array()

Facture::liste_array (   $shortlist = 0,
  $draft = 0,
  $excluser = '',
  $socid = 0,
  $limit = 0,
  $offset = 0,
  $sortfield = 'f.datef,
f.rowid'  ,
  $sortorder = 'DESC' 
)

Return list of invoices (eventually filtered on a user) into an array.

Parameters
int$shortlist0=Return array[id]=ref, 1=Return array[](id=>id,ref=>ref,name=>name)
int$draft0=not draft, 1=draft
User$excluserObjet user to exclude
int$socidId third pary
int$limitFor pagination
int$offsetFor pagination
string$sortfieldSort criteria
string$sortorderSort order
Returns
int -1 if KO, array with result if OK

Definition at line 3473 of file facture.class.php.

◆ load_board()

Facture::load_board (   $user)

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters
User$userObject user
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

Definition at line 3806 of file facture.class.php.

◆ load_state_board()

Facture::load_state_board ( )

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Returns
int <0 if KO, >0 if OK

Definition at line 4052 of file facture.class.php.

◆ newCycle()

Facture::newCycle ( )

Gets the smallest reference available for a new cycle.

Returns
int >= 1 if OK, -1 if error

Definition at line 4141 of file facture.class.php.

◆ replaceThirdparty()

static Facture::replaceThirdparty ( DoliDB  $db,
  $origin_id,
  $dest_id 
)
static

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 4296 of file facture.class.php.

References CommonObject\commonReplaceThirdparty().

◆ set_canceled()

Facture::set_canceled (   $user,
  $close_code = '',
  $close_note = '' 
)

Tag invoice as canceled, with no payment on it (example for replacement invoice or payment never received) + call trigger BILL_CANCEL Warning, if option to decrease stock on invoice was set, this function does not change stock (it might be a cancel because of no payment even if merchandises were sent).

Parameters
User$userObject user making change
string$close_codeCode of closing invoice (CLOSECODE_REPLACED, CLOSECODE_...)
string$close_noteComment
Returns
int <0 if KO, >0 if OK

Definition at line 2171 of file facture.class.php.

References dol_syslog().

◆ set_draft()

Facture::set_draft (   $user,
  $idwarehouse = -1 
)

Set draft status.

Parameters
User$userObject user that modify
int$idwarehouseId warehouse to use for stock change.
Returns
int <0 if KO, >0 if OK

Definition at line 2532 of file facture.class.php.

◆ set_paid()

Facture::set_paid (   $user,
  $close_code = '',
  $close_note = '' 
)

Tag la facture comme paye completement (si close_code non renseigne) => this->fk_statut=2, this->paye=1 ou partiellement (si close_code renseigne) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0.

Parameters
User$userObjet utilisateur qui modifie
string$close_codeCode renseigne si on classe a payee completement alors que paiement incomplet (cas escompte par exemple)
string$close_noteCommentaire renseigne si on classe a payee alors que paiement incomplet (cas escompte par exemple)
Returns
int <0 if KO, >0 if OK

Definition at line 2061 of file facture.class.php.

◆ set_ref_client()

Facture::set_ref_client (   $ref_client,
  $notrigger = 0 
)

Set customer ref.

Parameters
string$ref_clientCustomer ref
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1822 of file facture.class.php.

◆ set_remise()

Facture::set_remise (   $user,
  $remise,
  $notrigger = 0 
)

Set percent discount.

Parameters
User$userUser that set discount
double$remiseDiscount
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if ko, >0 if ok

Definition at line 3200 of file facture.class.php.

References price2num().

◆ set_remise_absolue()

Facture::set_remise_absolue (   $user,
  $remise,
  $notrigger = 0 
)

Set absolute discount.

Parameters
User$userUser that set discount
double$remiseDiscount
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 3266 of file facture.class.php.

◆ set_unpaid()

Facture::set_unpaid (   $user)

Tag la facture comme non payee completement + appel trigger BILL_UNPAYED Fonction utilisee quand un paiement prelevement est refuse, ou quand une facture annulee et reouverte.

Parameters
User$userObject user that change status
Returns
int <0 if KO, >0 if OK

Definition at line 2120 of file facture.class.php.

◆ setFinal()

Facture::setFinal ( User  $user,
  $notrigger = 0 
)

Sets the invoice as a final situation.

Parameters
User$userObject user
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 4216 of file facture.class.php.

◆ update()

Facture::update ( User  $user,
  $notrigger = 0 
)

Update database.

Parameters
User$userUser that modify
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1607 of file facture.class.php.

◆ update_percent()

Facture::update_percent (   $line,
  $percent 
)

Update invoice line with percentage.

Parameters
FactureLigne$lineInvoice line
int$percentPercentage
Returns
void

Definition at line 3101 of file facture.class.php.

◆ updateline()

Facture::updateline (   $rowid,
  $desc,
  $pu,
  $qty,
  $remise_percent,
  $date_start,
  $date_end,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $price_base_type = 'HT',
  $info_bits = 0,
  $type = self::TYPE_STANDARD,
  $fk_parent_line = 0,
  $skip_update_total = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $label = '',
  $special_code = 0,
  $array_options = 0,
  $situation_percent = 100,
  $fk_unit = null,
  $pu_ht_devise = 0,
  $notrigger = 0 
)

Update a detail line.

Parameters
int$rowidId of line to update
string$descDescription of line
double$puPrix unitaire (HT ou TTC selon price_base_type) (> 0 even for credit note lines)
double$qtyQuantity
double$remise_percentPourcentage de remise de la ligne
int$date_startDate de debut de validite du service
int$date_endDate de fin de validite du service
double$txtvaVAT Rate (Can be '8.5', '8.5 (ABC)')
double$txlocaltax1Local tax 1 rate
double$txlocaltax2Local tax 2 rate
string$price_base_typeHT or TTC
int$info_bitsMiscellaneous informations
int$typeType of line (0=product, 1=service)
int$fk_parent_lineId of parent line (0 in most cases, used by modules adding sublevels into lines).
int$skip_update_totalKeep fields total_xxx to 0 (used for special lines by some modules)
int$fk_fournpriceId of origin supplier price
int$pa_htPrice (without tax) of product when it was bought
string$labelLabel of the line (deprecated, do not use)
int$special_codeSpecial code (also used by externals modules!)
array$array_optionsextrafields array
int$situation_percentSituation advance percentage
string$fk_unitCode of the unit to use. Null to use the default one
double$pu_ht_deviseUnit price in currency
int$notriggerdisable line update trigger
Returns
int < 0 if KO, > 0 if OK

Definition at line 2882 of file facture.class.php.

◆ updatePriceNextInvoice()

Facture::updatePriceNextInvoice ( $langs)

Update price of next invoice.

Parameters
Translate$langsTranslate object
Returns
bool false if KO, true if OK

Definition at line 2491 of file facture.class.php.

◆ validate()

Facture::validate (   $user,
  $force_number = '',
  $idwarehouse = 0,
  $notrigger = 0 
)

Tag invoice as validated + call trigger BILL_VALIDATE Object must have lines loaded with fetch_lines.

Parameters
User$userObject user that validate
string$force_numberReference to force on invoice
int$idwarehouseId of warehouse to use for stock decrease if option to decreasenon stock is on (0=no decrease)
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, 0=Nothing done because invoice is not a draft, >0 if OK

Definition at line 2234 of file facture.class.php.

Member Data Documentation

◆ $products

Facture::$products =array()
Deprecated:

Definition at line 157 of file facture.class.php.

◆ STATUS_ABANDONED

const Facture::STATUS_ABANDONED = 3

Classified abandoned and no payment done.

$this->close_code can be:

  • CLOSECODE_BADDEBT
  • CLOSECODE_ABANDONED
  • CLOSECODE_REPLACED

Definition at line 265 of file facture.class.php.

◆ STATUS_CLOSED

const Facture::STATUS_CLOSED = 2

Classified paid.

If paid partially, $this->close_code can be:

  • CLOSECODE_DISCOUNTVAT
  • CLOSECODE_BADDEBT If paid completely, this->close_code will be null

Definition at line 256 of file facture.class.php.

◆ TYPE_PROFORMA

const Facture::TYPE_PROFORMA = 4

Proforma invoice (should not be used.

a proforma is an order)

Definition at line 232 of file facture.class.php.


The documentation for this class was generated from the following file: