dolibarr  7.0.0-beta
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:
+ Collaboration diagram for FactureFournisseur:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create ($user)
 Create supplier invoice into database. More...
 
 fetch ($id='', $ref='')
 Load object in memory from database. More...
 
 fetch_lines ()
 Load this->lines. More...
 
 update ($user=null, $notrigger=0)
 Update database. More...
 
 delete (User $user, $notrigger=0)
 Delete invoice from database. More...
 
 set_paid ($user, $close_code='', $close_note='')
 Tag invoice as a payed invoice. More...
 
 set_unpaid ($user)
 Tag la facture comme non payee completement + appel trigger BILL_UNPAYED Fonction utilisee quand un paiement prelevement est refuse, ou quand une facture annulee et reouverte. More...
 
 validate ($user, $force_number='', $idwarehouse=0, $notrigger=0)
 Tag invoice as validated + call trigger BILL_VALIDATE. More...
 
 set_draft ($user, $idwarehouse=-1)
 Set draft status. More...
 
 addline ($desc, $pu, $txtva, $txlocaltax1, $txlocaltax2, $qty, $fk_product=0, $remise_percent=0, $date_start='', $date_end='', $ventil=0, $info_bits='', $price_base_type='HT', $type=0, $rang=-1, $notrigger=false, $array_options=0, $fk_unit=null, $origin_id=0, $pu_ht_devise=0, $ref_supplier='')
 Ajoute une ligne de facture (associe a aucun produit/service predefini) Les parametres sont deja cense etre juste et avec valeurs finales a l'appel de cette methode. 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=false, $date_start='', $date_end='', $array_options=0, $fk_unit=null, $pu_ht_devise=0)
 Update a line detail into database. More...
 
 deleteline ($rowid, $notrigger=0)
 Delete a detail line from database. More...
 
 info ($id)
 Charge les informations d'ordre info dans l'objet facture. More...
 
 list_replacable_supplier_invoices ($socid=0)
 Renvoi liste des factures remplacables Statut validee ou abandonnee pour raison autre + non payee + aucun paiement + pas deja remplacee. More...
 
 list_qualified_avoir_supplier_invoices ($socid=0)
 Renvoi liste des factures qualifiables pour correction par avoir Les factures qui respectent les regles suivantes sont retournees: (validee + paiement en cours) ou classee (payee completement ou payee partiellement) + pas deja remplacee + pas deja avoir. More...
 
 load_board ($user)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $save_lastsearch_value=-1)
 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...
 
 load_state_board ()
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 createFromClone ($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)
 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...
 
- 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 and deposits invoices used by invoice. More...
 
 getListIdAvoirFromInvoice ()
 Renvoie tableau des ids de facture avoir issus de la facture. More...
 
 getIdReplacingInvoice ($option='')
 Renvoie l'id de la facture qui la remplace. More...
 
 is_erasable ()
 Return if an invoice can be deleted Rule is: If invoice is draft and has a temporary ref -> yes 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) More...
 
 getVentilExportCompta ()
 Return if an invoice was dispatched into bookkeeping. More...
 
 getLibType ()
 Return label of type of invoice. More...
 
 getLibStatut ($mode=0, $alreadypaid=-1)
 Return label of object status. More...
 
 LibStatut ($paye, $status, $mode=0, $alreadypaid=-1, $type=0)
 Return label of a status. More...
 
 calculate_date_lim_reglement ($cond_reglement=0)
 Renvoi une date limite de reglement de facture en fonction des conditions de reglements de la facture et date de facturation. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\n")
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 Charge le projet d'id $this->fk_project dans this->projet. More...
 
 fetch_user ($userid)
 Charge le user d'id userid dans this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key)
 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='')
 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 project. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id)
 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)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1)
 Fetch array of objects linked to current object. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 isInEEC ()
 Return if a country is inside the EEC (European Economic Community) More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it'st possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key)
 Update an exta field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='')
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 

Static Public Member Functions

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

Public Attributes

 $note
 
 $fournisseur
 
 $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 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.
 
const STATUS_VALIDATED = 1
 Validated (need to be paid)
 
const STATUS_CLOSED = 2
 Classified paid. More...
 
const STATUS_ABANDONED = 3
 Classified abandoned and no payment done. More...
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage suppliers invoices.

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

Constructor & Destructor Documentation

FactureFournisseur::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

FactureFournisseur::addline (   $desc,
  $pu,
  $txtva,
  $txlocaltax1,
  $txlocaltax2,
  $qty,
  $fk_product = 0,
  $remise_percent = 0,
  $date_start = '',
  $date_end = '',
  $ventil = 0,
  $info_bits = '',
  $price_base_type = 'HT',
  $type = 0,
  $rang = -1,
  $notrigger = false,
  $array_options = 0,
  $fk_unit = null,
  $origin_id = 0,
  $pu_ht_devise = 0,
  $ref_supplier = '' 
)

Ajoute une ligne de facture (associe a aucun produit/service predefini) Les parametres sont deja cense etre juste et avec valeurs finales a l'appel de cette methode.

Aussi, pour le taux tva, il doit deja avoir ete defini par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,idprod) et le desc doit deja avoir la bonne valeur (a l'appelant de gerer le multilangue).

Parameters
string$descDescription de la ligne
double$puPrix unitaire (HT ou TTC selon price_base_type, > 0 even for credit note)
double$txtvaForce Vat rate to use, -1 for auto.
double$txlocaltax1LocalTax1 Rate
double$txlocaltax2LocalTax2 Rate
double$qtyQuantite
int$fk_productId du produit/service predefini
double$remise_percentPourcentage de remise de la ligne
date$date_startDate de debut de validite du service
date$date_endDate de fin de validite du service
string$ventilCode de ventilation comptable
int$info_bitsBits de type de lines
string$price_base_typeHT ou TTC
int$typeType of line (0=product, 1=service)
int$rangPosition of line
int$notriggerDisable triggers
array$array_optionsextrafields array
string$fk_unitCode of the unit to use. Null to use the default one
int$origin_idid origin document
double$pu_ht_deviseAmount in currency
string$ref_supplierSupplier ref
Returns
int >0 if OK, <0 if KO

FIXME Add field ref (that should be named ref_supplier) and label into update. For example can be filled when product line created from order.

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

References calcul_price_total(), dol_syslog(), getLocalTaxesFromRate(), CommonObject\line_order(), price2num(), type, and CommonObject\update_price().

FactureFournisseur::create (   $user)

Create supplier invoice into database.

Parameters
User$userobject utilisateur qui cree
Returns
int Id invoice created if OK, < 0 if KO

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

References $resql, CommonObject\add_object_linked(), CommonObject\call_trigger(), description, dol_now(), dol_print_error(), dol_syslog(), MultiCurrency\getIdAndTxFromCode(), MultiCurrency\getIdFromCode(), CommonObject\insertExtraFields(), type, CommonObject\update_price(), and updateline().

FactureFournisseur::createFromClone (   $fromid,
  $invertdetail = 0 
)

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

Parameters
int$fromidId of object to clone
int$invertdetailReverse sign of amounts for lines
Returns
int New id of clone

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

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

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

References $resql, CommonObject\call_trigger(), CommonObject\deleteExtraFields(), CommonObject\deleteObjectLinked(), dol_delete_dir_recursive(), dol_delete_file(), dol_sanitizeFileName(), dol_syslog(), and get_exdir().

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

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

References CommonObject\update_price().

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

Load object in memory from database.

Parameters
int$idId supplier invoice
string$refRef supplier invoice
Returns
int <0 if KO, >0 if OK, 0 if not found

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

References $resql, dol_syslog(), fetch_lines(), CommonObject\fetch_optionals(), getEntity(), and type.

FactureFournisseur::fetch_lines ( )

Load this->lines.

Returns
int 1 si ok, < 0 si erreur

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

References dol_syslog().

Referenced by fetch(), and validate().

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

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
Returns
int <0 if KO, 0 if nothing done, >0 if OK

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

References CommonObject\commonGenerateDocument().

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 free ref or last ref

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

References dol_buildpath(), and dol_print_error().

Referenced by validate().

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

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
Returns
string String with URL

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

References dol_trunc(), img_object(), price(), and type.

FactureFournisseur::getRights ( )

Returns the rights used for this class.

Returns
stdClass

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

FactureFournisseur::hasDelay ( )

Is the payment of the supplier invoice having a delay?

Returns
bool

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

References dol_now().

FactureFournisseur::info (   $id)

Charge les informations d'ordre info dans l'objet facture.

Parameters
int$idId de la facture a charger
Returns
void

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

References dol_print_error().

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
void

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

References $resql, and dol_now().

FactureFournisseur::list_qualified_avoir_supplier_invoices (   $socid = 0)

Renvoi liste des factures qualifiables pour correction par avoir Les factures qui respectent les regles suivantes sont retournees: (validee + paiement en cours) ou classee (payee completement ou payee partiellement) + pas deja remplacee + pas deja avoir.

Parameters
int$socidId societe
Returns
array Tableau des factures ($id => array('ref'=>,'paymentornot'=>,'status'=>,'paye'=>)

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

References $resql, and dol_syslog().

FactureFournisseur::list_replacable_supplier_invoices (   $socid = 0)

Renvoi liste des factures remplacables Statut validee ou abandonnee pour raison autre + non payee + aucun paiement + pas deja remplacee.

Parameters
int$socidId societe
Returns
array Tableau des factures ('id'=>id, 'ref'=>ref, 'status'=>status, 'paymentornot'=>0/1)

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

References $resql, and dol_syslog().

FactureFournisseur::load_board (   $user)

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

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

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

References $resql, dol_now(), dol_print_error(), and img_object().

FactureFournisseur::load_state_board ( )

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

Returns
int <0 if KO, >0 if OK

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

References $resql, and dol_print_error().

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

Function used to replace a thirdparty id with another one.

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

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

References CommonObject\commonReplaceThirdparty().

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

Set draft status.

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

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

References CommonObject\call_trigger(), and dol_syslog().

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

Tag invoice as a payed invoice.

Parameters
User$userObject user
string$close_codeCode renseigne si on classe a payee completement alors que paiement incomplet. Not implementd yet.
string$close_noteCommentaire renseigne si on classe a payee alors que paiement incomplet. Not implementd yet.
Returns
int <0 si ko, >0 si ok

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

References $resql, CommonObject\call_trigger(), dol_print_error(), and dol_syslog().

FactureFournisseur::set_unpaid (   $user)

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

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

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

References $resql, CommonObject\call_trigger(), and dol_syslog().

FactureFournisseur::update (   $user = null,
  $notrigger = 0 
)

Update database.

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

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

References $resql, CommonObject\call_trigger(), dol_strlen(), dol_syslog(), and type.

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 = false,
  $date_start = '',
  $date_end = '',
  $array_options = 0,
  $fk_unit = null,
  $pu_ht_devise = 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
double$price_base_typeHT or TTC
int$info_bitsMiscellaneous informations of line
int$typeType of line (0=product, 1=service)
double$remise_percentPourcentage de remise de la ligne
int$notriggerDisable triggers
timestamp$date_startDate start of service
timestamp$date_endDate end of service
array$array_optionsextrafields array
string$fk_unitCode of the unit to use. Null to use the default one
double$pu_ht_deviseAmount in currency
Returns
int <0 if KO, >0 if OK

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

References calcul_price_total(), dol_syslog(), getLocalTaxesFromRate(), price2num(), and CommonObject\update_price().

Referenced by create().

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 <0 if KO, =0 if nothing to do, >0 if OK

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

References $resql, CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_sanitizeFileName(), dol_syslog(), fetch_lines(), CommonObject\fetch_thirdparty(), get_exdir(), getNextNumRef(), and price2num().

Member Data Documentation

FactureFournisseur::$fournisseur
Deprecated:

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

FactureFournisseur::$note
Deprecated:
See also
note_private, note_public

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

const FactureFournisseur::STATUS_ABANDONED = 3

Classified abandoned and no payment done.

$this->close_code can be:

  • CLOSECODE_BADDEBT
  • CLOSECODE_ABANDONED
  • CLOSECODE_REPLACED

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

const FactureFournisseur::STATUS_CLOSED = 2

Classified paid.

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

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

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


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