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

Class to manage payments of customer invoices. More...

+ Inheritance diagram for Paiement:
+ Collaboration diagram for Paiement:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 fetch ($id, $ref='', $fk_bank='')
 Load payment from database. More...
 
 create ($user, $closepaidinvoices=0)
 Create payment of invoices into database. More...
 
 delete ($notrigger=0)
 Delete a payment and generated links into account. More...
 
 addPaymentToBank ($user, $mode, $label, $accountid, $emetteur_nom, $emetteur_banque, $notrigger=0)
 Add a record into bank for payment + links between this bank record and sources of payment. More...
 
 update_fk_bank ($id_bank)
 Mise a jour du lien entre le paiement et la ligne generee dans llx_bank. More...
 
 update_date ($date)
 Updates the payment date. More...
 
 update_num ($num)
 Updates the payment number. More...
 
 valide ()
 Validate payment. More...
 
 reject ()
 Reject payment. More...
 
 info ($id)
 Information sur l'objet. More...
 
 getBillsArray ($filter='')
 Retourne la liste des factures sur lesquels porte le paiement. More...
 
 getNextNumRef ($soc, $mode='next')
 Return next reference of customer invoice not already used (or last reference) according to numbering module defined into constant FACTURE_ADDON. More...
 
 getWay ()
 get the right way of payment More...
 
 initAsSpecimen ($option='')
 Initialise an instance with random values. More...
 
 getNomUrl ($withpicto=0, $option='', $mode='withlistofinvoices')
 Return clicable name (with picto eventually) More...
 
 getLibStatut ($mode=0)
 Retourne le libelle du statut d'une facture (brouillon, validee, abandonnee, payee) More...
 
 LibStatut ($status, $mode=0)
 Renvoi le libelle d'un statut donne. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id into this->thirdparty. 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

 $total
 
 $montant
 
- 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

Class to manage payments of customer invoices.

Definition at line 36 of file paiement.class.php.

Constructor & Destructor Documentation

Paiement::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 74 of file paiement.class.php.

Member Function Documentation

Paiement::addPaymentToBank (   $user,
  $mode,
  $label,
  $accountid,
  $emetteur_nom,
  $emetteur_banque,
  $notrigger = 0 
)

Add a record into bank for payment + links between this bank record and sources of payment.

All payment properties (this->amount, this->amounts, ...) must have been set first like after a call to create().

Parameters
User$userObject of user making payment
string$mode'payment', 'payment_supplier'
string$labelLabel to use in bank record. Note: If label is '(WithdrawalPayment)', a third entry 'widthdraw' is added into bank_url.
int$accountidId of bank account to do link with
string$emetteur_nomName of transmitter
string$emetteur_banqueName of bank
int$notriggerNo trigger
Returns
int <0 if KO, bank_line_id if OK

Definition at line 522 of file paiement.class.php.

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

Paiement::create (   $user,
  $closepaidinvoices = 0 
)

Create payment of invoices into database.

Use this->amounts to have list of invoices for the payment. For payment of a customer invoice, amounts are postive, for payment of credit note, amounts are negative

Parameters
User$userObject user
int$closepaidinvoices1=Also close payed invoices to paid, 0=Do nothing more
Returns
int id of created payment, < 0 if error

Definition at line 150 of file paiement.class.php.

References $resql, $total, dol_now(), dol_syslog(), getNextNumRef(), getWay(), price2num(), and type.

Paiement::delete (   $notrigger = 0)

Delete a payment and generated links into account.

  • Si le paiement porte sur un ecriture compte qui est rapprochee, on refuse
  • Si le paiement porte sur au moins une facture a "payee", on refuse
Parameters
int$notriggerNo trigger
Returns
int <0 si ko, >0 si ok

Definition at line 412 of file paiement.class.php.

Paiement::fetch (   $id,
  $ref = '',
  $fk_bank = '' 
)

Load payment from database.

Parameters
int$idId of payment to get
string$refRef of payment to get (currently ref = id but this may change in future)
int$fk_bankId of bank line associated to payment
Returns
int <0 if KO, 0 if not found, >0 if OK

Definition at line 87 of file paiement.class.php.

References $resql, dol_print_error(), and getEntity().

Paiement::fetch_thirdparty (   $force_thirdparty_id = 0)

Load the third party of object, from id into this->thirdparty.

Parameters
int$force_thirdparty_idForce thirdparty id
Returns
int <0 if KO, >0 if OK

Definition at line 1143 of file paiement.class.php.

References getBillsArray().

Paiement::getBillsArray (   $filter = '')

Retourne la liste des factures sur lesquels porte le paiement.

Parameters
string$filterCritere de filtre
Returns
array Tableau des id de factures

Definition at line 873 of file paiement.class.php.

References $resql, and dol_syslog().

Referenced by fetch_thirdparty(), and getNomUrl().

Paiement::getLibStatut (   $mode = 0)

Retourne le libelle du statut d'une facture (brouillon, validee, abandonnee, payee)

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Libelle

Definition at line 1082 of file paiement.class.php.

References LibStatut().

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

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

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

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

Definition at line 911 of file paiement.class.php.

References dol_buildpath(), dol_print_error(), and print.

Referenced by create().

Paiement::getNomUrl (   $withpicto = 0,
  $option = '',
  $mode = 'withlistofinvoices' 
)

Return clicable name (with picto eventually)

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Only picto
string$optionSur quoi pointe le lien
string$mode'withlistofinvoices'=Include list of invoices into tooltip
Returns
string Chaine avec URL

Definition at line 1047 of file paiement.class.php.

References dol_escape_htmltag(), and getBillsArray().

Paiement::getWay ( )

get the right way of payment

Returns
string 'dolibarr' if standard comportment or paid in dolibarr currency, 'customer' if payment received from multicurrency inputs

Definition at line 994 of file paiement.class.php.

Referenced by create().

Paiement::info (   $id)

Information sur l'objet.

Parameters
int$idid du paiement dont il faut afficher les infos
Returns
void

Definition at line 829 of file paiement.class.php.

References dol_print_error(), and dol_syslog().

Paiement::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 1022 of file paiement.class.php.

References dol_getdate(), dol_mktime(), and dol_now().

Paiement::LibStatut (   $status,
  $mode = 0 
)

Renvoi le libelle d'un statut donne.

Parameters
int$statusStatut
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Libelle du statut

Definition at line 1094 of file paiement.class.php.

Referenced by getLibStatut().

Paiement::reject ( )

Reject payment.

Returns
int <0 if KO, >0 if OK

Definition at line 805 of file paiement.class.php.

References dol_syslog().

Paiement::update_date (   $date)

Updates the payment date.

Parameters
int$dateNew date
Returns
int <0 if KO, 0 if OK

Definition at line 722 of file paiement.class.php.

References dol_syslog().

Paiement::update_fk_bank (   $id_bank)

Mise a jour du lien entre le paiement et la ligne generee dans llx_bank.

Parameters
int$id_bankId compte bancaire
Returns
int <0 if KO, >0 if OK

Definition at line 697 of file paiement.class.php.

References dol_syslog().

Referenced by addPaymentToBank().

Paiement::update_num (   $num)

Updates the payment number.

Parameters
string$numNew num
Returns
int <0 if KO, 0 if OK

Definition at line 753 of file paiement.class.php.

References dol_syslog().

Paiement::valide ( )

Validate payment.

Returns
int <0 if KO, >0 if OK

Definition at line 782 of file paiement.class.php.

References dol_syslog().

Member Data Documentation

Paiement::$montant
Deprecated:
See also
amount, amounts

Definition at line 53 of file paiement.class.php.

Paiement::$total
Deprecated:
See also
amount, amounts

Definition at line 48 of file paiement.class.php.

Referenced by addPaymentToBank(), PaiementFourn\create(), and create().


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