dolibarr  20.0.0-beta
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:
Inheritance graph
[legend]
Collaboration diagram for Facture:
Collaboration graph
[legend]

Public Member Functions

 __construct (DoliDB $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 (User $user, $fromid=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...
 
 createFromContract ($object, User $user, $lines=array())
 Load an object from an order and create a new invoice into database. More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $addlinktonotes=0, $save_lastsearch_value=-1, $target='')
 Return clicable link of object (with eventually picto) More...
 
 fetch ($rowid, $ref='', $ref_ext='', $notused=0, $fetch_situation=false)
 Get object from database. More...
 
 fetch_lines ($only_product=0, $loadalsotranslation=0)
 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 the invoice as paid completely (if close_code is filled) => this->fk_statut=2, this->paye=1 or partially (if close_code filled) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0. More...
 
 setPaid ($user, $close_code='', $close_note='')
 Tag the invoice as : More...
 
 set_unpaid ($user)
 Tags the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened. More...
 
 setUnpaid ($user)
 Tag the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened. 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...
 
 setCanceled ($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, $batch_rule=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...
 
 setDraft ($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='', $fk_code_ventilation=0, $info_bits=0, $fk_remise_except=0, $price_base_type='HT', $pu_ttc=0, $type=0, $rang=-1, $special_code=0, $origin='', $origin_id=0, $fk_parent_line=0, $fk_fournprice=null, $pa_ht=0, $label='', $array_options=array(), $situation_percent=100, $fk_prev_id=0, $fk_unit=null, $pu_ht_devise=0, $ref_ext='', $noupdateafterinsertline=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=array(), $situation_percent=100, $fk_unit=null, $pu_ht_devise=0, $notrigger=0, $ref_ext='', $rang=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_price=true)
 Update invoice line with percentage. More...
 
 deleteLine ($rowid, $id=0)
 Delete line in database. More...
 
 set_remise ($user, $remise, $notrigger=0)
 Set percent discount. More...
 
 setDiscount ($user, $remise, $notrigger=0)
 Set percent discount. More...
 
 getNextNumRef ($soc, $mode='next')
 Set absolute discount. More...
 
 info ($id)
 Load miscellaneous information for tab "Info". More...
 
 liste_array ($shortlist=0, $draft=0, $excluser=null, $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...
 
 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...
 
 loadStateBoard ()
 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...
 
 displayRetainedWarranty ()
 Currently used for documents generation : to know if retained warranty need to be displayed. More...
 
 getRetainedWarrantyAmount ($rounding=-1)
 
 setRetainedWarranty ($value)
 Change the retained warranty. More...
 
 setRetainedWarrantyDateLimit ($timestamp, $dateYmd='')
 Change the retained_warranty_date_limit. More...
 
 sendEmailsRemindersOnInvoiceDueDate ($nbdays=0, $paymentmode='all', $template='', $datetouse='duedate', $forcerecipient='')
 Send reminders by emails for invoices validated that are due. More...
 
 willBeLastOfSameType ($allow_validated_drafts=false)
 See if current invoice date is posterior to the last invoice date among validated invoices of same type. More...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) 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...
 
 getSumFromThisCreditNotesNotUsed ($multicurrency=0)
 Return amount (with tax) of all converted amount for this credit note. More...
 
 getListIdAvoirFromInvoice ()
 Returns array of credit note ids from the invoice. More...
 
 getIdReplacingInvoice ($option='')
 Returns the id of the invoice that replaces it. More...
 
 getListOfPayments ($filtertype='', $multicurrency=0)
 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 ($withbadge=0)
 Return label of type of invoice. More...
 
 getSubtypeLabel ($table='')
 Return label of invoice subtype. More...
 
 getArrayOfInvoiceSubtypes ($mode=0)
 Retrieve a list of invoice subtype labels or codes. More...
 
 getLibStatut ($mode=0, $alreadypaid=-1)
 Return label of object status. More...
 
 LibStatut ($paye, $status, $mode=0, $alreadypaid=-1, $type=-1)
 Return label of a status. More...
 
 calculate_date_lim_reglement ($cond_reglement=0)
 Returns an invoice payment deadline based on the invoice settlement conditions and billing date. More...
 
 demande_prelevement ($fuser, $amount=0, $type='direct-debit', $sourcetype='facture', $checkduplicateamongall=0)
 Create a withdrawal request for a direct debit order or a credit transfer order. More...
 
 makeStripeCardRequest ($fuser, $id, $sourcetype='facture')
 Create a payment with Stripe card Must take amount using Stripe and record an event into llx_actioncomm Record bank payment Send email to customer ? More...
 
 makeStripeSepaRequest ($fuser, $did, $type='direct-debit', $sourcetype='facture', $service='', $forcestripe='')
 Create a direct debit order into prelevement_bons for a given prelevement_request, then Send the payment order to the service (for a direct debit order or a credit transfer order) and record an event in llx_actioncomm. More...
 
 demande_prelevement_delete ($fuser, $did)
 Remove a direct debit request or a credit transfer request. More...
 
 buildEPCQrCodeString ()
 Build string for EPC QR Code. More...
 
 buildZATCAQRString ()
 Build string for ZATCA QR Code (Arabi Saudia) More...
 
 buildSwitzerlandQRString ()
 Build string for QR-Bill (Switzerland) More...
 
- Public Member Functions inherited from CommonObject
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContent ($params)
 getTooltipContent More...
 
 errorsToString ()
 Method to output saved errors. More...
 
 getFormatedCustomerRef ($objref)
 Return customer ref for screen output. More...
 
 getFormatedSupplierRef ($objref)
 Return supplier ref for screen output. More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. 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 in llx_element_contact. More...
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 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...
 
 listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
 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->contact_id 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_project ()
 Load the project with id $this->fk_project into this->project. 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, $notrigger=0)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setPaymentTerms ($id, $deposit_percent=null)
 Change the payments terms. More...
 
 setTransportMode ($id)
 Change the transport mode methods. More...
 
 setRetainedWarrantyPaymentTerms ($id)
 Change the retained warranty payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=0, $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=0, $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, $includealltree=0)
 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='', $notrigger=0)
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='auto', $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, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 getElementType ()
 Return an element type string formatted like element_element target_type and source_type. 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...
 
 clearObjectLinkedCache ()
 Clear the cache saying that all linked object were already loaded. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 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, $entity=0)
 Function to check if an object is used by others (by children). 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...
 
 formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
 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, $extrafields=null, $defaulttpldir='/core/tpl')
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='', $selectedLines=array())
 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='', $defaulttpldir='/core/tpl', $selectedLines=array())
 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...
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 delThumbs ($file)
 Delete thumbs. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($triggerName, $user)
 Call trigger based on this instance. More...
 
 fetchValuesForExtraLanguages ()
 Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately. More...
 
 setValuesForExtraLanguages ($onlykey='')
 Fill array_options property of object by extrafields value (using for data sent by forms) More...
 
 fetchNoCompute ($id)
 Function to make a fetch but set environment to avoid to load computed values before. 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...
 
 insertExtraLanguages ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update 1 extra field value for the current object. More...
 
 updateExtraLanguages ($key, $trigger=null, $userused=null)
 Update an extra language value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 clearFieldError ($fieldKey)
 clear validation message result for a field More...
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field More...
 
 getFieldError ($fieldKey)
 get field error message More...
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
 Function to show lines of extrafields with output data. More...
 
 getJSListDependancies ($type='_extra')
 
 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...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 getDataToShowPhoto More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isDuration ($info)
 Function test if type is duration. 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...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 emtpyObjectVars ()
 Sets all object fields to null. More...
 
 getFieldList ($alias='', $excludefields=array())
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=0)
 Create object in the database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=0)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status. More...
 
 setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a signed status. 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...
 
 getCategoriesCommon ($type_categ)
 Sets object to given categories. More...
 
 setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
 Sets object to given categories. More...
 
 cloneCategories ($fromId, $toId, $type='')
 Copy related categories to another object. More...
 
 deleteEcmFiles ($mode=0)
 Delete related files of object in database. More...
 

Static Public Member Functions

static createDepositFromOrigin (CommonObject $origin, $date, $payment_terms_id, User $user, $notrigger=0, $autoValidateDeposit=false, $overrideFields=array())
 Creates a deposit from a proposal or an order by grouping lines by VAT rates. More...
 
static replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
 Replace a thirdparty id with another one. More...
 
static replaceProduct (DoliDB $db, $origin_id, $dest_id)
 Replace a product id with another one. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch. More...
 
static getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
 Function used to get an array with all items linked to an object id in association table. More...
 
static getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count items linked to an object id in association table. More...
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table. More...
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 

Public Attributes

 $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
 
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
 $origin_object
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 deprecatedProperties ()
 Provide list of deprecated properties and replacements. More...
 
 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...
 
 canBeNull ($info)
 Function test if field can be null. More...
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to return the array of data key-value from the ->fields and all the ->properties of an object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage invoices.

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

Constructor & Destructor Documentation

◆ __construct()

Facture::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented in WebPortalInvoice.

Definition at line 424 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 = '',
  $fk_code_ventilation = 0,
  $info_bits = 0,
  $fk_remise_except = 0,
  $price_base_type = 'HT',
  $pu_ttc = 0,
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $origin = '',
  $origin_id = 0,
  $fk_parent_line = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $label = '',
  $array_options = array(),
  $situation_percent = 100,
  $fk_prev_id = 0,
  $fk_unit = null,
  $pu_ht_devise = 0,
  $ref_ext = '',
  $noupdateafterinsertline = 0 
)

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

Note: ->thirdparty must be defined. Les parameters sont deja cense etre juste et avec valeurs finales a l'appel de cette method. Aussi, pour le taux tva, il doit deja avoir ete defini par l'appelant par la method 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 | string$date_startDate start of service
int | string$date_endDate end of service
int$fk_code_ventilationCode of dispatching into accountancy
int$info_bitsBits of type of lines
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 (-1 means last value + 1)
int$special_codeSpecial code (also used by externals modules!)
string$originDepend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be 'orderdet', 'propaldet'..., else 'order','propal,'....
int$origin_idDepend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be Id of origin object (aka line id), else object id
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
int | null$fk_unitCode of the unit to use. Null to use the default one
double$pu_ht_deviseUnit price in foreign currency
string$ref_extExternal reference of the line
int$noupdateafterinsertlineNo update after insert of line
Returns
int Return integer <0 if KO, Id of line if OK

Definition at line 3767 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
bool false if KO, true if OK

Definition at line 4275 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$forceduedateIf set, do not recalculate due date from payment condition but force it with value
Returns
int Return integer <0 if KO, >0 if OK

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

◆ createDepositFromOrigin()

static Facture::createDepositFromOrigin ( CommonObject  $origin,
  $date,
  $payment_terms_id,
User  $user,
  $notrigger = 0,
  $autoValidateDeposit = false,
  $overrideFields = array() 
)
static

Creates a deposit from a proposal or an order by grouping lines by VAT rates.

Parameters
Propal | Commande$originThe original proposal or order
int$dateInvoice date
int$payment_terms_idInvoice payment terms
User$userObject user
int$notrigger1=Does not execute triggers, 0= execute triggers
bool$autoValidateDepositWhether to aumatically validate the deposit created
array$overrideFieldsArray of fields to force values
Returns
Facture|null The deposit created, or null if error (populates $origin->error in this case)

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

◆ createFromClone()

Facture::createFromClone ( User  $user,
  $fromid = 0 
)

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

Parameters
User$userUser that clone
int$fromidId of object to clone
Returns
int New id of clone

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

◆ createFromContract()

Facture::createFromContract (   $object,
User  $user,
  $lines = array() 
)

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

Parameters
Object$objectObject source
User$userObject user
array$linesIds of lines to use for invoice. If empty, all lines will be used.
Returns
int Return integer <0 if KO, 0 if nothing done, 1 if OK

Definition at line 1484 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 Return integer <0 if KO, >0 if OK

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

References $fk_facture_source, and CommonObject\fetch_optionals().

◆ 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 Return integer <0 if KO, 0 if nothing done, 1 if OK

Definition at line 1354 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 Return integer <0 if KO, 0=Refused, >0 if OK

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

◆ deleteLine()

Facture::deleteLine (   $rowid,
  $id = 0 
)

Delete line in database.

Parameters
int$rowidId of line to delete
int$idId of object (for a check)
Returns
int Return integer <0 if KO, >0 if OK

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

◆ displayRetainedWarranty()

Facture::displayRetainedWarranty ( )

Currently used for documents generation : to know if retained warranty need to be displayed.

Returns
bool

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

◆ fetch()

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

Get object from database.

Get also lines.

Parameters
int$rowidId of object to load
string$refReference of invoice
string$ref_extExternal reference of invoice
int$notusedNot used
bool$fetch_situationLoad also the previous and next situation invoice into $tab_previous_situation_invoice and $tab_next_situation_invoice
Returns
int >0 if OK, <0 if KO, 0 if not found

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

◆ fetch_lines()

Facture::fetch_lines (   $only_product = 0,
  $loadalsotranslation = 0 
)

Load all detailed lines into this->lines.

Parameters
int$only_productReturn only physical products
int$loadalsotranslationReturn translation for products
Returns
int 1 if OK, < 0 if KO

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

References $sql, and dol_syslog().

Referenced by getLinesArray().

◆ fetchPreviousNextSituationInvoice()

Facture::fetchPreviousNextSituationInvoice ( )

Fetch previous and next situations invoices.

Return all previous and next invoices (both standard and credit notes).

Returns
void

Definition at line 2397 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->model_pdf or GETPOST('model','alpha') for example.
Translate$outputlangsObject lang to use for translation
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 5208 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 5282 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 4975 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 4985 of file facture.class.php.

References CommonObject\getIdContact().

◆ getKanbanView()

Facture::getKanbanView (   $option = '',
  $arraydata = null 
)

Return clicable link of object (with eventually picto)

Parameters
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
array$arraydataArray of data
Returns
string HTML Code for Kanban thumb.

Reimplemented in WebPortalInvoice.

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

◆ getLinesArray()

Facture::getLinesArray ( )

Create an array of invoice lines.

Returns
int >0 if OK, <0 if KO

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

References fetch_lines().

◆ getNextNumRef()

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

Set absolute discount.

Parameters
User$userUser that set discount
double$remiseDiscount
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >0 if OK 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.

Reimplemented from CommonInvoice.

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

◆ getNomUrl()

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

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
string$targetTarget of link ('', '_self', '_blank', '_parent', '_backoffice', ...)
Returns
string String with URL

Reimplemented in WebPortalInvoice.

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

◆ getRetainedWarrantyAmount()

Facture::getRetainedWarrantyAmount (   $rounding = -1)
Parameters
int$roundingMinimum number of decimal to show. If 0, no change, if -1, we use min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOT)
Returns
float or -1 if not available

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

◆ getTooltipContentArray()

Facture::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsex option, infologin
Since
v18
Returns
array

Reimplemented from CommonObject.

Reimplemented in WebPortalInvoice.

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

◆ hasDelay()

Facture::hasDelay ( )

Is the customer invoice delayed?

Returns
bool

Definition at line 5423 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 4661 of file facture.class.php.

References $sql.

◆ 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
int

Definition at line 4999 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 2575 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 5270 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 5359 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 (paid completely or paid partiely) + not already replaced + not already a credit note

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

Definition at line 4834 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 abandoned for a reason 'other') + not paid + no payment at all + not already replaced

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

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

◆ liste_array()

Facture::liste_array (   $shortlist = 0,
  $draft = 0,
  $excluser = null,
  $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$excluserObject user to exclude
int$socidId third party
int$limitFor pagination
int$offsetFor pagination
string$sortfieldSort criteria
string$sortorderSort order
Returns
array|int -1 if KO, array with result if OK

Definition at line 4705 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 Return integer <0 if KO, WorkboardResponse if OK

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

◆ loadStateBoard()

Facture::loadStateBoard ( )

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

Returns
int Return integer <0 if KO, >0 if OK

Definition at line 5155 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 5237 of file facture.class.php.

References $sql.

◆ replaceProduct()

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

Replace a product id with another one.

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

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

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

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

Replace a thirdparty id with another one.

Parameters
DoliDB$dbsDatabase handler, because function is static we name it $dbs not $db to avoid breaking coding test
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

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

References CommonObject\commonReplaceThirdparty().

◆ sendEmailsRemindersOnInvoiceDueDate()

Facture::sendEmailsRemindersOnInvoiceDueDate (   $nbdays = 0,
  $paymentmode = 'all',
  $template = '',
  $datetouse = 'duedate',
  $forcerecipient = '' 
)

Send reminders by emails for invoices validated that are due.

CAN BE A CRON TASK

Parameters
int$nbdaysDelay before due date (or after if delay is negative)
string$paymentmode'' or 'all' by default (no filter), or 'LIQ', 'CHQ', CB', ...
int | string$templateName (or id) of email template (Must be a template of type 'facture_send')
string$datetouse'duedate' (default) or 'invoicedate'
string$forcerecipientForce email of recipient (for example to send the email to an accountant supervisor instead of the customer)
Returns
int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

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

◆ 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).

Deprecated:
See also
setCanceled()
Parameters
User$userObject user making change
string$close_codeCode of closing invoice (CLOSECODE_REPLACED, CLOSECODE_...)
string$close_noteComment
Returns
int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and setCanceled().

◆ set_paid()

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

Tag the invoice as paid completely (if close_code is filled) => this->fk_statut=2, this->paye=1 or partially (if close_code filled) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0.

Deprecated:
See also
setPaid()
Parameters
User$userObject user that modify
string$close_codeCode set when forcing to set the invoice as fully paid while in practice it is incomplete (because of a discount (fr:escompte) for instance)
string$close_noteComment set when forcing to set the invoice as fully paid while in practice it is incomplete (because of a discount (fr:escompte) for instance)
Returns
int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and setPaid().

◆ 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 Return integer <0 if KO, >0 if OK

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

References $sql, and dol_syslog().

◆ set_remise()

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

Set percent discount.

Deprecated:
See also
setDiscount()
Parameters
User$userUser that set discount
double$remiseDiscount
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and setDiscount().

◆ set_unpaid()

Facture::set_unpaid (   $user)

Tags the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened.

Deprecated:
See also
setUnpaid()
Parameters
User$userObject user that change status
Returns
int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and setUnpaid().

◆ setCanceled()

Facture::setCanceled (   $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 Return integer <0 if KO, >0 if OK

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

References dol_syslog().

Referenced by set_canceled().

◆ setDiscount()

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

Set percent discount.

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

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

References $sql, dol_syslog(), float, and price2num().

Referenced by set_remise().

◆ setDraft()

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

Set draft status.

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

Definition at line 3646 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 Return integer <0 if KO, >0 if OK

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

References $sql, and dol_syslog().

◆ setPaid()

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

Tag the invoice as :

  • paid completely (if close_code is not filled) => this->fk_statut=2, this->paye=1
  • or partially (if close_code filled) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0
Parameters
User$userObject user that modify
string$close_codeCode set when forcing to set the invoice as fully paid while in practice it is incomplete (because of a discount (fr:escompte) for instance)
string$close_noteComment set when forcing to set the invoice as fully paid while in practice it is incomplete (because of a discount (fr:escompte) for instance)
Returns
int Return integer <0 if KO, >0 if OK

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

Referenced by set_paid().

◆ setRetainedWarranty()

Facture::setRetainedWarranty (   $value)

Change the retained warranty.

Parameters
float$valuevalue of retained warranty
Returns
int >0 if OK, <0 if KO

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

◆ setRetainedWarrantyDateLimit()

Facture::setRetainedWarrantyDateLimit (   $timestamp,
  $dateYmd = '' 
)

Change the retained_warranty_date_limit.

Parameters
int$timestampdate limit of retained warranty in timestamp format
string$dateYmddate limit of retained warranty in Y m d format
Returns
int >0 if OK, <0 if KO

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

◆ setUnpaid()

Facture::setUnpaid (   $user)

Tag the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened.

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

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

References $sql, and dol_syslog().

Referenced by set_unpaid().

◆ update()

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

Update database.

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

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

References type, and TYPE_STANDARD.

◆ update_percent()

Facture::update_percent (   $line,
  $percent,
  $update_price = true 
)

Update invoice line with percentage.

Parameters
FactureLigne$lineInvoice line
int$percentPercentage
boolean$update_priceUpdate object price
Returns
void

Definition at line 4305 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 = array(),
  $situation_percent = 100,
  $fk_unit = null,
  $pu_ht_devise = 0,
  $notrigger = 0,
  $ref_ext = '',
  $rang = 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_percentPercentage discount of the line
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 information
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
int | null$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
string$ref_extExternal reference of the line
integer$rangrank of line
Returns
int Return integer < 0 if KO, > 0 if OK

Definition at line 4063 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 3591 of file facture.class.php.

◆ validate()

Facture::validate (   $user,
  $force_number = '',
  $idwarehouse = 0,
  $notrigger = 0,
  $batch_rule = 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 decrease on stock is on (0=no decrease)
int$notrigger1=Does not execute triggers, 0= execute triggers
int$batch_rule0=do not decrement batch, else batch rule to use, 1=take in batches ordered by sellby and eatby dates
Returns
int Return integer <0 if KO, 0=Nothing done because invoice is not a draft, >0 if OK

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

◆ willBeLastOfSameType()

Facture::willBeLastOfSameType (   $allow_validated_drafts = false)

See if current invoice date is posterior to the last invoice date among validated invoices of same type.

Parameters
boolean$allow_validated_draftsreturn true if the invoice has been validated before returning to DRAFT state.
Returns
array return array

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

References $sql, and type.

Member Data Documentation

◆ 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 408 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 399 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 375 of file facture.class.php.


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