Third parties - Changing "Customer Code" [code_client] via API isn't possible

kreideholer · October 29, 2024, 7:29am

Hi everyone,
I am currently trying to synchronize the customer numbers of linked third party objects to the membership number in the membership module. I would like to use the API for this, as almost a hundred entries need to be adjusted.

Unfortunately, setting a changed value for the “Customer Code” [key code_client] does not work as expected. The “Customer Code” remains unchanged despite the successful API call. For debugging purposes, I also set the third party alias with the new value for the customer number. That works.
Dolibarr Version is 20.0.1

API-Request:

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'DOLAPIKEY: abc' -d '{ \ 
   "name_alias": "MEM2406-0002", \ 
   "code_client": "MEM2406-0002" \ 
 }' 'https://www.dolliurl.tld/api/index.php/thirdparties/10'

Response Body

{
  "module": "societe",
  "id": "10",
[...]
  "name_alias": "MEM2406-0002",
[...]
  "code_client": "CU2410-00001",   // the original value remains
[...]
  "absolute_creditnote": "0"
}

Response Code

200

Am I overlooking a configuration that needs to be set so that the value for code_client can be changed via API?

I am grateful for any advice and help.

best regards
Marcel

hansem · October 29, 2024, 1:46pm

Hi,

at the moment it doesn’t seem possible.

This is only possible if $allowmodcodeclient parameter is set to true in the update function

github.com

Dolibarr/dolibarr/blob/10fe6f1f9f6eb8f93f868d8c0aba7ba3268199ba/htdocs/societe/class/societe.class.php#L1425


      
          	 *
          	 *      @param	int		$id              			Id of company (deprecated, use 0 here and call update on an object loaded by a fetch)
          	 *      @param  User	$user            			User who requests the update
          	 *      @param  int		$call_trigger    			0=no, 1=yes
          	 *		@param	int		$allowmodcodeclient			Inclut modif code client et code compta
          	 *		@param	int		$allowmodcodefournisseur	Inclut modif code fournisseur et code compta fournisseur
          	 *		@param	string	$action						'add' or 'update' or 'merge'
          	 *		@param	int		$nosyncmember				Do not synchronize info of linked member
          	 *      @return int  			           			Return integer <0 if KO, >=0 if OK
          	 */
          	public function update($id, User $user, $call_trigger = 1, $allowmodcodeclient = 0, $allowmodcodefournisseur = 0, $action = 'update', $nosyncmember = 1)
          	{
          		global $langs, $conf, $hookmanager;
          
          		require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
          
          		if (empty($id)) {
          			$id = $this->id;
          		}
          
          		$error = 0;

And there is no way to specify this parameter with a API call

github.com

Dolibarr/dolibarr/blob/10fe6f1f9f6eb8f93f868d8c0aba7ba3268199ba/htdocs/societe/class/api_thirdparties.class.php#L345


      
          				}
          				continue;
          			}
          			$this->company->$field = $this->_checkValForAPI($field, $value, $this->company);
          		}
          
          		if (isModEnabled('mailing') && !empty($this->company->email) && isset($this->company->no_email)) {
          			$this->company->setNoEmail($this->company->no_email);
          		}
          
          		if ($this->company->update($id, DolibarrApiAccess::$user, 1, '', '', 'update', 1) > 0) {
          			return $this->get($id);
          		} else {
          			throw new RestException(500, $this->company->error);
          		}
          	}
          
          	/**
          	 * Merge a third party into another one.
          	 *
          	 * Merge content (properties, notes) and objects (like invoices, events, orders, proposals, ...) of a thirdparty into a target third party,

kreideholer · October 29, 2024, 2:41pm

Hi @hansem,
thank you for the explanation and the reference to the specific lines of code.
It is possible to change the customer number easily via the web front end. Changed entries are validated according to system specifications, see screenshot.

Am I right in assuming that the parameter $allowmodcodeclient = 0 applies to all update calls apart from the direct change in the Third-party web frontend?
Is there a technical or organizational reason why a modification to the “client code” cannot be initiated via API call? I assume that validation is also carried out here, as in the web frontend.

kreideholer · October 29, 2024, 10:16pm

I just found this issue documented on github (obviously did a bad job of searching beforehand ) :
“Unable to modify client_code through thirdparties rest API · Issue #30432 · Dolibarr/dolibarr · GitHub”

According to eldy’s comment: “No reason to not being able to edit customer code from api, surely a bug…”

What’s wrong with setting the two parameters $allowmodcodeclient and $allowmodcodefournisseur to “1” by default in api_thirdparties.class.php? This also was suggested in “REST api thirdparties update does ignore code_compta field · Issue #18146 · Dolibarr/dolibarr · GitHub”
Since the third-party object already exists as the API update-call is sent, it should not have any influence on the auto-generation of code_client or code_compta.

To verify the behavior, I adjusted the named line in api_thirdparties.class.php. The fourth parameter was set to 1.

if ($this->company->update($id, DolibarrApiAccess::$user, 1, 1, ‘’, ‘update’, 1) 0) {

After that, changing an existing “Customer Code” via API worked as expected.

kreideholer · November 6, 2024, 11:32am

Fixed, see solved issue #30432 in github