Coupa (Independent Publisher) (Preview)
Provides robust access to read, edit, or integrate your data with the Coupa platform.
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 |
| gl1@live.om |
| 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.
Recommended Scopes
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 | Enter Coupa Instance name excluding coupahost.com | True |
| Coupa Scope | string | Enter Coupa Oidc scopes with no commas | True |
| Coupa Client Id | string | Enter Coupa Client Id | True |
| Coupa Client Secret | securestring | Enter Coupa Client Secret | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
Addresses - Create Address
Create Address
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
name
|
name | string |
name |
|
|
Location Code
|
location-code | string |
location-code |
|
|
street1
|
street1 | string |
street1 |
|
|
street2
|
street2 | string |
street2 |
|
|
city
|
city | string |
city |
|
|
State
|
state | string |
state |
|
|
Postcode
|
postal-code | string |
postal-code |
|
|
code
|
code | True | string |
code |
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
ID
|
id | integer |
id |
Returns
- Body
- Address
Addresses - Get Address by ID
Addresses - Query Addresses
Query Address
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
Returns
- response
- array of Address
Addresses - Update Existing Address
Update Existing Address
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
name
|
name | string |
name |
|
|
Location Code
|
location-code | string |
location-code |
|
|
street1
|
street1 | string |
street1 |
|
|
street2
|
street2 | string |
street2 |
|
|
city
|
city | string |
city |
|
|
State
|
state | string |
state |
|
|
Postcode
|
postal-code | string |
postal-code |
|
|
code
|
code | True | string |
code |
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
ID
|
id | integer |
id |
Returns
- Body
- Address
Attachments - Add Attachment (URL) to a Comment
Add an Attachment (URL) to a Comment
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Comment id
|
id | True | string |
Comment id |
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
Returns
- Body
- Attachments
Attachments - Add Attachment (URL) to a Purchase Order
Add Attachment (URL) to a Purchase Order
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
Returns
- Body
- Attachments
Attachments - Get Attachments from a Purchase Order
Get Attachments from a Purchase Order
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Returns
- response
- array of Attachments
Comments - Add Purchase Order Comment
POST a comment on Purchase Order
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
po_id
|
po_id | True | string |
Purchase Order ID |
|
commentable-id
|
commentable-id | integer |
commentable-id |
|
|
comments
|
comments | string |
comments |
Returns
- Body
- Comments
Contracts - Add a contract term
Add a contract term
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
type
|
type | string |
type |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
Returns
- Body
- ContractTerm
Contracts - Create a Contract
Create contract
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
type
|
type | string |
type |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Descriptive notes about the contract |
|
|
end-date
|
end-date | string |
Expiry Date |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
maximum-value
|
maximum-value | string |
Maximum Commit Amount |
|
|
minimum-value
|
minimum-value | string |
Minimum Commit Amount |
|
|
name
|
name | string |
Contract Name |
|
|
number
|
number | string |
Contract Number |
|
|
start-date
|
start-date | string |
Start Date |
|
|
status
|
status | string |
Status of the Contract |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
supplier-account
|
supplier-account | string |
Supplier Account Number |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
version
|
version | integer |
version |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- Body
- Contract
Contracts - Get Contract by ID
Get Contract by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
offset
|
offset | integer |
Offset |
|
|
return_object
|
return_object | string |
return_object |
|
|
dir
|
dir | string |
dir |
Returns
- Body
- Contract
Contracts - Get Contracts
Get Contracts
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
offset
|
offset | integer |
Offset |
|
|
limit
|
limit | integer |
Limit |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
|
|
dir
|
dir | string |
dir |
Returns
- response
- array of Contract
Integration - Show integration errors
Show integration errors
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of IntegrationError
Integrations - Query integrations
Query integrations
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of Integration
Integrations - Show integration run
Show integration run
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
id |
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- Body
- IntegrationRun
Integrations - Show Integration Runs
Query Integration Runs
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of IntegrationRun
Invoice - Get Invoices
Get Invoices
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
dir
|
dir | string |
dir |
|
|
Invoice Date Less than
|
invoice_date[lt] | date-time |
Invoice Date < |
|
|
return_object
|
return_object | string |
return_object |
|
|
limit
|
limit | string |
limit |
|
|
offset
|
offset | string |
offset |
|
|
status
|
status | string |
status |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of Invoices
Invoices - Create Invoice
Create Invoice
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
invoice-date
|
invoice-date | string |
invoice-date |
|
|
invoice-number
|
invoice-number | string |
invoice-number |
|
|
line-level-taxation
|
line-level-taxation | boolean |
line-level-taxation |
|
|
total-with-taxes
|
total-with-taxes | string |
total-with-taxes |
|
|
document-type
|
document-type | string |
document-type |
|
|
login
|
login | string |
login |
|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
location-code
|
ship-to-address | string |
location-code |
|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
account-type-id
|
account-type-id | integer |
Account Type Id |
|
|
active
|
active | boolean |
Active\Inactive flag |
|
|
code
|
code | string |
All segments concatenated with a hyphen ( - ) |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
This is the nickname for the account. |
|
|
segment-1
|
segment-1 | string |
Each segment represents the segment of the account code |
|
|
segment-2
|
segment-2 | string |
Each segment represents the segment of the account code |
|
|
segment-3
|
segment-3 | string |
Each segment represents the segment of the account code |
|
|
segment-4
|
segment-4 | string |
Each segment represents the segment of the account code |
|
|
segment-5
|
segment-5 | string |
Each segment represents the segment of the account code |
|
|
segment-6
|
segment-6 | string |
Each segment represents the segment of the account code |
|
|
accounting-total
|
accounting-total | string |
accounting-total |
|
|
description
|
description | string |
description |
|
|
line-num
|
line-num | integer |
line-num |
|
|
line-id
|
id | integer |
Coupa Internal Order Line ID |
|
|
order-header-num
|
order-header-num | integer |
order-header-num |
|
|
po-number
|
po-number | string |
po-number |
|
|
order-line-num
|
order-line-num | string |
order-line-num |
|
|
price
|
price | string |
price |
|
|
quantity
|
quantity | string |
quantity |
|
|
total
|
total | string |
total |
|
|
type
|
type | string |
type |
|
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
type
|
type | string |
type |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Descriptive notes about the contract |
|
|
end-date
|
end-date | string |
Expiry Date |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
maximum-value
|
maximum-value | string |
Maximum Commit Amount |
|
|
minimum-value
|
minimum-value | string |
Minimum Commit Amount |
|
|
name
|
name | string |
Contract Name |
|
|
number
|
number | string |
Contract Number |
|
|
start-date
|
start-date | string |
Start Date |
|
|
status
|
status | string |
Status of the Contract |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
supplier-account
|
supplier-account | string |
Supplier Account Number |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
version
|
version | integer |
version |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
id
|
id | integer |
Coupa unique identifier |
Returns
- Body
- Invoices
Invoices - Delete Invoice by ID
Delete Invoices by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
Invoice ID |
Invoices - Get Invoice by ID
Get Invoices by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
id |
Returns
- Body
- Invoices
Invoices - Update Invoice
Update Invoice
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
Invoice ID |
|
invoice-date
|
invoice-date | string |
invoice-date |
|
|
invoice-number
|
invoice-number | string |
invoice-number |
|
|
line-level-taxation
|
line-level-taxation | boolean |
line-level-taxation |
|
|
total-with-taxes
|
total-with-taxes | string |
total-with-taxes |
|
|
document-type
|
document-type | string |
document-type |
|
|
login
|
login | string |
login |
|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
location-code
|
ship-to-address | string |
location-code |
|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
account-type-id
|
account-type-id | integer |
Account Type Id |
|
|
active
|
active | boolean |
Active\Inactive flag |
|
|
code
|
code | string |
All segments concatenated with a hyphen ( - ) |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
This is the nickname for the account. |
|
|
segment-1
|
segment-1 | string |
Each segment represents the segment of the account code |
|
|
segment-2
|
segment-2 | string |
Each segment represents the segment of the account code |
|
|
segment-3
|
segment-3 | string |
Each segment represents the segment of the account code |
|
|
segment-4
|
segment-4 | string |
Each segment represents the segment of the account code |
|
|
segment-5
|
segment-5 | string |
Each segment represents the segment of the account code |
|
|
segment-6
|
segment-6 | string |
Each segment represents the segment of the account code |
|
|
accounting-total
|
accounting-total | string |
accounting-total |
|
|
description
|
description | string |
description |
|
|
line-num
|
line-num | integer |
line-num |
|
|
line-id
|
id | integer |
Coupa Internal Order Line ID |
|
|
order-header-num
|
order-header-num | integer |
order-header-num |
|
|
po-number
|
po-number | string |
po-number |
|
|
order-line-num
|
order-line-num | string |
order-line-num |
|
|
price
|
price | string |
price |
|
|
quantity
|
quantity | string |
quantity |
|
|
total
|
total | string |
total |
|
|
type
|
type | string |
type |
|
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
type
|
type | string |
type |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Descriptive notes about the contract |
|
|
end-date
|
end-date | string |
Expiry Date |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
maximum-value
|
maximum-value | string |
Maximum Commit Amount |
|
|
minimum-value
|
minimum-value | string |
Minimum Commit Amount |
|
|
name
|
name | string |
Contract Name |
|
|
number
|
number | string |
Contract Number |
|
|
start-date
|
start-date | string |
Start Date |
|
|
status
|
status | string |
Status of the Contract |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
supplier-account
|
supplier-account | string |
Supplier Account Number |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
version
|
version | integer |
version |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
id
|
id | integer |
Coupa unique identifier |
Returns
- Body
- Invoices
Invoices - Void an Invoice
Void an Invoice
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
Invoice ID |
Returns
- Body
- Invoices
Items - Create Item
Create Item
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
name
|
name | string |
Item name |
|
|
description
|
description | string |
Item desciption |
|
|
item-number
|
item-number | string |
Unique item number |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
updated-at |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
URL for item image (will be copied into Coupa on item create/update) |
Returns
- Body
- Item
Items - Get Item by ID
Get Item by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
return_object
|
return_object | string |
return_object |
Returns
- Body
- Item
Items - Get Supplier Item by ID
Get Supplier Items by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
offset
|
offset | integer |
Offset |
|
|
return_object
|
return_object | string |
return_object |
|
|
dir
|
dir | string |
dir |
Returns
- Body
- SupplierItem
Items - Query Items
Query Items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of Item
Lookup - Query lookup values
Query lookup values
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Lookup Name
|
lookup[name] | string |
Lookup Name |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of LookupValue
Lookup - Query lookups
Query lookups
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Lookup Name
|
name | string |
Lookup Name |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of Lookup
Order Lists - Create Order List
Create Order List
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
add-all-items
|
add-all-items | string |
Flag indicating to add all items |
|
|
any-supplier
|
any-supplier | string |
any_supplier |
|
|
base-value
|
base-value |
base_value |
||
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
name
|
name | string |
Item name |
|
|
description
|
description | string |
Item desciption |
|
|
item-number
|
item-number | string |
Unique item number |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
updated-at |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
URL for item image (will be copied into Coupa on item create/update) |
|
|
order-amount-method
|
order-amount-method | True | string |
order_amount_method |
|
supplier-id
|
supplier-id | True | integer |
supplier_id |
|
par-level
|
par-level | number |
par_level |
|
|
amount
|
amount | number |
amount |
|
|
id
|
id | integer |
Coupa unique identifier |
Returns
- Body
- OrderPad
Order Lists - Get Order List by ID
Show Order List
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
id |
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- Body
- OrderPad
Order Lists - Query Order Lists
Query Order Lists
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of OrderPad
Purchase Orders - Cancel Purchase Order
Purchase Orders - Cancel Purchase Order
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Returns
- Body
- PurchaseOrder
Purchase Orders - Close Purchase Order
Purchase Orders - Close Purchase Order
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Returns
- Body
- PurchaseOrder
Purchase Orders - Get Purchase Order by ID
Get Purchase Order by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
filter
|
filter | string |
filter |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
Returns
- Body
- PurchaseOrder
Purchase Orders - Get Purchase Orders
Get Purchase Orders
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
filter
|
filter | string |
filter |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
Returns
- response
- array of PurchaseOrder
Purchase Orders - Reopen Purchase Order
Purchase Orders - Reopen Purchase Order
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
reason_insight_code
|
reason_insight_code | string |
Reason Code |
|
|
reason-insight-event-comment
|
reason-insight-event-comment | string |
Reason Comment |
Returns
- Body
- PurchaseOrder
Receipts - Create or Partial Void a goods receipt
Create a new goods receipt
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
quantity
|
quantity | integer |
quantity |
|
|
type
|
type | string |
type |
|
|
original-transaction-id
|
original-transaction-id | number |
Receipt transaction ID to void |
|
|
Coupa Interal Line ID
|
id | integer |
Order Line ID |
Returns
- Body
- InventoryTransaction
Receipts - Void a receipt
Void Receipts by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
fields
|
fields | string |
fields |
Returns
- Body
- InventoryTransaction
Requisitions - Add To Cart (Free Text)
Add a free text requistion to the cart
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
|
|
exported
|
exported | boolean |
Indicates if transaction has been exported |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
justification
|
justification | string |
Requisition Justification Comments |
|
|
need-by-date
|
need-by-date | date-time |
Item Need By Date |
|
|
req-title
|
req-title | string |
Optional title of the Requisition |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
account-type-id
|
account-type-id | integer |
Account Type Id |
|
|
active
|
active | boolean |
Active\Inactive flag |
|
|
code
|
code | string |
All segments concatenated with a hyphen ( - ) |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
This is the nickname for the account. |
|
|
segment-1
|
segment-1 | string |
Each segment represents the segment of the account code |
|
|
segment-2
|
segment-2 | string |
Each segment represents the segment of the account code |
|
|
segment-3
|
segment-3 | string |
Each segment represents the segment of the account code |
|
|
segment-4
|
segment-4 | string |
Each segment represents the segment of the account code |
|
|
segment-5
|
segment-5 | string |
Each segment represents the segment of the account code |
|
|
segment-6
|
segment-6 | string |
Each segment represents the segment of the account code |
|
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
updated-at |
|
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
type
|
type | string |
type |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Descriptive notes about the contract |
|
|
end-date
|
end-date | string |
Expiry Date |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
maximum-value
|
maximum-value | string |
Maximum Commit Amount |
|
|
minimum-value
|
minimum-value | string |
Minimum Commit Amount |
|
|
name
|
name | string |
Contract Name |
|
|
number
|
number | string |
Contract Number |
|
|
start-date
|
start-date | string |
Start Date |
|
|
status
|
status | string |
Status of the Contract |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
supplier-account
|
supplier-account | string |
Supplier Account Number |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
version
|
version | integer |
version |
|
|
description
|
description | True | string |
description |
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
Image url |
|
|
name
|
name | string |
Item name |
|
|
description
|
description | string |
Item desciption |
|
|
item-number
|
item-number | string |
Unique item number |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
URL for item image (will be copied into Coupa on item create/update) |
|
|
line-num
|
line-num | integer |
line_num |
|
|
line-type
|
line-type | string |
line type |
|
|
order-line-id
|
order-line-id | integer |
order_line_id |
|
|
status
|
status | string |
transaction status |
|
|
total
|
total | number |
total |
|
|
transmission-emails
|
transmission-emails | string |
Transmission emails |
|
|
transmission-method-override
|
transmission-method-override | string |
Transmission method override |
|
|
unit-price
|
unit-price | number |
line item price |
|
|
name
|
name | string |
name |
|
|
Location Code
|
location-code | string |
location-code |
|
|
street1
|
street1 | string |
street1 |
|
|
street2
|
street2 | string |
street2 |
|
|
city
|
city | string |
city |
|
|
State
|
state | string |
state |
|
|
Postcode
|
postal-code | string |
postal-code |
|
|
code
|
code | True | string |
code |
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
ID
|
id | integer |
id |
|
|
ship-to-attention
|
ship-to-attention | string |
Ship to Address Attention |
|
|
status
|
status | True | string |
transaction status |
Returns
- Body
- RequisitionHeader
Requisitions - Create Requisition
Create Requisition
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
|
|
exported
|
exported | boolean |
Indicates if transaction has been exported |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
justification
|
justification | string |
Requisition Justification Comments |
|
|
need-by-date
|
need-by-date | date-time |
Item Need By Date |
|
|
req-title
|
req-title | string |
Optional title of the Requisition |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
account-type-id
|
account-type-id | integer |
Account Type Id |
|
|
active
|
active | boolean |
Active\Inactive flag |
|
|
code
|
code | string |
All segments concatenated with a hyphen ( - ) |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
This is the nickname for the account. |
|
|
segment-1
|
segment-1 | string |
Each segment represents the segment of the account code |
|
|
segment-2
|
segment-2 | string |
Each segment represents the segment of the account code |
|
|
segment-3
|
segment-3 | string |
Each segment represents the segment of the account code |
|
|
segment-4
|
segment-4 | string |
Each segment represents the segment of the account code |
|
|
segment-5
|
segment-5 | string |
Each segment represents the segment of the account code |
|
|
segment-6
|
segment-6 | string |
Each segment represents the segment of the account code |
|
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
updated-at |
|
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
type
|
type | string |
type |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Descriptive notes about the contract |
|
|
end-date
|
end-date | string |
Expiry Date |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
maximum-value
|
maximum-value | string |
Maximum Commit Amount |
|
|
minimum-value
|
minimum-value | string |
Minimum Commit Amount |
|
|
name
|
name | string |
Contract Name |
|
|
number
|
number | string |
Contract Number |
|
|
start-date
|
start-date | string |
Start Date |
|
|
status
|
status | string |
Status of the Contract |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
supplier-account
|
supplier-account | string |
Supplier Account Number |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
version
|
version | integer |
version |
|
|
description
|
description | True | string |
description |
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
Image url |
|
|
name
|
name | string |
Item name |
|
|
description
|
description | string |
Item desciption |
|
|
item-number
|
item-number | string |
Unique item number |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
URL for item image (will be copied into Coupa on item create/update) |
|
|
line-num
|
line-num | integer |
line_num |
|
|
line-type
|
line-type | string |
line type |
|
|
order-line-id
|
order-line-id | integer |
order_line_id |
|
|
status
|
status | string |
transaction status |
|
|
total
|
total | number |
total |
|
|
transmission-emails
|
transmission-emails | string |
Transmission emails |
|
|
transmission-method-override
|
transmission-method-override | string |
Transmission method override |
|
|
unit-price
|
unit-price | number |
line item price |
|
|
name
|
name | string |
name |
|
|
Location Code
|
location-code | string |
location-code |
|
|
street1
|
street1 | string |
street1 |
|
|
street2
|
street2 | string |
street2 |
|
|
city
|
city | string |
city |
|
|
State
|
state | string |
state |
|
|
Postcode
|
postal-code | string |
postal-code |
|
|
code
|
code | True | string |
code |
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
ID
|
id | integer |
id |
|
|
ship-to-attention
|
ship-to-attention | string |
Ship to Address Attention |
|
|
status
|
status | True | string |
transaction status |
Returns
- Body
- RequisitionHeader
Requisitions - Get Requisition by ID
Get Requisition by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Returns
- Body
- RequisitionHeader
Requisitions - Get Requisitions
Get Requisitions
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | string |
limit |
|
|
offset
|
offset | string |
offset |
Returns
- response
- array of RequisitionHeader
Requisitions - Update Requisition
Update Requisition
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
|
|
exported
|
exported | boolean |
Indicates if transaction has been exported |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
justification
|
justification | string |
Requisition Justification Comments |
|
|
need-by-date
|
need-by-date | date-time |
Item Need By Date |
|
|
req-title
|
req-title | string |
Optional title of the Requisition |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
|
code
|
code | string | ||
|
enabled
|
enabled | string |
Enabled |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
account-type-id
|
account-type-id | integer |
Account Type Id |
|
|
active
|
active | boolean |
Active\Inactive flag |
|
|
code
|
code | string |
All segments concatenated with a hyphen ( - ) |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
active
|
active | boolean |
Active |
|
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
|
description
|
description | string |
description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Description |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
email
|
string |
|
||
|
login
|
login | string |
employee number |
|
|
fullname
|
fullname | string |
full name |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
This is the nickname for the account. |
|
|
segment-1
|
segment-1 | string |
Each segment represents the segment of the account code |
|
|
segment-2
|
segment-2 | string |
Each segment represents the segment of the account code |
|
|
segment-3
|
segment-3 | string |
Each segment represents the segment of the account code |
|
|
segment-4
|
segment-4 | string |
Each segment represents the segment of the account code |
|
|
segment-5
|
segment-5 | string |
Each segment represents the segment of the account code |
|
|
segment-6
|
segment-6 | string |
Each segment represents the segment of the account code |
|
|
id
|
id | integer |
id |
|
|
type
|
type | string |
type |
|
|
Intent
|
intent | string |
intent |
|
|
url
|
url | string |
url |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | True | string |
name |
|
updated-at
|
updated-at | date-time |
updated-at |
|
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
type
|
type | string |
type |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
description
|
description | string |
Descriptive notes about the contract |
|
|
end-date
|
end-date | string |
Expiry Date |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
maximum-value
|
maximum-value | string |
Maximum Commit Amount |
|
|
minimum-value
|
minimum-value | string |
Minimum Commit Amount |
|
|
name
|
name | string |
Contract Name |
|
|
number
|
number | string |
Contract Number |
|
|
start-date
|
start-date | string |
Start Date |
|
|
status
|
status | string |
Status of the Contract |
|
|
account-number
|
account-number | string |
Account number |
|
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
display-name
|
display-name | string |
display_name |
|
|
id
|
id | integer |
Coupa Internal ID |
|
|
name
|
name | string |
Supplier name |
|
|
number
|
number | string |
Supplier number |
|
|
status
|
status | string |
Supplier status |
|
|
supplier-account
|
supplier-account | string |
Supplier Account Number |
|
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
version
|
version | integer |
version |
|
|
description
|
description | True | string |
description |
|
id
|
id | integer |
Coupa unique identifier |
|
|
updated-at
|
updated-at | date-time |
Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
Image url |
|
|
name
|
name | string |
Item name |
|
|
description
|
description | string |
Item desciption |
|
|
item-number
|
item-number | string |
Unique item number |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
name
|
name | string |
name |
|
|
code
|
code | string |
code |
|
|
active
|
active | boolean |
Active\Inactive |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
id
|
id | integer |
Coupa unique identifier |
|
|
image-url
|
image-url | string |
URL for item image (will be copied into Coupa on item create/update) |
|
|
line-num
|
line-num | integer |
line_num |
|
|
line-type
|
line-type | string |
line type |
|
|
order-line-id
|
order-line-id | integer |
order_line_id |
|
|
status
|
status | string |
transaction status |
|
|
total
|
total | number |
total |
|
|
transmission-emails
|
transmission-emails | string |
Transmission emails |
|
|
transmission-method-override
|
transmission-method-override | string |
Transmission method override |
|
|
unit-price
|
unit-price | number |
line item price |
|
|
name
|
name | string |
name |
|
|
Location Code
|
location-code | string |
location-code |
|
|
street1
|
street1 | string |
street1 |
|
|
street2
|
street2 | string |
street2 |
|
|
city
|
city | string |
city |
|
|
State
|
state | string |
state |
|
|
Postcode
|
postal-code | string |
postal-code |
|
|
code
|
code | True | string |
code |
|
id
|
id | integer |
Coupa unique identifier |
|
|
name
|
name | string |
name |
|
|
ID
|
id | integer |
id |
|
|
ship-to-attention
|
ship-to-attention | string |
Ship to Address Attention |
|
|
status
|
status | True | string |
transaction status |
Returns
- Body
- RequisitionHeader
Suppliers - Query suppliers
Query suppliers
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of Supplier
Users - Query users
Query users
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
login
|
login | string |
login |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
order_by
|
order_by | string |
order_by |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filter
|
filter | string |
filter |
Returns
- response
- array of UserSimple
Definitions
RequisitionHeader
| Name | Path | Type | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachments | |
|
exported
|
exported | boolean |
Indicates if transaction has been exported |
|
id
|
id | integer |
Coupa unique identifier |
|
justification
|
justification | string |
Requisition Justification Comments |
|
need-by-date
|
need-by-date | date-time |
Item Need By Date |
|
req-title
|
req-title | string |
Optional title of the Requisition |
|
requester
|
requester | UserSimple | |
|
created-by
|
created-by | UserSimple | |
|
requisition-lines
|
requisition-lines | array of RequisitionLine | |
|
ship-to-address
|
ship-to-address | Address | |
|
ship-to-attention
|
ship-to-attention | string |
Ship to Address Attention |
|
status
|
status | string |
transaction status |
RequisitionLine
| Name | Path | Type | Description |
|---|---|---|---|
|
account
|
account | Account | |
|
attachments
|
attachments | array of Attachments | |
|
commodity
|
commodity | Commodity | |
|
contract
|
contract | Contract | |
|
currency
|
currency | Currency | |
|
description
|
description | string |
description |
|
form-response
|
form-response | FormResponse | |
|
id
|
id | integer |
Coupa unique identifier |
|
image-url
|
image-url | string |
Image url |
|
item
|
item | Item | |
|
line-num
|
line-num | integer |
line_num |
|
line-owner
|
line-owner | UserSimple | |
|
line-type
|
line-type | string |
line type |
|
order-line-id
|
order-line-id | integer |
order_line_id |
|
status
|
status | string |
transaction status |
|
supplier
|
supplier | Supplier | |
|
total
|
total | number |
total |
|
transmission-emails
|
transmission-emails | string |
Transmission emails |
|
transmission-method-override
|
transmission-method-override | string |
Transmission method override |
|
unit-price
|
unit-price | number |
line item price |
|
uom
|
uom | Uom |
Invoices
| Name | Path | Type | Description |
|---|---|---|---|
|
invoice-date
|
invoice-date | string |
invoice-date |
|
invoice-number
|
invoice-number | string |
invoice-number |
|
line-level-taxation
|
line-level-taxation | boolean |
line-level-taxation |
|
total-with-taxes
|
total-with-taxes | string |
total-with-taxes |
|
document-type
|
document-type | string |
document-type |
|
login
|
requested-by.login | string |
login |
|
account-type
|
account-type | AccountType | |
|
code
|
currency.code | string |
code |
|
supplier
|
supplier | Supplier | |
|
location-code
|
ship-to-address | string |
location-code |
|
invoice-lines
|
invoice-lines | array of object | |
|
account
|
invoice-lines.account | Account | |
|
accounting-total
|
invoice-lines.accounting-total | string |
accounting-total |
|
description
|
invoice-lines.description | string |
description |
|
line-num
|
invoice-lines.line-num | integer |
line-num |
|
line-id
|
invoice-lines.id | integer |
Coupa Internal Order Line ID |
|
order-header-num
|
invoice-lines.order-header-num | integer |
order-header-num |
|
po-number
|
invoice-lines.po-number | string |
po-number |
|
order-line-num
|
invoice-lines.order-line-num | string |
order-line-num |
|
price
|
invoice-lines.price | string |
price |
|
quantity
|
invoice-lines.quantity | string |
quantity |
|
total
|
invoice-lines.total | string |
total |
|
type
|
invoice-lines.type | string |
type |
|
contract
|
invoice-lines.contract | Contract | |
|
currency
|
invoice-lines.currency | Currency | |
|
uom
|
invoice-lines.uom | Uom |
PurchaseOrder
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
|
created-at
|
created-at | string |
created-at |
|
status
|
status | string |
status |
|
ship-to-attention
|
ship-to-attention | string |
ship-to-attention |
|
id
|
ship-to-address.id | integer |
id |
|
name
|
ship-to-address.name | string |
name |
|
order-lines
|
order-lines | array of OrderLine |
Attachments
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
|
type
|
type | string |
type |
|
Intent
|
intent | string |
intent |
|
url
|
url | string |
url |
Address
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
name |
|
Location Code
|
location-code | string |
location-code |
|
street1
|
street1 | string |
street1 |
|
street2
|
street2 | string |
street2 |
|
city
|
city | string |
city |
|
State
|
state | string |
state |
|
Postcode
|
postal-code | string |
postal-code |
|
country
|
country | Country | |
|
ID
|
id | integer |
id |
Country
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
name |
OrderPad
| Name | Path | Type | Description |
|---|---|---|---|
|
add-all-items
|
add-all-items | string |
Flag indicating to add all items |
|
any-supplier
|
any-supplier | string |
any_supplier |
|
base-value
|
base-value |
base_value |
|
|
base-value-currency
|
base-value-currency | Currency | |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
name |
|
order-pad-lines
|
order-pad-lines | array of OrderPadLine |
OrderPadLine
| Name | Path | Type | Description |
|---|---|---|---|
|
item
|
item | Item | |
|
order-amount-method
|
order-amount-method | string |
order_amount_method |
|
supplier-id
|
supplier-id | integer |
supplier_id |
|
par-level
|
par-level | number |
par_level |
|
amount
|
amount | number |
amount |
|
id
|
id | integer |
Coupa unique identifier |
Comments
| Name | Path | Type | Description |
|---|---|---|---|
|
commentable-id
|
commentable-id | integer |
commentable-id |
|
comments
|
comments | string |
comments |
Currency
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string | |
|
enabled
|
enabled | string |
Enabled |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
name |
Contract
| Name | Path | Type | Description |
|---|---|---|---|
|
contract-terms
|
contract-terms | array of ContractTerm | |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
description
|
description | string |
Descriptive notes about the contract |
|
end-date
|
end-date | string |
Expiry Date |
|
id
|
id | integer |
Coupa unique identifier |
|
maximum-value
|
maximum-value | string |
Maximum Commit Amount |
|
minimum-value
|
minimum-value | string |
Minimum Commit Amount |
|
name
|
name | string |
Contract Name |
|
number
|
number | string |
Contract Number |
|
start-date
|
start-date | string |
Start Date |
|
status
|
status | string |
Status of the Contract |
|
supplier
|
supplier | Supplier | |
|
supplier-account
|
supplier-account | string |
Supplier Account Number |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
version
|
version | integer |
version |
ContractTerm
| Name | Path | Type | Description |
|---|---|---|---|
|
contract-term-type
|
contract-term-type | string |
contract term type |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
name |
|
tier-1-disc-pct
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
tier-1-upper-bound
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
tier-2-disc-pct
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
tier-2-upper-bound
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
tier-3-disc-pct
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
tier-3-upper-bound
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
type
|
type | string |
type |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
use-pct-discounts
|
use-pct-discounts | string |
use_pct_discounts |
Supplier
| Name | Path | Type | Description |
|---|---|---|---|
|
account-number
|
account-number | string |
Account number |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
display-name
|
display-name | string |
display_name |
|
id
|
id | integer |
Coupa Internal ID |
|
name
|
name | string |
Supplier name |
|
number
|
number | string |
Supplier number |
|
status
|
status | string |
Supplier status |
UserSimple
| Name | Path | Type | Description |
|---|---|---|---|
|
active
|
active | boolean |
Active\Inactive |
|
approval-groups
|
approval-groups | array of UserGroup | |
|
business-group-security-type
|
business-group-security-type | integer |
business_group_security_type |
|
content-groups
|
content-groups | array of BusinessGroup | |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
email
|
string |
|
|
|
login
|
login | string |
employee number |
|
fullname
|
fullname | string |
full name |
|
id
|
id | integer |
Coupa unique identifier |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
user-groups
|
user-groups | array of UserGroup |
UserGroup
| Name | Path | Type | Description |
|---|---|---|---|
|
active
|
active | boolean |
Active |
|
can-approve
|
can-approve | boolean |
User group has the ability to be an approver |
|
content-groups
|
content-groups | array of BusinessGroup | |
|
description
|
description | string |
Description |
|
id
|
id | integer |
Coupa unique identifier |
BusinessGroup
| Name | Path | Type | Description |
|---|---|---|---|
|
description
|
description | string |
description |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
name |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
Commodity
| Name | Path | Type | Description |
|---|---|---|---|
|
active
|
active | boolean |
Active\Inactive |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
name |
|
updated-at
|
updated-at | date-time |
updated-at |
Item
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
Item name |
|
description
|
description | string |
Item desciption |
|
item-number
|
item-number | string |
Unique item number |
|
active
|
active | boolean |
Active\Inactive |
|
commodity
|
commodity | Commodity | |
|
uom
|
uom | Uom | |
|
id
|
id | integer |
Coupa unique identifier |
|
image-url
|
image-url | string |
URL for item image (will be copied into Coupa on item create/update) |
Uom
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
name |
|
code
|
code | string |
code |
|
active
|
active | boolean |
Active\Inactive |
|
id
|
id | integer |
Coupa unique identifier |
SupplierItem
| Name | Path | Type | Description |
|---|---|---|---|
|
price
|
price | string |
price |
|
currency
|
currency | Currency | |
|
contract
|
contract | Contract | |
|
contract-term
|
contract-term | ContractTerm | |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
item
|
item | Item | |
|
id
|
id | integer |
Coupa unique identifier |
|
lead-time
|
lead-time | integer |
lead_time |
|
manufacturer
|
manufacturer | string |
manufacturer |
|
minimum-order-quantity
|
minimum-order-quantity | string |
minimum_order_quantity |
|
order-increment
|
order-increment | string |
order_increment |
|
price-tier-1
|
price-tier-1 | string |
price_tier_1 |
|
price-tier-2
|
price-tier-2 | string |
price_tier_2 |
|
price-tier-3
|
price-tier-3 | string |
price_tier_3 |
|
supplier
|
supplier | Supplier | |
|
preferred
|
preferred | boolean |
Indicates preferred supplier for this item |
|
supplier-aux-part-num
|
supplier-aux-part-num | string |
supplier_aux_part_num |
|
supplier-part-num
|
supplier-part-num | string |
supplier_part_num |
|
unspsc-code
|
unspsc-code | string |
UNSPSC code |
IntegrationRun
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Coupa unique identifier |
|
integration
|
integration | Integration | |
|
integration-errors
|
integration-errors | array of IntegrationError | |
|
records-processed
|
records-processed | integer |
records_processed |
|
start-time
|
start-time | string |
start_time |
|
status
|
status | string |
transaction status |
|
total-records
|
total-records | integer |
total_records |
|
updated-at
|
updated-at | date-time |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
IntegrationError
| Name | Path | Type | Description |
|---|---|---|---|
|
contact-alert-type
|
contact-alert-type | string |
contact_alert_type |
|
created-by
|
created-by | UserSimple | |
|
creation-method
|
creation-method | string |
creation_method |
|
document-id
|
document-id | integer |
document_id |
|
document-status
|
document-status | string |
document_status |
|
document-type
|
document-type | string |
document_type |
|
id
|
id | integer |
Coupa unique identifier |
|
integration-filename
|
integration-filename | string |
filename that is associated with integration error |
|
status
|
status | string |
transaction status |
|
updated-at
|
updated-at | date-time |
Automatically created by Coupa |
|
updated-by
|
updated-by | UserSimple |
Integration
| Name | Path | Type | Description |
|---|---|---|---|
|
business-object
|
business-object | string |
Business Object |
|
code
|
code | string |
Unique Integration Code |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
direction
|
direction | string |
Direction |
|
end-system
|
end-system | string |
End System |
|
end-system-type
|
end-system-type | string |
End System Type |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
Integration Name |
|
standard
|
standard | boolean |
Standard |
OrderLine
| Name | Path | Type | Description |
|---|---|---|---|
|
account
|
account | Account | |
|
accounting-total
|
accounting-total | number |
accounting_total |
|
attachments
|
attachments | array of Attachments | |
|
commodity
|
commodity | Commodity | |
|
contract
|
contract | Contract | |
|
description
|
description | string |
description |
|
id
|
id | integer |
Coupa unique identifier |
|
invoiced
|
invoiced | number |
invoiced |
|
item
|
item | Item | |
|
line-num
|
line-num | string |
line_num |
|
order-header-id
|
order-header-id | integer |
order_header_id |
|
price
|
price | number |
price |
|
quantity
|
quantity | number |
quantity |
|
received
|
received | string |
Quantity/Amount received |
|
requester
|
requester | UserSimple | |
|
source-part-num
|
source-part-num | string |
source_part_num |
|
status
|
status | string |
transaction status |
|
supplier
|
supplier | Supplier | |
|
total
|
total | number |
total |
|
type
|
type | string |
type |
|
uom
|
uom | Uom |
InventoryTransaction
| Name | Path | Type | Description |
|---|---|---|---|
|
account
|
account | Account | |
|
attachments
|
attachments | array of Attachments | |
|
id
|
id | integer |
Coupa's Internal Inventory Transaction ID |
|
item
|
item | Item | |
|
order-line
|
order-line | OrderLine | |
|
price
|
price | number |
Item Price |
|
quantity
|
quantity | number |
Receipt Quantity |
|
receipt
|
receipt | Receipt | |
|
requester
|
requester | UserSimple | |
|
status
|
status | string |
Inventory Transaction Status |
|
total
|
total | number |
Receipt Total |
|
transaction-date
|
transaction-date | date-time |
Actual date of transaction |
|
type
|
type | string |
Inventory Transaction Type |
|
uom
|
uom | Uom | |
|
updated-at
|
updated-at | date-time |
Time of Inventory Transaction Updation |
Account
| Name | Path | Type | Description |
|---|---|---|---|
|
account-type
|
account-type | AccountType | |
|
account-type-id
|
account-type-id | integer |
Account Type Id |
|
active
|
active | boolean |
Active\Inactive flag |
|
code
|
code | string |
All segments concatenated with a hyphen ( - ) |
|
created-at
|
created-at | string |
YYYY-MM-DDTHH:MM:SS+HH:MMZ |
|
created-by
|
created-by | UserSimple | |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
This is the nickname for the account. |
|
segment-1
|
segment-1 | string |
Each segment represents the segment of the account code |
|
segment-2
|
segment-2 | string |
Each segment represents the segment of the account code |
|
segment-3
|
segment-3 | string |
Each segment represents the segment of the account code |
|
segment-4
|
segment-4 | string |
Each segment represents the segment of the account code |
|
segment-5
|
segment-5 | string |
Each segment represents the segment of the account code |
|
segment-6
|
segment-6 | string |
Each segment represents the segment of the account code |
|
updated-by
|
updated-by | UserSimple |
AccountType
| Name | Path | Type | Description |
|---|---|---|---|
|
active
|
active | boolean |
A false value will inactivate the COA |
|
currency
|
currency | Currency | |
|
id
|
id | integer |
Coupa unique identifier |
|
name
|
name | string |
name |
Receipt
| Name | Path | Type | Description |
|---|---|---|---|
|
created-at
|
created-at | string |
Automatically created by Coupa in the format |
|
id
|
id | integer |
Coupa unique identifier |
|
quantity
|
quantity | number |
quantity |
|
receipt-date
|
receipt-date | date-time |
receipt_date |
|
total
|
total | number |
total |
|
unit-price
|
unit-price | number |
line item price |
|
uom
|
uom | Uom | |
|
updated-at
|
updated-at | date-time |
Automatically created by Coupa in the format |
LookupValue
| Name | Path | Type | Description |
|---|---|---|---|
|
active
|
active | boolean |
Active\Inactive |
|
name
|
name | string |
Name of the lookup value |
|
description
|
description | string |
Description of the lookup value |
|
external-ref-num
|
external-ref-num | string |
External Ref Num (actual account value when used in accounting) |
|
id
|
id | integer |
Coupa unique identifier |
|
is-default
|
is-default | boolean |
is_default |
|
lookup
|
lookup | Lookup | |
|
lookup-id
|
lookup-id | integer |
lookup_id |
Lookup
| Name | Path | Type | Description |
|---|---|---|---|
|
active
|
active | boolean |
Active\Inactive Flag |
|
description
|
description | string |
description |
|
id
|
id | integer |
Coupa unique identifier |
|
level-1-name
|
level-1-name | string |
level_1_name |
|
level-2-name
|
level-2-name | string |
level_2_name |
|
level-3-name
|
level-3-name | string |
level_3_name |
|
level-4-name
|
level-4-name | string |
level_4_name |
|
name
|
name | string |
name |
FormResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Coupa unique identifier |
|
updated-at
|
updated-at | date-time |
Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ |