dolibarr  21.0.0-alpha
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
FactureFournisseur Class Reference

Class to manage suppliers invoices. More...

Inheritance diagram for FactureFournisseur:
Inheritance graph
[legend]
Collaboration diagram for FactureFournisseur:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create ($user)
 Create supplier invoice into database. More...
 
 fetch ($id=0, $ref='', $ref_ext='')
 Load object in memory from database. More...
 
 fetch_lines ()
 Load this->lines. More...
 
 update ($user=null, $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...
 
 delete (User $user, $notrigger=0)
 Delete invoice from database. More...
 
 set_paid ($user, $close_code='', $close_note='')
 Tag invoice as a paid invoice. More...
 
 setPaid ($user, $close_code='', $close_note='')
 Tag invoice as a paid invoice. More...
 
 set_unpaid ($user)
 Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened. More...
 
 setUnpaid ($user)
 Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened. 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)
 Tag invoice as validated + call trigger BILL_VALIDATE. More...
 
 setDraft ($user, $idwarehouse=-1, $notrigger=0)
 Set draft status. More...
 
 addline ($desc, $pu, $txtva, $txlocaltax1, $txlocaltax2, $qty, $fk_product=0, $remise_percent=0, $date_start=0, $date_end=0, $fk_code_ventilation=0, $info_bits=0, $price_base_type='HT', $type=0, $rang=-1, $notrigger=0, $array_options=[], $fk_unit=null, $origin_id=0, $pu_devise=0, $ref_supplier='', $special_code=0, $fk_parent_line=0, $fk_remise_except=0)
 Adds an invoice line (associated with no predefined product/service) The parameters are already supposed to be correct and with final values when calling this method. More...
 
 updateline ($id, $desc, $pu, $vatrate, $txlocaltax1=0, $txlocaltax2=0, $qty=1, $idproduct=0, $price_base_type='HT', $info_bits=0, $type=0, $remise_percent=0, $notrigger=0, $date_start='', $date_end='', $array_options=[], $fk_unit=null, $pu_devise=0, $ref_supplier='', $rang=0)
 Update a line detail into database. More...
 
 deleteLine ($rowid, $notrigger=0)
 Delete a detail line from database. More...
 
 info ($id)
 Loads the info order information into the invoice object. More...
 
 list_replacable_supplier_invoices ($socid=0)
 Return list of replaceable invoices Status valid or abandoned for other reason + not paid + no payment + not already replaced. More...
 
 list_qualified_avoir_supplier_invoices ($socid=0)
 Return list of qualifying invoices for correction by credit note Invoices that respect the following rules are returned: (validated + payment in progress) or classified (paid in full or paid in part) + not already replaced + not already having. More...
 
 load_board ($user)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $save_lastsearch_value=-1, $addlinktonotes=0)
 Return clicable name (with picto eventually) More...
 
 getNextNumRef ($soc, $mode='next')
 Return next reference of supplier invoice not already used (or last reference) according to numbering module defined into constant INVOICE_SUPPLIER_ADDON_NUMBER. More...
 
 initAsSpecimen ($option='')
 Initialise an instance with random values. More...
 
 loadStateBoard ()
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 createFromClone (User $user, $fromid, $invertdetail=0)
 Load an object from its id and create a new one in database. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template model. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 hasDelay ()
 Is the payment of the supplier invoice having a delay? More...
 
 isCreditNoteUsed ()
 Is credit note used. More...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
 setVATReverseCharge ($vatreversecharge)
 Change the option VAT reverse charge. More...
 
 sendEmailsRemindersOnSupplierInvoiceDueDate ($nbdays=0, $paymentmode='all', $template='', $datetouse='duedate', $forcerecipient='')
 Send reminders by emails for supplier invoices validated that are due. 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
 isEmpty ()
 isEmpty We consider CommonObject isEmpty if this->id is empty More...
 
 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...
 
 getExtraField ($key)
 Convenience method for retrieving the value of an extrafield without actually fetching it from the database. More...
 
 setExtraField ($key, $value)
 Convenience method for setting the value of an extrafield without actually updating it in the database. 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')
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 Function used to get the logos or photos of an object. 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 replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
static replaceProduct (DoliDB $db, $origin_id, $dest_id)
 Function used to 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

 $amount = 0
 
 $remise = 0
 
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 STATUS_DRAFT = 0
 Draft.
 
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 suppliers invoices.

Definition at line 53 of file fournisseur.facture.class.php.

Constructor & Destructor Documentation

◆ __construct()

FactureFournisseur::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 376 of file fournisseur.facture.class.php.

Member Function Documentation

◆ addline()

FactureFournisseur::addline (   $desc,
  $pu,
  $txtva,
  $txlocaltax1,
  $txlocaltax2,
  $qty,
  $fk_product = 0,
  $remise_percent = 0,
  $date_start = 0,
  $date_end = 0,
  $fk_code_ventilation = 0,
  $info_bits = 0,
  $price_base_type = 'HT',
  $type = 0,
  $rang = -1,
  $notrigger = 0,
  $array_options = [],
  $fk_unit = null,
  $origin_id = 0,
  $pu_devise = 0,
  $ref_supplier = '',
  $special_code = 0,
  $fk_parent_line = 0,
  $fk_remise_except = 0 
)

Adds an invoice line (associated with no predefined product/service) The parameters are already supposed to be correct and with final values when calling this method.

Also, for the VAT rate, it must already have been defined by the caller by by the get_default_tva method(vendor_company, buying company, idprod) and the desc must already have the right value (the caller has to manage the multilanguage).

Parameters
string$descDescription of the line
double$puUnit price (HT or TTC according to price_base_type, > 0 even for credit note)
double$txtvaForce Vat rate to use, -1 for auto.
double$txlocaltax1LocalTax1 Rate
double$txlocaltax2LocalTax2 Rate
double$qtyQuantity
int$fk_productProduct/Service ID predefined
double$remise_percentPercentage discount of the line
int$date_startService start date
int$date_endService expiry date
int$fk_code_ventilationAccounting breakdown code
int$info_bitsLine type bits
string$price_base_typeHT or TTC
int$typeType of line (0=product, 1=service)
int$rangPosition of line
int$notriggerDisable triggers
array$array_optionsextrafields array
int | null$fk_unitCode of the unit to use. Null to use the default one
int$origin_idid origin document
double$pu_deviseAmount in currency
string$ref_supplierSupplier ref
int$special_codeSpecial code
int$fk_parent_lineParent line id
int$fk_remise_exceptId discount used
Returns
int >0 if OK, <0 if KO

Definition at line 2084 of file fournisseur.facture.class.php.

◆ create()

FactureFournisseur::create (   $user)

Create supplier invoice into database.

Parameters
User$useruser object that creates
Returns
int Id invoice created if OK, < 0 if KO

Definition at line 389 of file fournisseur.facture.class.php.

◆ createFromClone()

FactureFournisseur::createFromClone ( User  $user,
  $fromid,
  $invertdetail = 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
int$invertdetailReverse sign of amounts for lines
Returns
int New id of clone

Definition at line 3152 of file fournisseur.facture.class.php.

◆ delete()

FactureFournisseur::delete ( User  $user,
  $notrigger = 0 
)

Delete invoice from database.

Parameters
User$userUser object
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1431 of file fournisseur.facture.class.php.

◆ deleteLine()

FactureFournisseur::deleteLine (   $rowid,
  $notrigger = 0 
)

Delete a detail line from database.

Parameters
int$rowidId of line to delete
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2505 of file fournisseur.facture.class.php.

References $sql, and dol_syslog().

◆ fetch()

FactureFournisseur::fetch (   $id = 0,
  $ref = '',
  $ref_ext = '' 
)

Load object in memory from database.

Parameters
int$idId supplier invoice
string$refRef supplier invoice
string$ref_extExternal reference of invoice
Returns
int Return integer <0 if KO, >0 if OK, 0 if not found

Definition at line 863 of file fournisseur.facture.class.php.

References $sql, and dol_syslog().

◆ fetch_lines()

FactureFournisseur::fetch_lines ( )

Load this->lines.

Returns
int 1 si ok, < 0 si erreur

Definition at line 1037 of file fournisseur.facture.class.php.

References $sql, and dol_syslog().

◆ generateDocument()

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

Create a document onto disk according to template model.

Parameters
string$modeleForce template to use ('' to not force)
Translate$outputlangsObject lang a utiliser pour traduction
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
?array<string,mixed>$moreparams Array to provide more information
Returns
int<-1,1> Return integer <0 if KO, 0 if nothing done, >0 if OK

Definition at line 3232 of file fournisseur.facture.class.php.

◆ getKanbanView()

FactureFournisseur::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{selected?:int<0,1>}$arraydata Array of data
Returns
string HTML Code for Kanban thumb.

Definition at line 3349 of file fournisseur.facture.class.php.

◆ getNextNumRef()

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

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

Parameters
Societe$socThirdparty object
string$mode'next' for next value or 'last' for last value
Returns
string|-1 Returns free reference or last reference, or '' or -1 if error

Reimplemented from CommonInvoice.

Definition at line 2962 of file fournisseur.facture.class.php.

◆ getNomUrl()

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

Return clicable name (with picto eventually)

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Only picto
string$optionWhere point the link
int$maxMax length of shown ref
int$short1=Return just URL
string$moretitleAdd more text to title tooltip
int$notooltip1=Disable tooltip
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$addlinktonotesAdd link to show notes
Returns
string String with URL

Definition at line 2847 of file fournisseur.facture.class.php.

◆ getRights()

FactureFournisseur::getRights ( )

Returns the rights used for this class.

Returns
int

Reimplemented from CommonObject.

Definition at line 3261 of file fournisseur.facture.class.php.

◆ getTooltipContentArray()

FactureFournisseur::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array{moretitle?:string}$params ex option, infologin
Since
v18
Returns
array{picto:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}

Reimplemented from CommonObject.

Definition at line 2758 of file fournisseur.facture.class.php.

◆ hasDelay()

FactureFournisseur::hasDelay ( )

Is the payment of the supplier invoice having a delay?

Returns
bool

Definition at line 3307 of file fournisseur.facture.class.php.

◆ info()

FactureFournisseur::info (   $id)

Loads the info order information into the invoice object.

Parameters
int$idId of the invoice to load
Returns
void

Definition at line 2559 of file fournisseur.facture.class.php.

References $sql.

◆ initAsSpecimen()

FactureFournisseur::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 3014 of file fournisseur.facture.class.php.

◆ insert_discount()

FactureFournisseur::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 1331 of file fournisseur.facture.class.php.

◆ isCreditNoteUsed()

FactureFournisseur::isCreditNoteUsed ( )

Is credit note used.

Returns
bool

Definition at line 3327 of file fournisseur.facture.class.php.

References $sql.

◆ list_qualified_avoir_supplier_invoices()

FactureFournisseur::list_qualified_avoir_supplier_invoices (   $socid = 0)

Return list of qualifying invoices for correction by credit note Invoices that respect the following rules are returned: (validated + payment in progress) or classified (paid in full or paid in part) + not already replaced + not already having.

Parameters
int$socidThirdparty id
Returns
array|int Table of invoices ($id => array('ref'=>,'paymentornot'=>,'status'=>,'paye'=>) <0 if error

Definition at line 2645 of file fournisseur.facture.class.php.

◆ list_replacable_supplier_invoices()

FactureFournisseur::list_replacable_supplier_invoices (   $socid = 0)

Return list of replaceable invoices Status valid or abandoned for other reason + not paid + no payment + not already replaced.

Parameters
int$socidThirdparty id
Returns
array|int Table of invoices ('id'=>id, 'ref'=>ref, 'status'=>status, 'paymentornot'=>0/1) <0 if error

Definition at line 2595 of file fournisseur.facture.class.php.

◆ load_board()

FactureFournisseur::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 2696 of file fournisseur.facture.class.php.

◆ loadStateBoard()

FactureFournisseur::loadStateBoard ( )

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

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

Definition at line 3112 of file fournisseur.facture.class.php.

◆ replaceProduct()

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

Function used to 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 3293 of file fournisseur.facture.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

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

Function used to 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 3276 of file fournisseur.facture.class.php.

References CommonObject\commonReplaceThirdparty().

◆ sendEmailsRemindersOnSupplierInvoiceDueDate()

FactureFournisseur::sendEmailsRemindersOnSupplierInvoiceDueDate (   $nbdays = 0,
  $paymentmode = 'all',
  $template = '',
  $datetouse = 'duedate',
  $forcerecipient = '' 
)

Send reminders by emails for supplier 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 'invoice_supplier_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 3437 of file fournisseur.facture.class.php.

◆ set_paid()

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

Tag invoice as a paid invoice.

Deprecated:
See also
setPaid()
Parameters
User$userObject user
string$close_codeCode indicates whether the class has paid in full while payment is incomplete. Not implemented yet.
string$close_noteComment informs if the class has been paid while payment is incomplete. Not implemented yet.
Returns
int Return integer <0 si ko, >0 si ok

Definition at line 1570 of file fournisseur.facture.class.php.

References dol_syslog(), and setPaid().

◆ set_unpaid()

FactureFournisseur::set_unpaid (   $user)

Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened.

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

Definition at line 1648 of file fournisseur.facture.class.php.

References dol_syslog(), and setUnpaid().

◆ setCanceled()

FactureFournisseur::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 1709 of file fournisseur.facture.class.php.

References $sql, and dol_syslog().

◆ setDraft()

FactureFournisseur::setDraft (   $user,
  $idwarehouse = -1,
  $notrigger = 0 
)

Set draft status.

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

Definition at line 1981 of file fournisseur.facture.class.php.

◆ setPaid()

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

Tag invoice as a paid invoice.

Parameters
User$userObject user
string$close_codeCode indicates whether the class has paid in full while payment is incomplete. Not implemented yet.
string$close_noteComment informs if the class has been paid while payment is incomplete. Not implemented yet.
Returns
int<-1,1> Return integer <0 si ko, >0 si ok

Definition at line 1585 of file fournisseur.facture.class.php.

Referenced by set_paid().

◆ setUnpaid()

FactureFournisseur::setUnpaid (   $user)

Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened.

Parameters
User$userObject user that change status
Returns
int Return integer <0 si ok, >0 si ok

Definition at line 1663 of file fournisseur.facture.class.php.

References $sql, and dol_syslog().

Referenced by set_unpaid().

◆ setVATReverseCharge()

FactureFournisseur::setVATReverseCharge (   $vatreversecharge)

Change the option VAT reverse charge.

Parameters
int$vatreversecharge0 = Off, 1 = On
Returns
int 1 if OK, 0 if KO

Definition at line 3403 of file fournisseur.facture.class.php.

References $sql, and dol_syslog().

◆ update()

FactureFournisseur::update (   $user = null,
  $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 1141 of file fournisseur.facture.class.php.

◆ updateline()

FactureFournisseur::updateline (   $id,
  $desc,
  $pu,
  $vatrate,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $qty = 1,
  $idproduct = 0,
  $price_base_type = 'HT',
  $info_bits = 0,
  $type = 0,
  $remise_percent = 0,
  $notrigger = 0,
  $date_start = '',
  $date_end = '',
  $array_options = [],
  $fk_unit = null,
  $pu_devise = 0,
  $ref_supplier = '',
  $rang = 0 
)

Update a line detail into database.

Parameters
int$idId of line invoice
string$descDescription of line
double$puPrix unitaire (HT ou TTC selon price_base_type)
double$vatrateVAT Rate (Can be '8.5', '8.5 (ABC)')
double$txlocaltax1LocalTax1 Rate
double$txlocaltax2LocalTax2 Rate
double$qtyQuantity
int$idproductId produit
string$price_base_typeHT or TTC
int$info_bitsMiscellaneous information of line
int$typeType of line (0=product, 1=service)
double$remise_percentPercentage discount of the line
int$notriggerDisable triggers
int | string$date_startDate start of service
int | string$date_endDate end of service
array$array_optionsextrafields array
int | null$fk_unitCode of the unit to use. Null to use the default one
double$pu_deviseAmount in currency
string$ref_supplierSupplier ref
int$rangLine rank
Returns
int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 2347 of file fournisseur.facture.class.php.

◆ validate()

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

Tag invoice as validated + call trigger BILL_VALIDATE.

Parameters
User$userObject user that validate
string$force_numberReference to force on invoice
int$idwarehouseId of warehouse for stock change
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, =0 if nothing to do, >0 if OK

Definition at line 1766 of file fournisseur.facture.class.php.

Member Data Documentation

◆ $amount

double FactureFournisseur::$amount = 0
Deprecated:
See $total_ttc, $total_ht, $total_tva

Definition at line 182 of file fournisseur.facture.class.php.

◆ $remise

double FactureFournisseur::$remise = 0
Deprecated:

Definition at line 187 of file fournisseur.facture.class.php.

◆ STATUS_ABANDONED

const FactureFournisseur::STATUS_ABANDONED = 3

Classified abandoned and no payment done.

$this->close_code can be:

  • CLOSECODE_BADCREDIT
  • CLOSECODE_ABANDONED
  • CLOSECODE_REPLACED

Definition at line 364 of file fournisseur.facture.class.php.

◆ STATUS_CLOSED

const FactureFournisseur::STATUS_CLOSED = 2

Classified paid.

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

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

Definition at line 355 of file fournisseur.facture.class.php.


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