dolibarr  17.0.4
Public Member Functions | Public Attributes | List of all members
CommonInvoice Class Reference

Superclass for invoices classes. More...

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

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 invoices + excess received used by invoice. More...
 
 getSumFromThisCreditNotesNotUsed ($multicurrency=0)
 Return amount (with tax) of all converted amount for this credit note. More...
 
 getListIdAvoirFromInvoice ()
 Returns array of credit note ids from the invoice. More...
 
 getIdReplacingInvoice ($option='')
 Returns the id of the invoice that replaces it. More...
 
 getListOfPayments ($filtertype='')
 Return list of payments. More...
 
 is_erasable ()
 Return if an invoice can be deleted Rule is: If invoice is draft and has a temporary ref -> yes (1) If hidden option INVOICE_CAN_NEVER_BE_REMOVED is on -> no (0) If invoice is dispatched in bookkeeping -> no (-1) If invoice has a definitive ref, is not last and INVOICE_CAN_ALWAYS_BE_REMOVED off -> no (-2) If invoice not last in a cycle -> no (-3) If there is payment -> no (-4) Otherwise -> yes (2) More...
 
 getVentilExportCompta ()
 Return if an invoice was dispatched into bookkeeping. More...
 
 getLibType ($withbadge=0)
 Return label of type of invoice. More...
 
 getLibStatut ($mode=0, $alreadypaid=-1)
 Return label of object status. More...
 
 LibStatut ($paye, $status, $mode=0, $alreadypaid=-1, $type=-1)
 Return label of a status. More...
 
 calculate_date_lim_reglement ($cond_reglement=0)
 Returns an invoice payment deadline based on the invoice settlement conditions and billing date. More...
 
 demande_prelevement ($fuser, $amount=0, $type='direct-debit', $sourcetype='facture')
 Create a withdrawal request for a direct debit order or a credit transfer order. More...
 
 makeStripeSepaRequest ($fuser, $did=0, $type='direct-debit', $sourcetype='facture')
 Create a withdrawal request for a direct debit order or a credit transfer order. More...
 
 demande_prelevement_delete ($fuser, $did)
 Remove a direct debit request or a credit transfer request. More...
 
 buildZATCAQRString ()
 Build string for ZATCA QR Code (Arabi Saudia) More...
 
 buildSwitzerlandQRString ()
 Build string for QR-Bill (Switzerland) More...
 
- Public Member Functions inherited from CommonObject
 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...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 setUpperOrLowerCase ()
 Set to upper or ucwords/lower if needed. More...
 
 getKanbanView ($option='')
 Return clicable link of object (with eventually picto) More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. 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...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. 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. 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...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 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 ($val, $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, $notitle=0, $usesharelink=0)
 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...
 

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 status.
 
const STATUS_VALIDATED = 1
 Validated (need to be paid)
 
const STATUS_CLOSED = 2
 Classified paid. More...
 
const STATUS_ABANDONED = 3
 Classified abandoned and no payment done. More...
 
- Public Attributes inherited from CommonObject
 $projet
 
 $fk_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 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 $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product 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...
 
 canBeNull ($info)
 Function test if field can be null. More...
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to return the array of data key-value from the ->fields and all the ->properties of an object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Superclass for invoices classes.

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

Member Function Documentation

◆ buildSwitzerlandQRString()

CommonInvoice::buildSwitzerlandQRString ( )

Build string for QR-Bill (Switzerland)

Returns
string String for Switzerland QR Code if QR-Bill

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

◆ buildZATCAQRString()

CommonInvoice::buildZATCAQRString ( )

Build string for ZATCA QR Code (Arabi Saudia)

Returns
string String for ZATCA QR Code

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

◆ calculate_date_lim_reglement()

CommonInvoice::calculate_date_lim_reglement (   $cond_reglement = 0)

Returns an invoice payment deadline based on the invoice settlement conditions and billing date.

Parameters
integer$cond_reglementCondition of payment (code or id) to use. If 0, we use current condition.
Returns
integer Date limit of payment if OK, <0 if KO

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

◆ demande_prelevement()

CommonInvoice::demande_prelevement (   $fuser,
  $amount = 0,
  $type = 'direct-debit',
  $sourcetype = 'facture' 
)

Create a withdrawal request for a direct debit order or a credit transfer order.

Use the remain to pay excluding all existing open direct debit requests.

Parameters
User$fuserUser asking the direct debit transfer
float$amountAmount we request direct debit for
string$type'direct-debit' or 'bank-transfer'
string$sourcetypeSource ('facture' or 'supplier_invoice')
Returns
int <0 if KO, >0 if OK

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

◆ demande_prelevement_delete()

CommonInvoice::demande_prelevement_delete (   $fuser,
  $did 
)

Remove a direct debit request or a credit transfer request.

Parameters
User$fuserUser making delete
int$didID of request to delete
Returns
int <0 if OK, >0 if KO

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

◆ getIdReplacingInvoice()

CommonInvoice::getIdReplacingInvoice (   $option = '')

Returns the id of the invoice that replaces it.

Parameters
string$optionstatus filter ('', 'validated', ...)
Returns
int <0 si KO, 0 if no invoice replaces it, id of invoice otherwise

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

◆ getLibStatut()

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

Reimplemented in FactureFournisseurRec, and FactureRec.

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

◆ getLibType()

CommonInvoice::getLibType (   $withbadge = 0)

Return label of type of invoice.

Parameters
int$withbadge1=Add span for badge css, 2=Add span and show short label
Returns
string Label of type of invoice

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

◆ getListIdAvoirFromInvoice()

CommonInvoice::getListIdAvoirFromInvoice ( )

Returns array of credit note ids from the invoice.

Returns
array Array of credit note ids

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

◆ getListOfPayments()

CommonInvoice::getListOfPayments (   $filtertype = '')

Return list of payments.

Parameters
string$filtertype1 to filter on type of payment == 'PRE'
Returns
array Array with list of payments

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

◆ getRemainToPay()

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
float Remain of amount to pay

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

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

◆ getSommePaiement()

CommonInvoice::getSommePaiement (   $multicurrency = 0)

Return amount of payments already done.

This must include ONLY the record into the payment table. Payments dones using discounts, credit notes, etc are not included.

Parameters
int$multicurrencyReturn multicurrency_amount instead of amount. -1=Return both.
Returns
float|int|array Amount of payment already done, <0 and set ->error if KO

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

Referenced by getRemainToPay().

◆ getSumCreditNotesUsed()

CommonInvoice::getSumCreditNotesUsed (   $multicurrency = 0)

Return amount (with tax) of all credit notes invoices + excess received used by invoice.

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

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

Referenced by getRemainToPay().

◆ getSumDepositsUsed()

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 for sale invoices (not recommended), of FACTURE_SUPPLIER_DEPOSITS_ARE_JUST_PAYMENTS is on for purchase invoices (not recommended).

Parameters
int$multicurrencyReturn multicurrency_amount instead of amount
Returns
float <0 and set ->error if KO, Sum of deposits amount otherwise

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

Referenced by getRemainToPay().

◆ getSumFromThisCreditNotesNotUsed()

CommonInvoice::getSumFromThisCreditNotesNotUsed (   $multicurrency = 0)

Return amount (with tax) of all converted amount for this credit note.

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

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

◆ getVentilExportCompta()

CommonInvoice::getVentilExportCompta ( )

Return if an invoice was dispatched into bookkeeping.

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

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

◆ is_erasable()

CommonInvoice::is_erasable ( )

Return if an invoice can be deleted Rule is: If invoice is draft and has a temporary ref -> yes (1) If hidden option INVOICE_CAN_NEVER_BE_REMOVED is on -> no (0) If invoice is dispatched in bookkeeping -> no (-1) If invoice has a definitive ref, is not last and INVOICE_CAN_ALWAYS_BE_REMOVED off -> no (-2) If invoice not last in a cycle -> no (-3) If there is payment -> no (-4) Otherwise -> yes (2)

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

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

◆ LibStatut()

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

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. If -1, we use $this->type
Returns
string Label of status

Reimplemented in FactureFournisseurRec, and FactureRec.

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

◆ makeStripeSepaRequest()

CommonInvoice::makeStripeSepaRequest (   $fuser,
  $did = 0,
  $type = 'direct-debit',
  $sourcetype = 'facture' 
)

Create a withdrawal request for a direct debit order or a credit transfer order.

Use the remain to pay excluding all existing open direct debit requests.

Parameters
User$fuserUser asking the direct debit transfer
int$didID of payment request
string$type'direct-debit' or 'bank-transfer'
string$sourcetypeSource ('facture' or 'supplier_invoice')
Returns
int <0 if KO, >0 if OK

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

Member Data Documentation

◆ STATUS_ABANDONED

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 93 of file commoninvoice.class.php.

◆ STATUS_CLOSED

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 84 of file commoninvoice.class.php.

◆ TYPE_PROFORMA

const CommonInvoice::TYPE_PROFORMA = 4

Proforma invoice.

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

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


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