Facture

Trait CommonSubtotal

Trait for incoterm classes

Class for handling deprecated properties and methods

Parent class of all other business classes (invoices, contracts, proposals, orders, ...)

Get deprecated property

Set deprecated property

Unset deprecated property

Test if deprecated property is set

Call deprecated method

Provide list of deprecated properties

Provide list of deprecated methods

Get caller info

Call trigger based on this instance.

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

isEmpty We consider CommonObject isEmpty if this->id is empty

setErrorsFromObject

getTooltipContentArray

getTooltipContent

Method to output saved errors

Return customer ref for screen output.

Return supplier ref for screen output.

Return full address of contact

Return the link of last main doc file for direct public download.

Add a link between element $this->element and a contact

Copy contact from one element to current

Update a link to contact line

Delete a link to contact line

Delete all links between an object $this and all its contacts in llx_element_contact

Get array of all contacts for an object

Update status of a contact linked to object

Return array with list of possible values for type of contacts

Return array with list of possible values for type of contacts

Return id of contacts for a source and a contact code.

Load object contact with id=$this->contact_id into $this->contact

Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty

Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set

Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.

Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.

Load the project with id $this->fk_project into this->project

Load the project with id $this->fk_project into this->project

Load the project with id $this->fk_project into this->project

Load the product with id $this->fk_product into this->product

Load the user with id $userid into this->user

Read linked origin object.

Load object from specific field

Getter generic. Load value from a specific field

Setter generic. Update a specific field into database.

Load properties id_previous and id_next by comparing $fieldid with $this->ref

Return list of id of contacts of object

Link element with a project

Change the payments methods

Change the multicurrency code

Change the multicurrency rate

Change the payments terms

Change the transport mode methods

Change the retained warranty payments terms

Define delivery address

Change the shipping method

Change the warehouse

Set last model used by doc generator

Change the bank account

Save a new position (field rang) for details lines.

Get children of line

Update a line to have a lower rank

Update a line to have a higher rank

Update position of line (rang)

Update position of line with ajax (rang)

Update position of line up (rang)

Update position of line down (rang)

Get position of line (rang)

Get rowid of the line relative to its position

Get max value used for position of line (rang)

Update external ref of element

Update note of element

Update public note (kept for backward compatibility)

Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).

Add an object link into llx_element_element.

Return an element type string formatted like element_element target_type and source_type

Fetch array of objects linked to current object (object of enabled modules only). Links are loaded into this->linkedObjectsIds array + this->linkedObjects array if $loadalsoobjects = 1 or $loadalsoobjects = type Possible usage for parameters:

• all parameters empty -> we look all link to current object (current object can be source or target)
• source id+type -> will get list of targets linked to source
• target id+type -> will get list of sources linked to target
• source id+type + target type -> will get list of targets of the type linked to source
• target id+type + source type -> will get list of sources of the type linked to target

Clear the cache saying that all linked object were already loaded. So next fetchObjectLinked will reload all links.

Update object linked of a current object

Delete all links between an object $this

Function used to get an array with all items linked to an object id in association table

Count items linked to an object id in association table

Function used to remove all items linked to an object id in association table

Set status of an object.

Load type of canvas of an object if it exists

Get special code of a line

Function to check if an object is used by others (by children).

Function to say how many lines object contains

Function that returns the total amount HT of discounts applied for all lines.

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.

Set extra parameters

Show add free and predefined products/services form

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.

Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)

Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).

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 resources to the current object : add entry into llx_element_resources Need $this->element & $this->id

Delete a link to resource line

Overwrite magic function to solve problem of cloning object that are kept as references

Common function for all objects extending CommonObject for generating documents

Index a file into the ECM database

Build thumb

Delete thumbs

Return the default value to use for a field when showing the create form of object.

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.

Fill array_options property of object by extrafields value (using for data sent by forms) Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty.

Function to make a fetch but set environment to avoid to load computed values before.

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.

Delete all extra fields values for the current object.

Add/Update all extra fields values for the current object.

Add/Update all extra languages values for the current object.

Update 1 extra field value for the current object. Keep other fields unchanged.

Convenience method for retrieving the value of an extrafield without actually fetching it from the database.

Convenience method for setting the value of an extrafield without actually updating it in the database.

Update an extra language value for the current object.

Return HTML string to put an input field into a page Code very similar with showInputField of extra fields

Return HTML string to show a field into a page Code very similar with showOutputField of extra fields

clear validation message result for a field

set validation error message a field

get field error message

Return validation test result for a field

Function to show lines of extrafields with output data.

No description

Returns the rights used for this class

Function used to replace a thirdparty id with another one.

Function used to replace a product id with another one.

Get buy price to use for margin calculation. This function is called when buy price is unknown.

Function used to get the logos or photos of an object

Show photos of an object (nbmax maximum), into several columns

Function test if type is array

Function test if type is date

Function test if type is duration

Function test if type is integer

Function test if type is float

Function test if type is text

Function test if field can be null

Function test if field is forced to null if zero or empty

Function test if is indexed

Function to return the array of data key-value from the ->fields and all the ->properties of an object.

Function to load data from a SQL pointer into properties of current object $this

Sets all object fields to null. Useful for example in lists, when printing multiple lines and a different object os fetched for each line.

Function to concat keys of fields

Add quote to field value if necessary

Create object in the database

Load object in memory from the database. This does not load line. This is done by parent fetch() that call fetchCommon

Load object in memory from the database

Update object into database

Delete object in database

Delete all child object from a parent ID

Delete a line of object in database

Set to a status

Initialise object with example values Id must be 0 if object instance is a specimen

Load comments linked with current task

Return nb comments already posted

Trim object parameters

Sets object to given categories.

Sets object to given categories.

Copy related categories to another object

Delete related files of object in database

Check if all products have the right status (on sale, on buy) called during validation of propal, order, supplier proposal, supplier order

Set the error message for the object without logging it.

Set the error message for the object and log it.

Return incoterms information TODO Use a cache for label get

Return incoterms information for pdf display

Define incoterms values of current object

Return remain amount to pay. Property ->id and ->total_ttc must be set.

Return amount of payments already done. This must include ONLY the record into the payment table.

Return amount (with tax) of all deposits invoices used by invoice.

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

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

Returns array of credit note ids from the invoice

Returns the id of the invoice that replaces it

Return list of open direct debit or credit transfer

Return list of payments

Return if an invoice can be set back to draft.

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 1 -> no (0) If invoice is transferred in bookkeeping -> no (-1) If invoice has a definitive ref, is not last in ref -> no (-2) If invoice has a definitive ref, is not last in a situation cycle -> no (-3) If there is one payment -> no (-4) If already sent by email -> no (-5) If already printed -> no (-6) If running a LNE version and customer invoice was validated -> no (-7) Other value (may be returned by a hook -10, -11, ...) Otherwise -> yes (2)

Return if an invoice was transferred into accountnancy.

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

Return label of type of invoice

Return label of invoice subtype

Retrieve a list of invoice subtype labels or codes.

Return label of object status

Return label of a status

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

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

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 ?

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.

Remove a direct debit request or a credit transfer request

Build string for EPC QR Code

Build string for ZATCA QR Code (Arabi Saudia)

Build string for QR-Bill (Switzerland)

Adds a subtotals line to a document.

Deletes a subtotal or a title line from a document.

Updates a subtotal line of a document.

Updates a block of lines of a document.

Return the total_ht of lines that are above the current line (excluded) and that are not a subtotal line until a title line of the same level is found

Return the multicurrency_total_ht of lines that are above the current line (excluded) and that are not a subtotal line until a title line of the same level is found

Retrieve the background color associated with a specific subtotal level.

Retrieve current object possible titles to choose from

Retrieve the current object possible levels (defined in admin page)

Returns an array with the IDs of the line that we don't need to show to avoid empty blocks

Constructor

Create invoice in database.

Create a new invoice in database from current invoice

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

Load an object from an order and create a new invoice into database

Load an object from a contract and create a new invoice into database

Creates a deposit from a proposal or an order by grouping lines by VAT rates

Return clickable link of object (with eventually picto)

Get object from database. Get also lines.

Load all detailed lines into this->lines

Fetch previous and next situations invoices.

Update database

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

Set customer ref

Update invoice input reason

Delete invoice

Tag the invoice as paid completely (if close_code is filled) => this->fk_statut=2, this->paye=1 or partially (if close_code filled) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0

Tag the invoice as :

• paid completely (if close_code is not filled) => this->fk_statut=2, this->paye=1
• or partially (if close_code filled) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0

Tags the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened.

Tag the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened.

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).

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).

Tag invoice as validated + call trigger BILL_VALIDATE Object must have lines loaded with fetch_lines This may rename files on disk because ref is modified but it does not generate any document.

Update price of next invoice

Set draft status

Add an invoice line into database (linked to product/service or not).

Update a detail line

Check if the percent edited is lower of next invoice line

Update invoice line with percentage

Delete line in database

Set percent discount

Set percent discount

Sets object to given categories.

Load miscellaneous information for tab "Info"

Return list of invoices (eventually filtered on a user) into an array

Return list of invoices qualified to be replaced by another invoice.

Return list of invoices qualified to be corrected by a credit note.

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

Retourne id des contacts clients de facturation

Retourne id des contacts clients de livraison

Initialise an instance with random values.

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

Create an array of invoice lines

Create a document onto disk according to template module.

Gets the smallest reference available for a new cycle

Checks if the invoice is the first of a cycle

Returns an array containing the previous situations as Facture objects

Sets the invoice as a final situation

Checks if the invoice is the last in its cycle

Replace a thirdparty id with another one.

Replace a product id with another one.

Is the customer invoice delayed?

Check if an invoice is a situation invoice

Currently used for documents generation : to know if retained warranty need to be displayed

No description

Change the retained warranty

Change the retained_warranty_date_limit

Send reminders by emails for invoices validated that are due.

See if current invoice date is posterior to the last invoice date among validated invoices of same type.

Return clickable link of object (with eventually picto)