Skip to main content

 

 

Coupa Success Portal

Expense API

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

See Integration Best Practices for more info.

Actions

Expense Reports

Verb Path Action Description
GET /api/expense_reports index Query expense reports
GET /api/expense_reports/:id show Show expense report

Expense Report Line

Verb Path Action Description
GET /api/expense_reports index Query expense reports
GET /api/expense_lines/classify classify Classify
GET /api/expense_reports/:expense_report_id/expense_lines index Query expense lines
GET /api/expense_lines index Query expense lines
GET /api/expense_lines/mobile_form mobile_form Create expense line via mobile form
GET /api/expense_reports/:expense_report_id/expense_lines/:id show Show expense line
GET /api/expense_lines/:id show Show expense line

Elements

Expense Reports

These are the elements available for the Approvals API:

Element Description Type API In API Out Required Length Allowable Values
approvals approvals integer   Yes No -  
audit-score Coupa's Audit Score integer   Yes No -  
auditor-note Auditor Comments on Expense Report text Yes Yes No -  
comments Comments integer   Yes      
created-at Time of Record Creation datetime   Yes No -  
created-by User who created integer   Yes No -  
currency Currency Code integer   Yes No -  
events events integer   Yes No -  
expense-lines expense_lines ExpenseLine Yes Yes No -  
ExpenseReport submitted_by integer     No   Any
expense-policy-violations expense_policy_violations integer   Yes No -  
expensed-by expensed_by User Yes Yes No -  
exported? Indicates if transaction has been exported integer   Yes No -  
external-src-name external_src_name string Yes Yes No -  
external-src-ref external_src_ref string Yes Yes No -  
id Coupa's Expense Report ID integer   Yes No -  
last-exported-at Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   Yes No -  
paid Has expense report been paid? integer Yes Yes No -  
payment payment Payment Yes Yes No -  
reject-reason Reason why report was rejected text Yes Yes No -  
status Current Expense Report Status string   Yes No -  
submitted-at Date Expense Report was Submitted for Approval datetime Yes Yes No -  
title Expense Report Title string Yes Yes No -  
total Expense Report Total in Transactional Currency decimal   Yes No -  
updated-at Time of Record Creation datetime   Yes No -  
updated-by User who updated integer   Yes No -

Expense Reports Lines

These are the columns available for the Expense Report Line:

Element Description Type API In API Out Required Length Allowable Values
account The billing account string for the expense line Account Yes Yes No -  
account-allocations Allocation of the accounting-total for the billing account string. ExpenseLineAllocation Yes Yes No -  
accounting-total The expense line total in the instance's accounting currency, defined for the Chart of Accounts the account is from decimal   Yes No -  
accounting-total-currency The currency in which the accounting total is in Currency Yes Yes No -  
amount The expense line total in the user's default currency decimal Yes Yes Yes -  
approved-amount Final amount in user's default currency once Report is in Approved for Payment status decimal Yes Yes No -  
audit-status An auditor specified status for each expense line or itemized expense line. Example: when an auditor reviews an expense line or itemized expense line, the auditor could set the audit status as 'verified receipt online', 'approved without receipt', and so on. AuditStatus Yes Yes No -  
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   Yes No -  
created-by User who created the expense line or itemized expense line integer   Yes No -  
currency The currency (CAD, USD, NTD, JPY, ect) used to pay for the expense line or itemized expense line. Currency Yes Yes Yes -  
custom-field-1 Expense line Custom Field 1 string Yes Yes No -  
custom-field-10 Expense line Custom Field 10 text Yes Yes No -  
custom-field-11 Expense line Custom Field 11 decimal Yes Yes No -  
custom-field-12 Expense line Custom Field 12 string Yes Yes No -  
custom-field-13 Expense line Custom Field 13 string Yes Yes No -  
custom-field-14 Expense line Custom Field 14 string Yes Yes No -  
custom-field-15 Expense line Custom Field 15 string Yes Yes No -  
custom-field-16 Expense line Custom Field 16 string Yes Yes No -  
custom-field-17 Expense line Custom Field 17 string Yes Yes No -  
custom-field-18 Expense line Custom Field 18 string Yes Yes No -  
custom-field-19 Expense line Custom Field 19 string Yes Yes No -  
custom-field-2 Expense line Custom Field 2 string Yes Yes No -  
custom-field-20 Expense line Custom Field 20 string Yes Yes No -  
custom-field-3 Expense line Custom Field 3 string Yes Yes No -  
custom-field-4 Expense line Custom Field 4 string Yes Yes No -  
custom-field-5 Expense line Custom Field 5 string Yes Yes No -  
custom-field-6 Expense line Custom Field 6 string Yes Yes No -  
custom-field-7 Expense line Custom Field 7 string Yes Yes No -  
custom-field-8 Expense line Custom Field 8 string Yes Yes No -  
custom-field-9 Expense line Custom Field 9 string Yes Yes No -  
description Description provided by the user who created or modified the expense line or itemized expense line string Yes Yes Yes -  
divisor Divisor amount if an expense category has a divisor set decimal Yes Yes No -  
end-date When enabled, this specifies when an expense line or itemized expense line purchase ends. Example: an employee on business travel checks out of a hotel. datetime Yes Yes No -  
exchange-rate Exchange rate used to calculate total, if a foreign currency is set. If users are able to set their own exchange rates, this will be the exchange rate they enter. If users are not able to set their own exchange rates, this will be the master data exchange rate set by customers in the Coupa instance. decimal Yes Yes No -  
expense-artifacts Information for each receipt attached to the expense line integer   Yes No -  
expense-category User assigned expense category for an expense line or itemized expense line. Examples: airfare, lodging, meal-dinner, parking, rental car, taxi…ect. ExpenseCategory Yes Yes Yes -  
expense-category-custom-field-1 Expense category custom field 1 string Yes Yes No -  
expense-category-custom-field-10 Expense category custom field 10 string Yes Yes No -  
expense-category-custom-field-2 Expense category custom field 2 string Yes Yes No -  
expense-category-custom-field-3 Expense category custom field 3 string Yes Yes No -  
expense-category-custom-field-4 Expense category custom field 4 string Yes Yes No -  
expense-category-custom-field-5 Expense category custom field 5 string Yes Yes No -  
expense-category-custom-field-6 Expense category custom field 6 string Yes Yes No -  
expense-category-custom-field-7 Expense category custom field 7 string Yes Yes No -  
expense-category-custom-field-8 Expense category custom field 8 string Yes Yes No -  
expense-category-custom-field-9 Expense category custom field 9 string Yes Yes No -  
expense-date Expense date of the line, populated by user for manually created lines and by Corp Card Integration from Transaction date for Corp Card transaction lines. Created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime Yes Yes Yes -  
expense-line-imported-data Points to additional or original data when processing corporate credit cards or travel. integer   Yes No -  
expense-report-id The Expense Report unqiue id integer   Yes No -  
expensed-by User who the expense report is being submitted for User Yes Yes No -  
external-src-data Denotes the Filename that the expense line was created from string   Yes No -  
external-src-name Denotes the type of external source the expense line was created from string Yes Yes No -  
external-src-ref Denotes the unique transaction id number from the Corp Card transaction that the expense line was created from string Yes Yes No -  
foreign-currency The foreign currency if expense line is set to a currency other than the User's deafult currency Currency Yes Yes No -  
foreign-currency-amount The expense line amount in the foreign currency. decimal Yes Yes No -  
foreign-currency-id The Coupa internal ID associated with the foreign currency record. integer       -  
frugality The frugality evauation for a given expense line or itemized expense line integer   Yes No -  
id Coupa unique ID for each expense line integer Yes Yes No -  
itemized-expense-lines Identifies an expense line as an itemized expense line. Note: Itemized expense lines can only be created if an admin enables Prompt users to itemize receipt for an Expense Category (Setup > Expense Tools > Expense categories). integer Yes     -  
merchant The user specified merchant for the item or service that was purchased. string Yes Yes No -  
order-line-id  This is used when converting a purchase order to a 'pre-approved' expense. integer Yes Yes No -  
over-limit? Specifies whether the expense line or an itemized expense line is over the admin specified limit integer   Yes No -  
parent-expense-line-id The id of an itemized expense line's parent expense line integer   Yes No -  
period Budget Period accounting string is associated with, if applicable Period Yes Yes No -  
reason The user specified reason why the item or service was purchased. string Yes Yes No -  
receipt-total-amount Total amount of receipt. decimal Yes Yes No -  
receipt-total-currency-id The Coupa internal ID associated with the receipt total currency integer Yes Yes No -  
reporting-total Total Amount reflected based on the reporting total set up in Dashboard configuration decimal   Yes No -  
start-date When enabled, this specifies when an expense line or itemized expense line purchase starts. Example: an employee on business travel checks into a hotel. datetime Yes Yes No -  
status The expense report status string   Yes No -  
suggested-exchange-rate If users are able to set their own exchange rates, this will be the master data exchange rate set by customer in Coupa instance. integer   Yes No -  
type The expense line type: ExpenseLine or ItemizedExpenseLine string   Yes No -  
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ datetime   Yes No -  
updated-by User who updated the expense report integer   Yes No -

 

  • Was this article helpful?