server_invoice.php File Reference

File that is entry point to call Dolibarr WebServices. More...

Go to the source code of this file.

Functions
	getInvoice ($authentication, $id=0, $ref='', $ref_ext='')
	Get invoice from id, ref or ref_ext.
	getInvoicesForThirdParty ($authentication, $idthirdparty)
	Get list of invoices for third party.
	createInvoice ($authentication, $invoice)
	Create an invoice.
	createInvoiceFromOrder ($authentication, $id_order='', $ref_order='', $ref_ext_order='')
	Create an invoice from an order.
	updateInvoice ($authentication, $invoice)
	Update an invoice, only change the state of an invoice.

Detailed Description

File that is entry point to call Dolibarr WebServices.

Definition in file server_invoice.php.

Function Documentation

createInvoice()

createInvoice	(		$authentication,
			$invoice )

Create an invoice.

Parameters

array{login:string,password:string,entity:?int,dolibarrkey:string}

$authentication Array of authentication information

array{id:string,ref:string,ref_ext:string,thirdparty_id:int,fk_user_author:string,fk_user_valid:string,date:string,date_due:string,date_creation:string,date_validation:string,date_modification:string,payment_mode_id:string,type:int,total_net:float,total_vat:float,total:float,note_private:string,note_public:string,status:int,close_code:string,close_note:string,project_id:string,lines?:array{id:string,type:int,desc:string,vat_rate:float,qty:float,unitprice:float,total_net:float,total_vat:float,total:float,date_start:string,date_end:string,product_id:int,product_ref:string,product_label:string,product_desc:string}}

$invoice Invoice

Returns

array{result:array{result_code:string,result_label:string}} Array result

Definition at line 559 of file server_invoice.php.

References $conf, check_authentication(), dol_now(), dol_stringtotime(), dol_syslog(), Facture\STATUS_DRAFT, and Facture\STATUS_VALIDATED.

createInvoiceFromOrder()

createInvoiceFromOrder	(		$authentication,
			$id_order = '',
			$ref_order = '',
			$ref_ext_order = '' )

Create an invoice from an order.

Parameters

	array{login:string,password:string,entity:?int,dolibarrkey:string}	$authentication Array of authentication information
string	$id_order	id of order to copy invoice from
string	$ref_order	ref of order to copy invoice from
string	$ref_ext_order	ref_ext of order to copy invoice from

Returns

array{result:array{result_code:string,result_label:string},id?:int,ref?:string,ref_ext?:string} Array result

Definition at line 680 of file server_invoice.php.

References $conf, check_authentication(), and dol_syslog().

getInvoice()

getInvoice	(		$authentication,
			$id = 0,
			$ref = '',
			$ref_ext = '' )

Get invoice from id, ref or ref_ext.

Parameters

	array{login:string,password:string,entity:?int,dolibarrkey:string}	$authentication Array of authentication information
int	$id	Id
string	$ref	Ref
string	$ref_ext	Ref_ext

Returns

array{result:array{result_code:string,result_label:string}} Array result

Definition at line 314 of file server_invoice.php.

References $conf, $id, check_authentication(), dol_htmlcleanlastbr(), dol_print_date(), and dol_syslog().

getInvoicesForThirdParty()

getInvoicesForThirdParty	(		$authentication,
			$idthirdparty )

Get list of invoices for third party.

Parameters

	array{login:string,password:string,entity:?int,dolibarrkey:string}	$authentication Array of authentication information
int	$idthirdparty	Id thirdparty

Returns

array{result:array{result_code:string,result_label:string}} Array result

Definition at line 423 of file server_invoice.php.

References $conf, check_authentication(), dol_print_date(), and dol_syslog().

updateInvoice()

updateInvoice	(		$authentication,
			$invoice )

Update an invoice, only change the state of an invoice.

Parameters

array{login:string,password:string,entity:?int,dolibarrkey:string}	$authentication Array of authentication information
array{id:string,ref:string,ref_ext:string,status?:string,close_code?:int,close_note?:int}	$invoice Invoice

Returns

array{result:array{result_code:string,result_label:string},id?:int,ref?:string,ref_ext?:string} Array result

Definition at line 761 of file server_invoice.php.

References $conf, $object, check_authentication(), dol_syslog(), Facture\STATUS_ABANDONED, Facture\STATUS_CLOSED, Facture\STATUS_DRAFT, and Facture\STATUS_VALIDATED.