Skip to main content

 

 

Coupa Success Portal

Requisitions API

The URL to access requisitions is: https://{your_instance_name}/api/requisitions

See Integration Best Practices for more info.

Actions

Requisitions API allows you to:

Verb Path Action Description
PUT /api/requisitions/:id/add_approver add_approver Manually add an approver for a requisition
POST /api/requisitions create Create a requisition in draft status, which will then need to be submitted manually
GET|POST /api/requisitions/new/create_as_cart create_as_cart Create a requisition in draft status, which will then need to be submitted manually
GET /api/requisitions index Query requisitions
PUT /api/requisitions/:id/remove_approval remove_approval Remove an approver who was manually added
GET /api/requisitions/:id show Show requisition
POST /api/requisitions/submit_for_approval submit_for_approval Create a requisition and attempt to submit it for approval / buyer action
GET|POST /api/requisitions/new/submit_for_approval submit_for_approval Create a requisition and attempt to submit it for approval / buyer action
PATCH /api/requisitions/:id update Update requisition
PUT /api/requisitions/:id update Update requisition

Elements

 Requisitions API:

Element Description Type API In API Out Required Length Allowable Values
approvals approvals integer   Yes No -  
approver approver User Yes   No -  
attachments attachments integer   Yes No -  
buyer-note Any comments or notes from the Buyer text Yes Yes No -  
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   Yes No -  
created-by

User who created

This value defaults from the API User key, but it can be overridden by the Requisition API. 

Contact your CSM or Coupa Support to allow the Requisition API to override the API User key value.

User Yes Yes No -  
currency Currency Code integer   Yes No -  
current-approval current_approval integer   Yes No -  
default-currency default_currency integer   Yes No -  
department Requisition Department Department Yes Yes No -  
exported? Indicates if transaction has been exported integer   Yes No -  
id Coupa unique identifier integer   Yes No -  
justification Requisition Justification Comments text Yes Yes No -  
need-by-date Item Need By Date datetime Yes Yes No -  
pcard Name of Pcard Pcard Yes Yes No -  
price-hidden Hide price from supplier. True or False boolean   Yes Yes    
reject-reason-comment reject_reason_comment integer   Yes No -  
requested-by requested_by User Yes Yes Yes -  
requisition-lines requisition_lines RequisitionLine Yes Yes Yes -  
RequisitionAmountLine supplier_site_id integer   No     Any
RequisitionLine supplier_site_id integer   No     Any
ship-to-address Name of Address Address Yes Yes Yes -  
ship-to-attention Ship to Address Attention string Yes Yes No -  
status transaction status string   Yes Yes -  
submitted-at submitted_at datetime   Yes No -  
total total integer   Yes No -  
total-in-own-currency total_in_own_currency integer   Yes No -  
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   Yes No -  
updated-by User who updated integer   Yes No -  
  • In a requisition-line, you can use either a description (free-form) or an item (catalog item).  If an item id is used, the item must exist.  The <source-type></source-type> is not used and ignored.
  • For the api to recognize custom fields, they must be set as api editable in the setup. 
  • Currencies, users in the requested-by and suppliers must be in the system with a status of active. 
  • Item:  If a preferred supplier and price is available for an item it will be used unless the unit-price is specified.  If a unit-price is specified, it will override the default pricing available for the item.  While it is not an error to specify a description and an item, using an item will set the description to the item description, ignoring the passed in description field.
  • Defaulting:  Unless otherwise specified in the XML, the system will respect the relevant defaulting within the system.  Such as defaulting payment and shipping terms from the supplier record.
  • Line Numbering:  The API expects the line-num to increment by one for each new line number.  If you use the same line-num, the system will ignore all other lines with the same number.

 

  • Was this article helpful?