dolibarr  18.0.0
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
BonPrelevement Class Reference

Class to manage withdrawal receipts. More...

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

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 AddFacture ($invoice_id, $client_id, $client_nom, $amount, $code_banque, $code_guichet, $number, $number_key, $type='debit-order')
 Add invoice to withdrawal. More...
 
 addline (&$line_id, $client_id, $client_nom, $amount, $code_banque, $code_guichet, $number, $number_key)
 Add line to withdrawal. More...
 
 getErrorString ($error)
 Return error string. More...
 
 fetch ($rowid, $ref='')
 Get object and lines from database. More...
 
 update (User $user, $notrigger=false)
 Update object into database. More...
 
 set_infocredit ($user, $date)
 Set direct debit or credit transfer order to "paid" status. More...
 
 set_infotrans ($user, $date, $method)
 Set withdrawal to transmited status. More...
 
 SommeAPrelever ($mode='direct-debit')
 Returns amount waiting for direct debit payment or credit transfer payment. More...
 
 nbOfInvoiceToPay ($mode='direct-debit')
 Get number of invoices waiting for payment. More...
 
 NbFactureAPrelever ($type='direct-debit')
 Get number of invoices to pay. More...
 
 create ($banque=0, $agence=0, $mode='real', $format='ALL', $executiondate='', $notrigger=0, $type='direct-debit', $did=0, $fk_bank_account=0)
 Create a BAN payment order: More...
 
 delete ($user=null, $notrigger=0)
 Get object and lines from database. More...
 
 getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
 Returns clickable name (with picto) More...
 
 deleteNotificationById ($rowid)
 Delete a notification def by id. More...
 
 deleteNotification ($user, $action)
 Delete a notification. More...
 
 addNotification ($db, $user, $action)
 Add a notification. More...
 
 generate ($format='ALL', $executiondate=0, $type='direct-debit', $fk_bank_account=0)
 Generate a direct debit or credit transfer file. More...
 
 EnregDestinataire ($rowid, $client_nom, $rib_banque, $rib_guichet, $rib_number, $amount, $ref, $facid, $rib_dom='', $type='direct-debit')
 Write recipient of request (customer) More...
 
 EnregDestinataireSEPA ($row_code_client, $row_nom, $row_address, $row_zip, $row_town, $row_country_code, $row_cb, $row_cg, $row_cc, $row_somme, $row_ref, $row_idfac, $row_iban, $row_bic, $row_datec, $row_drum, $row_rum, $type='direct-debit', $row_comment='')
 Write recipient (thirdparty concerned by request) More...
 
 EnregEmetteur ($type='direct-debit')
 Write sender of request (me). More...
 
 EnregEmetteurSEPA ($configuration, $ladate, $nombre, $total, $CrLf='\n', $format='FRST', $type='direct-debit', $fk_bank_account=0)
 Write sender of request (me). More...
 
 EnregTotal ($total)
 Write end. More...
 
 getLibStatut ($mode=0)
 Return status label of object. More...
 
 LibStatut ($status, $mode=0)
 Return status label for a status. More...
 
 load_board ($user, $mode)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
- Public Member Functions inherited from CommonObject
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContentArray ($params)
 Return array of datas to show into a tooltip. 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=false, $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=false, $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='')
 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, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. 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='', $f_user=null, $notrigger=0)
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0, $entity=0)
 Function to check if an object is used by others (by children). More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='', $selectedLines=array())
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 delThumbs ($file)
 Delete thumbs. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($triggerName, $user)
 Call trigger based on this instance. More...
 
 fetchValuesForExtraLanguages ()
 Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately. More...
 
 setValuesForExtraLanguages ($onlykey='')
 Fill array_options property of object by extrafields value (using for data sent by forms) More...
 
 fetchNoCompute ($id)
 Function to make a fetch but set environment to avoid to load computed values before. More...
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 insertExtraLanguages ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update 1 extra field value for the current object. More...
 
 updateExtraLanguages ($key, $trigger=null, $userused=null)
 Update an extra language value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 clearFieldError ($fieldKey)
 clear validation message result for a field More...
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field More...
 
 getFieldError ($fieldKey)
 get field error message More...
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0, $display_type='card')
 Function to show lines of extrafields with output datas. More...
 
 getJSListDependancies ($type='_extra')
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 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...
 
 getFieldList ($alias='')
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=false)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a 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 buildRumNumber ($row_code_client, $row_datec, $row_drum)
 Generate dynamically a RUM number for a customer bank account. 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 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 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...
 

Private Member Functions

 getListInvoices ($amounts=0)
 Get invoice list. More...
 

Additional Inherited Members

- Public Attributes inherited from CommonObject
 $fk_projet
 
 $note
 
 $date_modification
 
- 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...
 
 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 prepare a part of the query for insert by returning an array with all properties of object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage withdrawal receipts.

Definition at line 43 of file bonprelevement.class.php.

Constructor & Destructor Documentation

◆ __construct()

BonPrelevement::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 179 of file bonprelevement.class.php.

Member Function Documentation

◆ AddFacture()

BonPrelevement::AddFacture (   $invoice_id,
  $client_id,
  $client_nom,
  $amount,
  $code_banque,
  $code_guichet,
  $number,
  $number_key,
  $type = 'debit-order' 
)

Add invoice to withdrawal.

Parameters
int$invoice_idid invoice to add
int$client_idid invoice customer
string$client_nomcustomer name
int$amountamount of invoice
string$code_banquecode of bank withdrawal
string$code_guichetcode of bank's office
string$numberbank account number
string$number_keynumber key of account number
string$type'debit-order' or 'bank-transfer'
Returns
int >0 if OK, <0 if KO

Definition at line 223 of file bonprelevement.class.php.

◆ addline()

BonPrelevement::addline ( $line_id,
  $client_id,
  $client_nom,
  $amount,
  $code_banque,
  $code_guichet,
  $number,
  $number_key 
)

Add line to withdrawal.

Parameters
int$line_idid line to add
int$client_idid invoice customer
string$client_nomcustomer name
int$amountamount of invoice
string$code_banquecode of bank withdrawal
string$code_guichetcode of bank's office
string$numberbank account number
string$number_keynumber key of account number
Returns
int >0 if OK, <0 if KO

Definition at line 279 of file bonprelevement.class.php.

◆ addNotification()

BonPrelevement::addNotification (   $db,
  $user,
  $action 
)

Add a notification.

Parameters
DoliDB$dbdatabase handler
int | User$usernotification user
string$actionnotification action
Returns
int 0 if OK, <0 if KO

Definition at line 1450 of file bonprelevement.class.php.

◆ buildRumNumber()

static BonPrelevement::buildRumNumber (   $row_code_client,
  $row_datec,
  $row_drum 
)
static

Generate dynamically a RUM number for a customer bank account.

Parameters
string$row_code_clientCustomer code (soc.code_client)
int$row_datecCreation date of bank account (rib.datec)
string$row_drumId of customer bank account (rib.rowid)
Returns
string RUM number

Definition at line 1837 of file bonprelevement.class.php.

◆ create()

BonPrelevement::create (   $banque = 0,
  $agence = 0,
  $mode = 'real',
  $format = 'ALL',
  $executiondate = '',
  $notrigger = 0,
  $type = 'direct-debit',
  $did = 0,
  $fk_bank_account = 0 
)

Create a BAN payment order:

  • Select waiting requests from prelevement_demande (or use $did if provided)
  • Check BAN values
  • Then create a direct debit order or a credit transfer order
  • Link the order with the prelevement_demande lines TODO delete params banque and agence when not necessary
Parameters
int$banquedolibarr mysoc bank
int$agencedolibarr mysoc bank office (guichet)
string$modereal=do action, simu=test only
string$formatFRST, RCUR or ALL
string$executiondateDate to execute the transfer
int$notriggerDisable triggers
string$type'direct-debit' or 'bank-transfer'
int$didID of an existing payment request. If $did is defined, no entry
int$fk_bank_accountBank account ID the receipt is generated for. Will use the ID into the setup of module Direct Debit or Credit Transfer if 0.
Returns
int <0 if KO, No of invoice included into file if OK

Definition at line 847 of file bonprelevement.class.php.

◆ delete()

BonPrelevement::delete (   $user = null,
  $notrigger = 0 
)

Get object and lines from database.

Parameters
User$userObject user that delete
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int >0 if OK, <0 if KO

Definition at line 1243 of file bonprelevement.class.php.

◆ deleteNotification()

BonPrelevement::deleteNotification (   $user,
  $action 
)

Delete a notification.

Parameters
int | User$usernotification user
string$actionnotification action
Returns
int >0 if OK, <0 if KO

Definition at line 1423 of file bonprelevement.class.php.

◆ deleteNotificationById()

BonPrelevement::deleteNotificationById (   $rowid)

Delete a notification def by id.

Parameters
int$rowidid of notification
Returns
int 0 if OK, <0 if KO

Definition at line 1404 of file bonprelevement.class.php.

References $sql.

◆ EnregDestinataire()

BonPrelevement::EnregDestinataire (   $rowid,
  $client_nom,
  $rib_banque,
  $rib_guichet,
  $rib_number,
  $amount,
  $ref,
  $facid,
  $rib_dom = '',
  $type = 'direct-debit' 
)

Write recipient of request (customer)

Parameters
int$rowidid of line
string$client_nomname of customer
string$rib_banquecode of bank
string$rib_guichetcode of bank office
string$rib_numberbank account
float$amountamount
string$refref of invoice
int$facidid of invoice
string$rib_domrib domiciliation
string$type'direct-debit' or 'bank-transfer'
Returns
void
See also
EnregDestinataireSEPA()

Definition at line 1865 of file bonprelevement.class.php.

◆ EnregDestinataireSEPA()

BonPrelevement::EnregDestinataireSEPA (   $row_code_client,
  $row_nom,
  $row_address,
  $row_zip,
  $row_town,
  $row_country_code,
  $row_cb,
  $row_cg,
  $row_cc,
  $row_somme,
  $row_ref,
  $row_idfac,
  $row_iban,
  $row_bic,
  $row_datec,
  $row_drum,
  $row_rum,
  $type = 'direct-debit',
  $row_comment = '' 
)

Write recipient (thirdparty concerned by request)

Parameters
string$row_code_clientsoc.code_client as code,
string$row_nompl.client_nom AS name,
string$row_addresssoc.address AS adr,
string$row_zipsoc.zip
string$row_townsoc.town
string$row_country_codec.code AS country,
string$row_cbpl.code_banque AS cb, Not used for SEPA
string$row_cgpl.code_guichet AS cg, Not used for SEPA
string$row_ccpl.number AS cc, Not used for SEPA
string$row_sommepl.amount AS somme,
string$row_refInvoice ref (f.ref)
string$row_idfacpf.fk_facture AS idfac,
string$row_ibanrib.iban_prefix AS iban,
string$row_bicrib.bic AS bic,
string$row_datecrib.datec,
string$row_drumrib.rowid used to generate rum
string$row_rumrib.rum Rum defined on company bank account
string$type'direct-debit' or 'bank-transfer'
string$row_commentA free text string for the Unstructured data field
Returns
string Return string with SEPA part DrctDbtTxInf
See also
EnregDestinataire()

Definition at line 1948 of file bonprelevement.class.php.

◆ EnregEmetteur()

BonPrelevement::EnregEmetteur (   $type = 'direct-debit')

Write sender of request (me).

Parameters
string$type'direct-debit' or 'bank-transfer'
Returns
void
See also
EnregEmetteurSEPA()

Definition at line 2092 of file bonprelevement.class.php.

References dol_print_date().

◆ EnregEmetteurSEPA()

BonPrelevement::EnregEmetteurSEPA (   $configuration,
  $ladate,
  $nombre,
  $total,
  $CrLf = '\n',
  $format = 'FRST',
  $type = 'direct-debit',
  $fk_bank_account = 0 
)

Write sender of request (me).

Note: The tag PmtInf is opened here but closed into caller

Parameters
Conf$configurationconf
int$ladateDate
int$nombre0 or 1
float$totalTotal
string$CrLfEnd of line character
string$formatFRST or RCUR or ALL
string$type'direct-debit' or 'bank-transfer'
int$fk_bank_accountBank account ID the receipt is generated for. Will use the ID into the setup of module Direct Debit or Credit Transfer if 0.
Returns
string String with SEPA Sender
See also
EnregEmetteur()

Definition at line 2169 of file bonprelevement.class.php.

◆ EnregTotal()

BonPrelevement::EnregTotal (   $total)

Write end.

Parameters
int$totaltotal amount
Returns
void

Definition at line 2358 of file bonprelevement.class.php.

◆ fetch()

BonPrelevement::fetch (   $rowid,
  $ref = '' 
)

Get object and lines from database.

Parameters
int$rowidId of object to load
string$refRef of direct debit
Returns
int >0 if OK, <0 if KO

Definition at line 363 of file bonprelevement.class.php.

References $sql, and dol_syslog().

◆ generate()

BonPrelevement::generate (   $format = 'ALL',
  $executiondate = 0,
  $type = 'direct-debit',
  $fk_bank_account = 0 
)

Generate a direct debit or credit transfer file.

Generation Formats:

  • Europe: SEPA (France: CFONB no more supported, Spain: AEB19 if external module EsAEB is enabled)
  • Others countries: Warning message File is generated with name this->filename
Parameters
string$formatFRST, RCUR or ALL
int$executiondateTimestamp date to execute transfer
string$type'direct-debit' or 'bank-transfer'
int$fk_bank_accountBank account ID the receipt is generated for. Will use the ID into the setup of module Direct Debit or Credit Transfer if 0.
Returns
int >=0 if OK, <0 if KO

SECTION CREATION FICHIER SEPA - DIRECT DEBIT

SECTION CREATION SEPA FILE - ISO200022

SECTION CREATION FICHIER SEPA - CREDIT TRANSFER

SECTION CREATION SEPA FILE - CREDIT TRANSFER - ISO200022

Definition at line 1493 of file bonprelevement.class.php.

◆ getErrorString()

BonPrelevement::getErrorString (   $error)

Return error string.

Parameters
int$errorId of error
Returns
string Error string

Definition at line 345 of file bonprelevement.class.php.

◆ getKanbanView()

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

Return clicable link of object (with eventually picto)

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

Definition at line 2544 of file bonprelevement.class.php.

◆ getLibStatut()

BonPrelevement::getLibStatut (   $mode = 0)

Return status label of object.

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
Returns
string Label

Definition at line 2420 of file bonprelevement.class.php.

◆ getListInvoices()

BonPrelevement::getListInvoices (   $amounts = 0)
private

Get invoice list.

Parameters
int$amountsIf you want to get the amount of the order for each invoice
Returns
array Id of invoices

Definition at line 659 of file bonprelevement.class.php.

◆ getNomUrl()

BonPrelevement::getNomUrl (   $withpicto = 0,
  $option = '',
  $notooltip = 0,
  $morecss = '',
  $save_lastsearch_value = -1 
)

Returns clickable name (with picto)

Parameters
int$withpictoInclude picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string$optionOn what the link point to ('nolink', ...)
int$notooltip1=Disable tooltip
string$morecssAdd more css on link
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
Returns
string URL of target

Definition at line 1315 of file bonprelevement.class.php.

◆ LibStatut()

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

Return status label for a status.

Parameters
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
Returns
string Label

Definition at line 2433 of file bonprelevement.class.php.

◆ load_board()

BonPrelevement::load_board (   $user,
  $mode 
)

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

Parameters
User$userObjet user
string$modeMode 'direct_debit' or 'credit_transfer'
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

Definition at line 2471 of file bonprelevement.class.php.

◆ NbFactureAPrelever()

BonPrelevement::NbFactureAPrelever (   $type = 'direct-debit')

Get number of invoices to pay.

Parameters
string$type'direct-debit' or 'bank-transfer'
Returns
int <O if KO, number of invoices if OK

Definition at line 786 of file bonprelevement.class.php.

◆ nbOfInvoiceToPay()

BonPrelevement::nbOfInvoiceToPay (   $mode = 'direct-debit')

Get number of invoices waiting for payment.

Parameters
string$mode'direct-debit' or 'bank-transfer'
Returns
int <O if KO, number of invoices if OK

Definition at line 774 of file bonprelevement.class.php.

◆ set_infocredit()

BonPrelevement::set_infocredit (   $user,
  $date 
)

Set direct debit or credit transfer order to "paid" status.

Then create the payment for each invoice of the prelemevement_bon.

Parameters
User$userId of user
int$datedate of action
Returns
int >0 if OK, <0 if KO

Definition at line 440 of file bonprelevement.class.php.

◆ set_infotrans()

BonPrelevement::set_infotrans (   $user,
  $date,
  $method 
)

Set withdrawal to transmited status.

Parameters
User$userid of user
int$datedate of action
string$methodmethod of transmision to bank (0=Internet, 1=Api...)
Returns
int >0 if OK, <0 if KO

Definition at line 604 of file bonprelevement.class.php.

◆ SommeAPrelever()

BonPrelevement::SommeAPrelever (   $mode = 'direct-debit')

Returns amount waiting for direct debit payment or credit transfer payment.

Parameters
string$mode'direct-debit' or 'bank-transfer'
Returns
double <O if KO, Total amount

Definition at line 726 of file bonprelevement.class.php.

◆ update()

BonPrelevement::update ( User  $user,
  $notrigger = false 
)

Update object into database.

Parameters
User$userUser that modifies
bool$notriggerfalse=launch triggers after, true=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 426 of file bonprelevement.class.php.

References CommonObject\updateCommon().


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