FactureFournisseur Class Reference

Class to manage suppliers invoices. More...

Inheritance diagram for FactureFournisseur:

Collaboration diagram for FactureFournisseur:

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user)
	Create supplier invoice into database.
	fetch ($id=0, $ref='', $ref_ext='')
	Load object in memory from database.
	fetch_lines ()
	Load this->lines.
	update ($user=null, $notrigger=0)
	Update database.
	insert_discount ($idremise)
	Add a discount line into an invoice (as an invoice line) using an existing absolute discount (Consume the discount)
	delete (User $user, $notrigger=0)
	Delete invoice from database.
	set_paid ($user, $close_code='', $close_note='')
	Tag invoice as a paid invoice.
	setPaid ($user, $close_code='', $close_note='')
	Tag invoice as a paid invoice.
	set_unpaid ($user)
	Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened.
	setUnpaid ($user)
	Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened.
	setCanceled ($user, $close_code='', $close_note='')
	Tag invoice as canceled, with no payment on it (example for replacement invoice or payment never received) + call trigger BILL_CANCEL Warning, if option to decrease stock on invoice was set, this function does not change stock (it might be a cancel because of no payment even if merchandises were sent).
	validate ($user, $force_number='', $idwarehouse=0, $notrigger=0)
	Tag invoice as validated + call trigger BILL_VALIDATE.
	setDraft ($user, $idwarehouse=-1, $notrigger=0)
	Set draft status.
	addline ($desc, $pu, $txtva, $txlocaltax1, $txlocaltax2, $qty, $fk_product=0, $remise_percent=0, $date_start=0, $date_end=0, $fk_code_ventilation=0, $info_bits=0, $price_base_type='HT', $type=0, $rang=-1, $notrigger=0, $array_options=[], $fk_unit=null, $origin_id=0, $pu_devise=0, $ref_supplier='', $special_code=0, $fk_parent_line=0, $fk_remise_except=0)
	Adds an invoice line (associated with no predefined product/service) The parameters are already supposed to be correct and with final values when calling this method.
	updateline ($id, $desc, $pu, $vatrate, $txlocaltax1=0, $txlocaltax2=0, $qty=1, $idproduct=0, $price_base_type='HT', $info_bits=0, $type=0, $remise_percent=0, $notrigger=0, $date_start='', $date_end='', $array_options=[], $fk_unit=null, $pu_devise=0, $ref_supplier='', $rang=0)
	Update a line detail in the database.
	deleteLine ($rowid, $notrigger=0)
	Delete a detail line from database.
	info ($id)
	Loads the info order information into the invoice object.
	list_replacable_supplier_invoices ($socid=0)
	Return list of replaceable invoices Status valid or abandoned for other reason + not paid + no payment + not already replaced.
	list_qualified_avoir_supplier_invoices ($socid=0)
	Return list of qualifying invoices for correction by credit note Invoices that respect the following rules are returned: (validated + payment in progress) or classified (paid in full or paid in part) + not already replaced + not already having.
	load_board ($user)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $save_lastsearch_value=-1, $addlinktonotes=0)
	Return clickable name (with picto eventually)
	getNextNumRef ($soc, $mode='next')
	Return next reference of supplier invoice not already used (or last reference) according to numbering module defined into constant INVOICE_SUPPLIER_ADDON_NUMBER.
	initAsSpecimen ($option='')
	Initialise an instance with random values.
	loadStateBoard ()
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	createFromClone (User $user, $fromid, $invertdetail=0)
	Load an object from its id and create a new one in database.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template model.
	getRights ()
	Returns the rights used for this class.
	hasDelay ()
	Is the payment of the supplier invoice having a delay?
	isCreditNoteUsed ()
	Is credit note used.
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
	setVATReverseCharge ($vatreversecharge)
	Change the option VAT reverse charge.
	sendEmailsRemindersOnSupplierInvoiceDueDate ($nbdays=0, $paymentmode='all', $template='', $datetouse='duedate', $forcerecipient='')
	Send reminders by emails for supplier invoices validated that are due.
Public Member Functions inherited from CommonInvoice
	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.
	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
	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.
	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')
	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.

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
static	replaceProduct (DoliDB $db, $origin_id, $dest_id)
	Function used to replace a product id with another one.
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.

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	STATUS_DRAFT = 0
	Draft.
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 CommonInvoice
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

Protected Attributes
	$table_ref_field = 'ref'
	{}

Additional Inherited Members
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

Class to manage suppliers invoices.

Definition at line 53 of file fournisseur.facture.class.php.

Constructor & Destructor Documentation

__construct()

FactureFournisseur::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 384 of file fournisseur.facture.class.php.

Member Function Documentation

addline()

FactureFournisseur::addline	(		$desc,
			$pu,
			$txtva,
			$txlocaltax1,
			$txlocaltax2,
			$qty,
			$fk_product = 0,
			$remise_percent = 0,
			$date_start = 0,
			$date_end = 0,
			$fk_code_ventilation = 0,
			$info_bits = 0,
			$price_base_type = 'HT',
			$type = 0,
			$rang = -1,
			$notrigger = 0,
			$array_options = [],
			$fk_unit = null,
			$origin_id = 0,
			$pu_devise = 0,
			$ref_supplier = '',
			$special_code = 0,
			$fk_parent_line = 0,
			$fk_remise_except = 0 )

Adds an invoice line (associated with no predefined product/service) The parameters are already supposed to be correct and with final values when calling this method.

Also, for the VAT rate, it must already have been defined by the caller by by the get_default_tva method(vendor_company, buying company, idprod) and the desc must already have the right value (the caller has to manage the multilanguage).

Parameters

string	$desc	Description of the line
float	$pu	Unit price (HT or TTC according to price_base_type, > 0 even for credit note)
float	$txtva	Force Vat rate to use, -1 for auto.
float	$txlocaltax1	LocalTax1 Rate
float	$txlocaltax2	LocalTax2 Rate
float	$qty	Quantity
int	$fk_product	Product/Service ID predefined
float	$remise_percent	Percentage discount of the line
int	$date_start	Service start date
int	$date_end	Service expiry date
int	$fk_code_ventilation	Accounting breakdown code
int	$info_bits	Line type bits
string	$price_base_type	HT or TTC
int	$type	Type of line (0=product, 1=service)
int	$rang	Position of line
int	$notrigger	Disable triggers
	array<string,mixed>	$array_options extrafields array
int | null	$fk_unit	Code of the unit to use. Null to use the default one
int	$origin_id	id origin document
float	$pu_devise	Amount in currency
string	$ref_supplier	Supplier ref
int	$special_code	Special code
int	$fk_parent_line	Parent line id
int	$fk_remise_except	Id discount used

Returns

int >0 if OK, <0 if KO

Definition at line 2091 of file fournisseur.facture.class.php.

References calcul_price_total(), dol_syslog(), getDolGlobalString(), getLocalTaxesFromRate(), CommonObject\line_max(), CommonObject\line_order(), price2num(), status, type, CommonObject\update_price(), and CommonObject\updateRangOfLine().

Referenced by create().

create()

FactureFournisseur::create

(

$user

)

Create supplier invoice into database.

Parameters

User

$user

user object that creates

Returns

int Id invoice created if OK, < 0 if KO

Definition at line 397 of file fournisseur.facture.class.php.

References CommonObject\add_object_linked(), addline(), CommonInvoice\calculate_date_lim_reglement(), CommonObject\call_trigger(), complete_substitutions_array(), dol_concatdesc(), dol_now(), dol_print_date(), dol_print_error(), dol_syslog(), dol_time_plus_duree(), getCommonSubstitutionArray(), getDolGlobalInt(), getDolGlobalString(), MultiCurrency\getIdAndTxFromCode(), MultiCurrency\getIdFromCode(), GETPOST(), GETPOSTINT(), CommonObject\insertExtraFields(), make_substitutions(), price2num(), ref, status, STATUS_DRAFT, type, TYPE_STANDARD, CommonObject\update_price(), and updateline().

createFromClone()

FactureFournisseur::createFromClone	(	User	$user,
			$fromid,
			$invertdetail = 0 )

Load an object from its id and create a new one in database.

Parameters

User	$user	User that clone
int	$fromid	Id of object to clone
int	$invertdetail	Reverse sign of amounts for lines

Returns

int New id of clone

Definition at line 3159 of file fournisseur.facture.class.php.

References $object, dol_now(), getDolGlobalInt(), and STATUS_DRAFT.

delete()

FactureFournisseur::delete	(	User	$user,
			$notrigger = 0 )

Delete invoice from database.

Parameters

User	$user	User object
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

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

Definition at line 1438 of file fournisseur.facture.class.php.

References CommonObject\call_trigger(), CommonObject\deleteEcmFiles(), CommonObject\deleteExtraFields(), CommonObject\deleteObjectLinked(), dol_delete_dir_recursive(), dol_delete_file(), dol_sanitizeFileName(), dol_syslog(), fetch_lines(), get_exdir(), and ref.

deleteLine()

FactureFournisseur::deleteLine	(		$rowid,
			$notrigger = 0 )

Delete a detail line from database.

Parameters

int	$rowid	Id of line to delete
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

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

Definition at line 2512 of file fournisseur.facture.class.php.

References dol_syslog(), and CommonObject\update_price().

fetch()

FactureFournisseur::fetch	(		$id = 0,
			$ref = '',
			$ref_ext = '' )

Load object in memory from database.

Parameters

int	$id	Id supplier invoice
string	$ref	Ref supplier invoice
string	$ref_ext	External reference of invoice

Returns

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

Definition at line 870 of file fournisseur.facture.class.php.

References dol_syslog(), fetch_lines(), CommonObject\fetch_optionals(), ref, status, type, and TYPE_STANDARD.

fetch_lines()

FactureFournisseur::fetch_lines

(

)

Load this->lines.

Returns

int 1 si ok, < 0 si erreur

Definition at line 1044 of file fournisseur.facture.class.php.

References dol_syslog().

Referenced by delete(), fetch(), and validate().

generateDocument()

FactureFournisseur::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0,
			$moreparams = null )

Create a document onto disk according to template model.

Parameters

string	$modele	Force template to use ('' to not force)
Translate	$outputlangs	Object lang a utiliser pour traduction
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref
	?array<string,mixed>	$moreparams Array to provide more information

Returns

int<-1,1> Return integer <0 if KO, 0 if nothing done, >0 if OK

Definition at line 3239 of file fournisseur.facture.class.php.

References CommonObject\commonGenerateDocument(), and getDolGlobalString().

getKanbanView()

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

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	?array{selected?:int<0,1>}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

Definition at line 3356 of file fournisseur.facture.class.php.

References getNomUrl(), img_picto(), price(), and type.

getNextNumRef()

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

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

Parameters

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

Returns

string|-1 Returns free reference or last reference, or '' or -1 if error

Reimplemented from CommonInvoice.

Definition at line 2969 of file fournisseur.facture.class.php.

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

Referenced by validate().

getNomUrl()

FactureFournisseur::getNomUrl	(		$withpicto = 0,
			$option = '',
			$max = 0,
			$short = 0,
			$moretitle = '',
			$notooltip = 0,
			$save_lastsearch_value = -1,
			$addlinktonotes = 0 )

Return clickable name (with picto eventually)

Parameters

int	$withpicto	0=No picto, 1=Include picto into link, 2=Only picto
string	$option	Where point the link
int	$max	Max length of shown ref
int	$short	1=Return just URL
string	$moretitle	Add more text to title tooltip
int	$notooltip	1=Disable tooltip
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int	$addlinktonotes	Add link to show notes

Returns

string String with URL

Definition at line 2854 of file fournisseur.facture.class.php.

References dol_escape_htmltag(), dol_string_nohtmltag(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), img_object(), img_picto(), and type.

Referenced by getKanbanView().

getRights()

FactureFournisseur::getRights

(

)

Returns the rights used for this class.

Returns

int

Reimplemented from CommonObject.

Definition at line 3268 of file fournisseur.facture.class.php.

getTooltipContentArray()

FactureFournisseur::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array{moretitle?:string}

$params ex option, infologin

Since

v18

Returns

array{picto:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}

Reimplemented from CommonObject.

Definition at line 2765 of file fournisseur.facture.class.php.

References dol_print_date(), img_picto(), price(), ref, status, and type.

Referenced by getNomUrl().

hasDelay()

FactureFournisseur::hasDelay

(

)

Is the payment of the supplier invoice having a delay?

Returns

bool

Definition at line 3314 of file fournisseur.facture.class.php.

References dol_now(), and status.

info()

FactureFournisseur::info

(

$id

)

Loads the info order information into the invoice object.

Parameters

int

$id

Id of the invoice to load

Returns

void

Definition at line 2566 of file fournisseur.facture.class.php.

References dol_print_error().

initAsSpecimen()

FactureFournisseur::initAsSpecimen

(

$option = ''

)

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Parameters

string

$option

''=Create a specimen invoice with lines, 'nolines'=No lines

Returns

int

Definition at line 3021 of file fournisseur.facture.class.php.

References dol_now(), and ref.

insert_discount()

FactureFournisseur::insert_discount

(

$idremise

)

Add a discount line into an invoice (as an invoice line) using an existing absolute discount (Consume the discount)

Parameters

int

$idremise

Id of absolute discount

Returns

int >0 if OK, <0 if KO

Definition at line 1338 of file fournisseur.facture.class.php.

References getDolGlobalString(), CommonObject\update_price(), and CommonObject\updateRangOfLine().

isCreditNoteUsed()

FactureFournisseur::isCreditNoteUsed

(

)

Is credit note used.

Returns

bool

Definition at line 3334 of file fournisseur.facture.class.php.

list_qualified_avoir_supplier_invoices()

FactureFournisseur::list_qualified_avoir_supplier_invoices

(

$socid = 0

)

Return list of qualifying invoices for correction by credit note Invoices that respect the following rules are returned: (validated + payment in progress) or classified (paid in full or paid in part) + not already replaced + not already having.

Parameters

int

$socid

Thirdparty id

Returns

array|int Table of invoices ($id => array('ref'=>,'paymentornot'=>,'status'=>,'paye'=>) <0 if error

Definition at line 2652 of file fournisseur.facture.class.php.

References dol_syslog().

list_replacable_supplier_invoices()

FactureFournisseur::list_replacable_supplier_invoices

(

$socid = 0

)

Return list of replaceable invoices Status valid or abandoned for other reason + not paid + no payment + not already replaced.

Parameters

int

$socid

Thirdparty id

Returns

array|int Table of invoices ('id'=>id, 'ref'=>ref, 'status'=>status, 'paymentornot'=>0/1) <0 if error

Definition at line 2602 of file fournisseur.facture.class.php.

References dol_syslog().

load_board()

FactureFournisseur::load_board

(

$user

)

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

Parameters

User

$user

Object user

Returns

WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

Definition at line 2703 of file fournisseur.facture.class.php.

References dol_now(), dol_print_error(), and img_object().

loadStateBoard()

FactureFournisseur::loadStateBoard

(

)

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

Returns

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

Definition at line 3119 of file fournisseur.facture.class.php.

References dol_print_error().

replaceProduct()

static FactureFournisseur::replaceProduct ( DoliDB $db, $origin_id, $dest_id )

static

Function used to replace a product id with another one.

Parameters

DoliDB	$db	Database handler
int	$origin_id	Old product id
int	$dest_id	New product id

Returns

bool

Definition at line 3300 of file fournisseur.facture.class.php.

References CommonObject\commonReplaceProduct().

replaceThirdparty()

static FactureFournisseur::replaceThirdparty ( DoliDB $dbs, $origin_id, $dest_id )

static

Function used to replace a thirdparty id with another one.

Parameters

DoliDB	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Definition at line 3283 of file fournisseur.facture.class.php.

References CommonObject\commonReplaceThirdparty().

sendEmailsRemindersOnSupplierInvoiceDueDate()

FactureFournisseur::sendEmailsRemindersOnSupplierInvoiceDueDate	(		$nbdays = 0,
			$paymentmode = 'all',
			$template = '',
			$datetouse = 'duedate',
			$forcerecipient = '' )

Send reminders by emails for supplier invoices validated that are due.

CAN BE A CRON TASK

Parameters

int	$nbdays	Delay before due date (or after if delay is negative)
string	$paymentmode	'' or 'all' by default (no filter), or 'LIQ', 'CHQ', CB', ...
int | string	$template	Name (or id) of email template (Must be a template of type 'invoice_supplier_send')
string	$datetouse	'duedate' (default) or 'invoicedate'
string	$forcerecipient	Force email of recipient (for example to send the email to an accountant supervisor instead of the customer)

Returns

int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

Definition at line 3444 of file fournisseur.facture.class.php.

References complete_substitutions_array(), dol_get_first_hour(), dol_now(), dol_print_date(), dol_syslog(), dol_time_plus_duree(), getCommonSubstitutionArray(), getDolGlobalString(), and make_substitutions().

set_paid()

FactureFournisseur::set_paid	(		$user,
			$close_code = '',
			$close_note = '' )

Tag invoice as a paid invoice.

Deprecated

See also

setPaid()

Parameters

User	$user	Object user
string	$close_code	Code indicates whether the class has paid in full while payment is incomplete. Not implemented yet.
string	$close_note	Comment informs if the class has been paid while payment is incomplete. Not implemented yet.

Returns

int Return integer <0 si ko, >0 si ok

Definition at line 1577 of file fournisseur.facture.class.php.

References dol_syslog(), and setPaid().

set_unpaid()

FactureFournisseur::set_unpaid

(

$user

)

Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened.

Deprecated

See also

setUnpaid()

Parameters

User

$user

Object user that change status

Returns

int Return integer <0 si ok, >0 si ok

Definition at line 1655 of file fournisseur.facture.class.php.

References dol_syslog(), and setUnpaid().

setCanceled()

FactureFournisseur::setCanceled	(		$user,
			$close_code = '',
			$close_note = '' )

Tag invoice as canceled, with no payment on it (example for replacement invoice or payment never received) + call trigger BILL_CANCEL Warning, if option to decrease stock on invoice was set, this function does not change stock (it might be a cancel because of no payment even if merchandises were sent).

Parameters

User	$user	Object user making change
string	$close_code	Code of closing invoice (CLOSECODE_REPLACED, CLOSECODE_...)
string	$close_note	Comment

Returns

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

Definition at line 1716 of file fournisseur.facture.class.php.

References CommonObject\call_trigger(), and dol_syslog().

setDraft()

FactureFournisseur::setDraft	(		$user,
			$idwarehouse = -1,
			$notrigger = 0 )

Set draft status.

Parameters

User	$user	Object user that modify
int	$idwarehouse	Id warehouse to use for stock change.
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

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

Definition at line 1988 of file fournisseur.facture.class.php.

References CommonObject\call_trigger(), dol_syslog(), getDolGlobalString(), status, type, and TYPE_CREDIT_NOTE.

setPaid()

FactureFournisseur::setPaid	(		$user,
			$close_code = '',
			$close_note = '' )

Tag invoice as a paid invoice.

Parameters

User	$user	Object user
string	$close_code	Code indicates whether the class has paid in full while payment is incomplete. Not implemented yet.
string	$close_note	Comment informs if the class has been paid while payment is incomplete. Not implemented yet.

Returns

int<-1,1> Return integer <0 si ko, >0 si ok

Definition at line 1592 of file fournisseur.facture.class.php.

References CommonObject\call_trigger(), dol_now(), dol_print_error(), and dol_syslog().

Referenced by set_paid().

setUnpaid()

FactureFournisseur::setUnpaid

(

$user

)

Tag the invoice as not fully paid + trigger call BILL_UNPAYED Function used when a direct debit payment is refused, or when the invoice was canceled and reopened.

Parameters

User

$user

Object user that change status

Returns

int Return integer <0 si ok, >0 si ok

Definition at line 1670 of file fournisseur.facture.class.php.

References CommonObject\call_trigger(), dol_print_error(), and dol_syslog().

Referenced by set_unpaid().

setVATReverseCharge()

FactureFournisseur::setVATReverseCharge

(

$vatreversecharge

)

Change the option VAT reverse charge.

Parameters

int

$vatreversecharge

0 = Off, 1 = On

Returns

int 1 if OK, 0 if KO

Definition at line 3410 of file fournisseur.facture.class.php.

References dol_syslog().

update()

FactureFournisseur::update	(		$user = null,
			$notrigger = 0 )

Update database.

Parameters

User	$user	User that modify
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

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

Definition at line 1148 of file fournisseur.facture.class.php.

References CommonObject\call_trigger(), dol_strlen(), dol_syslog(), CommonObject\insertExtraFields(), ref, status, type, and TYPE_STANDARD.

updateline()

FactureFournisseur::updateline	(		$id,
			$desc,
			$pu,
			$vatrate,
			$txlocaltax1 = 0,
			$txlocaltax2 = 0,
			$qty = 1,
			$idproduct = 0,
			$price_base_type = 'HT',
			$info_bits = 0,
			$type = 0,
			$remise_percent = 0,
			$notrigger = 0,
			$date_start = '',
			$date_end = '',
			$array_options = [],
			$fk_unit = null,
			$pu_devise = 0,
			$ref_supplier = '',
			$rang = 0 )

Update a line detail in the database.

Parameters

int	$id	Id of line invoice
string	$desc	Description of line
float	$pu	Prix unitaire (HT ou TTC selon price_base_type)
float	$vatrate	VAT Rate (Can be '8.5', '8.5 (ABC)')
float	$txlocaltax1	LocalTax1 Rate
float	$txlocaltax2	LocalTax2 Rate
float	$qty	Quantity
int	$idproduct	Id produit
string	$price_base_type	HT or TTC
int	$info_bits	Miscellaneous information of line
int	$type	Type of line (0=product, 1=service)
float	$remise_percent	Percentage discount of the line
int	$notrigger	Disable triggers
int | string	$date_start	Date start of service
int | string	$date_end	Date end of service
	array<string,mixed>	$array_options extrafields array
?int	$fk_unit	Code of the unit to use. Null to use the default one
float	$pu_devise	Amount in currency
string	$ref_supplier	Supplier ref
int	$rang	Line rank

Returns

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

Definition at line 2354 of file fournisseur.facture.class.php.

References calcul_price_total(), dol_syslog(), getLocalTaxesFromRate(), price2num(), type, and CommonObject\update_price().

Referenced by create().

validate()

FactureFournisseur::validate	(		$user,
			$force_number = '',
			$idwarehouse = 0,
			$notrigger = 0 )

Tag invoice as validated + call trigger BILL_VALIDATE.

Parameters

User	$user	Object user that validate
string	$force_number	Reference to force on invoice
int	$idwarehouse	Id of warehouse for stock change
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

int Return integer <0 if KO, =0 if nothing to do, >0 if OK

Definition at line 1773 of file fournisseur.facture.class.php.

References CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_sanitizeFileName(), dol_syslog(), fetch_lines(), CommonObject\fetch_thirdparty(), get_exdir(), getDolGlobalString(), getNextNumRef(), isValidEmail(), price2num(), ref, status, STATUS_VALIDATED, type, and TYPE_CREDIT_NOTE.

Member Data Documentation

STATUS_ABANDONED

const FactureFournisseur::STATUS_ABANDONED = 3

Classified abandoned and no payment done.

$this->close_code can be:

• CLOSECODE_BADCREDIT
• CLOSECODE_ABANDONED
• CLOSECODE_REPLACED

Definition at line 372 of file fournisseur.facture.class.php.

STATUS_CLOSED

const FactureFournisseur::STATUS_CLOSED = 2

Classified paid.

If paid partially, $this->close_code can be:

• CLOSECODE_DISCOUNTVAT
• CLOSECODE_BADCREDIT If paid completely, this->close_code will be null

Definition at line 363 of file fournisseur.facture.class.php.

---

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

• dolibarr_dev/htdocs/fourn/class/fournisseur.facture.class.php