API PA - Mise à jour du statut

Pour mettre à jour le statut d'un PA, veuillez utiliser l'API suivante, notamment dans le cadre d'une post-action.

Cette API permet de :

• garantir la traçabilité de l'action ;
• vérifier la faisabilité du changement de statut ;
• déclencher l'événement permettant de mettre effectivement à jour le statut sur le PA.

def update_status(
    usession,
    entity,
    newstatusid: int,
    tfqn=None,
    vrsid=None,
    pa_entity_id=None,
    remote=True,
    pa_tstamp=None,
    motifid=0
) -> tuple[int, str, int]:

L'entité à mettre à jour peut être identifiée de deux façons.

Utiliser :

tfqn = nom_de_la_table
vrsid = identifiant_auto_increment

Il est également possible de fournir directement l'identifiant auto-incrémenté de l'entité dans :

• paachat pour un achat ;
• pavente pour une vente.

Pour une mise à jour effectuée localement, utilisez toujours :

remote=False

La valeur remote=True est réservée aux statuts reçus du PA.

Ne renseignez pas le paramètre pa_tstamp.

L'API utilisera automatiquement la date et l'heure courantes.

Dans cet exemple, l'achat passe au statut principal 210 avec le motif 21002.

import common
import pa_common
 
vses = common.dbses()
 
retcode, reterror, retlogid = pa_common.update_status(
    vses,
    "achat",
    210,
    tfqn="ez_facture_fournisseur",
    vrsid=345,
    remote=False,
    motifid=21002
)
 
vses.db.disconnect()

L'API retourne un tuple de trois valeurs :

(retcode, reterror, retlogid)

0, "ok", 15487

Dans cet exemple :

• 0 indique que l'opération a réussi ;
• “ok” indique qu'aucune erreur n'a été rencontrée ;
• 15487 est l'identifiant du log de traçabilité.

-5, "mise a jour de statut impossible pour ce statut : deja en cours de synchronisation", 0

Dans cet exemple, la mise à jour n'a pas été effectuée car le PA est déjà en cours de synchronisation.