• Dernière modification le: 30 August 2022

API des contrats (/contract)

Utilisez l'API des contrats pour créer, mettre à jour ou interroger un contrat, y compris les entités professionnelles concernées, les dates clés, le statut du contrat et les conditions financières.

Utilisez l'API des contrats pour créer, mettre à jour ou interroger un contrat, y compris les entités professionnelles concernées, les dates clés, le statut du contrat et les conditions financières.

L'URL pour accéder aux contrats est : https://{your_instance_name}/api/contracts

Consultez la rubrique Bonnes pratiques d'intégration pour plus d'informations.

wiki.tree()

Actions

Verbe Chemin d'accès Action Description
METTRE /api/contracts/:id/add_approver ajouter_approbateur Ajouter manuellement un approbateur pour un contrat
METTRE /api/contracts/:id/ccc_signature_created ccc_signature_créée Indique qu'une signature a été ajoutée dans CCC.
METTRE /api/contracts/:id/complete terminé Fait passer le contrat à l'état Terminé.
POSTE /api/contracts créer Créer un contrat
POSTE /api/contracts/:id/create_published créer_publié /api/contracts/:id/create_published
OBTENIR /api/contracts index Demander des contrats
POSTE /api/contracts/:id/legal_agreement accord_juridique Ajouter ou mettre à jour le fichier legal_agreement
METTRE /api/contracts/:id/legal_agreement accord_juridique Ajouter ou mettre à jour le fichier legal_agreement
METTRE /api/contracts/:id/remove_approval supprimer_approbation Supprimer un approbateur ajouté manuellement
OBTENIR /api/contracts/:id/retrieve_legal_agreement accord_juridique_de_récupération Obtenir le fichier legal_agreement
OBTENIR /api/contracts/:id montrer Afficher le contrat
METTRE /api/contracts/:id/submit_for_approval soumettre_pour_approbation Soumet le contrat pour approbation.
METTRE /api/contracts/:id mettre à jour Actualiser le contrat
METTRE /api/contracts/:id/update_published mise à jour_publiée Met à jour un contrat lors de sa publication.*
METTRE /api/contracts/:id/withdraw_signatures retirer_signatures Met le contrat au statut correspondant après un retrait de signatures CCC.

* La mise à jourdes contrats terminésoupubliés(directement, sans créer de brouillon) nécessite quel'option Activer la hiérarchiedescontrats soit activée dans les paramètres de votre entreprise (Configuration > Informationssur l'entreprise ). Si vous ne disposez pas de la norme CLM , vous pouvez utiliser lesrévisionsde contrat .

Éléments

Élément Description Demande d'achat Unique Valeur autorisée Dans Sortie Type de données
type-contrat-amendé Type de contrat modifié       oui oui string(255)
prolonger-auto-date-de-fin-pour-renouvellement Mettre à jour automatiquement la date d'expiration       oui oui booléen
consentement Avis de consentement     avis, consentement, non_requis, non_cessible oui oui string(255)
groupes de contenu Groupes commerciaux       oui oui Groupe commercial
titulaire du contrat Propriétaire du contrat       oui oui Utilisateur
conditions du contrat conditions_du_contrat       oui oui Conditions du contrat
type de contrat Étiquette personnalisée pour la catégorisation no no tout oui oui
champ-personnalisé-de-type-de-contrat-1 Champ personnalisé du type de contrat 1 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-2 Champ personnalisé du type de contrat 2 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-3 Champ personnalisé du type de contrat 3 no no tout oui oui string(255)
champ-personnalisé-type-de-contrat-4 Champ personnalisé du type de contrat 4 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-5 Champ personnalisé du type de contrat 5 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-6 Champ personnalisé du type de contrat 6 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-7 Champ personnalisé du type de contrat 7 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-8 Champ personnalisé du type de contrat 8 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-9 Champ personnalisé du type de contrat 9 no no tout oui oui string(255)
champ-personnalisé-de-type-de-contrat-10 Champ personnalisé du type de contrat 10 no no tout oui oui string(255)
créé à Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ         oui datetime
créé par Créateur         oui Utilisateur
devise Code de devise du contrat       oui oui Devise
approbation en cours Approbation actuelle         oui Approbation
compte par défaut compte_par_défaut       oui oui Compte
département Département du propriétaire no no tout oui oui Département 
description Notes descriptives sur le contrat false false tout oui oui string(1024)
diversité-catégories Catégories de diversité des fournisseurs         oui chaîne
date de fin Date d'expiration no     oui oui datetime
date d'exécution Date à laquelle le contrat est terminé et juridiquement contraignant no no tout oui oui datetime
id Identifiant Coupa unique         oui entier
est-par défaut Compte par défaut associé aux factures fournisseur       oui oui booléen
url-accord-juridique URL facultative pour l'accord juridique       oui oui string(255)
unité de durée de préavis Unité de durée du préavis (jours/mois/années)     jours, mois, années oui oui string(255)
valeur-de-préavis Valeur de la durée du préavis       oui oui string(255)
bloqué par un tiers Partie au contrat CLMS détenant un verrou de modification no no   oui   chaîne
verrouillé par id-utilisateur Utilisateur CLMS verrouillé en mode édition no no   oui   entier
contrat cadre Numéro ou nom du contrat maître       oui oui Contrat
max-commit Montant d'engagement maximal       oui oui décimal(32,4)
valeur maximale Montant d'engagement maximal       oui oui décimal(32,4)
min-commit Montant d'engagement minimum       oui oui décimal(32,4)
valeur minimale Montant d'engagement minimum       oui oui décimal(32,4)
Nom Nom du contrat oui oui   oui oui string(100)
non-renouvellement Nb de renouvellements oui   Les valeurs autorisées incluent désormais ["1..100"] oui oui entier
numéro Numéro de contrat oui oui   oui oui string(50)
fenêtre-commande-tz fenêtre_commande_tz     Un fuseau horaire valide oui oui string(255)
parent Parent       oui oui Contrat
délai de paiement Code des conditions de paiement du contrat       oui oui Modalités de paiement 
po-message Fenêtres de commandes - Message des commandes       oui oui string(255)
préféré Indiquer le contrat préféré pour le fournisseur       oui oui booléen
id-fournisseur-proxy Identifiant d'un fournisseur proxy     tout oui oui entier
date de publication Date de publication du contrat no no tout oui oui datetime
id_réponse_devis ID de la réponse au devis         oui entier
demande-risque-ra Demande de risque réel         oui DemandeRisqueRa 
événements-insights-de-la-raison Événements Insight de motif oui     oui oui Événement Reason Insight
unité-longueur-de-renouvellement Unité de la durée du renouvellement (jours/mois/années) oui   jours, mois, années oui oui string(255)
valeur-longueur-de-renouvellement Valeur de la durée du renouvellement oui     oui oui entier
message-demande Fenêtres de commandes - Message des demandes       oui oui string(255)
id-utilisateur-réviseur Évaluateurs internes CLMS no no   oui   entier
pourcentage d'économies Économies réalisées grâce à la tarification des contrats       oui oui décimal(20,2)
calendrier calendrier       oui oui Fenêtre de commande 
condition d'expédition Code des conditions d'expédition du contrat       oui oui Conditions d'expédition 
id_source ID source de la création du contrat       oui oui sting(255)
type de source Type d'origine de la création du contrat       oui oui string(255)
date de début Date de début       oui oui datetime
statut Statut du contrat oui     oui oui Brouillon
règles-strictes-de-facturation Règles strictes de facturation       oui oui booléen
stop-spend-based-on-max-value Arrêter les dépenses en fonction de la valeur maximale no no oui, non oui oui string(255)
déposant Utilisateur ayant soumis le contrat pour approbation         oui Utilisateur
Fournisseur Nom du fournisseur oui     oui oui Fournisseur 
compte-fournisseur Numéro de compte fournisseur       oui oui string(255)
facturable par le fournisseur Le fournisseur peut facturer directement       oui oui booléen
marquage Etiquetages no no   oui oui API de marquage
étiquettes Balises no no   oui oui API de balise
terme-type Type de terme     fixe, renouvellement_automatique, perpétuel oui oui string(255)
terminé Résilié       oui oui booléen
préavis de résiliation Préavis de résiliation     oui, non oui oui string(255)
unité-longueur-préavis-de-terminaison Longueur de l'avis de résiliation (jours/mois/années)     jours, mois, années oui oui string(255)
valeur-longueur-préavis-terminaison Valeur de la longueur de préavis de résiliation       oui oui entier
conditions conditions       oui oui texte
type Type de contrat     ContratMaître, ModificationContrat   oui chaîne
mis à jour à Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ         oui datetime
mis à jour par Utilisateur ayant réalisé la mise à jour         oui Utilisateur
fenêtres de commandes Utiliser les fenêtres de commande       oui oui booléen
d'occasion Utilisé pour l'achat       oui oui booléen
version version       oui oui entier
stop-spend-based-on-max-value Arrêter les dépenses en fonction de la valeur maximale no no oui, non oui oui string(255)
id_contrat_externe Identifiant de contrat externe no no   oui oui string(255)
dont_papier Auteur no no non_spécifié, notre_papier, papier_contrepartie oui oui entier
litige_contractuel   no no   oui oui  
propriété_intellectuelle_et_données   no no   oui oui  
compte_fournisseur_design   no no   oui oui  
clauses_contrats   no no   oui oui []
utiliser_signature_en_ligne Exige des signatures électroniques no no     oui booléen
classification_des_contrats Classification du contrat no no   oui oui  
détail_contrat Détail du contrat no no   oui oui  
conteneur_parties_contrat Conteneur de champ des parties au contrat no no   oui oui  
conditions_et_renouvellement_du_contrat Modalités et renouvellement du contrat no no   oui oui  
résiliation_contrat Résiliation du contrat no no   oui oui  
performance_contrat Performances du contrat no no   oui oui  
prix_et_paiement_contrat Prix et paiement du contrat no no   oui oui  
relation_contractuelle_et_reporting Relations contractuelles et reporting no no   oui oui  
Remarque
  • Lorsque vous traitez de grands ensembles de contrats, limitez toujours votre GET à certains critères.
  • Les groupes de contenu et les catégories doivent déjà exister dans le système.

Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.

Articles associés


L'API Coupa Core

Notre API RESTful fournit un accès robuste pour lire, modifier ou intégrer vos données à la plate-forme Coupa.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : Données de référence, données transactionnelles et ressources partagées.

Ressources de données de référence

Les données de référence sont utilisées pour configurer les composants de base de Coupa tels que les utilisateurs, les fournisseurs, les comptes, et plus encore.

Ressources transactionnelles

Au fur et à mesure que les gens utilisent Coupa, des données transactionnelles telles que des demandes, des bons de commande et des factures sont créées.