How to link a invoice with a contract using the AP

dboulo · April 29, 2018, 2:58pm

Hello,
I’m developing an order/contract module in a web site and I need to send the contract to Dolibarr. I want to create a contract and its lines using the API, then validate the contract and then create an invoice linked with the contract. I have succeed in creating both using the API but I can’t link them.
Thanks in advance.

eldy · April 29, 2018, 4:10pm

When you create or update the contract or invoice, try to fill the array linkedObjectsIds

dboulo · April 30, 2018, 7:10pm

Thanks for your answer. I’ve tried to modify the linkedobjectID, but I haven’t succeed in finding the right syntax. I’ve seen in the data sent by the API
‘linkedObjectsIds’ =>
array (
‘contrat’ =>
array (
7 => ‘3’,
),
),

but I don’t understand what 7 means.
Regards

michielp · June 12, 2018, 8:39am

The 7 is in the database the link id between the contract and the invoice.

I have created via API, the link between the contract and the invoice with:
invoice[‘linkedObjectsIds’][‘contrat’] = contractId
I hope that helps

michielp · June 12, 2018, 8:43am

The 7 is in the database the link id between the contract and the invoice.

I have created via API, the link between the contract and the invoice with:

invoice['linkedObjectsIds']['contrat'] = contractId

I hope that helps

PS. Some texts got interpreted by bbcode

jonbendtsen · March 17, 2024, 5:16pm

I tried linking a subscription and an invoice with json like this

{
  "linkedObjectsIds": {
    "subscription": "4"
    }
}

on an url like this http://localhost/api/index.php/invoices/2

I don’t get any errors, but I also do not get any link.

If I use the GUI to create a subscription and an invoice, and I then use the API to get that invoice I get data like this:

  "linkedObjectsIds": {
    "subscription": {
      "1": "3"
    }
  },

Where 1 is the rowid in llx_element_element, but I can not just guess the next free number and I can not look it up in the API can I?

llx_element_element

jonbendtsen · March 17, 2024, 6:33pm

Please prove me wrong

I no longer think this is possible to link an invoice object using the API to update an existing invoice because it seems like this function:

github.com

Dolibarr/dolibarr/blob/develop/htdocs/core/class/commonobject.class.php#L3983


      
          	/**
          	 *	Add an object link into llx_element_element.
          	 *
          	 *	@param		string	$origin		Linked element type
          	 *	@param		int		$origin_id	Linked element id
          	 * 	@param		User	$f_user		User that create
          	 * 	@param		int		$notrigger	1=Does not execute triggers, 0=execute triggers
          	 *	@return		int					Return integer <=0 if KO, >0 if OK
          	 *	@see		fetchObjectLinked(), updateObjectLinked(), deleteObjectLinked()
          	 */
          	public function add_object_linked($origin = null, $origin_id = null, $f_user = null, $notrigger = 0)
          	{
          		// phpcs:enable
          		global $user, $hookmanager, $action;
          		$origin = (!empty($origin) ? $origin : $this->origin);
          		$origin_id = (!empty($origin_id) ? $origin_id : $this->origin_id);
          		$f_user = isset($f_user) ? $f_user : $user;
          
          		// Special case
          		if ($origin == 'order') {
          			$origin = 'commande';

is the function used to link objects and it is only mentioned in 2 create public functions in

450:	public function create(User $user, $notrigger = 0, $forceduedate = 0)
735:							$ret = $this->add_object_linked($origin, $origin_id);
743:						$ret = $this->add_object_linked($origin, $origin_id);
1128:	public function createFromCurrent(User $user, $invertdetail = 0)
1204:					$facture->add_object_linked($typeObject, $fk_object);
1208:			$facture->add_object_linked('facture', $this->fk_facture_source);
1222:	public function createFromClone(User $user, $fromid = 0)

github.com

Dolibarr/dolibarr/blob/develop/htdocs/compta/facture/class/facture.class.php#L450


      
          	/**
          	 *	Create invoice in database.
          	 *  Note: this->ref can be set or empty. If empty, we will use "(PROV999)"
          	 *  Note: this->fac_rec must be set to create invoice from a recurring invoice
          	 *
          	 *	@param	User	$user      		Object user that create
          	 *	@param  int		$notrigger		1=Does not execute triggers, 0 otherwise
          	 * 	@param	int		$forceduedate	If set, do not recalculate due date from payment condition but force it with value
          	 *	@return	int						Return integer <0 if KO, >0 if OK
          	 */
          	public function create(User $user, $notrigger = 0, $forceduedate = 0)
          	{
          		global $langs, $conf, $mysoc, $hookmanager;
          		$error = 0;
          
          		// Clean parameters
          		if (empty($this->type)) {
          			$this->type = self::TYPE_STANDARD;
          		}
          
          		$this->ref_client = trim($this->ref_client);

jonbendtsen · March 17, 2024, 10:03pm

I ended up extending htdocs/adherents/class/subscription.class.php

with this code

				// Add object linked
				if (!$error && $this->id && !empty($this->linked_objects) && is_array($this->linked_objects)) {
					foreach ($this->linked_objects as $origin => $tmp_origin_id) {
						if (is_array($tmp_origin_id)) {       // New behaviour, if linked_object can have several links per type, so is something like array('contract'=>array(id1, id2, ...))
							foreach ($tmp_origin_id as $origin_id) {
								$ret = $this->add_object_linked($origin, $origin_id);
								if (!$ret) {
									$this->error = $this->db->lasterror();
									$error++;
								}
							}
						} else { // Old behaviour, if linked_object has only one link per type, so is something like array('contract'=>id1))
							$origin_id = $tmp_origin_id;
							$ret = $this->add_object_linked($origin, $origin_id);
							if (!$ret) {
								$this->error = $this->db->lasterror();
								$error++;
							}
						}
					}
				}

from htdocs/fourn/class/fournisseur.facture-rec.class.php

The only change I did was some indentation

Afterwards, if posting this json to create a subscription it made the link that I needed

{
  "linkedObjectsIds": {
    "facture": "6"  
  },
  "note_public": "api Contribution 2024",
  "datec": 1710699079,
  "datem": 1710699079,
  "dateh": 1710509000,
  "datef": 1744999200,
  "fk_type": "1",
  "fk_adherent": "1",
  "amount": "100.00000000"
}

Will submit a pull request