dolibarr  7.0.0-beta
Public Member Functions | Public Attributes | List of all members
CommonInvoice Class Reference

Superclass for invoices classes. More...

+ Inheritance diagram for CommonInvoice:
+ Collaboration diagram for CommonInvoice:

Public Member Functions

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

Public Attributes

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
 

Additional Inherited Members

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

Superclass for invoices classes.

Definition at line 31 of file commoninvoice.class.php.

Member Function Documentation

CommonInvoice::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.

Parameters
integer$cond_reglementCondition of payment (code or id) to use. If 0, we use current condition.
Returns
date Date limite de reglement si ok, <0 si ko

Definition at line 539 of file commoninvoice.class.php.

References dol_mktime(), dol_syslog(), and getEntity().

Referenced by Facture\create(), FactureRec\initAsSpecimen(), Facture\initAsSpecimen(), and Facture\validate().

CommonInvoice::getIdReplacingInvoice (   $option = '')

Renvoie l'id de la facture qui la remplace.

Parameters
string$optionfiltre sur statut ('', 'validated', ...)
Returns
int <0 si KO, 0 si aucune facture ne remplace, id facture sinon

Definition at line 242 of file commoninvoice.class.php.

References $resql.

CommonInvoice::getLibStatut (   $mode = 0,
  $alreadypaid = -1 
)

Return label of object status.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto
integer$alreadypaid0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
Returns
string Label of status

Definition at line 396 of file commoninvoice.class.php.

References LibStatut(), and type.

CommonInvoice::getLibType ( )

Return label of type of invoice.

Returns
string Label of type of invoice

Definition at line 377 of file commoninvoice.class.php.

References type, TYPE_CREDIT_NOTE, TYPE_DEPOSIT, TYPE_PROFORMA, TYPE_REPLACEMENT, TYPE_SITUATION, and TYPE_STANDARD.

CommonInvoice::getListIdAvoirFromInvoice ( )

Renvoie tableau des ids de facture avoir issus de la facture.

Returns
array Tableau d'id de factures avoirs

Definition at line 209 of file commoninvoice.class.php.

References $resql, and dol_print_error().

CommonInvoice::getRemainToPay (   $multicurrency = 0)

Return remain amount to pay.

Property ->id and ->total_ttc must be set. This does not include open direct debit requests.

Parameters
int$multicurrencyReturn multicurrency_amount instead of amount
Returns
double Remain of amount to pay

Definition at line 100 of file commoninvoice.class.php.

References getSommePaiement(), getSumCreditNotesUsed(), and getSumDepositsUsed().

CommonInvoice::getSommePaiement (   $multicurrency = 0)

Return amount of payments already done.

Parameters
int$multicurrencyReturn multicurrency_amount instead of amount
Returns
int Amount of payment already done, <0 if KO

Definition at line 115 of file commoninvoice.class.php.

References $resql, and dol_syslog().

Referenced by Facture\demande_prelevement(), and getRemainToPay().

CommonInvoice::getSumCreditNotesUsed (   $multicurrency = 0)

Return amount (with tax) of all credit notes and deposits invoices used by invoice.

Parameters
int$multicurrencyReturn multicurrency_amount instead of amount
Returns
int <0 if KO, Sum of credit notes and deposits amount otherwise

Definition at line 181 of file commoninvoice.class.php.

Referenced by Facture\demande_prelevement(), and getRemainToPay().

CommonInvoice::getSumDepositsUsed (   $multicurrency = 0)

Return amount (with tax) of all deposits invoices used by invoice.

Should always be empty, except if option FACTURE_DEPOSITS_ARE_JUST_PAYMENTS is on (not recommended).

Parameters
int$multicurrencyReturn multicurrency_amount instead of amount
Returns
int <0 if KO, Sum of deposits amount otherwise

Definition at line 152 of file commoninvoice.class.php.

Referenced by Facture\demande_prelevement(), and getRemainToPay().

CommonInvoice::getVentilExportCompta ( )

Return if an invoice was dispatched into bookkeeping.

Returns
int <0 if KO, 0=no, 1=yes

Definition at line 341 of file commoninvoice.class.php.

References $resql.

Referenced by is_erasable().

CommonInvoice::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)

Returns
int <=0 if no, >0 if yes

Definition at line 289 of file commoninvoice.class.php.

References CommonObject\fetch_thirdparty(), and getVentilExportCompta().

Referenced by Facture\delete().

CommonInvoice::LibStatut (   $paye,
  $status,
  $mode = 0,
  $alreadypaid = -1,
  $type = 0 
)

Return label of a status.

Parameters
int$payeStatus field paye
int$statusId status
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=long label + picto
integer$alreadypaid0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, -1 otherwise)
int$typeType invoice
Returns
string Label of status

Definition at line 411 of file commoninvoice.class.php.

References img_picto().

Referenced by getLibStatut().

Member Data Documentation

const CommonInvoice::STATUS_ABANDONED = 3

Classified abandoned and no payment done.

$this->close_code can be:

  • CLOSECODE_BADDEBT
  • CLOSECODE_ABANDONED
  • CLOSECODE_REPLACED

Definition at line 90 of file commoninvoice.class.php.

const CommonInvoice::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 81 of file commoninvoice.class.php.

const CommonInvoice::TYPE_PROFORMA = 4

Proforma invoice.

Remove this. A "proforma invoice" is an order with a look of invoice, not an invoice !

Definition at line 57 of file commoninvoice.class.php.

Referenced by getLibType().


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