Expenses v4
The Expenses API can be used to read the expenses that belong to a specific expense report and modify an expense on an existing expense report. This API can be used to change attributes like transaction date, transaction amount, location, etc.
Prior Versions
- Expense entry v1.1 (Deprecated) documentation is available here
- Expense Entry v3 documentation is available here
- Expense Itemizations v3 documentation is available here
Limitations
Access to this documentation does not provide access to the API.
Products and Editions
- Concur Expense Professional Edition
- Concur Expense Standard Edition
Scope Usage
Required Scopes:
Name | Description | Endpoint |
---|---|---|
expense.report.read |
Get information about expense reports. | GET |
expense.report.readwrite |
Read and write expense report headers. | PATCH |
user.read |
Get User Information, necessary for userID . |
GET |
Optional Scope:
Name | Description | Endpoint |
---|---|---|
spend.listitem.read |
Read only access to spend list items listItemId . |
GET |
spend.list.read |
Read only access to spend list and category details. | GET |
Dependencies
SAP Concur clients must purchase Concur Expense in order to use this API. This API requires the Identity v4 API which is currently only available to approved early access partners. Please contact your SAP Concur representative for more information.
Access Token Usage
This API supports both company level and user level access tokens.
Retrieve Expenses on a Specific Report ID
Retrieves the expenses that belong to a specific report ID.
Scopes
expense.report.read
- Refer to Scope Usage for full details.
Request
URI Template
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/expenses
Parameters
Name | Type | Format | Description |
---|---|---|---|
userID |
string |
- | Required The unique identifier of the SAP Concur user. Use Identity v4 API to retrieve the userID . |
contextType |
string |
- | Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported value: TRAVELER |
reportId |
string |
- | Required The unique identifier of the report that is being read. |
Headers
- RFC 7231 Accept-Language
- RFC 7231 Content-Type
- RFC 7231 Content-Encoding
- RFC 7234 Cache-Control
- RFC 7232 If-Modified-Since
- RFC 7231 Accept-Encoding
- RFC 7235 Authorization - Bearer Token that identifies the caller. This is the Company or User access token.
Response
Status Codes
Payload
Example
Request
curl --location --request GET 'https://us.api.concursolutions.com/expensereports/v4/users/32C2FCC3-B2E8-4907-9672-5B3F49B1C643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json'
Response
200 OK
[
{
"expenseId": "84FCBB92BD4E5342B849DAC29FD163A1",
"approverAdjustedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"allocationState": "NOT_ALLOCATED",
"allocationSetId": null,
"approvedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"businessPurpose": "test",
"claimedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"ereceiptImageId": null,
"exchangeRate": {
"value": 1.00000000000000,
"operation": "MULTIPLY"
},
"expenseSourceIdentifiers": null,
"expenseType": {
"id": "LUNCH",
"name": "Lunch",
"code": "OTHER",
"isDeleted": false
},
"hasBlockingExceptions": false,
"hasExceptions": false,
"hasMissingReceiptDeclaration": false,
"isAutoCreated": false,
"imageCertificationStatus": null,
"isImageRequired": true,
"isPaperReceiptRequired": false,
"isPersonalExpense": false,
"location": {
"id": "04F3ED00D0884F4681628E3337A5B515",
"name": "Bellevue, Washington",
"city": "Bellevue",
"countrySubDivisionCode": "US-WA",
"countryCode": "US"
},
"paymentType": {
"id": "CASH",
"name": "Cash",
"code": "CASH"
},
"postedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"receiptImageId": null,
"ticketNumber": null,
"transactionAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"transactionDate": "2020-03-11",
"travelAllowance": {
"dailyLimitAmount": null,
"dailyTravelAllowanceId": null,
"isExpensePartOfTravelAllowance": false
},
"vendor": null,
"attendeeCount": 1,
"links": [
{
"rel": "self",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1",
"method": "GET",
"isTemplated": false
},
{
"rel": "itemizations",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/itemizations",
"method": "GET",
"isTemplated": false
},
{
"rel": "comments",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/comments",
"method": "GET",
"isTemplated": false
}
]
},
{
"expenseId": "29EE3C62F5D844458828A5C1086072D1",
"approverAdjustedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"allocationState": "NOT_ALLOCATED",
"allocationSetId": null,
"approvedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"businessPurpose": "Facility supplies",
"claimedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"ereceiptImageId": null,
"exchangeRate": {
"value": 1.00000000000000,
"operation": "MULTIPLY"
},
"expenseSourceIdentifiers": null,
"expenseType": {
"id": "OFCSP",
"name": "Office Supplies",
"code": "OTHER",
"isDeleted": false
},
"hasBlockingExceptions": false,
"hasExceptions": false,
"hasMissingReceiptDeclaration": false,
"isAutoCreated": false,
"imageCertificationStatus": null,
"isImageRequired": true,
"isPaperReceiptRequired": false,
"isPersonalExpense": false,
"location": {
"id": "0BC6B782B77349898E2CA814F5B57C08",
"name": "Seattle, Washington",
"city": "Seattle",
"countrySubDivisionCode": "US-WA",
"countryCode": "US"
},
"paymentType": {
"id": "1022",
"name": "Mastercard",
"code": "CBCP"
},
"postedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"receiptImageId": null,
"ticketNumber": null,
"transactionAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"transactionDate": "2020-03-11",
"travelAllowance": {
"dailyLimitAmount": null,
"dailyTravelAllowanceId": null,
"isExpensePartOfTravelAllowance": false
},
"vendor": {
"id": null,
"name": null,
"description": "Antioch Construction"
},
"attendeeCount": 0,
"links": [
{
"rel": "self",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/29EE3C62F5D844458828A5C1086072D1",
"method": "GET",
"isTemplated": false
},
{
"rel": "itemizations",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/29EE3C62F5D844458828A5C1086072D1/itemizations",
"method": "GET",
"isTemplated": false
},
{
"rel": "comments",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/29EE3C62F5D844458828A5C1086072D1/comments",
"method": "GET",
"isTemplated": false
}
]
}
]
Retrieve an Expense by ID
Retrieves the details of the specific expense entry on a report.
Scopes
expense.report.read
- Refer to Scope Usage for full details.
Request
URI Template
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/expenses/{expenseId}
Parameters
Name | Type | Format | Description |
---|---|---|---|
userID |
string |
- | Required The unique identifier of the SAP Concur user. Use Identity v4 API to retrieve the userID . |
contextType |
string |
- | Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported value: TRAVELER , MANAGER , PROXY |
reportId |
string |
- | Required The unique identifier of the report to which this expense entry belongs. |
expenseId |
string |
- | Required The unique identifier of the expense entry that is being read. |
Headers
- RFC 7231 Accept-Language
- RFC 7231 Content-Type
- RFC 7231 Content-Encoding
- RFC 7234 Cache-Control
- RFC 7232 If-Modified-Since
- RFC 7231 Accept-Encoding
- RFC 7235 Authorization - Bearer Token that identifies the caller. This is the Company or User access token.
Response
Status Codes
Payload
Example
Request
curl --location --request GET 'https://us.api.concursolutions.com/expensereports/v4/users/32C2FCC3-B2E8-4907-9672-5B3F49B1C643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json'
Response
200 OK
{
"expenseId": "84FCBB92BD4E5342B849DAC29FD163A1",
"approverAdjustedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"allocationState": "NOT_ALLOCATED",
"allocationSetId": null,
"approvedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"businessPurpose": "test",
"claimedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"ereceiptImageId": null,
"exchangeRate": {
"value": 1.00000000000000,
"operation": "MULTIPLY"
},
"expenseSourceIdentifiers": null,
"expenseType": {
"id": "ONLIN",
"name": "Online Fees",
"code": "OTHER",
"isDeleted": false
},
"hasBlockingExceptions": false,
"hasExceptions": false,
"hasMissingReceiptDeclaration": false,
"isAutoCreated": false,
"imageCertificationStatus": null,
"isImageRequired": true,
"isPaperReceiptRequired": false,
"isPersonalExpense": false,
"location": {
"id": "04F3ED00D0884F4681628E3337A5B515",
"name": "Bellevue, Washington",
"city": "Bellevue",
"countrySubDivisionCode": "US-WA",
"countryCode": "US"
},
"paymentType": {
"id": "CASH",
"name": "Cash",
"code": "CASH"
},
"postedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"receiptImageId": null,
"ticketNumber": null,
"transactionAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"transactionDate": "2020-03-11",
"travelAllowance": {
"dailyLimitAmount": null,
"dailyTravelAllowanceId": null,
"isExpensePartOfTravelAllowance": false
},
"vendor": null,
"attendeeCount": 1,
"links": [
{
"rel": "self",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1",
"method": "GET",
"isTemplated": false
},
{
"rel": "itemizations",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/itemizations",
"method": "GET",
"isTemplated": false
},
{
"rel": "comments",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/comments",
"method": "GET",
"isTemplated": false
}
],
"budgetAccrualDate": null,
"authorizationRequestExpenseId": null,
"customData": [
{
"id": "custom9",
"value": "AB8596D91C994F4DBBD820D6DCBDC599",
"isValid": true,
"listItemUrl": "https://us.api.concursolutions.com/list/v4/items?id=AB8596D91C994F4DBBD820D6DCBDC599"
}
],
"expenseTaxSummary": {
"totalTaxPostedAmount": {
"value": 0E-8,
"currencyCode": "USD"
},
"totalTaxAdjustedAmount": {
"value": 0E-8,
"currencyCode": "USD"
},
"totalReclaimPostedAmount": {
"value": 0E-8,
"currencyCode": "USD"
},
"totalReclaimAdjustedAmount": {
"value": 0E-8,
"currencyCode": "USD"
},
"netTaxAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"netAdjustedTaxAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"netReclaimAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"netReclaimAdjustedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"vatTaxTotal": null
},
"isExcludedFromCashAdvanceByUser": false,
"isExpenseBillable": false,
"isExpenseRejected": false,
"isPaperReceiptReceived": false,
"merchantTaxId": null,
"mileage": null,
"parentExpenseId": null,
"receiptType": {
"id": "N",
"status": "No Receipt"
},
"taxRateLocation": "HOME",
"travel": null,
"lastModifiedDate": null
}
Retrieve Itemizations on a Specific Expense ID
Retrieves the itemizations that belong to a specific expense ID.
Scopes
expense.report.read
- Refer to Scope Usage for full details.
Request
URI Template
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/expenses/{expenseId}/itemizations
Parameters
Name | Type | Format | Description |
---|---|---|---|
userID |
string |
- | Required The unique identifier of the SAP Concur user. Use Identity v4 API to retrieve the userID . |
contextType |
string |
- | Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported value: TRAVELER |
reportId |
string |
- | Required The unique identifier of the report that is being read. |
expenseId |
string |
- | Required The unique identifier of the expense that is being read. |
Response
Payload
Example
Request
curl --location --request GET 'https://us.api.concursolutions.com/expensereports/v4/users/32C2FCC3-B2E8-4907-9672-5B3F49B1C643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/itemizations' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json'
Response
200 OK
[
{
"expenseId": "95GCBB92AE4E5342B849DAC29FD163A1",
"approverAdjustedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"allocationState": "NOT_ALLOCATED",
"allocationSetId": null,
"approvedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"businessPurpose": "test",
"claimedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"ereceiptImageId": null,
"exchangeRate": {
"value": 1.00000000000000,
"operation": "MULTIPLY"
},
"expenseSourceIdentifiers": null,
"expenseType": {
"id": "LUNCH",
"name": "Lunch",
"code": "OTHER",
"isDeleted": false
},
"hasBlockingExceptions": false,
"hasExceptions": false,
"hasMissingReceiptDeclaration": false,
"isAutoCreated": false,
"imageCertificationStatus": null,
"isImageRequired": true,
"isPaperReceiptRequired": false,
"isPersonalExpense": false,
"location": {
"id": "04F3ED00D0884F4681628E3337A5B515",
"name": "Bellevue, Washington",
"city": "Bellevue",
"countrySubDivisionCode": "US-WA",
"countryCode": "US"
},
"paymentType": {
"id": "CASH",
"name": "Cash",
"code": "CASH"
},
"postedAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"receiptImageId": null,
"ticketNumber": null,
"transactionAmount": {
"value": 25.00000000,
"currencyCode": "USD"
},
"transactionDate": "2020-03-11",
"travelAllowance": {
"dailyLimitAmount": null,
"dailyTravelAllowanceId": null,
"isExpensePartOfTravelAllowance": false
},
"vendor": null,
"attendeeCount": 1,
"links": [
{
"rel": "self",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/95GCBB92AE4E5342B849DAC29FD163A1",
"method": "GET",
"isTemplated": false
},
{
"rel": "comments",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/95GCBB92AE4E5342B849DAC29FD163A1/comments",
"method": "GET",
"isTemplated": false
}
]
},
{
"expenseId": "30FF3C62F5D844458828A5C1086072D1",
"approverAdjustedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"allocationState": "NOT_ALLOCATED",
"allocationSetId": null,
"approvedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"businessPurpose": "Facility supplies",
"claimedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"ereceiptImageId": null,
"exchangeRate": {
"value": 1.00000000000000,
"operation": "MULTIPLY"
},
"expenseSourceIdentifiers": null,
"expenseType": {
"id": "OFCSP",
"name": "Office Supplies",
"code": "OTHER",
"isDeleted": false
},
"hasBlockingExceptions": false,
"hasExceptions": false,
"hasMissingReceiptDeclaration": false,
"isAutoCreated": false,
"imageCertificationStatus": null,
"isImageRequired": true,
"isPaperReceiptRequired": false,
"isPersonalExpense": false,
"location": {
"id": "0BC6B782B77349898E2CA814F5B57C08",
"name": "Seattle, Washington",
"city": "Seattle",
"countrySubDivisionCode": "US-WA",
"countryCode": "US"
},
"paymentType": {
"id": "1022",
"name": "Mastercard",
"code": "CBCP"
},
"postedAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"receiptImageId": null,
"ticketNumber": null,
"transactionAmount": {
"value": 500.00000000,
"currencyCode": "USD"
},
"transactionDate": "2020-03-11",
"travelAllowance": {
"dailyLimitAmount": null,
"dailyTravelAllowanceId": null,
"isExpensePartOfTravelAllowance": false
},
"vendor": {
"id": null,
"name": null,
"description": "Antioch Construction"
},
"attendeeCount": 0,
"links": [
{
"rel": "self",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/30FF3C62F5D844458828A5C1086072D1",
"deprecation": null,
"method": "GET",
"isTemplated": false
},
{
"rel": "comments",
"href": "https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3-b2e8-4907-9672-5b3f49b1c643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/30FF3C62F5D844458828A5C1086072D1/comments",
"method": "GET",
"isTemplated": false
}
]
}
]
Update a Specific Expense Entry in a Submitted Report
Updates the specified expense on an unsubmitted or submitted report and is restricted to modify ‘Business Purpose’, ‘ Custom/Org unit’, ‘Expense Rejected’ and ‘Paper Receipt Received’ fields only.
Scopes
expense.report.readwrite
- Refer to Scope Usage for full details.
Request
URI Template
https://{datacenterURI}/expensereports/v4/reports/{reportId}/expenses/{expenseId}
Parameters
Name | Type | Format | Description |
---|---|---|---|
reportId |
string |
- | Required The unique identifier of the report to which this expense entry belongs. |
expenseId |
string |
- | Required The unique identifier of the expense entry that is being read. |
Headers
- RFC 7231 Accept-Language
- RFC 7231 Content-Type
- RFC 7231 Content-Encoding
- RFC 7234 Cache-Control
- RFC 7232 If-Modified-Since
- RFC 7231 Accept-Encoding
- RFC 7235 Authorization - Bearer Token that identifies the caller. This is the Company or User access token.
REST Design Specification
PATCH operations in Expense Reports v4 conform to the JSON Merge Patch specification:
Payload
Response
Status Codes
- 204 No Content
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 500 Internal Server Error
Payload
Update Report Expense Compact Schema
Name | Type | Format | Description |
---|---|---|---|
businessPurpose |
string |
- | The text input for the business purpose by the user. Maximum length: 64 characters. |
customData |
CustomData |
- | The details from the customData fields. These fields may not have data, depending on the configuration. |
expenseSource |
string |
- | Required The source of the expense. Supported values: EA - Expense Assistant, MOB - Mobile, OTHER - Unknown, SE - Smart Expense, TA - Travel Allowance, TR - Travel Request, UI - Web UI. |
isExpenseRejected |
boolean |
true /false |
Whether the approver or processor has rejected this expense in the report. If this is true then this expense will be sent back to the report submitted in an addendum (split) report. |
isPaperReceiptReceived |
boolean |
true /false |
Whether paper receipts have been received for the expense. |
CustomData
Name | Type | Format | Description |
---|---|---|---|
id |
string |
- | Required The unique identifier of the custom field. Examples: custom1 , orgUnit1 |
isValid |
boolean |
true /false |
Whether the value returned is valid or not. This value is returned for custom fields of all data types and is specifically evaluated for list items to represent the current status. Default: true |
value |
string |
- | The value of the custom field. This field can have values for all the supported data types such as text , integer , boolean and listItemId . Maximum length: 48 characters |
Example
Request
curl --location --request PATCH 'https://us.api.concursolutions.com/expensereports/v4/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--header 'Content-Type: text/plain' \
--data-raw '{
"customData": [
{
"id": "custom09",
"value": "81188b39-605d-2d4f-b80b-43efa84a7b49",
"isValid": true
}
],
"businessPurpose":"Office Supplies",
"expenseSource":"OTHER",
"isExpenseRejected": false,
"isPaperReceiptReceived": false
}'
Response
204 No Content
Schema
ReportExpenseSummary
Name | Type | Format | Description |
---|---|---|---|
allocationSetId |
string |
- | The identifier of the allocation set associated with the expense. Allocations which belong to the same set were created at the same time. |
allocationState |
string |
- | Required Allocation state for the expense. Supported values: FULLY_ALLOCATED , NOT_ALLOCATED , PARTIALLY_ALLOCATED |
approvedAmount |
Amount |
- | The approved amount of the expense, in the report currency. |
approverAdjustedAmount |
Amount |
- | The total amount adjusted for the expense by the approver |
attendeeCount |
integer |
int32 |
The total number of attendees associated with the expense. |
businessPurpose |
string |
- | The text input for the business purpose by the user. |
claimedAmount |
Amount |
- | The total non-personal amount claimed for reimbursement for the expense. |
ereceiptImageId |
string |
- | The unique identifier of the eReceipt image associated with the expense. |
exchangeRate |
ExchangeRate |
- | Required Exchange rate data for the expense. |
expenseId |
string |
- | Required The unique identifier for the expense. |
expenseSourceIdentifiers |
ExpenseSourceIdentifiers |
- | The list of expense sources associated with the expense |
expenseType |
ExpenseType |
- | Required The expense type information for the expense. |
fuelTypeListItem |
CustomData |
- | The unique id of Fuel Type. |
hasBlockingExceptions |
boolean |
- | Required Whether the expense has any exceptions that block it from being submitted. |
hasExceptions |
boolean |
true /false |
Required Whether the expense has any exceptions. |
hasMissingReceiptDeclaration |
boolean |
true /false |
Required Whether the expense has an affidavit declaration for missing receipt. |
imageCertificationStatus |
string |
- | The final status of the receipt image associated with the expense. |
isAutoCreated |
boolean |
true /false |
Required Whether the expense is auto-created. |
isImageRequired |
boolean |
true /false |
Required Whether the image is required for the expense. |
isPaperReceiptRequired |
boolean |
true /false |
Required Whether the paper receipt is required for the expense to be submitted. |
isPersonalExpense |
boolean |
true /false |
Required Whether the expense is marked as personal (non-reimbursable) by the user. |
jptRouteId |
string |
- | The unique route ID to identify a Japan rail route. |
links |
Link |
- | Resource links related to this call. |
location |
Location |
- | The location information of the expense. |
paymentType |
PaymentType |
- | Required The payment type information for the expense. |
postedAmount |
Amount |
- | Required The amount of the expense, in the report currency. |
receiptImageId |
string |
- | The unique identifier of the image associated with the expense. |
ticketNumber |
string |
- | The ticket number associated with the travel. |
transactionAmount |
Amount |
- | Required The amount of the expense, in the transaction currency paid to the vendor. |
transactionDate |
string |
YYYY-MM-DD |
The transaction date. |
travelAllowance |
TravelAllowance |
- | The travel allowance data associated with the expense. |
vendor |
Vendor |
- | The vendor information for the expense. |
ReportExpenseDetail
Name | Type | Format | Description |
---|---|---|---|
allocationSetId |
string |
- | The identifier of the allocation set associated with the expense. Allocations which belong to the same set are created at the same time. |
allocationState |
string |
- | Required Allocation state for the expense. Supported values: FULLY_ALLOCATED , NOT_ALLOCATED , PARTIALLY_ALLOCATED |
approvedAmount |
Amount |
- | The approved amount of the expense, in the report currency. |
approverAdjustedAmount |
Amount |
- | The total amount adjusted for the expense by the approver. |
attendeeCount |
integer |
int32 |
The total number of attendees associated with the expense. |
authorizationRequestExpenseId |
string |
- | The authorization request expense ID associated with the expense. |
budgetAccrualDate |
string |
YYYY-MM-DD |
The budget accrual date of the expense. |
businessPurpose |
string |
- | The text input for the business purpose by the user. |
claimedAmount |
Amount |
- | The total non-personal amount claimed for reimbursement for the expense |
customData |
CustomData |
- | The details from the customData fields. These fields may not have data, depending on the configuration. |
ereceiptImageId |
string |
- | The unique identifier of the eReceipt image associated with the expense. |
exchangeRate |
ExchangeRate |
- | Required Exchange rate data for the expense. |
expenseId |
string |
- | Required The unique identifier for the expense |
expenseSourceIdentifiers |
ExpenseSourceIdentifiers |
- | The list of expense sources associated with the expense. |
expenseTaxSummary |
ExpenseTaxSummary |
- | Tax information for the expense. |
expenseType |
ExpenseType |
- | Required The expense type information for the expense. |
fuelTypeListItem |
CustomData |
- | The unique id of Fuel Type. |
hasBlockingExceptions |
boolean |
true /false |
Required Whether the expense has any exceptions that blocks it from being submitted. |
hasExceptions |
boolean |
true /false |
Required Whether the expense has any exceptions. |
hasMissingReceiptDeclaration |
boolean |
true /false |
Whether the expense has an affidavit declaration for missing receipt. |
imageCertificationStatus |
string |
- | The final status of the receipt image associated with the expense. Supported values: ACCEPTED , PROCESSED , PROCESSING , PDF , FAILED , NO_PROCESSING_REQUIRED |
isAutoCreated |
boolean |
true /false |
Required Whether the expense is auto created. |
isExcludedFromCashAdvanceByUser |
boolean |
true /false |
Required Whether the user has excluded the expense from cash advance. |
isExpenseBillable |
boolean |
true /false |
Required Whether the expense is billable. |
isExpenseRejected |
boolean |
true /false |
Required Whether the approver or processor has rejected this expense in the report. If true , then this expense will be sent back to the report submitted in an addendum (split) report. |
isImageRequired |
boolean |
true /false |
Required Whether the image is required for the expense. |
isPaperReceiptReceived |
boolean |
true /false |
Required Whether the paper receipt was received for the expense. |
isPaperReceiptRequired |
boolean |
true /false |
Required Whether the paper receipt is required for the expense to be submitted. |
isPersonalExpense |
boolean |
true /false |
Required Whether the expense is marked as personal (non-reimbursable) by the user. |
jptRouteId |
string |
- | The unique route ID to identify a Japan rail route. |
links |
Link |
- | Resource links related to this call. |
location |
Location |
- | The location information of the expense. |
merchantTaxId |
string |
- | Merchant tax ID for the expense. |
mileage |
Mileage |
- | The mileage data associated with the expense. |
parentExpenseId |
string |
- | Expense ID of the parent expense. |
paymentType |
PaymentType |
- | Required The payment type information for the expense. |
postedAmount |
Amount |
- | Required The amount of the expense, in the report currency. |
receiptImageId |
string |
- | The unique identifier of the image associated with the expense. |
receiptType |
ReceiptType |
- | Receipt type for the expense. |
taxRateLocation |
string |
- | Required Transaction location relative to the employee’s home location as defined by their user profile. Supported values: FOREIGN - The expense transaction took place in foreign currency, HOME - The expense transaction took place in the reimbursement currency, OUT_OF_PROVINCE - The expense transaction took place outside the state jurisdiction. Default: HOME |
transactionAmount |
Amount |
- | Required The amount of the expense, in the transaction currency paid to the vendor. |
transactionDate |
string |
YYYY-MM-DD |
The transaction date of the expense. |
travel |
Travel |
- | The travel data associated with the expense. |
travelAllowance |
TravelAllowance |
- | The travel allowance data associated with the expense. |
vendor |
Vendor |
- | The vendor information for the expense. |
lastModifiedDate |
string |
YYYY-MM-DDTHH:mm:ssZ |
The UTC datetime of when the expense was last modified (ISO-8601)(https://www.iso.org/iso-8601-date-and-time-format.html). |
CustomData
Name | Type | Format | Description |
---|---|---|---|
id |
string |
- | Required The unique identifier of the custom field. Examples: custom1 , orgUnit1 |
isValid |
boolean |
true /false |
Whether the value returned is valid or not. This value is returned for custom fields of all data types and is specifically evaluated for list items to represent the current status. Default: true |
value |
string |
- | The value of the custom field. This field can have values for all the supported data types such as text , integer , boolean and listItemId . Maximum length: 48 characters |
Amount
Name | Type | Format | Description |
---|---|---|---|
currencyCode |
string |
- | Required The 3-letter ISO 4217 currency code for the expense report currency, based on the user’s assigned reimbursement currency when the report was created. Examples: USD - US dollars; BRL - Brazilian real; CAD - Canadian dollar; CHF - Swiss franc; EUR - Euro; GBO - Pound sterling; HKD - Hong Kong dollar; INR - Indian rupee; MXN - Mexican peso; NOK - Norwegian krone; SEK - Swedish krona |
value |
number |
double |
Required The amount in the defined currency. |
ExpenseSourceIdentifiers
Name | Type | Format | Description |
---|---|---|---|
creditCardTransactionId |
string |
- | The unique identifier of the credit card transaction (indexed transactionId ) associated with the expense. |
ereceiptId |
string |
- | - |
eReceiptURL |
string |
- | The URL to get details of the associated eReceipt. |
expenseCaptureImageId |
string |
- | The unique identifier of the expense capture image associated with the expense. |
jptRouteId |
string |
- | The unique identifier to identify a Japan rail route. |
personalCardTransactionId |
string |
- | The unique identifier of the personal card transaction associated with the expense. |
quickExpenseId |
string |
- | The unique identifier of the mobile expense associated with the expense. |
receiptImageId |
string |
- | The unique identifier of the image associated with the expense. |
receipts |
array |
ReportReceiptMapping | Details for the associated receipts from Receipt Service v5. |
segmentId |
integer |
int64 |
The unique identifier of the segment associated with the expense. |
segmentTypeId |
string |
- | Segment type ID associated with the trip. Supported values: AIRFR - Air Ticket, AIRSU - Air Subscription, CARRT - Car Rental, DININ - Dining, EVENT - Event, HOTEL - Hotel Reservation, INSUR - Insurance, LIMOF - Limousine Reservation, MISC - Miscellaneous, PARKG - Parking Fee, RAILF - Train Ticket, RAISU - Train Subscription, TAXIF - Taxi Fare, VISA - Visa |
tripId |
integer |
int64 |
The unique identifier of the trip ID associated with the expense. |
Report Receipt Mapping
Name | Type | Format | Description |
---|---|---|---|
receiptId |
string |
UUID | Required The unique identifier of the Receipt with the expense. |
imageId |
string |
- | Required The unique identifier of the Receipt image associated with the expense. |
feature |
string |
- | Required Receipt feature of the Receipt with the expense. Supported values: ‘expenseIt’ |
version |
string |
- | Receipt version of the Receipt with the expense. Default value: 5 |
ExchangeRate
Name | Type | Format | Description |
---|---|---|---|
operation |
string |
- | Required Exchange rate operation. Supported values: MULTIPLY or DIVIDE |
value |
number |
double |
Required Exchange rate value. |
ExpenseTaxSummary
Name | Type | Format | Description |
---|---|---|---|
netAdjustedTaxAmount |
Amount |
- | Net adjusted tax amount. |
netReclaimAdjustedAmount |
Amount |
- | Net reclaim adjusted amount. |
netReclaimAmount |
Amount |
- | Net reclaim amount. |
netTaxAmount |
Amount |
- | Net tax amount. |
totalReclaimAdjustedAmount |
Amount |
- | Total reclaim adjusted amount. |
totalReclaimPostedAmount |
Amount |
- | Total reclaim posted amount. |
totalTaxAdjustedAmount |
Amount |
- | Total tax adjusted amount. |
totalTaxPostedAmount |
Amount |
- | Total tax posted amount. |
vatTaxTotal |
Amount |
- | VAT tax total amount. |
ExpenseType
Name | Type | Format | Description |
---|---|---|---|
code |
string |
- | The code of the expense type. |
id |
string |
- | Required The unique identifier of the expense type. Maximum length: 5 characters. Example: BRKFT |
isDeleted |
boolean |
true /false |
Whether the expense type returned is deleted or not. |
name |
string |
- | The name of the expense type (localized as per accept-language header). |
Location
Name | Type | Format | Description |
---|---|---|---|
city |
string |
- | The location city. |
countryCode |
string |
- | The location country ISO 3166-1 code. |
countrySubDivisionCode |
string |
- | The location country sub division ISO 3166-2 code. |
id |
string |
- | The unique identifier of the location. When location id is specified (when creating or updating a resource), other location object fields will be ignored. |
name |
string |
- | The location name (localized as per accept-language header). |
Mileage
Name | Type | Format | Description |
---|---|---|---|
hasCaravanAttached |
boolean |
true /false |
Whether the mileage expense has caravan or trailer attached to the car. Default: false |
hasDogIncluded |
boolean |
true /false |
Whether the mileage expense includes a dog for work purposes. Default: false |
hasForestOrConstructionSiteRoadInRoute |
boolean |
true /false |
Whether the mileage route is via a forest road or construction site road. Default: false |
hasForestRoadInRoute |
boolean |
true /false |
Whether the mileage route has forest road. Default: false |
hasMachinery |
boolean |
true /false |
Whether machines or equipment are transported in the car for this mileage expenses. Default: false |
hasMobileCanteenOrHeavyLoadAttached |
boolean |
true /false |
Whether the mileage expense has mobile canteen or is transporting a heavy load attached to the car. Default: false |
hasTrailerAttached |
boolean |
true /false |
Whether the mileage expense has trailer attached to the car. Default: false |
isMarkedAsHigherRate |
boolean |
true /false |
Whether a higher rate should be applied to the mileage expense. Default: false |
odometerEnd |
integer |
int32 |
The odometer reading at the end of the journey. |
odometerStart |
integer |
int32 |
The odometer reading at the start of the journey. |
passengerCount |
integer |
int32 |
The number of passengers in the vehicle during the journey. |
personalDistance |
integer |
int32 |
The portion of the journey attributed to personal use. Default: 0 |
routeId |
string |
- | The unique identifier of the route for this journey. |
totalDistance |
integer |
int32 |
Required The total distance for this journey. |
vehicleId |
string |
- | Required The unique identifier for the vehicle used for this journey. |
PaymentType
Name | Type | Format | Description |
---|---|---|---|
code |
string |
- | The code of the payment type. |
id |
string |
- | Required The unique identifier of the payment type. Maximum length: 4 characters. Example: CASH |
name |
string |
- | The name of the payment type (localized as per accept-language header). |
ReceiptType
Name | Type | Format | Description |
---|---|---|---|
id |
string |
- | Required The unique identifier for the receipt type. Supported values: N - No Receipt, R - Regular Receipt, T - Tax Receipt. Default value: N |
status |
string |
- | Receipt status (localized as per accept-language header). |
Travel
Name | Type | Format | Description |
---|---|---|---|
airlineFeeTypeCode |
string |
- | Airline fee type code. Supported values: BAGGS , BUSIN , OBENT , ONBRD , OTHER , PRACC , SEATS , TKCHG , UPGRD |
airlineFeeTypeName |
string |
- | The localized airline fee type name. |
airlineServiceClassCode |
string |
- | The airline service class code. Supported values: BUSIN , COACH , FIRST |
airlineServiceClassName |
string |
- | The localized airline service class name. |
carRentalDays |
integer |
int32 |
The number of days car was rented. Minimum value: 0 |
endLocation |
string |
- | Location where the travel ended. Maximum length: 100 characters |
hotelCheckinDate |
string |
YYYY-MM-DD |
The hotel checkin date of the expense. |
hotelCheckoutDate |
string |
YYYY-MM-DD |
The hotel checkout date of the expense. |
startLocation |
string |
- | Location where the travel started. Maximum length: 100 characters |
ticketNumber |
string |
- | The ticket number associated with the travel. Maximum length: 32 characters |
TravelAllowance
Name | Type | Format | Description |
---|---|---|---|
dailyLimitAmount |
number |
double |
The allowed amount based on government travel allowance rates. |
dailyTravelAllowanceId |
string |
- | The fixed daily travel allowance ID associated with the expense. Maximum length: 32 characters |
isExpensePartOfTravelAllowance |
boolean |
true /false |
Whether the expense is part of travel allowance. Default value: false |
Vendor
Name | Type | Format | Description |
---|---|---|---|
description |
string |
- | The description of the vendor. Maximum length: 64 characters |
id |
string |
- | The unique identifier of the vendor. |
name |
string |
- | The name of the vendor (localized as per accept-language header). |
UpdateReportExpense
Name | Type | Format | Description |
---|---|---|---|
approverAdjustedAmount |
Amount |
- | The total amount adjusted for the expense by the approver. |
authorizationRequestExpenseId |
string |
- | The authorization request expense ID associated with the expense. |
budgetAccrualDate |
string |
YYYY-MM-DD |
The budget accrual date. |
businessPurpose |
string |
- | The text input for the business purpose by the user. Maximum length: 64 characters |
comment |
string |
- | A comment that describes the expense. Maximum length: 2000 characters |
customData |
CustomData |
- | The details from the customData fields. These fields may not have data, depending on the configuration. |
exchangeRate |
ExchangeRate |
- | The exchange rate data for the expense. |
expenseSource |
string |
- | Required The source of the expense. Supported values: EA - Expense Assistant, MOB - Mobile, OTHER - Unknown, SE - Smart Expense, TA - Travel Allowance, TR - Travel Request, UI - Web UI |
expenseType |
ExpenseType |
- | The expense type data for the expense. |
fuelTypeListItem |
CustomData |
- | The unique id of Fuel Type. |
hasMissingReceiptDeclaration |
boolean |
true /false |
Whether the expense has an affidavit declaration for missing receipt. |
isCopyDownInherited |
boolean |
true /false |
If true , any change in the report expense fields will be copied down to itemizations and allocations, as per the configuration. |
isExcludedFromCashAdvanceByUser |
boolean |
true /false |
Whether the user has excluded the expense from cash advance. |
isExpenseBillable |
boolean |
true /false |
Whether the expense is billable. |
isExpenseRejected |
boolean |
true /false |
Whether the approver or processor has rejected this expense in the report. If true , then this expense will be sent back to the report submitted in an addendum (split) report. |
isPaperReceiptReceived |
boolean |
true /false |
Whether paper receipts have been received for the expense. |
isPersonalExpense |
boolean |
true /false |
Whether the expense is marked as personal (non-reimbursable) by the user. |
jptRouteId |
string |
- | The unique route ID to identify a Japan rail route. |
location |
Location |
- | The location data of the expense. |
merchantTaxId |
string |
- | The merchant tax ID for the expense. Maximum length: 64 characters |
mileage |
Mileage |
- | The mileage data associated with the expense. |
paymentType |
PaymentType |
- | The payment type data for the expense. Default: CASH |
receiptImageId |
string |
- | The unique identifier of the image associated with the expense. |
receiptType |
ReceiptType |
- | Receipt type for the expense. |
smartExpense |
SmartExpense |
- | The smart expense data associated with this expense. |
tax |
Tax |
- | The tax data associated with the expense. |
taxRateLocation |
string |
- | Transaction location relative to the employee’s home location as defined by their user profile. Supported values: FOREIGN - The expense transaction took place in foreign currency, HOME - The expense transaction took place in the reimbursement currency, OUT_OF_PROVINCE - The expense transaction took place outside the state jurisdiction |
transactionAmount |
Amount |
- | The amount of the expense, in the transaction currency paid to the vendor. |
transactionDate |
string |
YYYY-MM-DD |
The transaction date (ISO-8601) of the expense. |
travel |
Travel |
- | The travel data associated with the expense. |
travelAllowance |
TravelAllowance |
- | The travel allowance data associated with the expense. |
vendor |
Vendor |
- | The vendor data for the expense. |
SmartExpense
Name | Type | Format | Description |
---|---|---|---|
creditCardTransactionId |
string |
- | The unique identifier of the credit card transaction (indexed transactionId ) associated with the expense. |
ereceipt |
EReceipt |
- | EReceipt information for the expense. |
expenseAttendees |
ExpenseAttendees |
- | The attendee details associated with the smart expense. |
isAutoCreated |
boolean |
true /false |
Whether this expense is auto-created. This element only applies to POST expense request. Default: false |
personalCardTransactionId |
string |
- | The unique identifier of the personal card transaction associated with the expense. |
quickExpenseId |
string |
- | The unique identifier of the mobile expense associated with the expense. When quickExpenseId is specified, the exchangeRate.value field value will be ignored and its value will be read from exchange rate currency service. exchangeRate.operation will still be honored. |
trip |
Trip |
- | Trip data associated with the expense. |
Tax
Name | Type | Format | Description |
---|---|---|---|
expenseTax1 |
ExpenseTax |
- | Required The tax data for the expense. |
expenseTax2 |
ExpenseTax |
- | The tax data for the expense. |
ExpenseTax
Name | Type | Format | Description |
---|---|---|---|
customData |
CustomData | - | The details from the customData fields. These fields may not have data, depending on the configuration. |
reclaimCode |
string |
- | The tax reclaim code. Maximum length: 20 characters |
reclaimTransactionAmount |
number |
double |
The tax reclaim transaction amount. |
taxAuthorityId |
string |
- | Required The unique identifier of the tax authority. |
taxAuthorityName |
string |
- | The name of the tax authority. |
taxCode |
string |
- | The tax code. Maximum length: 20 characters |
taxFormId |
string |
- | The unique identifier of the tax form associated with the expense. |
taxLabel |
string |
- | The localized label of the tax authority. |
taxRateTypeId |
string |
- | The unique identifier of the tax rate type ID. |
taxRateTypeName |
string |
- | The name of the tax rate type. |
taxReclaimConfigurationId |
string |
- | The unique identifier of the tax reclaim configuration ID. |
taxTransactionAmount |
number |
double |
The tax transaction amount. |
EReceipt
Name | Type | Format | Description |
---|---|---|---|
carEReceipt |
CarEReceipt |
- | The eReceipt car data. |
hotelEReceipt |
HotelEReceipt |
- | The eReceipt hotel data. |
id |
string |
- | Required The unique identifier of the eReceipt with the expense. |
imageId |
string |
- | The unique identifier of the eReceipt image associated with the expense. |
templateURL |
string |
- | The URL of the eReceipt template. Maximum length: 512 characters |
type |
string |
- | Required The type of eReceipt associated with the expense. Supported values: AIR , CAR , GASXX , GENERAL , GRTRN , HOTEL , JPT , MEALS , OFFIC , PRKNG , RAIL , RIDE , SHIPG , TELEC |
HotelEReceipt
Name | Type | Format | Description |
---|---|---|---|
calculatedDailyRate |
number |
double |
The calculated hotel daily rate. |
endDate |
string |
YYYY-MM-DD |
The hotel checkout date. |
locationId |
string |
- | The unique identifier of the location for this hotel. |
startDate |
string |
YYYY-MM-DD |
The hotel check-in date. |
totalAmountPaid |
Amount |
- | The total amount paid. |
vendorName |
string |
- | The name of the hotel vendor. Maximum length: 255 characters. Examples: Hilton , Four Points by Sheraton, Seattle |
CarEReceipt
Name | Type | Format | Description |
---|---|---|---|
calculatedDailyRate |
number |
double |
The calculated car rental daily rate. |
carClass |
string |
- | The car class. Maximum length: 4 characters. Examples: IDAD , ECMZ , PCAV , IGDV |
currencyCode |
string |
- | The 3-letter ISO 4217 currency code. Examples: USD - US dollars, BRL - Brazilian real, CAD - Canadian dollar |
endDate |
string |
YYYY-MM-DD |
The car rental end date. |
fuelServiceCharge |
number |
double |
The fuel service charge. Minimum value: 0 |
numberOfRentalDays |
integer |
int32 |
The number of car rental calculated days. Minimum value: 0 |
startDate |
string |
YYYY-MM-DD |
The car rental start date. |
unitsDriven |
integer |
int32 |
The total units driven. Minimum value: 0 |
vendorName |
string |
- | The name of the car vendor. Maximum length: 255 characters. Example: ABC Rent A Car |
ExpenseAttendee
Name | Type | Format | Description |
---|---|---|---|
associatedAttendeeCount |
integer |
int32 |
The count of total attendees. A count greater than one (1) means there are unnamed attendees associated with this expense-attendee record. Default : 1 |
attendeeId |
string |
- | Required The unique identifier of the associated expense attendee within SAP Concur solutions. |
customData |
CustomData |
- | The details from the customData fields. These fields may not have data, depending on the configuration. |
isAmountUserEdited |
boolean |
true /false |
This field indicates if the amount value for the attendee on this expense was ever manually edited by the end user. Default: false |
isTraveling |
boolean |
true /false |
Whether the attendee was traveling when the expense was incurred. Used for FBT tax calculations. |
transactionAmount |
number |
double |
The portion of the expense transaction amount assigned to this attendee for both individual expense tracking and attendee totals across time periods. |
versionNumber |
integer |
int32 |
The version number of the attendee. This field value may always be one (1), depending on the configuration. Default: 1 |
ExpenseAttendees
Name | Type | Format | Description |
---|---|---|---|
expenseAttendeeList |
ExpenseAttendee |
- | The list of attendees associated with the expense. Maximum attendees: 500 |
noShowAttendeeCount |
integer |
int32 |
The number of attendees that were planned but did not show up. Default value: 0 |
Trip
Name | Type | Format | Description |
---|---|---|---|
airTrip |
AirTrip |
- | Air trip data associated with the expense. |
bookingOrigin |
string |
- | Booking origin of the trip. Supported values: AETM - Amadeus E-Travel, CLIQ - Concur Travel, PANM - Open Booking, TRPT - TripIt, TSUP - Travel Supplier |
bookingSource |
string |
- | Booking source of the trip. Maximum length: 48 characters. Examples: Expedia , Travelocity , Manual |
carTrip |
CarTrip |
- | Car trip data associated with the expense. |
cliqbookPaymentId |
integer |
int32 |
Cliqbook payment ID associated with the trip. |
cliqbookPaymentMethod |
string |
- | Cliqbook payment method associated with the trip. Supported values: GHOST_CARD or FLGHT_PASS |
hotelTrip |
HotelTrip |
- | Hotel trip data associated with the expense. |
merchantCode |
string |
- | Merchant code associated with the trip. Maximum length: 4 characters |
rideTrip |
RideTrip |
- | Ride or taxi trip data associated with the expense. |
segmentId |
integer |
int64 |
Required The unique identifier of the segment associated with the expense. |
segmentTypeId |
string |
- | Required Segment type ID associated with the trip. Supported values: AIRFR - Air Ticket, AIRSU - Air Subscription, CARRT - Car Rental, DININ - Dining, EVENT - Event, HOTEL - Hotel Reservation, INSUR - Insurance, LIMOF - Limousine Reservation, MISC - Miscellaneous, PARKG - Parking Fee, RAILF - Train Ticket, RAISU - Train Subscription, TAXIF - Taxi Fare, VISA - Visa |
startLocationId |
string |
- | The unique identifier of the start location associated with the trip. |
tripId |
integer |
int64 |
Required The unique identifier of the trip ID associated with the expense. |
HotelTrip
Name | Type | Format | Description |
---|---|---|---|
calculatedDailyRate |
number |
double |
The calculated hotel daily rate. |
endDate |
string |
YYYY-MM-DD |
The hotel checkout date. |
numberOfNights |
integer |
int32 |
The number of nights. Minimum value: 1 |
numberOfRooms |
integer |
int32 |
The number of hotel rooms. Minimum value: 1 |
startDate |
string |
YYYY-MM-DD |
The hotel check-in date. |
totalAmountPaid |
Amount |
- | The total amount paid. |
vendorName |
string |
- | The name of the hotel vendor. Maximum length: 255 characters. Examples: Hilton , Four Points by Sheraton, Seattle |
AirTrip
Name | Type | Format | Description |
---|---|---|---|
airlineName |
string |
- | The name of the airline vendor. Maximum length: 255 characters. Example: Alaska Airlines |
endDate |
string |
YYYY-MM-DD |
The last travel date or the travel end date. |
numberOfTravelDays |
integer |
int32 |
The number of days of travel. Minimum value: 1 |
startDate |
string |
YYYY-MM-DD |
The first travel date or the travel start date. |
ticketType |
string |
- | The airline class of service. Maximum length: 10 characters. Example: Economy |
totalAmountPaid |
Amount |
- | The total amount paid. |
RideTrip
Name | Type | Format | Description |
---|---|---|---|
startDate |
string |
YYYY-MM-DD |
The start date for the ride. |
totalAmountPaid |
Amount |
- | The total amount paid. |
vendorName |
string |
- | The name of the vendor. Maximum length: 255 characters. Example: Yellow Cab |
CarTrip
Name | Type | Format | Description |
---|---|---|---|
calculatedDailyRate |
number |
double |
The calculated car rental daily rate. |
carClass |
string |
- | The car class. Maximum length: 10 characters. Examples: IDAD , ECMZ , PCAV , IGDV |
endDate |
string |
YYYY-MM-DD |
The car rental end date. |
numberOfCars |
integer |
int32 |
The number of cars rented. Minimum value: 1 |
numberOfRentalDays |
integer |
int32 |
The number of car rental calculated days. Minimum value: 0 |
startDate |
string |
YYYY-MM-DD |
The car rental start date. |
totalAmountPaid |
Amount |
- | The total amount paid. |
vendorName |
string |
- | The name of the car vendor. Maximum length: 255 characters. Example: ABC Rent A Car |
Link
Name | Type | Format | Description |
---|---|---|---|
deprecation |
string |
- | - |
href |
string |
- | Required The URL of the related HATEOAS link that you can use for subsequent calls. |
hreflang |
string |
- | - |
isTemplated |
boolean |
true /false |
Required Whether the href is parameterized. |
media |
string |
- | - |
method |
string |
- | Required The HTTP method required for the related call. |
rel |
string |
- | Required The link relationship that describes how the href relates to the API call. |
title |
string |
- | - |
type |
string |
- | - |
ErrorMessage
Name | Type | Format | Description |
---|---|---|---|
customResponseData |
object |
- | The custom parameters related to error. |
errorId |
string |
- | The unique identifier of the error associated with the response. |
errorMessage |
string |
- | Required The detailed error message. |
httpStatus |
string |
- | Required The http response code and phrase for the response. |
path |
string |
- | Required The URI of the attempted request. |
timestamp |
string |
date-time |
Required The time when the error was captured. |
validationErrors |
ValidationError |
- | The validation error messages. |
ValidationError
Name | Type | Format | Description |
---|---|---|---|
id |
string |
- | The ID of the validation error. |
message |
string |
- | The detailed message of the validation error. |
source |
string |
- | The type of validation which failed. |