CommonInvoice Class Reference

Superclass for invoice classes. More...

Inheritance diagram for CommonInvoice:

Collaboration diagram for CommonInvoice:

Public Member Functions
	getRemainToPay ($multicurrency=0)
	Return remain amount to pay.
	getSommePaiement ($multicurrency=0)
	Return amount of payments already done.
	getSumDepositsUsed ($multicurrency=0)
	Return amount (with tax) of all deposits invoices used by invoice.
	getSumCreditNotesUsed ($multicurrency=0)
	Return amount (with tax) of all credit notes invoices + excess received used by invoice.
	getSumFromThisCreditNotesNotUsed ($multicurrency=0)
	Return amount (with tax) of all converted amount for this credit note.
	getListIdAvoirFromInvoice ()
	Returns array of credit note ids from the invoice.
	getIdReplacingInvoice ($option='')
	Returns the id of the invoice that replaces it.
	getListOfPayments ($filtertype='', $multicurrency=0, $mode=0)
	Return list of payments.
	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)
	getVentilExportCompta ()
	Return if an invoice was transferred into accountnancy.
	getNextNumRef ($soc, $mode='next')
	Return next reference of invoice not already used (or last reference)
	getLibType ($withbadge=0)
	Return label of type of invoice.
	getSubtypeLabel ($table='')
	Return label of invoice subtype.
	getArrayOfInvoiceSubtypes ($mode=0)
	Retrieve a list of invoice subtype labels or codes.
	getLibStatut ($mode=0, $alreadypaid=-1)
	Return label of object status.
	LibStatut ($paye, $status, $mode=0, $alreadypaid=-1, $type=-1)
	Return label of a status.
	calculate_date_lim_reglement ($cond_reglement=0)
	Returns an invoice payment deadline based on the invoice settlement conditions and billing date.
	demande_prelevement (User $fuser, float $amount=0, string $type='direct-debit', string $sourcetype='facture', int $checkduplicateamongall=0, int $ribId=0)
	Create a withdrawal request for a direct debit order or a credit transfer order.
	makeStripeCardRequest ($fuser, $id, $sourcetype='facture')
	Create a payment with Stripe card Must take amount using Stripe and record an event into llx_actioncomm Record bank payment Send email to customer ?
	makeStripeSepaRequest ($fuser, $did, $type='direct-debit', $sourcetype='facture', $service='', $forcestripe='')
	Create a direct debit order into prelevement_bons for a given prelevement_request, then Send the payment order to the service (for a direct debit order or a credit transfer order) and record an event in llx_actioncomm.
	demande_prelevement_delete ($fuser, $did)
	Remove a direct debit request or a credit transfer request.
	buildEPCQrCodeString ()
	Build string for EPC QR Code.
	buildZATCAQRString ()
	Build string for ZATCA QR Code (Arabi Saudia)
	buildSwitzerlandQRString ()
	Build string for QR-Bill (Switzerland)
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContentArray ($params)
	Return array of data to show into a tooltip.
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchBarCode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	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).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	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.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	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.
	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)
	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).
	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).
	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.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	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.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	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.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	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.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	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.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

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.
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.
const	STATUS_ABANDONED = 3
	Classified abandoned and no payment done.
Public Attributes inherited from CommonObject
	$origin_object

Additional Inherited Members
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
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.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

Superclass for invoice classes.

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

Member Function Documentation

buildEPCQrCodeString()

CommonInvoice::buildEPCQrCodeString

(

)

Build string for EPC QR Code.

Returns

string String for EPC QR Code

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

buildSwitzerlandQRString()

CommonInvoice::buildSwitzerlandQRString

(

)

Build string for QR-Bill (Switzerland)

Returns

string String for Switzerland QR Code if QR-Bill

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

References $conf, dol_print_date(), dol_trunc(), getDolGlobalString(), price(), price2num(), and ref.

buildZATCAQRString()

CommonInvoice::buildZATCAQRString

(

)

Build string for ZATCA QR Code (Arabi Saudia)

Returns

string String for ZATCA QR Code

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

References $conf, dol_print_date(), and price2num().

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

int

$cond_reglement

Condition of payment (code or id) to use. If 0, we use current condition.

Returns

int|string Date limit of payment if OK, <0 or string if KO

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

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

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

demande_prelevement()

CommonInvoice::demande_prelevement	(	User	$fuser,
		float	$amount = 0,
		string	$type = 'direct-debit',
		string	$sourcetype = 'facture',
		int	$checkduplicateamongall = 0,
		int	$ribId = 0 )

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	$fuser	User asking the direct debit transfer
float	$amount	Amount we request direct debit for
string	$type	'direct-debit' or 'bank-transfer'
string	$sourcetype	Source ('facture' or 'supplier_invoice')
int	$checkduplicateamongall	0=Default (check among open requests only to find if request already exists). 1=Check also among requests completely processed and cancel if at least 1 request exists whatever is its status.
int	$ribId	If defined, will use this ID to get the RIB. Otherwise, the default RIB will be taken.

Returns

int Return integer <0 if KO, 0 if a request already exists, >0 if OK

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

References $conf, dol_getIdFromCode(), dol_now(), dol_syslog(), getSommePaiement(), getSumCreditNotesUsed(), getSumDepositsUsed(), price2num(), CommonObject\setPaymentMethods(), and status.

demande_prelevement_delete()

CommonInvoice::demande_prelevement_delete	(		$fuser,
			$did )

Remove a direct debit request or a credit transfer request.

Parameters

User	$fuser	User making delete
int	$did	ID of request to delete

Returns

int Return integer <0 if OK, >0 if KO

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

References dol_syslog().

getArrayOfInvoiceSubtypes()

CommonInvoice::getArrayOfInvoiceSubtypes

(

$mode = 0

)

Retrieve a list of invoice subtype labels or codes.

Parameters

int<0,1>

$mode 0=Return id+label, 1=Return code+id

Returns

array<int,string>|array<string,int> Array of subtypes

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

References dol_syslog(), and getEntity().

getIdReplacingInvoice()

CommonInvoice::getIdReplacingInvoice

(

$option = ''

)

Returns the id of the invoice that replaces it.

Parameters

string

$option

status filter ('', 'validated', ...)

Returns

int Return integer <0 si KO, 0 if no invoice replaces it, id of invoice otherwise

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

getLibStatut()

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

Return label of object status.

Parameters

int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto
integer	$alreadypaid	0=No payment already done, >0=Some payments were already done (we recommend to put here amount paid if you have it, 1 otherwise)

Returns

string Label of status

Reimplemented in FactureFournisseurRec, FactureRec, and WebPortalInvoice.

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

References LibStatut(), status, and type.

getLibType()

CommonInvoice::getLibType

(

$withbadge = 0

)

Return label of type of invoice.

Parameters

int

$withbadge

1=Add span for badge css, 2=Add span and show short label

Returns

string Label of type of invoice

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

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

getListIdAvoirFromInvoice()

CommonInvoice::getListIdAvoirFromInvoice

(

)

Returns array of credit note ids from the invoice.

Returns

int[] Array of credit note ids

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

References dol_print_error().

getListOfPayments()

CommonInvoice::getListOfPayments	(		$filtertype = '',
			$multicurrency = 0,
			$mode = 0 )

Return list of payments.

See also

$error Empty string '' if no error.

Parameters

string	$filtertype	1 to filter on type of payment == 'PRE' for the payment lines
int	$multicurrency	Return multicurrency_amount instead of amount
int	$mode	0=payments + discount, 1=payments only

Returns

array<array{amount:int|float,date:int,num:string,ref:string,ref_ext?:string,fk_bank_line?:int,type:string}> Array with list of payments

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

References dol_print_error(), and dol_syslog().

getNextNumRef()

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

Return next reference of invoice not already used (or last reference)

Parameters

Societe	$soc	Thirdparty object
string	$mode	'next' for next value or 'last' for last value

Returns

string free ref or last ref

Reimplemented in Facture, FactureFournisseur, FactureFournisseurRec, and FactureRec.

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

Referenced by is_erasable().

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

$multicurrency

Return multicurrency_amount instead of amount

Returns

float|string Remain of amount to pay

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

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

getSommePaiement()

CommonInvoice::getSommePaiement

(

$multicurrency = 0

)

Return amount of payments already done.

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

Parameters

int<-1,1>

$multicurrency Return multicurrency_amount instead of amount. -1=Return both.

Returns

float|int|array{alreadypaid:float,alreadypaid_multicurrency:float} Amount of payment already done, <0 and set ->error if KO

See also

getSumDepositsUsed(), getSumCreditNotesUsed()

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

References dol_syslog().

Referenced by demande_prelevement(), getRemainToPay(), Facture\getTooltipContentArray(), Facture\hasDelay(), and is_erasable().

getSubtypeLabel()

CommonInvoice::getSubtypeLabel

(

$table = ''

)

Return label of invoice subtype.

Parameters

string

$table

table of invoice

Returns

string|int Label of invoice subtype or -1 if error

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

References dol_print_error(), and ref.

getSumCreditNotesUsed()

CommonInvoice::getSumCreditNotesUsed

(

$multicurrency = 0

)

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

Parameters

int

$multicurrency

Return multicurrency_amount instead of amount

Returns

float Return integer <0 and set ->error if KO, Sum of credit notes and deposits amount otherwise

See also

getSommePaiement(), getSumDepositsUsed()

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

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

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

$multicurrency

Return multicurrency_amount instead of amount

Returns

float Return integer <0 and set ->error if KO, Sum of deposits amount otherwise

See also

getSommePaiement(), getSumCreditNotesUsed()

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

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

getSumFromThisCreditNotesNotUsed()

CommonInvoice::getSumFromThisCreditNotesNotUsed

(

$multicurrency = 0

)

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

Parameters

int

$multicurrency

Return multicurrency_amount instead of amount

Returns

float Return integer <0 if KO, Sum of credit notes and deposits amount otherwise

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

getVentilExportCompta()

CommonInvoice::getVentilExportCompta

(

)

Return if an invoice was transferred into accountnancy.

This is true if at least on line was transferred into table accounting_bookkeeping

Returns

int Return integer <0 if KO, 0=no, 1=yes

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

Referenced by is_erasable().

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 Return integer <=0 if no, >0 if yes

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

References CommonObject\fetch_thirdparty(), getDolGlobalString(), getNextNumRef(), getSommePaiement(), getVentilExportCompta(), ref, and status.

Referenced by Facture\delete().

LibStatut()

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

Return label of a status.

Parameters

int	$paye	Status field paye
int	$status	Id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=long label + picto
integer	$alreadypaid	0=No payment already done, >0=Some payments were already done (we recommend to put here amount paid if you have it, -1 otherwise)
int	$type	Type invoice. If -1, we use $this->type

Returns

string Label of status

Reimplemented in FactureFournisseurRec, FactureRec, and WebPortalInvoice.

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

References dolGetStatus().

Referenced by getLibStatut().

makeStripeCardRequest()

CommonInvoice::makeStripeCardRequest	(		$fuser,
			$id,
			$sourcetype = 'facture' )

Create a payment with Stripe card Must take amount using Stripe and record an event into llx_actioncomm Record bank payment Send email to customer ?

Parameters

User	$fuser	User asking the direct debit transfer
int	$id	Invoice ID with remain to pay
string	$sourcetype	Source ('facture' or 'supplier_invoice')

Returns

int Return integer <0 if KO, >0 if OK

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

makeStripeSepaRequest()

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

Create a direct debit order into prelevement_bons for a given prelevement_request, then Send the payment order to the service (for a direct debit order or a credit transfer order) and record an event in llx_actioncomm.

Parameters

User	$fuser	User asking the direct debit transfer
int	$did	ID of unitary payment request to pay
string	$type	'direct-debit' or 'bank-transfer'
string	$sourcetype	Source ('facture' or 'supplier_invoice')
string	$service	'StripeTest', 'StripeLive', ...
string	$forcestripe	To force another stripe env: 'cus_account@pk_...:sk_...'

Returns

int Return integer <0 if KO, >0 if OK

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

References $conf, $object, description, dol_now(), dol_print_error(), dol_syslog(), dol_trunc(), CommonObject\fetch_thirdparty(), getDolGlobalInt(), getDolGlobalString(), GETPOST(), ref, and status.

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 267 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 completely, this->close_code will be null

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

TYPE_PROFORMA

const CommonInvoice::TYPE_PROFORMA = 4

Proforma invoice.

Deprecated

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

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

Referenced by getLibType().

---

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

• dolibarr_dev/htdocs/core/class/commoninvoice.class.php