API des contrats (/contrats)
Utilisez l'API des contrats pour créer, mettre à jour ou interroger un contrat, y compris les groupes d'entreprises concernés, les dates clés, l'état du contrat et les conditions financières.
Aperçu
Utilisez l'API des contrats pour créer, mettre à jour ou interroger un contrat, y compris les groupes d'entreprises concernés, les dates clés, l'état du contrat et les conditions financières.
L'URL pour accéder aux contrats est : https ://{your_instance_name}/api/
contracts
Voir les meilleures pratiques d'intégration pour plus d'informations.
Objets enfants
- Exemples d'appels d'API de contrat
- API de classification du contrat
- API de la clause contractuelle
- API de référence de la clause contractuelle
- API des détails du contrat
- API du litige contractuel
- API du partenaire contractuel
- API du contact de la partie contractante
- API du modèle de contrat (/contracts/templates)
- API des conditions du contrat
- API des types de contrats
- API de subdivision de pays
- Propriété intellectuelle et API de données
- API Reason Insights
- API Reason Insights Events
Actions
Verbe | Chemin d'accès | Action | Description |
---|---|---|---|
METTRE | /api/contracts/:id/add_approver |
add_approver | Ajouter manuellement un approbateur pour un contrat |
METTRE | /api/contracts/:id/ccc_signature_created |
ccc_signature_created | Notifie qu'une signature a été ajoutée dans CCC. |
METTRE | /api/contracts/:id/complete |
terminé | Déplace le contrat à l'état terminé. |
PUBLIER | /API/contrats |
créer | Créer un contrat |
PUBLIER | /api/contracts/:id/create_published |
create_published | /api/contracts/:id/create_published |
OBTENIR | /API/contrats |
index | Demander les contrats |
PUBLIER | /api/contracts/:id/legal_agreement |
legal_agreement | Ajouter ou mettre à jour le fichier legal_agreement |
METTRE | /api/contracts/:id/legal_agreement |
legal_agreement | Ajouter ou mettre à jour le fichier legal_agreement |
METTRE | /api/contracts/:id/remove_approval |
remove_approval | Supprimer un approbateur ajouté manuellement |
OBTENIR | /api/contracts/:id/retrieve_legal_agreement |
retrieve_legal_agreement | Obtenir le fichier legal legal_agreement |
OBTENIR | /api/contracts/:id |
afficher | Afficher le contrat |
METTRE | /api/contracts/:id/submit_for_approval |
submit_for_approval | Soumet le contrat pour approbation. |
METTRE | /api/contracts/:id |
mettre à jour | Actualiser le contrat |
METTRE | /api/contracts/:id/update_published |
update_published | Met à jour un contrat lorsqu'il est publié.* |
METTRE | /api/contracts/:id/withdraw_signatures |
withdraw_signatures | Déplace le contrat au statut correspondant après le retrait des signatures de la CCC. |
* La mise à jour des contrats terminés ou publiés (directement, sans créer de brouillon) nécessite que l'option Activer la hiérarchie des contrats soit activée dans les paramètres de votre entreprise (Configurer les informations sur l'>entreprise). Si vous n'avez pas la norme CLM, vous pouvez travailler avec des révisions de contrat.
Éléments
Élément | Description | Dem. | Unique | Valeur autorisée | Dans | Sortie | Type de données |
---|---|---|---|---|---|---|---|
type-contrat-amendé | Type de contrat modifié | oui | oui | string(255) | |||
auto-extend-end-date-for-renewal | Mettre à jour automatiquement la date d'expiration | oui | oui | boolean | |||
consentement | Préavis de consentement | avis, consentement, not_required, not_assignable | oui | oui | string(255) | ||
content-groups | Groupes commerciaux | oui | oui | Groupe d'entreprise | |||
souscripteur | Responsable du contrat | oui | oui | Utilisateur | |||
termes du contrat | contract_terms | oui | oui | Conditions du contrat | |||
type-de-contrat | Étiquette personnalisée pour la catégorisation | non | non | tout | oui | oui | |
contract-type-custom-field-1 | Champ personnalisé 1 du type de contrat | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-2 | Champ personnalisé 2 du type de contrat | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-3 | Champ personnalisé 3 du type de contrat | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-4 | Champ personnalisé du type de contrat 4 | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-5 | Champ personnalisé du type de contrat 5 | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-6 | Champ personnalisé du type de contrat 6 | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-7 | Champ personnalisé du type de contrat 7 | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-8 | Champ personnalisé du type de contrat 8 | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-9 | Champ personnalisé du type de contrat 9 | non | non | tout | oui | oui | string(255) |
contract-type-custom-field-10 | Champ personnalisé du type de contrat 10 | non | non | tout | oui | oui | string(255) |
created-at | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
créé par | Utilisateur qui a créé | oui | Utilisateur | ||||
devise | Code de la devise du contrat | oui | oui | Devise | |||
approbation-actuelle | Approbation actuelle | oui | Approbation | ||||
approbations-parallèles-actuelles | Approbations parallèles actuelles | oui | Approbation | ||||
default-account | default_account | oui | oui | Compte | |||
département | Département du propriétaire | non | non | tout | oui | oui | Département |
description | Notes descriptives sur le contrat | false | false | any | oui | oui | string(1024) |
diversity-categories | Catégories de diversité des fournisseurs | oui | chaîne | ||||
date de fin | Date d'expiration | non | oui | oui | datetime | ||
date d'exécution | Date à laquelle le contrat est terminé et juridiquement contraignant | non | non | tout | oui | oui | datetime |
iD | Identifiant unique Coupa | oui | nombre entier | ||||
is-default | Compte par défaut associé à la facture du fournisseur | oui | oui | boolean | |||
legal-agreement-url | URL facultative pour l'accord juridique | oui | oui | string(255) | |||
durée-de-la-notification-unité | Unité de durée de l'avis(jours/mois/années) | jours, mois, années | oui | oui | string(255) | ||
durée-de-valeur-de-notification | Valeur de la durée du préavis | oui | oui | string(255) | |||
verrouillé-par-autre-partie | Partie contractuelle CLMS détenant un verrou d'édition | non | non | oui | chaîne | ||
verrouillé-par-id utilisateur | Utilisateur CLMS tenant un verrou d'édition | non | non | oui | nombre entier | ||
contrat-cadre | Numéro ou nom du contrat principal | oui | oui | Contrat | |||
max-commit | Montant d'engagement maximum | oui | oui | décimale(32,4) | |||
valeur maximale | Montant d'engagement maximum | oui | oui | décimale(32,4) | |||
min-commit | Montant minimum d'engagement | oui | oui | décimale(32,4) | |||
valeur minimale | Montant minimum d'engagement | oui | oui | décimale(32,4) | |||
nom | Nom du contrat | oui | oui | oui | oui | string(100) | |
no-of-renewals | Nb de renouvellements | oui | Les valeurs admissibles comprennent maintenant ["1..100"] | oui | oui | nombre entier | |
numéro | Numéro du contrat | oui | oui | oui | oui | string(50) | |
order-window-tz | order_window_tz | Un fuseau horaire valide | oui | oui | string(255) | ||
parent | Parent | oui | oui | Contrat | |||
délai de paiement | Code modalité de paiement sur le contrat | oui | oui | Modalités de paiement | |||
po-message | Message concernant le BdC des Fenêtres de commande | oui | oui | string(255) | |||
préféré | Indiquer le contrat préféré pour le fournisseur | oui | oui | boolean | |||
proxy-supplier-id | Identifiant pour un fournisseur proxy | any | oui | oui | nombre entier | ||
date-de-publication | Date de publication du contrat | non | non | tout | oui | oui | datetime |
quote-response-id | ID de la réponse au devis | oui | nombre entier | ||||
ra-risk-request | Demande de risque Ra | oui | RaRiskRequest | ||||
reason-insight-events | Événements Reason Insight | oui | oui | oui | Événement Reason Insight | ||
renouvellement-longueur-unité | Unité de durée de renouvellement (jours/mois/années) | oui | jours, mois, années | oui | oui | string(255) | |
renewal-length-value | Valeur de la durée de renouvellement | oui | oui | oui | nombre entier | ||
demande-message | Fenêtres de commandes - Message des demandes | oui | oui | string(255) | |||
reviewer-user-ids | Réviseurs internes de CLMS | non | non | oui | nombre entier | ||
savings-pct | Économies réalisées grâce à la tarification des contrats | Un pourcentage entre 0 et 100 | oui | oui | décimale(20,2) | ||
calendrier | calendrier | oui | oui | Fenêtre de commande | |||
délai d'expédition | Code du délai d'expédition sur le contrat | oui | oui | Condition d'expédition | |||
source-id | L'ID source de la création du contrat | oui | oui | piqûre(255) | |||
type de source | Le type de source de 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-de-facturation strictes | Règles de facturation strictes | oui | oui | boolean | |||
stop-spend-based-on-max-value | Arrêter les dépenses en fonction de la valeur maximale | non | non | oui, non | oui | oui | string(255) |
expéditeur | Utilisateur ayant soumis le contrat pour approbation | oui | Utilisateur | ||||
fournisseur | Nom du fournisseur | oui | oui | oui | Fournisseur | ||
compte-fournisseur | Numéro de compte du fournisseur | oui | oui | string(255) | |||
fournisseur-facturable | Le fournisseur peut directement facturer | oui | oui | boolean | |||
étiquetages | Etiquetages | non | non | oui | oui | API de balisage | |
étiquettes | Étiquettes | non | non | oui | oui | API d'étiquette | |
term-type | Type des conditions | fixe, auto_renew, perpétuel | oui | oui | string(255) | ||
terminé | Résilié | oui | oui | boolean | |||
avis-de-résiliation | Avis de cessation | oui, non | oui | oui | string(255) | ||
unité-longueur-avis-de-résiliation | Longueur de l'avis de résiliation (jours/mois/années) | jours, mois, années | oui | oui | string(255) | ||
valeur-longueur-avis-de-résiliation | Valeur de la longueur de l'avis de résiliation | oui | oui | nombre entier | |||
conditions | modalité | oui | oui | texte | |||
type | Type de contrat | MasterContract, AmendmentContract | 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 | ||||
use-order-windows | Utiliser les fenêtres de commande | oui | oui | boolean | |||
utilisé pour l'achat | Utilisé lors de l'achat | oui | oui | boolean | |||
version | version | oui | oui | nombre entier | |||
stop-spend-based-on-max-value | Arrêter les dépenses en fonction de la valeur maximale | non | non | oui, non | oui | oui | string(255) |
external_contract_id | Identifiant de contrat externe | non | non | oui | oui | string(255) | |
remplir-avec-contrepartie | Remplir avec la contrepartie | oui | oui | boolean | |||
dont_papier | Auteur | non | non | not_specified, our_paper, counterparty_paper | oui | oui | nombre entier |
contract_dispute | non | non | oui | oui | |||
intellectual_property_and_data | non | non | oui | oui | |||
esign_provider_account | non | non | oui | oui | |||
contract_clauses | non | non | oui | oui | [] | ||
use_online_signing | Exige des signatures électroniques | non | non | oui | boolean | ||
contract_classification | Classification du contrat | non | non | oui | oui | ||
contract_detail | Détail du contrat | non | non | oui | oui | ||
contract_parties_field_container | Conteneur de champ des parties contractantes | non | non | oui | oui | ||
contract_terms_and_renewal | Conditions du contrat et renouvellement | non | non | oui | oui | ||
contract_termination | Résiliation du contrat | non | non | oui | oui | ||
contract_performance | Exécution du contrat | non | non | oui | oui | ||
contract_price_and_payment | Prix du contrat et paiement | non | non | oui | oui | ||
contract_relationship_and_reporting | Relation contractuelle et reporting | non | non | oui | oui |
- Lorsque vous traitez avec de grands ensembles de données de contrats, limitez toujours votre GET avec certains critères.
- Les groupes et catégories de contenu doivent déjà exister dans le système.