API d'approbations (/approbations)

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

Éléments

Il s'agit des éléments disponibles pour l'API des approbations

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.