Share via


Coupa (Independent Publisher) (Preview)

Coupa P2P connector — 162 operations. No Authentication — Bearer token passed via Access-Token header, rewritten to Authorization by policy. Dynamic host via connection parameter.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name NovaGL
URL https://www.coupa.com
Email gl1@live.com
Connector Metadata
Publisher NovaGL
Website https://www.coupa.com
Privacy policy https://www.coupa.com/privacy-policy
Categories Commerce

Coupa P2P Connector

Publisher: NovaGL
Version: 1.8.15
Operations: 152
Entities: 33

A Power Automate custom connector for the Coupa Procurement & Accounts Payable API. Covers purchase orders, invoices, requisitions, contracts, sourcing, suppliers, and more.


Prerequisites

  • A Coupa instance with API access enabled
  • An OAuth2 client configured in Coupa under Setup → OAuth2/OpenID Connect Clients
  • The client must use the client_credentials grant type
  • Appropriate OAuth2 scopes granted to the client

Authentication

This connector uses No Authentication with a policy rewrite — the confirmed community workaround for injecting a dynamic Bearer token in Power Automate custom connectors.

How It Works

Every action exposes an Access Token header field. A connector policy rewrites this into the real Authorization header before the request reaches Coupa:

Flow passes:     Access-Token: Bearer eyJ...
Policy rewrites: Authorization: Bearer eyJ...
Coupa receives:  Authorization: Bearer eyJ...

This works because the platform only blocks adding Authorization as a parameter directly — it does not block a policy from setting it based on another header value.

Getting a Bearer Token

Use the standard Power Automate HTTP action at the top of each flow to obtain a token from Coupa's OAuth2 endpoint:

Method:  POST
URI:     https://{instance}.{domain}/oauth2/token
Headers: Content-Type: application/x-www-form-urlencoded
Body:    grant_type=client_credentials
         &client_id={your-client-id}
         &client_secret={your-client-secret}
         &scope={your-scopes}

Connection Setup

When creating a connection provide two fields:

Field Description
Coupa Instance Name Subdomain only — e.g. mycompany-test (not the full URL)
Coupa Domain coupahost.com (standard) or coupacloud.com

Flow Pattern

Every flow should follow this pattern:

Step 1 — HTTP action to get token (see above)

Step 2 — Initialize Variable

Field Value
Name token
Type String
Value concat('Bearer ', body('HTTP')?['access_token'])

Step 3 — Connector action — pass @{variables('token')} in the Access Token field of every connector action

Token Expiry

Tokens expire after approximately 1 hour. Always fetch a fresh token at the start of each flow run — never cache tokens between runs.

Request only the scopes your flows need:

Scope Access
core.purchase_order.read Read purchase orders
core.purchase_order.write Create/update purchase orders
core.invoice.read Read invoices
core.invoice.write Create/update invoices
core.requisition.read Read requisitions
core.requisition.write Create/update requisitions
core.contract.read Read contracts
core.contract.write Create/update contracts
core.supplier.read Read suppliers
core.supplier.write Update suppliers
core.user.read Read users
core.common.read Read common data (accounts, addresses, etc.)
core.sourcing.read Read sourcing events
core.sourcing.write Create/update sourcing events
core.inventory.read Read inventory
core.budget.read Read budget lines
core.approval.read Read approvals
core.receiving.read Read receiving transactions
core.receiving.write Create receiving transactions
core.order_pad.read Read order lists
core.order_pad.write Create/update order lists

Example Flow — Get the Most Recent Purchase Order

Step 1 — HTTP (get token)

Field Value
Method POST
URI https://mycompany-test.coupahost.com/oauth2/token
Headers Content-Type: application/x-www-form-urlencoded
Body grant_type=client_credentials&client_id=xxx&client_secret=xxx&scope=core.purchase_order.read

Step 2 — Initialize Variable

Field Value
Name token
Type String
Value concat('Bearer ', body('HTTP')?['access_token'])

Step 3 — Purchase Order: Get All

Field Value
Access Token @{variables('token')}
Limit 1
Order By created-at
Direction desc

Step 4 — Use the result

first(body('Purchase_Order_Get_All'))
first(body('Purchase_Order_Get_All'))?['po-number']
first(body('Purchase_Order_Get_All'))?['id']

Operations

Account (2)

Action Description
Account: Get All Retrieve all accounts
Account: Get by ID Retrieve a single account by ID

Address (2)

Action Description
Address: Get All Retrieve all addresses
Address: Get by ID Retrieve a single address by ID

Approval (2)

Action Description
Approval: Get All Retrieve all approvals
Approval: Get by ID Retrieve a single approval by ID

Budget Line (2)

Action Description
Budget Line: Get All Retrieve all budget lines
Budget Line: Get by ID Retrieve a single budget line by ID

Commodity (2)

Action Description
Commodity: Get All Retrieve all commodities
Commodity: Get by ID Retrieve a single commodity by ID

Contract (13)

Action Description
Contract: Get All Retrieve all contracts
Contract: Get by ID Retrieve a single contract by ID
Contract: Get Terms Retrieve all terms for a contract
Contract: Get Term by ID Retrieve a specific contract term by ID
Contract: Create Term Add a new term to a contract
Contract: Update Term Update an existing contract term
Contract: Get Attachments Retrieve all attachments on a contract
Contract: Post Attachment (Text or URL) Add a text or URL attachment to a contract
Contract: Add Approver Manually add an approver to a contract
Contract: Remove Approver Remove a manually added approver from a contract
Contract: Submit for Approval Submit a contract for approval
Contract: Complete Move a contract to the completed state
Contract: Create and Publish Create and publish a contract

Data Source (1)

Action Description
Data Source: Get All Retrieve all data file sources

Exchange Rate (2)

Action Description
Exchange Rate: Get All Retrieve all exchange rates
Exchange Rate: Get by ID Retrieve a single exchange rate by ID

Integration Run (2)

Action Description
Integration Run: Get All Retrieve all integration runs
Integration Run: Get by ID Retrieve a single integration run by ID

Inventory (2)

Action Description
Inventory: Get All Retrieve all inventory records
Inventory: Get by ID Retrieve a single inventory record by ID

Inventory Transaction (2)

Action Description
Inventory Transaction: Get All Retrieve all inventory transactions
Inventory Transaction: Get by ID Retrieve a single inventory transaction by ID

Invoice (25)

Action Description
Invoice: Get All Retrieve all invoices
Invoice: Get by ID Retrieve a single invoice by ID
Invoice: Update (Partial) Partially update an invoice (PATCH)
Invoice: Update (Full) Fully update an invoice (PUT)
Invoice: Delete Delete an invoice
Invoice: Get Attachments Retrieve all attachments on an invoice
Invoice: Post Attachment (Text or URL) Add a text or URL attachment to an invoice
Invoice: Get Comments Retrieve all comments on an invoice
Invoice: Post Comment Add a comment to an invoice
Invoice: Abandon Abandon an invoice
Invoice: Add Approver Manually add an approver to an invoice
Invoice: Bypass Approvals Bypass the full approval workflow
Invoice: Bypass Current Approval Bypass only the current approval step
Invoice: Dispute Dispute an invoice
Invoice: Withdraw Dispute Withdraw a dispute on an invoice
Invoice: Flip to Advance Ship Notice Convert an invoice to an advance ship notice
Invoice: Remove Approver Remove a manually added approver
Invoice: Restart Approvals Restart the approval workflow
Invoice: Revalidate Tolerances Revalidate tolerance checks
Invoice: Submit for Approval Submit an invoice for approval
Invoice: Update Line Accounts Update account coding on invoice lines
Invoice: Void Void an invoice
Invoice: Download Clearance Doc Download the clearance document
Invoice: Download Image Scan Download the image scan
Invoice: Download Legal Invoice PDF Download the legal invoice PDF

Item (2)

Action Description
Item: Get All Retrieve all items
Item: Get by ID Retrieve a single item by ID

Lookup (2)

Action Description
Lookup: Get All Retrieve all lookups
Lookup: Get by ID Retrieve a single lookup by ID

Lookup Value (4)

Action Description
Lookup Value: Get All Retrieve all lookup values
Lookup Value: Get by ID Retrieve a single lookup value by ID
Lookup Value: Create Create a new lookup value
Lookup Value: Update Update an existing lookup value

Order List (4)

Action Description
Order List: Get All Retrieve all order lists
Order List: Get by ID Retrieve a single order list by ID
Order List: Create Create a new order list
Order List: Update Update an existing order list

Order List Line (4)

Action Description
Order List Line: Get All Retrieve all order list lines
Order List Line: Get by ID Retrieve a single order list line by ID
Order List Line: Create Create a new order list line
Order List Line: Update Update an existing order list line

Payment Term (2)

Action Description
Payment Term: Get All Retrieve all payment terms
Payment Term: Get by ID Retrieve a single payment term by ID

PO Change (5)

Action Description
PO Change: Get All Retrieve all purchase order changes
PO Change: Get by ID Retrieve a single PO change by ID
PO Change: Add Approver Manually add an approver to a PO change
PO Change: Remove Approver Remove a manually added approver
PO Change: Submit for Approval Submit a PO change for approval

PO Line (8)

Action Description
PO Line: Get All Retrieve all purchase order lines
PO Line: Get by ID Retrieve a single PO line by ID
PO Line: Get Attachments Retrieve all attachments on a PO line
PO Line: Post Attachment (Text or URL) Add a text or URL attachment to a PO line
PO Line: Reopen for Invoicing Reopen a PO line for invoicing
PO Line: Reopen for Receiving Reopen a PO line for receiving
PO Line: Soft Close for Invoicing Soft close a PO line for invoicing
PO Line: Soft Close for Receiving Soft close a PO line for receiving

Purchase Order (11)

Action Description
Purchase Order: Get All Retrieve all purchase orders
Purchase Order: Get by ID Retrieve a single purchase order by ID
Purchase Order: Get Attachments Retrieve all attachments on a purchase order
Purchase Order: Post Attachment (Text or URL) Add a text or URL attachment to a purchase order
Purchase Order: Get Comments Retrieve all comments on a purchase order
Purchase Order: Post Comment Add a comment to a purchase order
Purchase Order: Cancel Cancel a purchase order
Purchase Order: Close Close a purchase order
Purchase Order: Issue Issue a purchase order to the supplier
Purchase Order: Release from Buyer Hold Release a purchase order from buyer hold
Purchase Order: Reopen Reopen a closed purchase order

Receipt Request (2)

Action Description
Receipt Request: Get All Retrieve all receipt requests
Receipt Request: Get by ID Retrieve a single receipt request by ID

Receiving Transaction (4)

Action Description
Receiving Transaction: Get All Retrieve all receiving transactions
Receiving Transaction: Get by ID Retrieve a single receiving transaction by ID
Receiving Transaction: Get Attachments Retrieve all attachments on a receiving transaction
Receiving Transaction: Post Attachment (Text or URL) Add a text or URL attachment to a receiving transaction

Requisition (13)

Action Description
Requisition: Get All Retrieve all requisitions
Requisition: Get by ID Retrieve a single requisition by ID
Requisition: Get Attachments Retrieve all attachments on a requisition
Requisition: Post Attachment (Text or URL) Add a text or URL attachment to a requisition
Requisition: Get Comments Retrieve all comments on a requisition
Requisition: Post Comment Add a comment to a requisition
Requisition: Get Mine Retrieve requisitions belonging to the authenticated user
Requisition: Get Current Cart Retrieve the current shopping cart
Requisition: Add to Cart (Free Text) Add a free-text line item to the current cart
Requisition: Add Approver Manually add an approver to a requisition
Requisition: Remove Approver Remove a manually added approver
Requisition: Create and Submit Create a requisition and submit for approval
Requisition: Update and Submit Update a requisition and submit for approval

Requisition Line (2)

Action Description
Requisition Line: Get Attachments Retrieve all attachments on a requisition line
Requisition Line: Post Attachment (Text or URL) Add a text or URL attachment to a requisition line

Sourcing (13)

Action Description
Sourcing: Get Quote Requests Retrieve all quote requests
Sourcing: Get Quote Request by ID Retrieve a single quote request by ID
Sourcing: Create Quote Request Create a new quote request
Sourcing: Update Quote Request Update an existing quote request
Sourcing: Get Quote Request Attachments Retrieve attachments on a quote request
Sourcing: Post Quote Request Attachment (Text or URL) Add a text or URL attachment to a quote request
Sourcing: Get Quote Response by ID Retrieve a single quote response by ID
Sourcing: Get All Quote Responses Retrieve all quote responses across all events
Sourcing: Get All Quote Responses (incl. Drafts) Retrieve all quote responses including drafts
Sourcing: Get Quote Responses for Event Retrieve quote responses for a specific event
Sourcing: Get Quote Responses for Event (All) Retrieve all quote responses for a specific event including drafts
Sourcing: Award Quote Response Award a quote response to a supplier
Sourcing: Remove Quote Response Award Remove an award from a quote response

Supplier (3)

Action Description
Supplier: Get All Retrieve all suppliers
Supplier: Get by ID Retrieve a single supplier by ID
Supplier: Update Update an existing supplier

Supplier Information (2)

Action Description
Supplier Information: Get All Retrieve all supplier information records
Supplier Information: Get by ID Retrieve a single supplier information record by ID

Supplier Item (6)

Action Description
Supplier Item: Get All Retrieve all supplier items
Supplier Item: Get by ID Retrieve a single supplier item by ID
Supplier Item: Get by Item Retrieve supplier items for a specific item
Supplier Item: Get by Item and ID Retrieve a specific supplier item for a specific item
Supplier Item: Create Create a new supplier item
Supplier Item: Update Update an existing supplier item

UOM (2)

Action Description
UOM: Get All Retrieve all units of measure
UOM: Get by ID Retrieve a single unit of measure by ID

User (2)

Action Description
User: Get All Retrieve all users
User: Get by ID Retrieve a single user by ID

User Group (2)

Action Description
User Group: Get All Retrieve all user groups
User Group: Get by ID Retrieve a single user group by ID

User Group Membership (2)

Action Description
User Group Membership: Get All Retrieve all user group memberships
User Group Membership: Get by ID Retrieve a single user group membership by ID

Known Limitations

File Uploads Not Supported

File attachment uploads (multipart/form-data) are not supported in Power Automate custom connectors. To upload files to Coupa attachments, use the standard HTTP action directly with multipart encoding.

Token Management

The connector does not handle token refresh automatically. Tokens expire after approximately 1 hour. Always fetch a fresh token using the HTTP action at the start of each flow run.

Numeric Fields Returned as Strings

Coupa returns monetary and quantity values (totals, prices, amounts) as strings rather than numbers — e.g. "1250.00" not 1250.00. This is a known Coupa quirk. Account for this when using these values in calculations within your flow.

Boolean Fields

Some Coupa boolean fields are returned as "true"/"false" strings rather than actual booleans. Use equals(field, 'true') rather than direct boolean comparison in flow conditions.

Independent Publisher OAuth2 Limitation

Power Automate does not support the OAuth2 client credentials grant type for independent publisher connectors. The Access-Token header pattern used by this connector is the established community workaround.


Filtering and Pagination

All Get All operations support these standard parameters:

Parameter Description
Limit Maximum records to return (max 50 per call)
Offset Records to skip — use for pagination
Order By Field name to sort by e.g. created-at
Direction Sort direction: asc or desc
Updated After Return records updated after this ISO 8601 date — ideal for polling/delta flows
Updated Before Return records updated before this ISO 8601 date
Created After Return records created after this ISO 8601 date
Return Object Response depth: limited, shallow, or omit for full

Pagination Pattern

Do Until (no more results):
  Purchase Order: Get All
    Limit:  50
    Offset: @{variables('offset')}
  
  Append to array variable: @{body('Purchase_Order_Get_All')}
  
  Increment offset by 50
  
  Condition: length(body('Purchase_Order_Get_All')) is less than 50

Delta / Polling Pattern

Purchase Order: Get All
  Updated After: @{addHours(utcNow(), -1)}
  Order By:      updated-at
  Direction:     desc

Version History

Version Changes
1.8.15 Added descriptions to 738 responses, 739 definition properties, and 1 missing parameter
1.8.14 Fixed ContractTerm.id type; cleaned up operationIds (CompleteContract, SubmitContractForApproval)
1.8.13 Added ContractTerm definition; fixed Contract Terms schemas
1.8.12 Removed Invoice image scan multipart op; full nested schema audit
1.8.11 Fixed 13 wrong response schemas on nested paths (Supplier Item, Order List Line, Sourcing, Contract Terms)
1.8.10 Removed undocumented supplier_items/search endpoint
1.8.9 Stripped all leaf type constraints from definitions — no more type validation on responses
1.8.8 Fixed 36 missing parameter summaries and descriptions
1.8.7 Removed all 9 multipart file upload operations (platform limitation)
1.8.6 Fixed non-ID integers and date-time nullable; comprehensive type audit
1.8.5 Fixed number (no format) and boolean type fields
1.8.4 Converted all number/double fields to string (Coupa returns monetary values as strings)
1.8.3 Fixed inline schemas; added missing definitions (InventoryRecord, InventoryTransaction, ReceiptRequest, DataFileSource); fixed attachment/comment $refs
1.8.2 Fixed 4 inline object schemas in integration runs, data sources, and requisition comments
1.8.1 Added descriptions to 27 operations missing them
1.8.0 Set all 162 operations to important visibility
1.7.9 Stripped all type constraints from definition properties
1.7.8 Removed all response schemas to prevent type validation errors
1.7.7 Fixed response type enforcement errors
1.7.6 Fixed parameter visibility — important/advanced/internal correctly applied
1.7.5 Fixed summary inconsistencies; moved Item supplier ops to Supplier Item group
1.7.4 Fixed Requisition: Get Mine and Add to Cart summaries
1.7.3 Replaced prefix abbreviations with full entity names in all summaries
1.7.2 Set Get All operations to important visibility
1.7.1 Removed all x-ms-trigger: batch flags — Get All ops were hidden as triggers
1.7.0 Full rebuild from v1.3.0 base — Access-Token auth, full summaries, operationIds, attachments, comments
1.3.0 Original base file

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Coupa Instance Name string Coupa instance subdomain only — e.g. mycompany-test True
Coupa Domain string Select your Coupa domain True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Account: Get All

Get Accounts. Requires OAuth scope: core.common.read

Account: Get by ID

Get Account by ID. Requires OAuth scope: core.common.read

Address: Get All

Get Addresses. Requires OAuth scope: core.common.read

Address: Get by ID

Get Address by ID. Requires OAuth scope: core.common.read

Approval: Get All

Get Approvals. Requires OAuth scope: core.approval.read

Approval: Get by ID

Get Approval by ID. Requires OAuth scope: core.approval.read

Budget Line: Get All

Get Budget Lines. Requires OAuth scope: core.budget.read

Budget Line: Get by ID

Get Budget Line by ID. Requires OAuth scope: core.budget.read

Commodity: Get All

Get Commodities. Requires OAuth scope: core.common.read

Commodity: Get by ID

Get Commodity by ID. Requires OAuth scope: core.common.read

Contract: Add Approver

Manually add an approver for a contract

Contract: Complete

Moves the contract to the completed state.

Contract: Create and Publish

Create and publish a contract

Contract: Create Term

Create contract term

Contract: Get All

Get Contracts. Requires OAuth scope: core.contract.read

Contract: Get Attachments

Retrieve all attachments on a Contract record.

Contract: Get by ID

Get Contract by ID. Requires OAuth scope: core.contract.read

Contract: Get Term by ID

Show contract term

Contract: Get Terms

Query contract terms

Contract: Post Attachment (Text or URL)

Add a text or URL attachment to a Contract record. Set intent to Internal or Supplier.

Contract: Remove Approver

Remove an approver who was manually added

Contract: Submit for Approval

Submits the contract for approval.

Contract: Update Term

Update contract term

Data Source: Get All

Query Data Sources

Exchange Rate: Get All

Query FX exchange rates.

Exchange Rate: Get by ID

Get a single exchange rate.

Integration Run: Get All

Query Integration Runs

Integration Run: Get by ID

Retreive a Integration by its ID

Inventory Transaction: Get All

Get Inventory Transactions. Requires appropriate OAuth scope.

Inventory Transaction: Get by ID

Get Inventory Transaction by ID. Requires appropriate OAuth scope.

Inventory: Get All

Get Inventory. Requires appropriate OAuth scope.

Inventory: Get by ID

Get Inventory by ID. Requires appropriate OAuth scope.

Invoice: Abandon

Abandon invoice

Invoice: Add Approver

Manually add an approver for an invoice

Invoice: Bypass Approvals

Bypass approvals

Invoice: Bypass Current Approval

Bypass current approval

Invoice: Delete

Delete Invoice in New status

Invoice: Dispute

Dispute invoice

Invoice: Download Clearance Doc

Retrieve/Download clearance document

Invoice: Download Image Scan

Retrieve/Download image scan

Invoice: Download Legal Invoice PDF

Retrieve/Download legal invoice pdf

Invoice: Flip to Advance Ship Notice

Flip invoice to Advance Ship Notice

Invoice: Get All

Query Invoice headers. Use return_object=shallow to embed invoice-lines. Note: /invoice_lines has NO standalone Coupa endpoint.

Invoice: Get Attachments

Retrieve all attachments on a Invoice record.

Invoice: Get by ID

Get a single Invoice. Use return_object=shallow to include embedded invoice-lines.

Invoice: Get Comments

Get comments for an Invoice.

Invoice: Post Attachment (Text or URL)

Add a text or URL attachment to a Invoice record. Set intent to Internal or Supplier.

Invoice: Post Comment

Add a comment to a Invoice record. Use to-supplier to control visibility.

Invoice: Remove Approver

Remove an approver who was manually added

Invoice: Restart Approvals

Restart approvals

Invoice: Revalidate Tolerances

Revalidate tolerances

Invoice: Submit for Approval

Submit draft invoice for approval

Invoice: Update (Full)

Update invoice

Invoice: Update (Partial)

Update invoice

Invoice: Update Line Accounts

Update line accounts

Invoice: Void

Void an approved invoice

Invoice: Withdraw Dispute

Withdraw dispute

Item: Get All

Get Items. Requires OAuth scope: core.item.read

Item: Get by ID

Get Item by ID. Requires OAuth scope: core.item.read

Lookup Value: Create

Create a new Lookup Value. Requires OAuth scope core.common.write

Lookup Value: Get All

Get Lookup Values. Requires OAuth scope: core.common.read

Lookup Value: Get by ID

Get Lookup Value by ID. Requires OAuth scope: core.common.read

Lookup Value: Update

Update an existing Lookup Value. Requires OAuth scope core.common.write

Lookup: Get All

Get Lookups. Requires OAuth scope: core.common.read

Lookup: Get by ID

Get Lookup by ID. Requires OAuth scope: core.common.read

Order List Line: Create

Create an Order List Line. Requires OAuth scope: core.order_pad.write

Order List Line: Get All

Get Order List Lines. Requires OAuth scope: core.order_pad.read

Order List Line: Get by ID

Get Order List Line by ID. Requires OAuth scope: core.order_pad.read

Order List Line: Update

Update an Order List Line. Requires OAuth scope: core.order_pad.write

Order List: Create

Create an Order List. Requires OAuth scope: core.order_pad.write

Order List: Get All

Get Order Lists. Requires OAuth scope: core.order_pad.read

Order List: Get by ID

Get Order List by ID. Requires OAuth scope: core.order_pad.read

Order List: Update

Update an Order List. Requires OAuth scope: core.order_pad.write

Payment Term: Get All

Query payment terms reference data.

Payment Term: Get by ID

Get a single payment term.

PO Change: Add Approver

Purchase Order Changes - Manually add an approver

PO Change: Get All

Get Purchase Order Changes. Requires OAuth scope: core.purchase_order.read

PO Change: Get by ID

Get Purchase Order Change by ID. Requires OAuth scope: core.purchase_order.read

PO Change: Remove Approver

Purchase Order Changes - Remove an approver who was manually added

PO Change: Submit for Approval

Purchase Order Changes - Submit Purchase Order for Approval

PO Line: Get All

Get all purchase order lines across all POs. Supports filtering by supplier part number and other fields. Requires OAuth scope: core.purchase_order.read

PO Line: Get Attachments

Retrieve all attachments on a PO Line record.

PO Line: Get by ID

Get a specific purchase order line by its Coupa ID. Requires OAuth scope: core.purchase_order.read

PO Line: Post Attachment (Text or URL)

Add a text or URL attachment to a PO Line record. Set intent to Internal or Supplier.

PO Line: Reopen for Invoicing

Reopen for invoicing

PO Line: Reopen for Receiving

Reopen for receiving

PO Line: Soft Close for Invoicing

Soft close for invoicing

PO Line: Soft Close for Receiving

Soft close for receiving

Purchase Order: Cancel

Cancel a purchase order. Requires OAuth scope: core.purchase_order.write

Purchase Order: Close

Close a purchase order. Requires OAuth scope: core.purchase_order.write

Purchase Order: Get All

Get Purchase Orders. Requires OAuth scope: core.purchase_order.read

Purchase Order: Get Attachments

Retrieve all attachments on a Purchase Order record.

Purchase Order: Get by ID

Get Purchase Order by ID. Requires OAuth scope: core.purchase_order.read

Purchase Order: Get Comments

Get comments for a PO.

Purchase Order: Issue

Issue a purchase order, sending it to the supplier. Requires OAuth scope: core.purchase_order.write

Purchase Order: Post Attachment (Text or URL)

Add a text or URL attachment to a Purchase Order record. Set intent to Internal or Supplier.

Purchase Order: Post Comment

POST a comment on PurchaseOrder

Purchase Order: Release from Buyer Hold

Release purchase order on buyer hold

Purchase Order: Reopen

Reopen a previously closed purchase order. Requires OAuth scope: core.purchase_order.write

Receipt Request: Get All

Returns a list of receipt requests. Requires scope: core.receiving.read

Receipt Request: Get by ID

Returns a single receipt request by ID. Requires scope: core.receiving.read

Receiving Transaction: Get All

Get Receiving Transactions. Requires OAuth scope: core.receiving.read

Receiving Transaction: Get Attachments

Retrieve all attachments on a Receiving Transaction record.

Receiving Transaction: Get by ID

Get Receiving Transaction by ID. Requires OAuth scope: core.receiving.read

Receiving Transaction: Post Attachment (Text or URL)

Add a text or URL attachment to a Receiving Transaction record. Set intent to Internal or Supplier.

Requisition Line: Get Attachments

Retrieve all attachments on a Requisition Line record.

Requisition Line: Post Attachment (Text or URL)

Add a text or URL attachment to a Requisition Line record. Set intent to Internal or Supplier.

Requisition: Add Approver

Manually add an approver for a requisition

Requisition: Add to Cart (Free Text)

Add a free text requistion to the cart

Requisition: Create and Submit

Create a requisition and attempt to submit it for approval

Requisition: Get All

Get Requisitions. Requires OAuth scope: core.requisition.read

Requisition: Get Attachments

Retrieve all attachments on a Requisition record.

Requisition: Get by ID

Get Requisition by ID. Requires OAuth scope: core.requisition.read

Requisition: Get Comments

Retrieve all comments on a Requisition record.

Requisition: Get Current Cart

Send current cart for user

Requisition: Get Mine

Requistions - Query My Requistions

Requisition: Post Attachment (Text or URL)

Add a text or URL attachment to a Requisition record. Set intent to Internal or Supplier.

Requisition: Post Comment

Add a comment to a Requisition record. Use to-supplier to control visibility.

Requisition: Remove Approver

Remove an approver who was manually added

Requisition: Update and Submit

Update requisition and submit for approval

Sourcing: Award Quote Response

Award a supplier response. Optionally specify line IDs to award individual lines; omit body to award all lines at once. Requires OAuth scope: core.sourcing.write

Sourcing: Create Quote Request

Create a new sourcing event (RFP, RFI, or RFQ). Requires OAuth scope: core.sourcing.write

Sourcing: Get All Quote Responses

Get the most recent submitted responses across all sourcing events. Requires OAuth scope: core.sourcing.read

Sourcing: Get All Quote Responses (incl. Drafts)

Retrieves all responses across all sourcing events, including submitted and draft versions. Requires OAuth scope: core.sourcing.read

Sourcing: Get Quote Request Attachments

Get Quote Request Attachments on a Sourcing record in Coupa.

Sourcing: Get Quote Request by ID

Get a sourcing event by ID. Requires OAuth scope: core.sourcing.read

Sourcing: Get Quote Requests

Get sourcing events (quote requests). Requires OAuth scope: core.sourcing.read

Sourcing: Get Quote Response by ID

Get information about a specific quote response. Requires OAuth scope: core.sourcing.read

Sourcing: Get Quote Responses for Event

Retrieves the most recent submitted response per supplier for a specific sourcing event. Requires OAuth scope: core.sourcing.read

Sourcing: Get Quote Responses for Event (All)

Retrieves all responses for a specific sourcing event, including submitted and draft versions. Requires OAuth scope: core.sourcing.read

Sourcing: Post Quote Request Attachment (Text or URL)

Post Quote Request Attachment (Text or URL) on a Sourcing record in Coupa.

Sourcing: Remove Quote Response Award

Removes the award designation from a quote response. Requires OAuth scope: core.sourcing.write

Sourcing: Update Quote Request

Update a sourcing event. Requires OAuth scope: core.sourcing.write

Supplier Information: Get All

Get Supplier Information records (SIM). Requires SIM API permissions in Coupa.

Supplier Information: Get by ID

Get Supplier Information by ID (SIM). Requires SIM API permissions in Coupa.

Supplier Item: Create

Supplier Items - Create supplier item

Supplier Item: Get All

Query supplier items with contracted pricing.

Supplier Item: Get by ID

Get a single supplier item.

Supplier Item: Get by Item

Supplier Items - Query supplier items

Supplier Item: Get by Item and ID

Supplier Items - Show supplier item

Supplier Item: Update

Update supplier item

Supplier: Get All

Get Suppliers. Requires OAuth scope: core.supplier.read

Supplier: Get by ID

Get Supplier by ID. Requires OAuth scope: core.supplier.read

Supplier: Update

Update a supplier. Requires OAuth scope: core.supplier.write

UOM: Get All

Get UOMs. Requires OAuth scope: core.common.read

UOM: Get by ID

Get UOM by ID. Requires OAuth scope: core.common.read

User Group Membership: Get All

Get User Group Memberships. Requires OAuth scope: core.user_group.read

User Group Membership: Get by ID

Get User Group Membership by ID. Requires OAuth scope: core.user_group.read

User Group: Get All

Get User Groups. Requires OAuth scope: core.user_group.read

User Group: Get by ID

Get User Group by ID. Requires OAuth scope: core.user_group.read

User: Get All

Query Coupa users.

User: Get by ID

Get a single user.

Account: Get All

Get Accounts. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Code contains value
code[contains] string

Filter: Code contains value

Filter: Name contains value
name[contains] string

Filter: Name contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

response
array of Account

Account: Get by ID

Get Account by ID. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Account

Address: Get All

Get Addresses. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Filter: Location Code contains value
location-code[contains] string

Filter: Location Code contains value

Filter: City contains value
city[contains] string

Filter: City contains value

Filter: Postal Code contains value
postal-code[contains] string

Filter: Postal Code contains value

Filter: Country contains value
country[name][contains] string

Filter: Country contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

response
array of Address

Address: Get by ID

Get Address by ID. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Address

Approval: Get All

Get Approvals. Requires OAuth scope: core.approval.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Status in list
status[in] string

Filter by status. Comma-separated values: pending_approval, approved, rejected

Filter: Approver contains value
approver[login][contains] string

Filter: Approver contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Approval: Get by ID

Get Approval by ID. Requires OAuth scope: core.approval.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Approval

Budget Line: Get All

Get Budget Lines. Requires OAuth scope: core.budget.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Active
active boolean

Active

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Budget Line: Get by ID

Get Budget Line by ID. Requires OAuth scope: core.budget.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
BudgetLine

Commodity: Get All

Get Commodities. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Active
active boolean

Active

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Commodity: Get by ID

Get Commodity by ID. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Commodity

Contract: Add Approver

Manually add an approver for a contract

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Contract

Contract: Complete

Moves the contract to the completed state.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Contract

Contract: Create and Publish

Create and publish a contract

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Contract

Contract: Create Term

Create contract term

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Contract ID
contract_id True string

The Coupa ID of the parent Contract record.

Returns

Contract: Get All

Get Contracts. Requires OAuth scope: core.contract.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Status in list
status[in] string

Filter by status. Comma-separated values: draft, pending_approval, approved, expired, cancelled

Filter: Number contains value
number[contains] string

Filter: Number contains value

Filter: Name contains value
name[contains] string

Filter: Name contains value

Filter: Supplier contains value
supplier[name][contains] string

Filter: Supplier contains value

Filter: Start Date greater than value
start-date[gt] date-time

Filter: Start Date greater than value

Filter: End Date less than value
end-date[lt] date-time

Filter: End Date less than value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Supplier ID
supplier[id] string

Filter contracts by supplier Coupa ID

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Contract: Get Attachments

Retrieve all attachments on a Contract record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Contract: Get by ID

Get Contract by ID. Requires OAuth scope: core.contract.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Contract

Contract: Get Term by ID

Show contract term

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Contract ID
contract_id True string

The Coupa ID of the parent Contract record.

Record ID
id True integer

Resource numeric identifier.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Returns

Contract: Get Terms

Query contract terms

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Contract ID
contract_id True string

The Coupa ID of the parent Contract record.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Returns

Contract: Post Attachment (Text or URL)

Add a text or URL attachment to a Contract record. Set intent to Internal or Supplier.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

Contract: Remove Approver

Remove an approver who was manually added

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Contract

Contract: Submit for Approval

Submits the contract for approval.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Contract

Contract: Update Term

Update contract term

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Contract ID
contract_id True string

The Coupa ID of the parent Contract record.

Record ID
id True integer

Resource numeric identifier.

Returns

Data Source: Get All

Query Data Sources

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Data Source Filename
file-file-name string

Filename

File Progress
progress[in] string

Progress (either 0 or 1)

Direction
dir string

Sort direction asc or desc.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Returns

Exchange Rate: Get All

Query FX exchange rates.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: From Currency contains
from-currency[code][contains] string

Filter: From Currency contains value

Filter: To Currency contains
to-currency[code][contains] string

Filter: To Currency contains value

Filter: Rate Date after
rate-date[gt] date-time

Rate Date greater than (ISO 8601).

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Exchange Rate: Get by ID

Get a single exchange rate.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Integration Run: Get All

Query Integration Runs

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Direction
dir string

Sort direction asc or desc.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Returns

Integration Run: Get by ID

Retreive a Integration by its ID

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Direction
dir string

Sort direction asc or desc.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Record ID
id True integer

Resource numeric identifier.

Returns

Inventory Transaction: Get All

Get Inventory Transactions. Requires appropriate OAuth scope.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Returns

Inventory Transaction: Get by ID

Get Inventory Transaction by ID. Requires appropriate OAuth scope.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Inventory: Get All

Get Inventory. Requires appropriate OAuth scope.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Direction
dir string

Sort direction asc or desc.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Order By
order_by string

Sort by field name e.g., created-at.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Returns

Inventory: Get by ID

Get Inventory by ID. Requires appropriate OAuth scope.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Invoice: Abandon

Abandon invoice

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Add Approver

Manually add an approver for an invoice

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Bypass Approvals

Bypass approvals

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Bypass Current Approval

Bypass current approval

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Delete

Delete Invoice in New status

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Invoice

Invoice: Dispute

Dispute invoice

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Download Clearance Doc

Retrieve/Download clearance document

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Invoice

Invoice: Download Image Scan

Retrieve/Download image scan

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Body
Invoice

Retrieve/Download legal invoice pdf

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Flip to Advance Ship Notice

Flip invoice to Advance Ship Notice

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Get All

Query Invoice headers. Use return_object=shallow to embed invoice-lines. Note: /invoice_lines has NO standalone Coupa endpoint.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Status in list
status[in] string

Filter by invoice status. Multiple values supported (comma-separated).

Filter: Supplier contains value
supplier[name][contains] string

Filter: Supplier contains value

Filter: Invoice Number contains value
invoice-number[contains] string

Filter: Invoice Number contains value

Filter: PO Number contains value
po-number[contains] string

Filter invoices by PO number (partial match). Only returns invoices linked to a PO. Leave blank to retrieve all invoices regardless of PO association.

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Filter: Invoice Date greater than value
invoice-date[gt] date-time

Filter: Invoice Date greater than value

Invoice Date Before
invoice-date[lt] date-time

Return invoices with invoice date before this date (ISO 8601)

Supplier ID
supplier[id] string

Filter invoices by supplier Coupa ID

Amount Greater Than
amount[gt] number

Filter invoices with total amount greater than this value

Amount Less Than
amount[lt] number

Filter invoices with total amount less than this value

Invoice Line Supplier Part Number contains
invoice_lines[supplier_part_num][contains] string

Filter invoices where any invoice line has a supplier part number containing this value. Invoice lines have no standalone endpoint; use this to find invoices by line-level supplier part number.

Invoice Line Supplier Part Number (exact)
invoice_lines[supplier_part_num] string

Filter invoices where any invoice line has this exact supplier part number.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

response
array of Invoice

Invoice: Get Attachments

Retrieve all attachments on a Invoice record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Invoice: Get by ID

Get a single Invoice. Use return_object=shallow to include embedded invoice-lines.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Get Comments

Get comments for an Invoice.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

response
array of Comment

Invoice: Post Attachment (Text or URL)

Add a text or URL attachment to a Invoice record. Set intent to Internal or Supplier.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

Invoice: Post Comment

Add a comment to a Invoice record. Use to-supplier to control visibility.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Comment
comments True string

Comment text. Mention user with @[User:{id}]

Visible to Supplier
to-supplier boolean

Returns

Body
Comment

Invoice: Remove Approver

Remove an approver who was manually added

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Restart Approvals

Restart approvals

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Revalidate Tolerances

Revalidate tolerances

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Submit for Approval

Submit draft invoice for approval

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Update (Full)

Update invoice

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Update (Partial)

Update invoice

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Update Line Accounts

Update line accounts

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Void

Void an approved invoice

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Invoice: Withdraw Dispute

Withdraw dispute

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Coupa unique identifier

reason
reason

Reason

id
id

Coupa unique identifier

name
name

Name

advance-payment-received-amount
advance-payment-received-amount

Amount of advance payment received

amount-due
amount-due

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discount
amount-due-less-discount

Amount due after applying the discount

amount-of-advance-payment
amount-of-advance-payment

Amount Of Advance Payment

id
id

Coupa unique identifier

status
status

Current status of the record

approver-id
approver-id

Approver Id

approver-name
approver-name

Approver Name

position
position

Position

created-at
created-at

Record created timestamp

archive-entity-id
archive-entity-id

Archive Entity Id

id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

buyer-representative-name
buyer-representative-name

Buyer Representative Name

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

canceled
canceled

Indicates if transaction has been canceled

cash-accounting-scheme-reference
cash-accounting-scheme-reference

Note if using cash accounting scheme

cash-register-operator
cash-register-operator

Cash Register Operator

channel
channel

How the invoice was delivered to Coupa

clearance-document
clearance-document

Clearance document attachment file name. Accessible via /retrieve_clearance_document

comments
comments

comments

compliant
compliant

Invoice compliance indicator

confirmation
confirmation

Confirmation

content-validation
content-validation

Invoice Content Validation Indicator

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

correct-value-of-supply
correct-value-of-supply

Correct Value of Supply

coupa-accelerate-status
coupa-accelerate-status

Status indicating whether the invoice has discount payment terms via Static Discounting

created-at
created-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

credit-note-differences-with-original-invoice
credit-note-differences-with-original-invoice

Credit Note Differences With Original Invoice

credit-reason
credit-reason

The reason of creating the credit

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

currency-id
currency-id

Internal ID of the invoice currency

currency-tax-rounding-mode
currency-tax-rounding-mode

Currency Tax Rounding Method

id
id

Coupa unique identifier

status
status

Current status of the record

connector
connector

Connector

created-at
created-at

Record created timestamp

customer-account-number
customer-account-number

Customer Account Number

customer-accounting-tax
customer-accounting-tax

Customer accounting tax

customer-accounting-tax-less-discount
customer-accounting-tax-less-discount

Customer accounting tax after applying the discount

customs-declaration-date
customs-declaration-date

Customs Declaration Date

customs-declaration-number
customs-declaration-number

Customs Declaration Number

customs-office
customs-office

Customs Office

date-of-discovery-of-facts-decisive-for-correction
date-of-discovery-of-facts-decisive-for-correction

Date of Discovery of Facts Decisive for Correction

date-received
date-received

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-date
delivery-date

Date of Supply

delivery-number
delivery-number

Delivery Number

id
id

Coupa unique identifier

code
code

Code

name
name

Name

discount-amount
discount-amount

Discount Amount provided by supplier

discount-due-date
discount-due-date

Discount Due Date calculated based on the discount payment terms

discount-percent
discount-percent

Discount %

dispute-method
dispute-method

Dispute Method

id
id

Coupa unique identifier

reason
reason

Reason

document-type
document-type

Invoice or Credit Note

early-payment-provisions
early-payment-provisions

Early payment incentives (This field has been deprecated)

endorsement-on-invoices
endorsement-on-invoices

Endorsement On Invoices

exchange-rate
exchange-rate

Exchange Rate

exported
exported

Indicates if transaction has been exported

id
id

Coupa unique identifier

tolerance-type
tolerance-type

Tolerance Type

message
message

Message

folio-number
folio-number

Folio Number

form-of-payment
form-of-payment

Payment Form

freight-type
freight-type

Freight Type

gross-total
gross-total

Gross Total

gross-total-less-discount
gross-total-less-discount

Invoice total after applying the discount

handling-amount
handling-amount

Handling amount

id
id

Coupa unique identifier

image-scan
image-scan

Invoice Image Scan attachment filename

image-scan-content-type
image-scan-content-type

Content type of image scan

image-scan-file-name
image-scan-file-name

File name of the image scan

image-scan-file-size
image-scan-file-size

Size of image scan file in MB

image-scan-url
image-scan-url

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

id
id

Coupa unique identifier

status
status

Current status of the record

invoice-number
invoice-number

Invoice number

inbox-name
inbox-name

Inbox Name

internal-note
internal-note

Internal Note

id
id

Coupa unique identifier

description
description

Description

amount
amount

Amount

accounting-total
accounting-total

Accounting Total

line-num
line-num

Line number

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-date
invoice-date True

Date of Invoice

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

invoice-issuance-time
invoice-issuance-time

Invoice Issuance Time

id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

uom-name
uom-name

Uom Name

account-id
account-id

Account Id

account-code
account-code

Account code

order-line-id
order-line-id

Order Line Id

supplier-part-num
supplier-part-num

Supplier Part Num

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

invoice-number
invoice-number True

Invoice number

id
id

Coupa unique identifier

amount
amount

Amount

created-at
created-at

Record created timestamp

invoice-reference-number
invoice-reference-number

Invoice Reference Number (IRN)

is-credit-note
is-credit-note

Document Type Credit Note

is-ers-invoice
is-ers-invoice

Indicates if Invoice created against ERS Order

issuance-place
issuance-place

Issuance Place

last-exported-at
last-exported-at

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penalties
late-payment-penalties

Late Payment Penalties

id
id

Coupa unique identifier

code
code

Code

name
name

Name

line-count
line-count

Number of lines on this invoice

line-level-taxation
line-level-taxation True

Flag indicating whether taxes are provided at line level in this invoice

lock-version-key
lock-version-key

Lock Version

margin-scheme
margin-scheme

Reason for using margin scheme

means-of-payment
means-of-payment

Means Of Payment

misc-amount
misc-amount

Miscellaneous Amount

municipal-tax-number
municipal-tax-number

Municipality Tax ID Number

national-enrollment-of-conveyor
national-enrollment-of-conveyor

National Enrollment of Conveyor

nature-of-operation
nature-of-operation

Nature of Operation

net-due-date
net-due-date

Net Due Date calculated based on the net payment terms

net-total-less-discount
net-total-less-discount

Net total after applying the discount

new-means-of-transport
new-means-of-transport

New Means Of Transport

id
id

Coupa unique identifier

code
code

Code

name
name

Name

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

origin-currency-gross
origin-currency-gross True

Local Currency Gross

origin-currency-net
origin-currency-net True

Local Currency Net

original-invoice-date
original-invoice-date True

Original invoice date used in case of a Credit Note

original-invoice-number
original-invoice-number True

Original invoice number used in case of a Credit Note

original-value-of-supply
original-value-of-supply

Original Value of Supply

id
id

Coupa unique identifier

code
code

Code

name
name

Name

paid
paid

Paid

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

id
id

Coupa unique identifier

note
note

Note

created-at
created-at

Record created timestamp

payment-channel
payment-channel

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-date
payment-date

Date of payment for invoice

payment-due-date
payment-due-date

Payment Due Date

payment-method
payment-method

Payment Method

payment-notes
payment-notes

Notes included with payment for invoice

payment-order-number
payment-order-number

Payment Order Number

payment-order-reference
payment-order-reference

Payment Order Reference

payment-schedule-terms
payment-schedule-terms

Payment Schedule Terms

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

payment-date
payment-date

Payment date

place-of-issuance
place-of-issuance

Place Of Issuance

place-of-supply
place-of-supply

Place Of Supply

pre-payment-date
pre-payment-date

Pre-Payment Date

protocol-number
protocol-number

Protocol Number

id
id

Coupa unique identifier

status
status

Current status of the record

amount
amount

Amount

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

requester-email
requester-email

Requester Email

requester-lookup-name
requester-lookup-name

Requester Lookup Name

requester-name
requester-name

Requester Fullname

resolution-number
resolution-number

Resolution Number

reverse-charge-reference
reverse-charge-reference

Reverse Charge Reference

security-code-of-issuer
security-code-of-issuer

Security Code Of Issuer

self-billing-reference
self-billing-reference

Self billing reference on the invoice

sender-email
sender-email

Sender Email

serial-code-of-fiscal-invoice
serial-code-of-fiscal-invoice

Serial Code of Fiscal Invoice

series
series

Series

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

id
id

Coupa unique identifier

name
name

Name

street1
street1

Street1

city
city

City

postal-code
postal-code

Postal Code

country
country

Country name

shipping-amount
shipping-amount

Shipping Amount

id
id

Coupa unique identifier

code
code

Code

name
name

Name

show-tax-information?
show-tax-information?

Show tax information in the invoice

signed-qr-code
signed-qr-code

Signed QR Code

split-payment-mechanism
split-payment-mechanism

Split Payment Mechanism

state-tax-number
state-tax-number

State Tax ID Number

state-tax-number-for-substitute-taxpayer
state-tax-number-for-substitute-taxpayer

State Tax ID Number for Substitute Taxpayer

status
status

Invoice Status

id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

supplier-created
supplier-created

Supplier created indicator for invoice

supplier-invoice-issuer-name
supplier-invoice-issuer-name

Supplier Invoice Issuer Name

supplier-invoice-reviewer-name
supplier-invoice-reviewer-name

Supplier Invoice Reviewer Name

supplier-note
supplier-note

Note provided by supplier

supplier-payment-collector-name
supplier-payment-collector-name

Supplier Payment Collector Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

supplier-representative-name
supplier-representative-name

Supplier Representative Name

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether this record is active

id
id

Coupa unique identifier

tax-number
tax-number

Tax Number

country
country

Country

tax-type
tax-type

Tax Type

supplier-total
supplier-total

Supplier Total

id
id

Coupa unique identifier

tag
tag

Tag

taggable-type
taggable-type

Taggable Type

id
id

Coupa unique identifier

name
name

Name

tax-amount
tax-amount

Tax amount (not used if tax is provided at line level)

tax-amount-engine
tax-amount-engine

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

id
id

Coupa unique identifier

name
name

Name

code
code

Code

tax-code-engine
tax-code-engine

Tax code returned by External Tax Engine based on configuration

tax-due-to-supplier
tax-due-to-supplier

Tax due to the supplier

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-rate
tax-rate

Tax rate (not used if tax is provided at line level)

tax-rate-engine
tax-rate-engine

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currency
taxes-in-origin-country-currency True

Local Currency Tax

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tolerance-failures
tolerance-failures

Tolerance Failure

total-for-coupa-pay
total-for-coupa-pay

Invoice total for Coupa Pay

total-taxes-less-discount
total-taxes-less-discount

Total taxes after applying the discount

total-with-taxes
total-with-taxes

Total with taxes

transaction-notification-date
transaction-notification-date

Transaction Notification Date

transaction-uuid
transaction-uuid

Transaction UUID

type-of-document
type-of-document

Type of Document

type-of-operation
type-of-operation

Type of Operation

type-of-receipt
type-of-receipt

Type of Receipt

type-of-relationship
type-of-relationship

Type of Relationship

unique-identification-code-of-cash-receipt
unique-identification-code-of-cash-receipt

Unique Identification Code Of Cash Receipt

updated-at
updated-at

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

id
id

Coupa unique identifier

login
login True

Login

email
email True

Email

fullname
fullname

Fullname

use-of-invoice
use-of-invoice

Use of the Invoice

vat-chargeability-system
vat-chargeability-system

VAT Chargeability System

vehicle-license-plate
vehicle-license-plate

Vehicle License Plate

verification-code
verification-code

Verification Code

volume-amount
volume-amount

Volume Amount

volume-brand
volume-brand

Volume Brand

volume-gross-weight
volume-gross-weight

Volume Gross Weight

volume-liquid-weight
volume-liquid-weight

Volume Liquid Weight

volume-numbering
volume-numbering

Volume Numbering

volume-type
volume-type

Volume Type

id
id

Coupa unique identifier

tax-code
tax-code

Tax Code

amount
amount

Amount

rate
rate

Rate

tax-code-id
tax-code-id

Tax Code Id

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

withholding-tax-override
withholding-tax-override

Withholding Tax Override

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Invoice

Item: Get All

Get Items. Requires OAuth scope: core.item.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Filter: Description contains value
description[contains] string

Filter: Description contains value

Active
active boolean

Active

Filter: Supplier Items contains value
supplier_items[supplier][name][contains] string

Filter: Supplier Items contains value

Filter: Supplier Items contains value
supplier_items[supplier-part-num][contains] string

Filter: Supplier Items contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

response
array of Item

Item: Get by ID

Get Item by ID. Requires OAuth scope: core.item.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Item

Lookup Value: Create

Create a new Lookup Value. Requires OAuth scope core.common.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

name
name True

Lookup value name

external-ref-code
external-ref-code

External reference code

active
active

Whether value is active

id
id

Unique Coupa ID

name
name

Lookup name

active
active

Whether lookup is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Lookup Value: Get All

Get Lookup Values. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Lookup contains value
lookup[name][contains] string

Filter: Lookup contains value

Filter: Name contains value
name[contains] string

Filter: Name contains value

Active
active boolean

Active

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Lookup Value: Get by ID

Get Lookup Value by ID. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Lookup Value: Update

Update an existing Lookup Value. Requires OAuth scope core.common.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

name
name True

Lookup value name

external-ref-code
external-ref-code

External reference code

active
active

Whether value is active

id
id

Unique Coupa ID

name
name

Lookup name

active
active

Whether lookup is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Lookup: Get All

Get Lookups. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

response
array of Lookup

Lookup: Get by ID

Get Lookup by ID. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Lookup

Order List Line: Create

Create an Order List Line. Requires OAuth scope: core.order_pad.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Order List ID
order_pad_id True integer

Order List identifier.

id
id

Unique Coupa ID

id
id

Unique Coupa ID

name
name

Item name

description
description

Item description

item-number
item-number

Item number/SKU

active
active

Whether item is active

id
id

Unique Coupa ID

name
name

Unit of measure name

code
code

UOM code (e.g. EA, KG, HR)

active
active

Whether UOM is active

allowable-precision
allowable-precision

Decimal precision allowed

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

name
name

Commodity name

active
active

Whether commodity is active

id
id

Coupa unique identifier

name
name

Name

level
level

Hierarchy level

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

order-amount-method
order-amount-method True

Order amount method

supplier-id
supplier-id True

Supplier Coupa ID (Coupa may return as number or string)

par-level
par-level

Par level quantity (Coupa may return as string or number)

amount
amount

Order amount (Coupa may return as string or number)

key-item
key-item

Whether this line is marked as a key item (Coupa may return as boolean or string)

id
id

Unique Coupa ID

name
name

Section name

position
position

Section order (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

position
position

Display/order position (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Order List Line: Get All

Get Order List Lines. Requires OAuth scope: core.order_pad.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Order List ID
order_pad_id True integer

Order List identifier.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Order List Line: Get by ID

Get Order List Line by ID. Requires OAuth scope: core.order_pad.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Order List ID
order_pad_id True integer

Order List identifier.

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Order List Line: Update

Update an Order List Line. Requires OAuth scope: core.order_pad.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Order List ID
order_pad_id True integer

Order List identifier.

Record ID
id True integer

Resource numeric identifier.

id
id

Unique Coupa ID

id
id

Unique Coupa ID

name
name

Item name

description
description

Item description

item-number
item-number

Item number/SKU

active
active

Whether item is active

id
id

Unique Coupa ID

name
name

Unit of measure name

code
code

UOM code (e.g. EA, KG, HR)

active
active

Whether UOM is active

allowable-precision
allowable-precision

Decimal precision allowed

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

name
name

Commodity name

active
active

Whether commodity is active

id
id

Coupa unique identifier

name
name

Name

level
level

Hierarchy level

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

order-amount-method
order-amount-method True

Order amount method

supplier-id
supplier-id True

Supplier Coupa ID (Coupa may return as number or string)

par-level
par-level

Par level quantity (Coupa may return as string or number)

amount
amount

Order amount (Coupa may return as string or number)

key-item
key-item

Whether this line is marked as a key item (Coupa may return as boolean or string)

id
id

Unique Coupa ID

name
name

Section name

position
position

Section order (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

position
position

Display/order position (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Order List: Create

Create an Order List. Requires OAuth scope: core.order_pad.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Unique Coupa ID

name
name True

Order list name

id
id

Unique Coupa ID

id
id

Unique Coupa ID

name
name

Item name

description
description

Item description

item-number
item-number

Item number/SKU

active
active

Whether item is active

id
id

Unique Coupa ID

name
name

Unit of measure name

code
code

UOM code (e.g. EA, KG, HR)

active
active

Whether UOM is active

allowable-precision
allowable-precision

Decimal precision allowed

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

name
name

Commodity name

active
active

Whether commodity is active

id
id

Coupa unique identifier

name
name

Name

level
level

Hierarchy level

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

order-amount-method
order-amount-method True

Order amount method

supplier-id
supplier-id True

Supplier Coupa ID (Coupa may return as number or string)

par-level
par-level

Par level quantity (Coupa may return as string or number)

amount
amount

Order amount (Coupa may return as string or number)

key-item
key-item

Whether this line is marked as a key item (Coupa may return as boolean or string)

id
id

Unique Coupa ID

name
name

Section name

position
position

Section order (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

position
position

Display/order position (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

add-all-items
add-all-items

Whether all eligible items are automatically included (Coupa may return as boolean or string)

any-supplier
any-supplier

Whether items can be sourced from any supplier (Coupa may return as boolean or string)

base-value
base-value

Base value

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

id
id

Coupa unique identifier

name
name

Name

locked
locked

Whether the order list is locked (Coupa may return as boolean or string)

use-base-value
use-base-value

Whether base value is used (Coupa may return as boolean or string)

id
id

Unique Coupa ID

name
name

Section name

position
position

Section order (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

name
name

Supplier display name

display-name
display-name

Supplier display name (alternate)

number
number

Supplier number

status
status

Supplier status

po-method
po-method

PO delivery method (email, cxml, etc.)

po-email
po-email

Email address for PO delivery

payment-method
payment-method

Default payment method

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-id
tax-id

Tax identification number

website
website

Supplier website URL

duns
duns

DUNS number

on-hold
on-hold

Whether supplier is on hold

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Body
OrderPad

Order List: Get All

Get Order Lists. Requires OAuth scope: core.order_pad.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Order List: Get by ID

Get Order List by ID. Requires OAuth scope: core.order_pad.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
OrderPad

Order List: Update

Update an Order List. Requires OAuth scope: core.order_pad.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

id
id

Unique Coupa ID

name
name True

Order list name

id
id

Unique Coupa ID

id
id

Unique Coupa ID

name
name

Item name

description
description

Item description

item-number
item-number

Item number/SKU

active
active

Whether item is active

id
id

Unique Coupa ID

name
name

Unit of measure name

code
code

UOM code (e.g. EA, KG, HR)

active
active

Whether UOM is active

allowable-precision
allowable-precision

Decimal precision allowed

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

name
name

Commodity name

active
active

Whether commodity is active

id
id

Coupa unique identifier

name
name

Name

level
level

Hierarchy level

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

order-amount-method
order-amount-method True

Order amount method

supplier-id
supplier-id True

Supplier Coupa ID (Coupa may return as number or string)

par-level
par-level

Par level quantity (Coupa may return as string or number)

amount
amount

Order amount (Coupa may return as string or number)

key-item
key-item

Whether this line is marked as a key item (Coupa may return as boolean or string)

id
id

Unique Coupa ID

name
name

Section name

position
position

Section order (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

position
position

Display/order position (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

add-all-items
add-all-items

Whether all eligible items are automatically included (Coupa may return as boolean or string)

any-supplier
any-supplier

Whether items can be sourced from any supplier (Coupa may return as boolean or string)

base-value
base-value

Base value

id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

id
id

Coupa unique identifier

name
name

Name

locked
locked

Whether the order list is locked (Coupa may return as boolean or string)

use-base-value
use-base-value

Whether base value is used (Coupa may return as boolean or string)

id
id

Unique Coupa ID

name
name

Section name

position
position

Section order (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

name
name

Supplier display name

display-name
display-name

Supplier display name (alternate)

number
number

Supplier number

status
status

Supplier status

po-method
po-method

PO delivery method (email, cxml, etc.)

po-email
po-email

Email address for PO delivery

payment-method
payment-method

Default payment method

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-id
tax-id

Tax identification number

website
website

Supplier website URL

duns
duns

DUNS number

on-hold
on-hold

Whether supplier is on hold

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Body
OrderPad

Payment Term: Get All

Query payment terms reference data.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Code contains
code[contains] string

Filter: Code contains value

Filter: Name contains
name[contains] string

Filter: Name contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Payment Term: Get by ID

Get a single payment term.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

PO Change: Add Approver

Purchase Order Changes - Manually add an approver

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

PO Change: Get All

Get Purchase Order Changes. Requires OAuth scope: core.purchase_order.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Purchase Order id
purchase_order[id] string

Filter: Purchase Order id

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Returns

PO Change: Get by ID

Get Purchase Order Change by ID. Requires OAuth scope: core.purchase_order.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

PO Change: Remove Approver

Purchase Order Changes - Remove an approver who was manually added

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

PO Change: Submit for Approval

Purchase Order Changes - Submit Purchase Order for Approval

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

PO Line: Get All

Get all purchase order lines across all POs. Supports filtering by supplier part number and other fields. Requires OAuth scope: core.purchase_order.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Purchase Order ID
order_header[id] string

Filter lines by parent purchase order Coupa ID.

Source Part Number contains
source_part_num[contains] string

Filter lines where source part number contains this value.

Source Part Number exact
source_part_num string

Filter lines by exact source part number.

Item Name contains
item[name][contains] string

Filter lines where the item name contains this value.

Status
status string

Filter by line status (e.g., issued, closed, cancelled).

Supplier ID
order_header[supplier][id] string

Filter lines by supplier Coupa ID.

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

PO Line: Get Attachments

Retrieve all attachments on a PO Line record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

PO Line: Get by ID

Get a specific purchase order line by its Coupa ID. Requires OAuth scope: core.purchase_order.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

PO Line: Post Attachment (Text or URL)

Add a text or URL attachment to a PO Line record. Set intent to Internal or Supplier.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

PO Line: Reopen for Invoicing

Reopen for invoicing

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

PO Line: Reopen for Receiving

Reopen for receiving

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

PO Line: Soft Close for Invoicing

Soft close for invoicing

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

PO Line: Soft Close for Receiving

Soft close for receiving

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Purchase Order: Cancel

Cancel a purchase order. Requires OAuth scope: core.purchase_order.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Purchase Order: Close

Close a purchase order. Requires OAuth scope: core.purchase_order.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Purchase Order: Get All

Get Purchase Orders. Requires OAuth scope: core.purchase_order.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Status in list
status[in] string

Filter by status. Comma-separated values: draft, pending_buyer_action, pending_approval, issued, soft_closed, closed, cancelled

Filter: Supplier contains value
supplier[name][contains] string

Filter: Supplier contains value

Filter: Ship To Attention contains value
ship-to-attention[contains] string

Filter: Ship To Attention contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Filter: Number contains value
number[contains] string

Filter: Number contains value

Supplier ID
supplier[id] string

Filter purchase orders by supplier Coupa ID

Currency Code
currency[code] string

Filter purchase orders by ISO 4217 currency code (e.g., USD, AUD)

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Order Line Source Part Number contains
order_lines[source_part_num][contains] string

Filter POs where any order line source part number contains this value.

Order Line Source Part Number exact
order_lines[source_part_num] string

Filter POs by exact order line source part number.

Returns

Purchase Order: Get Attachments

Retrieve all attachments on a Purchase Order record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Purchase Order: Get by ID

Get Purchase Order by ID. Requires OAuth scope: core.purchase_order.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Purchase Order: Get Comments

Get comments for a PO.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

response
array of Comment

Purchase Order: Issue

Issue a purchase order, sending it to the supplier. Requires OAuth scope: core.purchase_order.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Purchase Order: Post Attachment (Text or URL)

Add a text or URL attachment to a Purchase Order record. Set intent to Internal or Supplier.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

Purchase Order: Post Comment

POST a comment on PurchaseOrder

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

commentable-type
commentable-type string

commentable-type

Comments
comments string

comments

Returns

Body
Comment

Purchase Order: Release from Buyer Hold

Release purchase order on buyer hold

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Purchase Order: Reopen

Reopen a previously closed purchase order. Requires OAuth scope: core.purchase_order.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

reason_insight_code
reason_insight_code string
reason-insight-event-comment
reason-insight-event-comment string
Record ID
id True integer

Resource numeric identifier.

Returns

Receipt Request: Get All

Returns a list of receipt requests. Requires scope: core.receiving.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Status
status[in] string

Filter by status. Comma-separated values: received, voided, pending

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Receipt Request: Get by ID

Returns a single receipt request by ID. Requires scope: core.receiving.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Receiving Transaction: Get All

Get Receiving Transactions. Requires OAuth scope: core.receiving.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Status in list
status[in] string

Filter by status. Comma-separated values: received, voided

Filter: Item contains value
item[name][contains] string

Filter: Item contains value

Filter: Order Line id
order_line[order_header][id] string

Filter: Order Line id

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Receiving Transaction: Get Attachments

Retrieve all attachments on a Receiving Transaction record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Receiving Transaction: Get by ID

Get Receiving Transaction by ID. Requires OAuth scope: core.receiving.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Receiving Transaction: Post Attachment (Text or URL)

Add a text or URL attachment to a Receiving Transaction record. Set intent to Internal or Supplier.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

Requisition Line: Get Attachments

Retrieve all attachments on a Requisition Line record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Requisition Line: Post Attachment (Text or URL)

Add a text or URL attachment to a Requisition Line record. Set intent to Internal or Supplier.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

Requisition: Add Approver

Manually add an approver for a requisition

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Requisition: Add to Cart (Free Text)

Add a free text requistion to the cart

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Ship To ID
id integer

Ship To ID

Non Catalogue Item Description
description string

Item Description

Quantity
quantity integer

quantity

Line Type
line-type string

Line type (Qty or Amt)

Unit Price
unit-price string

unit-price

Supplier Part Number
source-part-num string

Supplier Part Number

Commodity ID
id integer

Commodity ID

UOM ID
id integer

UOM ID

Supplier ID
id integer

Supplier ID

Requestion Status
status string

status

Requestor ID
id integer

Requestor ID

Created By ID
id integer

Created By ID

Tag ID
id integer

Tag ID

Returns

Requisition: Create and Submit

Create a requisition and attempt to submit it for approval

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Requisition: Get All

Get Requisitions. Requires OAuth scope: core.requisition.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Status in list
status[in] string

Filter by status. Comma-separated values: draft, pending_approval, approved, ordered, soft_closed, closed, cancelled, rejected

Filter: Requested By contains value
requested-by[login][contains] string

Filter: Requested By contains value

Filter: Req Title contains value
req-title[contains] string

Filter: Req Title contains value

Filter: Requisition Lines contains value
requisition-lines[item][name][contains] string

Filter: Requisition Lines contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Requisition: Get Attachments

Retrieve all attachments on a Requisition record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Requisition: Get by ID

Get Requisition by ID. Requires OAuth scope: core.requisition.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Requisition: Get Comments

Retrieve all comments on a Requisition record.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Returns

response
array of Comment

Requisition: Get Current Cart

Send current cart for user

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Requisition: Get Mine

Requistions - Query My Requistions

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Requisition: Post Attachment (Text or URL)

Add a text or URL attachment to a Requisition record. Set intent to Internal or Supplier.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

Requisition: Post Comment

Add a comment to a Requisition record. Use to-supplier to control visibility.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Comment
comments True string

Comment text. Mention user with @[User:{id}]

Visible to Supplier
to-supplier boolean

Returns

Body
Comment

Requisition: Remove Approver

Remove an approver who was manually added

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Requisition: Update and Submit

Update requisition and submit for approval

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Sourcing: Award Quote Response

Award a supplier response. Optionally specify line IDs to award individual lines; omit body to award all lines at once. Requires OAuth scope: core.sourcing.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

quote_response_line_ids
quote_response_line_ids array of integer

Array of specific quote response line IDs to award. Omit to award all lines at once.

Returns

Sourcing: Create Quote Request

Create a new sourcing event (RFP, RFI, or RFQ). Requires OAuth scope: core.sourcing.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

id
id

Unique Coupa ID

description
description

Name/description of the sourcing event

event-type
event-type

Type of event: rfp, rfi, or rfq. Defaults to rfi if not specified.

status
status

Event status (e.g., draft, published, closed, awarded, cancelled)

allow-award-individual-line-items
allow-award-individual-line-items

Ability to award individual line items

allow-multiple-response
allow-multiple-response

Allow multiple responses from a supplier

auto-unseal-bid
auto-unseal-bid

If checked, bids will be unsealed automatically

exported
exported

Whether the event has been exported

end-time
end-time

Time when the event should end

id
id

Coupa unique identifier

code
code

Code

procurement-category
procurement-category

Procurement category

content-groups
content-groups

Content groups (business groups)

attachments
attachments object
comments
comments

Comments on the event

easy-forms
easy-forms

Forms associated with the event

custom-fields
custom-fields

Custom fields

business-partners
business-partners

Business partners

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Sourcing: Get All Quote Responses

Get the most recent submitted responses across all sourcing events. Requires OAuth scope: core.sourcing.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Awarded
awarded string

Filter by awarded status (true or false)

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Sourcing: Get All Quote Responses (incl. Drafts)

Retrieves all responses across all sourcing events, including submitted and draft versions. Requires OAuth scope: core.sourcing.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Returns

Sourcing: Get Quote Request Attachments

Get Quote Request Attachments on a Sourcing record in Coupa.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Returns

Sourcing: Get Quote Request by ID

Get a sourcing event by ID. Requires OAuth scope: core.sourcing.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Sourcing: Get Quote Requests

Get sourcing events (quote requests). Requires OAuth scope: core.sourcing.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Description contains value
description[contains] string

Filter: Event name/description contains value

Filter: Status in list
status[in] string

Filter by event status. Comma-separated values: draft, published, closed, awarded, cancelled

Filter: Event Type
event-type[eq] string

Filter by event type (e.g., rfi, rfp, rfq)

Filter: Exported
exported string

Filter by exported flag (true or false)

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Sourcing: Get Quote Response by ID

Get information about a specific quote response. Requires OAuth scope: core.sourcing.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Returns

Sourcing: Get Quote Responses for Event

Retrieves the most recent submitted response per supplier for a specific sourcing event. Requires OAuth scope: core.sourcing.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Quote Request ID
quote_request_id True integer

Quote Request (sourcing event) numeric identifier.

Filter: Awarded
awarded string

Filter by awarded status (true or false)

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Sourcing: Get Quote Responses for Event (All)

Retrieves all responses for a specific sourcing event, including submitted and draft versions. Requires OAuth scope: core.sourcing.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Quote Request ID
quote_request_id True integer

Quote Request (sourcing event) numeric identifier.

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Returns

Sourcing: Post Quote Request Attachment (Text or URL)

Post Quote Request Attachment (Text or URL) on a Sourcing record in Coupa.

Parameters

Name Key Required Type Description
Record ID
id True integer

Resource numeric identifier.

Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Intent
intent True string
Text
text string
URL
url uri

Returns

Body
Attachment

Sourcing: Remove Quote Response Award

Removes the award designation from a quote response. Requires OAuth scope: core.sourcing.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Returns

Sourcing: Update Quote Request

Update a sourcing event. Requires OAuth scope: core.sourcing.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

id
id

Unique Coupa ID

description
description

Name/description of the sourcing event

event-type
event-type

Type of event: rfp, rfi, or rfq. Defaults to rfi if not specified.

status
status

Event status (e.g., draft, published, closed, awarded, cancelled)

allow-award-individual-line-items
allow-award-individual-line-items

Ability to award individual line items

allow-multiple-response
allow-multiple-response

Allow multiple responses from a supplier

auto-unseal-bid
auto-unseal-bid

If checked, bids will be unsealed automatically

exported
exported

Whether the event has been exported

end-time
end-time

Time when the event should end

id
id

Coupa unique identifier

code
code

Code

procurement-category
procurement-category

Procurement category

content-groups
content-groups

Content groups (business groups)

attachments
attachments object
comments
comments

Comments on the event

easy-forms
easy-forms

Forms associated with the event

custom-fields
custom-fields

Custom fields

business-partners
business-partners

Business partners

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Supplier Information: Get All

Get Supplier Information records (SIM). Requires SIM API permissions in Coupa.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Filter: Status in list
status[in] string

Filter by status. Comma-separated values: active, inactive, draft

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Supplier Information: Get by ID

Get Supplier Information by ID (SIM). Requires SIM API permissions in Coupa.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Supplier Item: Create

Supplier Items - Create supplier item

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Supplier Item ID
item_id True string

The Coupa ID of the parent Supplier Item record.

Returns

Supplier Item: Get All

Query supplier items with contracted pricing.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Item Name contains
item[name][contains] string

Filter: Item Name contains value

Filter: Supplier Name contains
supplier[name][contains] string

Filter: Supplier Name contains value

Filter: Supplier Part Number contains
supplier-part-num[contains] string

Filter: Supplier Part Number contains value

Filter: Supplier ID
supplier[id] string

Filter by Supplier ID

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Supplier Item: Get by ID

Get a single supplier item.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Supplier Item: Get by Item

Supplier Items - Query supplier items

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Supplier Item ID
item_id True string

The Coupa ID of the parent Supplier Item record.

Returns

Supplier Item: Get by Item and ID

Supplier Items - Show supplier item

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Supplier Item ID
item_id True string

The Coupa ID of the parent Supplier Item record.

Record ID
id True integer

Resource numeric identifier.

Returns

Supplier Item: Update

Update supplier item

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Parent Supplier Item ID
item_id True string

The Coupa ID of the parent Supplier Item record.

Record ID
id True integer

Resource numeric identifier.

Returns

Supplier: Get All

Get Suppliers. Requires OAuth scope: core.supplier.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Filter: Number contains value
number[contains] string

Filter: Number contains value

Filter: Status in list
status[in] string

Filter by status. Comma-separated values: active, inactive

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

Supplier: Get by ID

Get Supplier by ID. Requires OAuth scope: core.supplier.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
Supplier

Supplier: Update

Update a supplier. Requires OAuth scope: core.supplier.write

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

id
id

Unique Coupa ID

name
name

Supplier display name

display-name
display-name

Supplier display name (alternate)

number
number

Supplier number

status
status

Supplier status

po-method
po-method

PO delivery method (email, cxml, etc.)

po-email
po-email

Email address for PO delivery

payment-method
payment-method

Default payment method

id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

tax-id
tax-id

Tax identification number

website
website

Supplier website URL

duns
duns

DUNS number

on-hold
on-hold

Whether supplier is on hold

id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
id

Coupa unique identifier

name
name

Name

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Coupa unique identifier

name
name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
id

Coupa unique identifier

name
name

Name

code
code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Returns

Body
Supplier

UOM: Get All

Get UOMs. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Filter: Code contains value
code[contains] string

Filter: Code contains value

Active
active boolean

Active

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

response
array of UOM

UOM: Get by ID

Get UOM by ID. Requires OAuth scope: core.common.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
UOM

User Group Membership: Get All

Get User Group Memberships. Requires OAuth scope: core.user_group.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: User contains value
user[login][contains] string

Filter: User contains value

Filter: User Group contains value
user_group[name][contains] string

Filter: User Group contains value

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

User Group Membership: Get by ID

Get User Group Membership by ID. Requires OAuth scope: core.user_group.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

User Group: Get All

Get User Groups. Requires OAuth scope: core.user_group.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Name contains value
name[contains] string

Filter: Name contains value

Active
active boolean

Active

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

User Group: Get by ID

Get User Group by ID. Requires OAuth scope: core.user_group.read

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
UserGroup

User: Get All

Query Coupa users.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Filter: Login contains
login[contains] string

Filter: Login contains value

Filter: Email contains
email[contains] string

Filter: Email contains value

Filter: Last Name contains
lastname[contains] string

Filter: Last Name contains value

Active
active boolean

Filter by active status

Created After
created-at[gt] date-time

Return records created after this date (ISO 8601).

Updated After
updated-at[gt] date-time

Return records updated after this date (ISO 8601). Use for polling incremental changes.

Updated Before
updated-at[lt] date-time

Return records updated before this date (ISO 8601).

Limit
limit integer

Maximum number of records to return (max 50). Use offset for pagination.

Offset
offset integer

Number of records to skip before returning results.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Order By
order_by string

Sort by field name e.g., created-at.

Direction
dir string

Sort direction asc or desc.

Returns

response
array of User

User: Get by ID

Get a single user.

Parameters

Name Key Required Type Description
Access Token
Access-Token True string

Bearer token — pass as: Bearer {access_token}

Record ID
id True integer

Resource numeric identifier.

Return Object
return_object string

Controls response depth. limited=key fields only, shallow=top-level only, none=minimal. Omit for full response.

Fields
fields string

Comma-separated list of fields to include in the response, e.g. id,status,supplier.

Raw Filter
filter string

Advanced Coupa filter expression (raw).

Returns

Body
User

Definitions

Item

Name Path Type Description
id
id

Unique Coupa ID

name
name

Item name

description
description

Item description

item-number
item-number

Item number/SKU

active
active

Whether item is active

uom
uom UOM
commodity
commodity Commodity
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Supplier

Name Path Type Description
id
id

Unique Coupa ID

name
name

Supplier display name

display-name
display-name

Supplier display name (alternate)

number
number

Supplier number

status
status

Supplier status

po-method
po-method

PO delivery method (email, cxml, etc.)

po-email
po-email

Email address for PO delivery

payment-method
payment-method

Default payment method

payment-term
payment-term PaymentTerm
tax-id
tax-id

Tax identification number

website
website

Supplier website URL

duns
duns

DUNS number

on-hold
on-hold

Whether supplier is on hold

primary-contact
primary-contact User
primary-address
primary-address Address
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

SupplierInformation

Name Path Type Description
id
id

Supplier Information (SIM) record ID

supplier-id
supplier-id

Linked Supplier ID

supplier-name
supplier-name

Supplier name

name
name

Supplier Information name

status
status

SIM status

display-name
display-name

Supplier display name

supplier-number
supplier-number

Supplier number

payment-term
payment-term PaymentTerm
po-method
po-method

Purchase order transmission method

po-email
po-email

PO email

website
website

Supplier website

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
updated-by
updated-by User

Requisition

Name Path Type Description
id
id

Unique Coupa ID

req-title
req-title

Requisition title

status
status

Requisition status

requested-by
requested-by User
submitted-by
submitted-by User
submitted-at
submitted-at

When requisition was submitted

current-approval
current-approval Approval
ship-to-address
ship-to-address Address
id
currency.id

Coupa unique identifier

code
currency.code

Code

total
total

Total requisition amount

requisition-lines
requisition-lines array of RequisitionLine

Requisition line items

id
department.id

Coupa unique identifier

name
department.name

Name

justification
justification

Business justification

need-by-date
need-by-date

Required delivery date

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

PurchaseOrder

Name Path Type Description
id
id

Unique Coupa ID

po-number
po-number

Purchase order number

number
number

PO number (alias)

status
status

PO status

version
version

PO version number

supplier
supplier Supplier
id
currency.id

Coupa unique identifier

code
currency.code

Code

total
total

Total PO amount

ship-to-address
ship-to-address Address
bill-to-address
bill-to-address Address
payment-term
payment-term PaymentTerm
ship-to-attention
ship-to-attention

Ship to attention name

requester
requester User
buyer
buyer User
transmission-status
transmission-status

PO transmission status

transmission-date
transmission-date

When PO was last transmitted

acknowledged-at
acknowledged-at

When supplier acknowledged PO

order-lines
order-lines array of OrderLineSummary

Purchase order lines

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
updated-by
updated-by User

OrderPad

Name Path Type Description
id
id

Unique Coupa ID

name
name

Order list name

order-pad-lines
order-pad-lines array of OrderPadLine

Order Pad Lines

add-all-items
add-all-items

Whether all eligible items are automatically included (Coupa may return as boolean or string)

any-supplier
any-supplier

Whether items can be sourced from any supplier (Coupa may return as boolean or string)

base-value
base-value

Base value

base-value-currency
base-value-currency Currency
business-groups
business-groups array of object

Business groups assigned to this order list

id
business-groups.id

Coupa unique identifier

name
business-groups.name

Name

locked
locked

Whether the order list is locked (Coupa may return as boolean or string)

use-base-value
use-base-value

Whether base value is used (Coupa may return as boolean or string)

order-pad-sections
order-pad-sections array of OrderPadSection

Order Pad Sections

suppliers
suppliers array of Supplier

Suppliers

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
updated-by
updated-by User

OrderPadLine

Name Path Type Description
id
id

Unique Coupa ID

item
item Item
order-amount-method
order-amount-method

Order amount method

supplier-id
supplier-id

Supplier Coupa ID (Coupa may return as number or string)

par-level
par-level

Par level quantity (Coupa may return as string or number)

amount
amount

Order amount (Coupa may return as string or number)

key-item
key-item

Whether this line is marked as a key item (Coupa may return as boolean or string)

order-pad-section
order-pad-section OrderPadSection
position
position

Display/order position (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
updated-by
updated-by User

OrderPadSection

Name Path Type Description
id
id

Unique Coupa ID

name
name

Section name

position
position

Section order (Coupa may return as number or string)

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

ReceivingTransaction

Name Path Type Description
id
id

Unique Coupa ID

status
status

Receipt status

quantity
quantity

Quantity received

total
total

Total amount

order-line-id
order-line-id

PO line ID

order-header-id
order-header-id

PO header ID

order-header-number
order-header-number

PO number

uom
uom UOM
item
item Item
receipt-date
receipt-date

Date goods were received

received-by
received-by User
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Invoice

Name Path Type Description
id
id

Unique Coupa ID

invoice-number
invoice-number

Supplier invoice number

status
status

Invoice status

supplier
supplier Supplier
invoice-date
invoice-date

Invoice date

due-date
due-date

Payment due date

payment-date
payment-date

Actual payment date

id
currency.id

Coupa unique identifier

code
currency.code

Code

total
total

Invoice total amount

tax-amount
tax-amount

Total tax amount

shipping-amount
shipping-amount

Shipping amount

handling-amount
handling-amount

Handling amount

miscellaneous-amount
miscellaneous-amount

Miscellaneous charges

payment-term
payment-term PaymentTerm
ship-to-address
ship-to-address Address
remit-to-address
remit-to-address Address
bill-to-address
bill-to-address Address
invoice-lines
invoice-lines array of InvoiceLine

Invoice line items

po-number
po-number

Linked purchase order number. Null for standalone invoices not associated with a PO.

origin
origin

Invoice origin (api, cxml, email, etc.)

paid
paid

Whether invoice has been paid

document-type
document-type

Document type

current-approval
current-approval Approval
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
total-with-taxes
total-with-taxes

Gross invoice total including all taxes

line-level-taxation
line-level-taxation

Whether tax is calculated at line level

User

Name Path Type Description
id
id

Unique Coupa ID

login
login

User login name

email
email

Email address

firstname
firstname

First name

lastname
lastname

Last name

fullname
fullname

Full display name

employee-number
employee-number

Employee number

active
active

Whether user is active

id
department.id

Coupa unique identifier

name
department.name

Name

default-address
default-address Address
roles
roles array of object

Roles

id
roles.id

Coupa unique identifier

name
roles.name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Address

Name Path Type Description
id
id

Unique Coupa ID

name
name

Address name/label

location-code
location-code

Location code

street1
street1

Street address line 1

street2
street2

Street address line 2

city
city

City

state
state

State/Province

postal-code
postal-code

Postal/ZIP code

id
country.id

Coupa unique identifier

name
country.name

Name

code
country.code

Code

active
active

Whether address is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Contract

Name Path Type Description
id
id

Unique Coupa ID

number
number

Contract number

name
name

Contract name

status
status

Contract status

supplier
supplier Supplier
id
currency.id

Coupa unique identifier

code
currency.code

Code

start-date
start-date

Contract start date

end-date
end-date

Contract end date

maximum-value
maximum-value

Maximum contract value

minimum-value
minimum-value

Minimum contract value

committed-value
committed-value

Committed spend amount

current-value
current-value

Current spend amount

contract-owner
contract-owner User
description
description

Contract description

terms
terms

Contract terms text

is-default
is-default

Whether this is a default contract

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
contract-terms
contract-terms array of ContractTerm

Contract terms and conditions

Lookup

Name Path Type Description
id
id

Unique Coupa ID

name
name

Lookup name

active
active

Whether lookup is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

LookupValue

Name Path Type Description
id
id

Unique Coupa ID

name
name

Lookup value name

external-ref-code
external-ref-code

External reference code

active
active

Whether value is active

lookup
lookup Lookup
id
parent.id

Coupa unique identifier

name
parent.name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Account

Name Path Type Description
id
id

Unique Coupa ID

code
code

Account code

name
name

Account name

active
active

Whether account is active

segment-1
segment-1

Account segment 1 (e.g. company code)

segment-2
segment-2

Account segment 2 (e.g. cost centre)

segment-3
segment-3

Account segment 3 (e.g. GL account)

id
account-type.id

Coupa unique identifier

name
account-type.name

Name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Approval

Name Path Type Description
id
id

Unique Coupa ID

status
status

Approval status

approval-date
approval-date

When approval decision was made

approvable-type
approvable-type

Type of object being approved (Requisition, Invoice, etc.)

approvable-id
approvable-id

ID of the object being approved

approver
approver User
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

BudgetLine

Name Path Type Description
id
id

Unique Coupa ID

name
name

Budget line name

description
description

Budget line description

amount
amount

Budget amount

remaining
remaining

Remaining budget

active
active

Whether budget line is active

id
period.id

Coupa unique identifier

name
period.name

Name

account
account Account
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Commodity

Name Path Type Description
id
id

Unique Coupa ID

name
name

Commodity name

active
active

Whether commodity is active

id
parent.id

Coupa unique identifier

name
parent.name

Name

level
level

Hierarchy level

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

UOM

Name Path Type Description
id
id

Unique Coupa ID

name
name

Unit of measure name

code
code

UOM code (e.g. EA, KG, HR)

active
active

Whether UOM is active

allowable-precision
allowable-precision

Decimal precision allowed

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

UserGroup

Name Path Type Description
id
id

Unique Coupa ID

name
name

User group name

description
description

Group description

active
active

Whether group is active

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

UserGroupMembership

Name Path Type Description
id
id

Unique Coupa ID

user
user User
user_group
user_group UserGroup
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Attachment

Name Path Type Description
id
id

Unique Coupa ID

file-name
file-name

File name

file-size
file-size

File size in bytes

content-type
content-type

MIME type (application/pdf, etc.)

url
url

URL to download the attachment

created-at
created-at

Record created timestamp

created-by
created-by User

Comment

Name Path Type Description
id
id

Unique Coupa ID

text
text

Comment text content

commentable-type
commentable-type

Type of parent object

commentable-id
commentable-id

ID of parent object

created-at
created-at

Record created timestamp

created-by
created-by User

PurchaseOrderChange

Name Path Type Description
id
id

Unique Coupa ID

purchase_order
purchase_order PurchaseOrder
change-reason
change-reason

Reason for change

status
status

Change status

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

SupplierItem

Name Path Type Description
id
id

Coupa unique identifier

active
active

Whether this record is active

supplier-part-num
supplier-part-num

Supplier Part Num

unit-price
unit-price

Unit price

code
currency.code

Code

item
item Item
supplier
supplier Supplier
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

PaymentTerm

Name Path Type Description
id
id

Coupa unique identifier

code
code

Code

name
name

Name

net-days
net-days

Net Days

discount-days
discount-days

Discount Days

discount-percent
discount-percent

Discount Percent

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

ExchangeRate

Name Path Type Description
id
id

Coupa unique identifier

rate
rate

Rate

rate-date
rate-date

Rate Date

code
from-currency.code

Code

code
to-currency.code

Code

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

InvoiceLine

Invoice line - no standalone endpoint exists. Embedded in GET /invoices responses. Filter invoices by invoice line supplier part number using invoice_lines[supplier_part_num][contains] on GET /invoices.

Name Path Type Description
id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

total
total

Total amount

price
price

Price

quantity
quantity

Quantity

tax-amount
tax-amount

Tax amount

order-line-id
order-line-id

Linked PO line ID. Null if this invoice line is not associated with a PO line.

po-number
po-number

Linked purchase order number. Null if this invoice line is not associated with a PO.

supplier-part-num
supplier-part-num

Supplier part number on this invoice line. Filter invoices by this field using invoice_lines[supplier_part_num][contains] on GET /invoices.

account
account Account
item
item Item
uom
uom UOM
commodity
commodity Commodity
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

RequisitionLine

Name Path Type Description
id
id

Unique Coupa ID

line-num
line-num

Line number within the requisition

status
status

Line status

description
description

Line description

quantity
quantity

Requested quantity

price
price

Unit price

total
total

Line total

need-by-date
need-by-date

Required delivery date

line-type
line-type

Line type (e.g., GoodsLine, ServiceLine)

supplier-part-num
supplier-part-num

Supplier part number for this line

supplier-aux-part-num
supplier-aux-part-num

Supplier auxiliary part number

item
item Item
supplier
supplier Supplier
account
account Account
uom
uom UOM
commodity
commodity Commodity
id
currency.id

Coupa unique identifier

code
currency.code

Code

id
requisition.id

Parent requisition Coupa ID

req-title
requisition.req-title

Parent requisition title

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Currency

Name Path Type Description
id
id

Unique Coupa ID

code
code

ISO 4217 currency code (e.g., USD, AUD, EUR)

name
name

Currency display name

enabled
enabled

Whether currency is enabled in Coupa

ContractTerm

Name Path Type Description
id
id

Coupa unique identifier

name
name

Term name

description
description

Term description

created-at
created-at date-time

Record created timestamp

updated-at
updated-at date-time

Record last updated timestamp

QuoteRequest

Name Path Type Description
id
id

Unique Coupa ID

description
description

Name/description of the sourcing event

event-type
event-type

Type of event: rfp, rfi, or rfq. Defaults to rfi if not specified.

status
status

Event status (e.g., draft, published, closed, awarded, cancelled)

allow-award-individual-line-items
allow-award-individual-line-items

Ability to award individual line items

allow-multiple-response
allow-multiple-response

Allow multiple responses from a supplier

auto-unseal-bid
auto-unseal-bid

If checked, bids will be unsealed automatically

exported
exported

Whether the event has been exported

end-time
end-time

Time when the event should end

id
currency.id

Coupa unique identifier

code
currency.code

Code

procurement-category
procurement-category

Procurement category

content-groups
content-groups

Content groups (business groups)

attachments
attachments array of object

Attachments

items
attachments object
comments
comments

Comments on the event

easy-forms
easy-forms

Forms associated with the event

custom-fields
custom-fields

Custom fields

business-partners
business-partners

Business partners

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
updated-by
updated-by User

QuoteResponse

Name Path Type Description
id
id

Unique Coupa ID

state
state

Response state (e.g. submitted, draft)

awarded
awarded

Whether this response has been awarded

position
position

Position of this response

promoted
promoted

Whether this response has been promoted

comments
comments

Comments on the response

quote-request-id
quote-request-id

Quote request (sourcing event) ID this response belongs to

quote-request-original-id
quote-request-original-id

Original sourcing event identifier

quote-request-revision
quote-request-revision

Sourcing event revision number

submitted-at
submitted-at

Date/time the response was submitted

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
updated-by
updated-by User
quote-supplier
quote-supplier object

Supplier who submitted this response

lines
lines array of QuoteResponseLine

Quote response lines

quote-request-attachment-response
quote-request-attachment-response object

Attachment response details

QuoteResponseLine

Name Path Type Description
id
id

Unique Coupa ID

quantity
quantity

Quantity

reporting-price-amount
reporting-price-amount

Reporting price amount

quote-request-line-id
quote-request-line-id

Quote request line ID

lot-id
lot-id

Lot ID

awarded
awarded

Whether this response line has been awarded

easy-form-response
easy-form-response

Form response

shipping-term
shipping-term

Shipping term

price-amount
price-amount

Offered price

cost-element-values
cost-element-values

Offered prices for cost elements

lead-time
lead-time

Offered lead time

supplier-item-name
supplier-item-name

Supplier name for offered item

item-part-number
item-part-number

Supplier part number for offered item

item-description
item-description

Supplier description for offered item

price-currency
price-currency

Currency for the offered price

attachments
attachments array of object

Attachments

items
attachments object
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

created-by
created-by User
updated-by
updated-by User

Flow

Name Path Type Description
id
id

Coupa unique identifier

name
name

Flow name

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

Integration

Name Path Type Description
business-object
business-object

Business Object

code
code

Unique Integration Code

created-at
created-at

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

created-by
created-by UserSimple
direction
direction

Direction

end-system
end-system

End System

end-system-type
end-system-type

End System Type

id
id

Coupa unique identifier

integration-type
integration-type

Type of integration

name
name

Integration Name

standard
standard

Standard

updated-at
updated-at

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

updated-by
updated-by UserSimple

IntegrationError

Name Path Type Description
contact-alert-type
contact-alert-type

contact_alert_type

created-at
created-at

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

created-by
created-by UserSimple
creation-method
creation-method

creation_method

document-id
document-id

document_id

document-revision
document-revision

document_revision

document-status
document-status

document_status

document-type
document-type

document_type

external-id
external-id

external_id

id
id

Coupa unique identifier

integration
integration Integration
integration-filename
integration-filename

filename that is associated with integration error

integration-run
integration-run IntegrationRun
integration-run-id
integration-run-id

Integration Run ID

resolved
resolved

True if this error is resolved

responses
responses array of IntegrationRecordResponse

Responses

status
status

transaction status

updated-at
updated-at

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

updated-by
updated-by UserSimple

IntegrationRecordResponse

Name Path Type Description
created-at
created-at

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

created-by
created-by UserSimple
id
id

Coupa unique identifier

response-code
response-code

response_code

response-message
response-message

response_message

updated-at
updated-at

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

updated-by
updated-by UserSimple

IntegrationRun

Name Path Type Description
created-at
created-at

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

created-by
created-by UserSimple
end-time
end-time

end_time

flow
flow Flow
id
id

Coupa unique identifier

integration
integration Integration
integration-errors
integration-errors array of IntegrationError

Integration Errors

records-processed
records-processed

records_processed

start-time
start-time

start_time

status
status

transaction status

total-records
total-records

total_records

updated-at
updated-at

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

updated-by
updated-by UserSimple

UserSimple

Name Path Type Description
id
id

Coupa unique identifier

login
login

Login

email
email

Email

fullname
fullname

Fullname

OrderLineAllocation

Account allocation for a purchase order line

Name Path Type Description
id
id

Coupa unique identifier

account-id
account-id

ID of the account

account-code
account-code

Code of the account

account-name
account-name

Name of the account

account-type-id
account-type-id

ID of the account type

account-type-name
account-type-name

Name of the account type

pct
pct

Allocation percentage

amount
amount

Allocation amount

period-id
period-id

ID of the period

period-name
period-name

Name of the period

created-at
created-at

Created timestamp

updated-at
updated-at

Updated timestamp

AccountTypeSimple

Name Path Type Description
id
id

Coupa unique identifier

name
name

Name

PeriodSimple

Name Path Type Description
id
id

Coupa unique identifier

name
name

Name

start-date
start-date

Start date

end-date
end-date

End date

ContractSimple

Name Path Type Description
id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

AttachmentSimple

Name Path Type Description
id
id

Coupa unique identifier

file-name
file-name

File Name

url
url

URL

content-type
content-type

Content Type

file-size
file-size

File Size

SupplierSimple

Supplier (summary)

Name Path Type Description
id
id

Coupa unique identifier

name
name

Name

number
number

Number

status
status

Current status of the record

PurchaseOrderLine

Name Path Type Description
id
id

Unique Coupa ID

line-num
line-num

Line number

status
status

Line status

description
description

Line description

quantity
quantity

Ordered quantity

price
price

Unit price

total
total

Line total

accounting-total
accounting-total

Accounting total for this line

invoiced
invoiced

Total amount invoiced against this line

received
received

Total amount or quantity received against this line

need-by-date
need-by-date

Required delivery date

receipt-required
receipt-required

Whether a receipt is required before payment

match-type
match-type

Invoice match type (e.g., 2-way, 3-way)

source-part-num
source-part-num

Buyer-side source part number

supp-aux-part-num
supp-aux-part-num

Supplier auxiliary part number

supplier-order-number
supplier-order-number

Supplier's own order reference number

order-header-id
order-header-id

Parent PO header Coupa ID

order-header-number
order-header-number

Parent PO number

item
item Item
supplier
supplier Supplier
account
account Account
account-allocations
account-allocations array of OrderLineAllocation

Account allocations for this line

id
requester.id

Coupa unique identifier

login
requester.login

Login

employee-number
requester.employee-number

Employee Number

uom
uom UOM
commodity
commodity Commodity
id
currency.id

Coupa unique identifier

code
currency.code

Code

custom-fields
custom-fields

Custom fields configured for this line

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

id
created-by.id

Coupa unique identifier

login
created-by.login

Login

id
updated-by.id

Coupa unique identifier

login
updated-by.login

Login

sub-line-num
sub-line-num

Sub-line number

service-type
service-type

Service type

reporting-total
reporting-total

Reporting total

savings-pct
savings-pct

Savings percentage

minimum-order-quantity
minimum-order-quantity

Minimum order quantity

receipt-approval-required
receipt-approval-required

Receipt approval required

invoice-stop
invoice-stop

Invoice stop flag

version
version

Version

manufacturer-name
manufacturer-name

Manufacturer name

manufacturer-part-number
manufacturer-part-number

Manufacturer part number

external-reference-number
external-reference-number

External reference number

external-reference-type
external-reference-type

External reference type

accounting-total-currency
accounting-total-currency Currency
account-type
account-type AccountTypeSimple
department
department DepartmentSimple
contract
contract ContractSimple
period
period PeriodSimple
attachments
attachments array of AttachmentSimple

Attachments

DepartmentSimple

Name Path Type Description
id
id

Coupa unique identifier

name
name

Name

OrderLineSummary

Name Path Type Description
id
id

Coupa unique identifier

line-num
line-num

Line number

status
status

Current status of the record

description
description

Description

source-part-num
source-part-num

Source Part Num

quantity
quantity

Quantity

price
price

Price

total
total

Total amount

order-header-id
order-header-id

Order Header Id

order-header-number
order-header-number

Order Header Number

supplier
supplier SupplierSimple

Supplier (summary)

item
item Item
uom
uom UOM
need-by-date
need-by-date

Need By Date

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

InventoryRecord

Name Path Type Description
id
id

Coupa unique identifier

item
item Item
quantity
quantity

Quantity on hand

location
location

Inventory location

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

InventoryTransaction

Name Path Type Description
id
id

Coupa unique identifier

transaction-type
transaction-type

Type of inventory transaction

quantity
quantity

Transaction quantity

item
item Item
created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

ReceiptRequest

Name Path Type Description
id
id

Coupa unique identifier

status
status

Receipt request status

created-at
created-at

Record created timestamp

updated-at
updated-at

Record last updated timestamp

DataFileSource

Name Path Type Description
id
id

Coupa unique identifier

name
name

Data source name

active
active

Whether the data source is active