Skip to main content

 

 

Coupa Success Portal

Approvals API

Use the approvals API to create, update, or query the approval of a document. This includes specific endpoints to take action (reject/hold/approve) as well as requisition details like requestor, line items, and shipping details.

The URL to access account validation rules is: https://<instance>/api/approvals/<approval id>

See Integration Best Practices for more info.

Actions

Verb Path Action Description
PATCH|PUT /api/approvals/:id/approve approve Perform Approve action on an approval
POST /api/approvals create Create approval
PATCH|PUT /api/approvals/:id/hold hold Perform Hold action on an approval
GET /api/approvals index Query approvals
PATCH|PUT /api/approvals/:id/reject reject Perform Reject action on an approval
GET /api/approvals/:id show Show approval
PATCH /api/approvals/:id update Update approval
PUT /api/approvals/:id update Update approval

Elements

These are the elements available for the Approvals API:

Element Description Type API In API Out Required Length Allowable Values
approvable-id approvable_id integer   yes      
approvable-type approvable_type string   yes      
approval-chain-id approval_chain_id integer   yes      
approval-date approved_date datetime   yes      
approved-by approved_by user   yes      
approved-instead-by approved_instead_by     yes      
approver approver     yes      
created-at

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

datetime   yes      
created-by User who created user   yes      
delegate-id delegate_id integer   yes      
id Coupa unique identifier integer   yes      
note note text   yes      
position position integer   yes      
status transaction status string   yes      
type type string   yes      
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   yes      
updated-by user who updated user   yes      
  • Was this article helpful?