Invoices Class Reference

Inheritance diagram for Invoices:

Collaboration diagram for Invoices:

Public Member Functions
	__construct ()
	Constructor.
	get ($id, $contact_list=1)
	Get properties of a invoice object. More...
	getByRef ($ref, $contact_list=1)
	Get properties of an invoice object by ref. More...
	getByRefExt ($ref_ext, $contact_list=1)
	Get properties of an invoice object by ref_ext. More...
	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $thirdparty_ids= '', $status= '', $sqlfilters= '')
	List invoices. More...
	post ($request_data=null)
	Create invoice object. More...
	createInvoiceFromOrder ($orderid)
	Create an invoice using an existing order. More...
	getLines ($id)
	Get lines of an invoice. More...
	putLine ($id, $lineid, $request_data=null)
	Update a line to a given invoice. More...
	postContact ($id, $contactid, $type)
	Add a contact type of given invoice. More...
	deleteContact ($id, $contactid, $type)
	Delete a contact type of given invoice. More...
	deleteLine ($id, $lineid)
	Deletes a line of a given invoice. More...
	put ($id, $request_data=null)
	Update invoice. More...
	delete ($id)
	Delete invoice. More...
	postLine ($id, $request_data=null)
	Add a line to a given invoice. More...
	addContact ($id, $fk_socpeople, $type_contact, $source, $notrigger=0)
	Adds a contact to an invoice. More...
	settodraft ($id, $idwarehouse=-1)
	Sets an invoice as draft. More...
	validate ($id, $idwarehouse=0, $notrigger=0)
	Validate an invoice. More...
	settopaid ($id, $close_code= '', $close_note= '')
	Sets an invoice as paid. More...
	settounpaid ($id)
	Sets an invoice as unpaid. More...
	getDiscount ($id)
	Get discount from invoice. More...
	markAsCreditAvailable ($id)
	Create a discount (credit available) for a credit note or a deposit. More...
	useDiscount ($id, $discountid)
	Add a discount line into an invoice (as an invoice line) using an existing absolute discount. More...
	useCreditNote ($id, $discountid)
	Add an available credit note discount to payments of an existing invoice. More...
	getPayments ($id)
	Get list of payments of a given invoice. More...
	addPayment ($id, $datepaye, $paymentid, $closepaidinvoices, $accountid, $num_payment= '', $comment= '', $chqemetteur= '', $chqbank= '')
	Add payment line to a specific invoice with the remain to pay as amount. More...
	addPaymentDistributed ($arrayofamounts, $datepaye, $paymentid, $closepaidinvoices, $accountid, $num_payment= '', $comment= '', $chqemetteur= '', $chqbank= '', $ref_ext= '', $accepthigherpayment=false)
	Add a payment to pay partially or completely one or several invoices. More...
	putPayment ($id, $num_payment= '')
	Update a payment. More...
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir= '', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
Protected Member Functions inherited from DolibarrApi
	_cleanObjectDatas ($object)
	Executed method when API is called without parameter. More...
	_checkFilters ($sqlfilters)
	Return if a $sqlfilters parameter is valid. More...

Private Member Functions
	_fetch ($id, $ref= '', $ref_ext= '', $contact_list=1)
	Get properties of an invoice object. More...
	_validate ($data)
	Validate fields before create or update object. More...

Additional Inherited Members
Static Protected Member Functions inherited from DolibarrApi
static	_checkAccessToResource ($resource, $resource_id=0, $dbtablename= '', $feature2= '', $dbt_keyfield= 'fk_soc', $dbt_select= 'rowid')
	Check user access to a resource. More...
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria. More...

Detailed Description

Definition at line 29 of file api_invoices.class.php.

Member Function Documentation

Invoices::_cleanObjectDatas (   $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Definition at line 1649 of file api_invoices.class.php.

Referenced by _fetch(), addContact(), createInvoiceFromOrder(), deleteContact(), getLines(), index(), markAsCreditAvailable(), postContact(), putLine(), settodraft(), settopaid(), settounpaid(), and validate().

Invoices::_fetch (   $id,   $ref = '',   $ref_ext = '',   $contact_list = 1  )

private

Get properties of an invoice object.

Return an array with invoice informations

Parameters

int	$id	ID of order
string	$ref	Ref of object
string	$ref_ext	External reference of object
int	$contact_list	0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id

Returns

array|mixed data without useless information

Exceptions

RestException

Definition at line 119 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), and price2num().

Referenced by get(), getByRef(), and getByRefExt().

Invoices::_validate (   $data )

private

Validate fields before create or update object.

Parameters

array | null

$data

Datas to validate

Returns

array

Exceptions

RestException

Definition at line 1672 of file api_invoices.class.php.

Referenced by post().

Invoices::addContact	(		$id,
			$fk_socpeople,
			$type_contact,
			$source,
			$notrigger = 0
	)

Adds a contact to an invoice.

Parameters

int	$id	Order ID
int	$fk_socpeople	Id of thirdparty contact (if source = 'external') or id of user (if souce = 'internal') to link
string	$type_contact	Type of contact (code). Must a code found into table llx_c_type_contact. For example: BILLING
string	$source	external=Contact extern (llx_socpeople), internal=Contact intern (llx_user)
int	$notrigger	Disable all triggers

POST {id}/contacts

Returns

array

Exceptions

RestException	304
RestException	401
RestException	404
RestException	500

Definition at line 748 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::addPayment	(		$id,
			$datepaye,
			$paymentid,
			$closepaidinvoices,
			$accountid,
			$num_payment = '',
			$comment = '',
			$chqemetteur = '',
			$chqbank = ''
	)

Add payment line to a specific invoice with the remain to pay as amount.

Parameters

int	$id	Id of invoice
string	$datepaye	{ body} Payment date { timestamp}
int	$paymentid	{ body} Payment mode Id { 1}
string	$closepaidinvoices	{ body} Close paid invoices { yes,no}
int	$accountid	{ body} Account Id { 1}
string	$num_payment	{ body} Payment number (optional)
string	$comment	{ body} Note private (optional)
string	$chqemetteur	{ body} Payment issuer (mandatory if paymentcode = 'CHQ')
string	$chqbank	{ body} Issuer bank name (optional)

POST {id}/payments

Returns

int Payment ID

Exceptions

RestException	400
RestException	401
RestException	404

Definition at line 1349 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), db, dol_getIdFromCode(), price2num(), and Facture\TYPE_CREDIT_NOTE.

Invoices::addPaymentDistributed	(		$arrayofamounts,
			$datepaye,
			$paymentid,
			$closepaidinvoices,
			$accountid,
			$num_payment = '',
			$comment = '',
			$chqemetteur = '',
			$chqbank = '',
			$ref_ext = '',
			$accepthigherpayment = false
	)

Add a payment to pay partially or completely one or several invoices.

Warning: Take care that all invoices are owned by the same customer. Example of value for parameter arrayofamounts: {"1": {"amount": "99.99", "multicurrency_amount": ""}, "2": {"amount": "", "multicurrency_amount": "10"}}

Parameters

array	$arrayofamounts	{ body} Array with id of invoices with amount to pay for each invoice
string	$datepaye	{ body} Payment date { timestamp}
int	$paymentid	{ body} Payment mode Id { 1}
string	$closepaidinvoices	{ body} Close paid invoices { yes,no}
int	$accountid	{ body} Account Id { 1}
string	$num_payment	{ body} Payment number (optional)
string	$comment	{ body} Note private (optional)
string	$chqemetteur	{ body} Payment issuer (mandatory if paiementcode = 'CHQ')
string	$chqbank	{ body} Issuer bank name (optional)
string	$ref_ext	{ body} External reference (optional)
bool	$accepthigherpayment	{ body} Accept higher payments that it remains to be paid (optional)

POST /paymentsdistributed

Returns

int Payment ID

Exceptions

RestException	400
RestException	401
RestException	403
RestException	404

Definition at line 1471 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), db, dol_getIdFromCode(), price2num(), and Facture\TYPE_CREDIT_NOTE.

Invoices::createInvoiceFromOrder

(

$orderid

)

Create an invoice using an existing order.

Parameters

int

$orderid

Id of the order

POST /createfromorder/{orderid}

Returns

int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405

Definition at line 305 of file api_invoices.class.php.

References _cleanObjectDatas(), and db.

Invoices::delete

(

$id

)

Delete invoice.

Parameters

int

$id

Invoice ID

Returns

array

Definition at line 612 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource().

Invoices::deleteContact	(		$id,
			$contactid,
			$type
	)

Delete a contact type of given invoice.

Parameters

int	$id	Id of invoice to update
int	$contactid	Row key of the contact in the array contact_ids.
string	$type	Type of the contact (BILLING, SHIPPING, CUSTOMER).

DELETE {id}/contact/{contactid}/{type}

Returns

array

Exceptions

RestException	401
RestException	404
RestException	500

Definition at line 490 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::deleteLine	(		$id,
			$lineid
	)

Deletes a line of a given invoice.

Parameters

int	$id	Id of invoice
int	$lineid	Id of the line to delete

DELETE {id}/lines/{lineid}

Returns

array

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405

Definition at line 536 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource().

Invoices::get	(		$id,
			$contact_list = 1
	)

Get properties of a invoice object.

Return an array with invoice informations

Parameters

int	$id	ID of invoice
int	$contact_list	0:Return array contains all properties, 1:Return array contains just id

Returns

array|mixed data without useless information

Exceptions

RestException

Definition at line 65 of file api_invoices.class.php.

References _fetch().

Invoices::getByRef	(		$ref,
			$contact_list = 1
	)

Get properties of an invoice object by ref.

Return an array with invoice informations

Parameters

string	$ref	Ref of object
int	$contact_list	0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id

Returns

array|mixed data without useless information

GET ref/{ref}

Exceptions

RestException

Definition at line 83 of file api_invoices.class.php.

References _fetch().

Invoices::getByRefExt	(		$ref_ext,
			$contact_list = 1
	)

Get properties of an invoice object by ref_ext.

Return an array with invoice informations

Parameters

string	$ref_ext	External reference of object
int	$contact_list	0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id

Returns

array|mixed data without useless information

GET ref_ext/{ref_ext}

Exceptions

RestException

Definition at line 101 of file api_invoices.class.php.

References _fetch().

Invoices::getDiscount

(

$id

)

Get discount from invoice.

Parameters

int

$id

Id of invoice

GET {id}/discount

Returns

mixed

Definition at line 993 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and db.

Invoices::getLines

(

$id

)

Get lines of an invoice.

Parameters

int

$id

Id of invoice

GET {id}/lines

Returns

int

Definition at line 343 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::getPayments

(

$id

)

Get list of payments of a given invoice.

Parameters

int

$id

Id of invoice

GET {id}/payments

Returns

array

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405

Definition at line 1300 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource().

Invoices::index	(		$sortfield = "t.rowid",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$thirdparty_ids = '',
			$status = '',
			$sqlfilters = ''
	)

List invoices.

Get a list of invoices

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$thirdparty_ids	Thirdparty ids to filter orders of (example '1' or '1,2,3') { /^[0-9,]*$/i}
string	$status	Filter by invoice status : draft | unpaid | paid | cancelled
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"

Returns

array Array of invoice objects

Exceptions

RestException	404 Not found
RestException	503 Error

Definition at line 164 of file api_invoices.class.php.

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), db, and price2num().

Invoices::markAsCreditAvailable

(

$id

)

Create a discount (credit available) for a credit note or a deposit.

Parameters

int

$id

Invoice ID POST {id}/markAsCreditAvailable

Returns

array An invoice object

Exceptions

RestException	304
RestException	401
RestException	404
RestException	500

Definition at line 1036 of file api_invoices.class.php.

References $resql, DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), db, dol_print_error(), Facture\TYPE_CREDIT_NOTE, Facture\TYPE_DEPOSIT, Facture\TYPE_REPLACEMENT, Facture\TYPE_SITUATION, and Facture\TYPE_STANDARD.

Invoices::post

(

$request_data = null

)

Create invoice object.

Parameters

array

$request_data

Request datas

Returns

int ID of invoice

Definition at line 262 of file api_invoices.class.php.

References _validate(), and dol_now().

Invoices::postContact	(		$id,
			$contactid,
			$type
	)

Add a contact type of given invoice.

Parameters

int	$id	Id of invoice to update
int	$contactid	Id of contact to add
string	$type	Type of the contact (BILLING, SHIPPING, CUSTOMER)

POST {id}/contact/{contactid}/{type}

Returns

int

Exceptions

RestException	401
RestException	404

Definition at line 446 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::postLine	(		$id,
			$request_data = null
	)

Add a line to a given invoice.

Exemple of POST query : { "desc": "Desc", "subprice": "1.00000000", "qty": "1", "tva_tx": "20.000", "localtax1_tx": "0.000", "localtax2_tx": "0.000", "fk_product": "1", "remise_percent": "0", "date_start": "", "date_end": "", "fk_code_ventilation": 0, "info_bits": "0", "fk_remise_except": null, "product_type": "1", "rang": "-1", "special_code": "0", "fk_parent_line": null, "fk_fournprice": null, "pa_ht": "0.00000000", "label": "", "array_options": [], "situation_percent": "100", "fk_prev_id": null, "fk_unit": null }

Parameters

int	$id	Id of invoice
array	$request_data	InvoiceLine data

POST {id}/lines

Returns

int

Exceptions

RestException	304
RestException	401
RestException	404
RestException	400

Definition at line 663 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and getMarginInfos().

Invoices::put	(		$id,
			$request_data = null
	)

Update invoice.

Parameters

int	$id	Id of invoice to update
array	$request_data	Datas

Returns

int

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

References DolibarrApi\_checkAccessToResource().

Invoices::putLine	(		$id,
			$lineid,
			$request_data = null
	)

Update a line to a given invoice.

Parameters

int	$id	Id of invoice to update
int	$lineid	Id of line to update
array	$request_data	InvoiceLine data

PUT {id}/lines/{lineid}

Returns

array

Exceptions

RestException	304
RestException	401
RestException	404 Invoice not found

Definition at line 380 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::putPayment	(		$id,
			$num_payment = ''
	)

Update a payment.

Parameters

int	$id	Id of payment
string	$num_payment	Payment number

PUT payments/{id}

Returns

array

Exceptions

RestException	400 Bad parameters
RestException	401 Not allowed
RestException	404 Not found

Definition at line 1609 of file api_invoices.class.php.

References db.

Invoices::settodraft	(		$id,
			$idwarehouse = -1
	)

Sets an invoice as draft.

Parameters

int	$id	Order ID
int	$idwarehouse	Warehouse ID

POST {id}/settodraft

Returns

array

Exceptions

RestException	304
RestException	401
RestException	404
RestException	500

Definition at line 797 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::settopaid	(		$id,
			$close_code = '',
			$close_note = ''
	)

Sets an invoice as paid.

Parameters

int	$id	Order ID
string	$close_code	Code filled if we classify to 'Paid completely' when payment is not complete (for escompte for example)
string	$close_note	Comment defined if we classify to 'Paid' when payment is not complete (for escompte for example)

POST {id}/settopaid

Returns

array An invoice object

Exceptions

RestException	304
RestException	401
RestException	404
RestException	500

Definition at line 899 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::settounpaid

(

$id

)

Sets an invoice as unpaid.

Parameters

int

$id

Order ID

POST {id}/settounpaid

Returns

array An invoice object

Exceptions

RestException	304
RestException	401
RestException	404
RestException	500

Definition at line 949 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

Invoices::useCreditNote	(		$id,
			$discountid
	)

Add an available credit note discount to payments of an existing invoice.

Note that this consume the credit note.

Parameters

int	$id	Id of invoice
int	$discountid	Id of a discount coming from a credit note

POST {id}/usecreditnote/{discountid}

Returns

int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405

Definition at line 1254 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and db.

Invoices::useDiscount	(		$id,
			$discountid
	)

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

Note that this consume the discount.

Parameters

int	$id	Id of invoice
int	$discountid	Id of discount

POST {id}/usediscount/{discountid}

Returns

int

Exceptions

RestException	400
RestException	401
RestException	404
RestException	405

Definition at line 1207 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource().

Invoices::validate	(		$id,
			$idwarehouse = 0,
			$notrigger = 0
	)

Validate an invoice.

If you get a bad value for param notrigger check that ou provide this in body { "idwarehouse": 0, "notrigger": 0 }

Parameters

int	$id	Invoice ID
int	$idwarehouse	Warehouse ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

POST {id}/validate

Returns

array

Definition at line 849 of file api_invoices.class.php.

References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

---

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

• htdocs/compta/facture/class/api_invoices.class.php