API d'approbations (/approbations)
Utilisez l'API d'approbation pour créer, mettre à jour ou interroger l'approbation d'un document.
Utilisez l'API d'approbation pour créer, mettre à jour ou interroger l'approbation d'un document. Cela inclut des points de terminaison spécifiques pour prendre des mesures (rejeter/mettre en attente/approuver) ainsi que des détails de demande tels que le demandeur, les articles de ligne et les détails d'expédition.
L'URL pour accéder à l'API d'approbation est : https://<instance>/api/approvals/<approval id>
Consultez la rubrique Bonnes pratiques d'intégration pour plus d'informations.
Actions
Verbe | Chemin d'accès | Action | Description |
---|---|---|---|
METTRE | /api/approvals/:id/approve |
approuver | Effectuer une action d'approbation sur une approbation |
METTRE | /api/approvals/:id/hold |
mettre en attente | Effectuer une action de mise en attente sur une approbation |
OBTENIR | /api/approvals |
index | Demander les approbations |
METTRE | /api/approvals/:id/reject |
rejeter | Effectuer une action de rejet sur une approbation |
OBTENIR | /api/approvals/:id |
montrer | Afficher approbation |
METTRE | /api/approvals/:id |
mettre à jour | Actualiser approbation |
Éléments
Il s'agit des éléments disponibles pour l'API des approbations
Nom de champ | Description du champ | Demande d'achat | Unique ? | Valeurs autorisées | Dans | Sortie | Type |
---|---|---|---|---|---|---|---|
approbable-id | ID du document qui a été approuvé | oui | entier | ||||
type homologué | Type de document qui a été approuvé (demande, bon de commande, etc.) | oui | string(255) | ||||
id de la chaîne d'approbation | ID de la chaîne d'approbation dans laquelle se trouve cette approbation | oui | entier | ||||
date d'approbation | Date de l'approbation | oui | datetime | ||||
approuvé par | Nom d'utilisateur qui a effectué l'approbation | oui | Utilisateur | ||||
approbateur | approbateur | oui | Utilisateur, groupe d'approbation | ||||
créé à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ | oui | datetime | ||||
créé par | Créateur | oui | Utilisateur | ||||
délégué | délégué | oui | Utilisateur, groupe d'approbation | ||||
id_délégué | ID du délégué qui a effectué l'approbation (le cas échéant) | oui | entier | ||||
délégués | Délégués | oui | Approbation du délégué | ||||
titulaire | Maintenir ou non l'approbation | oui | booléen | ||||
id | Identifiant Coupa unique | oui | entier | ||||
remarque | Motif de l'approbation ou du rejet | oui | texte | ||||
position | Position dans la chaîne d'approbation de cette approbation | oui | entier | ||||
motifs | Motifs | oui | Motif d'approbation | ||||
statut | Statut de l'approbation (approuvée, remontée, rejetée, etc.) | oui | string(50) | ||||
type | Mode d'approbation (remplacer l'approbation, approbation de la chaîne d'approbation, etc.) | oui | string(255) | ||||
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 |
Exemple
Dans cet exemple, nous avons demandé une approbation unique avec l'ID 12622. Nous avons accédé à l'URL :
https://<instance url>/api/approvals/12622
Approbations - Réponse GET
<?xml version="1.0" encoding="UTF-8"?>
<approval>
<id type="integer">12622</id>
<created-at type="datetime">2012-02-15T14:56:22-08:00</created-at>
<updated-at type="datetime">2012-04-23T11:49:25-07:00</updated-at>
<position type="integer">1</position>
<approval-chain-id nil="true" />
<status>approved</status>
<approval-date type="datetime">2012-02-15T14:56:59-08:00</approval-date>
<note />
<type>ManagementHierarchyApproval</type>
<approvable-type>RequisitionHeader</approvable-type>
<approvable-id type="integer">2696</approvable-id>
<approver>
<id type="integer">3</id>
<login>vpierre</login>
<email>upgrade+vp@coupa.com</email>
<employee-number />
<firstname>Victor (CFO)</firstname>
<lastname>Pierre</lastname>
<salesforce-id nil="true" />
</approver>
<created-by>
<id type="integer">9</id>
<login>bjenkins</login>
<email>upgrade+bj@coupa.com</email>
<employee-number />
<firstname>Bob (VP Procurement)</firstname>
<lastname>Jenkins</lastname>
<salesforce-id nil="true" />
</created-by>
<updated-by>
<id type="integer">17</id>
<login>coupa_metrics_gatherer</login>
<email>do_not_reply_metrics@coupa.com</email>
<employee-number nil="true" />
<firstname>Coupa</firstname>
<lastname>Metrics</lastname>
<salesforce-id nil="true" />
</updated-by>
</approval>
Approbation ou rejet
La section suivante décrit comment utiliser l'API Coupa pour effectuer des actions sur les approbations.
Approbation
/api/approvals/{id}/approve
Rejet
/api/approvals/{id}/reject
Ajout du motif
Dans les deux cas, une approbation doit être en attente (et pas encore approuvée ou rejetée) pour que l'action soit valide. Il est également possible de fournir un "motif" pour le rejet via la demande XML directement. For example, to reject an approval by id of 12612 and provide a reason of "Rejected by Integration", you would use the following request :
PUT https://{instance url}/api/approvals/12612/reject?reason=Rejected%20by%20Integration
Les demandes réussies seront renvoyées HTTP 200 Response
. Le corps de la réponse inclura la demande créée. Les demandes infructueuses seront renvoyées HTTP 400 Bad Request
. Le corps de la réponse inclut les erreurs de validation au format XML.
Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.