SAP Concur Connector Objects
Name | Description |
---|---|
Allocations | Lists all allocations per entry or report. |
Attendees | Create, update, delete, and query all attendees owned by the specified user. |
AttendeeTypes | Create, update, delete, and query all active attendee types for the company. |
BudgetCategories | Retrieve a list of all budget categories. |
BudgetCategoriesExpenseTypes | Retrieve a list of all expense types belonging to a budget category. |
BudgetItems | Retrieve all budget items |
BudgetTrackingFields | Retrieve budget tracking fields information that is setup in budget configuration. |
CompanyCardTransactions | Retrieves the list of corporate or credit card charges that are available for use in expense reports. |
DigitalTaxInvoices | Gets all digital tax invoices that can be validated by the user based on the search criteria. |
Entries | Create, update, delete, and query all expense entries owned by the user. |
EntryAttendeeAssociations | Create, update, delete, and query all entry-attendee associations owned by the user. These are the associations between an expense entry and an attendee. |
ExpenseDelegators | Retrieves the list of users that have granted delegate permissions to you. |
ExpenseDetails | Retrieves the details of a Expense by specifying an ExpenseId |
ExpenseGroupConfigurationAttendeeTypes | Lists the Attendee Types of the Expense Group Configurations. |
ExpenseGroupConfigurationPaymentTypes | Lists the payment types of the Expense Group Configurations. |
ExpenseGroupConfigurationPolicies | Lists the policies of Expense Group Configurations. |
ExpenseGroupConfigurationPolicyExpenseTypes | Lists the expense types for the Expense Group Configuration Policies. |
ExpenseGroupConfigurations | Lists the configurations of expense groups. |
Expenses | Retrieves the expenses that belong to a specific expense report or modifies an expense on an existing expense report. |
FinancialTransactions | The request returns a list of financial documents that are ready to be processed. The request can include parameters to limit the results. |
FiscalPeriod | Retrieve a list of all fiscal periods |
FiscalYears | Retrieve a list of all fiscal years. |
FormCodes | Query the list of form codes. |
FormFields | Query all expense form fields. |
Forms | Query all expense forms. |
Invoice | Gets all relevant information (Payment Request Header, Payment Request Line Item and Payment Request Allocation) of a Payment Request. |
Itemizations | Create, update, delete, and query all expense itemizations owned by the user. |
Items | Lists list items based on the search criteria. |
ListItems | Lists list items based on the search criteria. |
Lists | The driver uses the SAP Concur APIs to view your configured lists within SAP Concur products. |
LocalizedData | List the localized strings of various codes. |
Locations | Retrieve details of locations that are used by Concur and that are valid at the company of the user. |
Notifications | Query all the notifications that have failed. |
Opportunities | Gets opportunities for a specified trip or for all trips that fall within a date range. |
PaymentBatches | Lists all the payment batches. |
PaymentRequestDigests | A payment request digest is a collection of summarized payment requests to invoice vendors. |
PurchaseRequests | Gets purchase request details. The supported mode is COMPACT, which returns basic info about the purchase request along with any exceptions. |
ReceiptImages | Create, update, delete, and query all receipt Ids owned by the user. |
ReportComments | Read the comments entered on the expense report header, or the expenses of an existing expense report. |
Reports | Create, update, delete, and query all reports owned by the user. |
ReportsV4 | Retrieves the expenses that belong to a specific expense report or modifies an expense on an existing expense report. |
TravelRequestComments | Get the list of comments for an existing Request |
TravelRequests | Retrieve a list of all budget categories. |
TripBookingPassengers | Query all the bookings passengers for a trip. |
TripBookings | Query all the bookings for a trip. |
TripBookingSegmentCharges | Query all the charges for a trip. |
TripBookingSegments | Query all the bookings for a trip. |
TripBookingSegmentSeats | Query all the seats for a trip. |
Trips | Query all the trips. |
Users | Lists user data based on the search criteria. |
UsersV4 | Read the user's core identity profile. |
ValidExpenseTypes | Retrieve a list of all possible expense types that may be used in a budget category. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identifier of the resource. | |
ContextType | String | False | No | The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported value: TRAVELER | |
ReportId | String | False | ReportsV4.Id | No | The unique identifier of the report to which the expense entry belongs whose allocations are being retrieved. |
ExpenseId | String | False | Expenses.ExpenseId | No | The unique identifier of the expense entry whose allocations are being retrieved. |
UserID | String | False | UsersV4.Id | No | The unique identifier of the SAP Concur user. Use UsersV4 to resolve the userId |
AccountCode | String | False | No | The ledger account code associated with the allocation. | |
IsPercentEdited | Boolean | False | No | Whether the allocation percent has been edited. | |
IsSystemAllocation | Boolean | False | No | Whether the allocation is a system allocation, usually hidden from the user. If displayed to the user, should be read-only. | |
OverLimitAccountCode | String | False | No | The ledger account code associated with the allocation if it exceeds a pre-defined threshold, for example, the user's travel allowance limit. | |
Percentage | Double | False | No | The percentage of the total expense that this allocation represents. | |
ApprovedAmountCurrencyCode | String | False | No | 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 | |
ApprovedAmountValue | Double | False | No | The amount in the defined currency. | |
ClaimedAmountCurrencyCode | String | False | No | 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 | |
ClaimedAmountValue | Double | False | No | The amount in the defined currency. | |
CustomDataId [KEY] | String | True | No | The unique identifier of the custom field. Examples: custom1, orgUnit1 | |
CustomDataIsValid | String | False | No | 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 | |
CustomDataIsListItemUrl | String | False | No | ||
CustomDataValue | String | False | No | 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 |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | False | No | The unique identifier of the resource. | |
Custom10ListItemID | String | False | No | For list fields, this is the list item ID. | |
AttendeeTypeID | String | False | No | The ID of the attendee type. | |
Custom11ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom12ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom13ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom14ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom15ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom16ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom17ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom18ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom19ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom1ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom20ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom21ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom22ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom23ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom24ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom25ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom2ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom3ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom4ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom5ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom6ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom7ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom8ListItemID | String | False | No | For list fields, this is the list item ID. | |
Custom9ListItemID | String | False | No | For list fields, this is the list item ID. | |
ExternalID | String | False | No | A unique identifier for the attendee, assigned outside of Concur. Maximum length: 48 characters | |
MiddleInitial | String | False | No | The attendee's middle initial. Maximum length: 1 character | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user that is making the request (this must also be the owner if the attendee type is private) . The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
AttendeeTypeCode | String | False | No | A code that indicates the type of attendee. Examples: EMPLOYEE, SPOUSE, BUSGUEST. Maximum length: 40 characters | |
Company | String | False | No | The name of the attendee's company. Maximum length: 150 characters | |
CurrencyCode | String | False | No | The ISO 4217 currency code for monetary amounts related to an attendee. | |
Custom10Code | String | False | No | For list fields, this is the list item code. | |
Custom10Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom10Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom11Code | String | False | No | For list fields, this is the list item code. | |
Custom11Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom11Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom12Code | String | False | No | For list fields, this is the list item code. | |
Custom12Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom12Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom13Code | String | False | No | For list fields, this is the list item code. | |
Custom13Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom13Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom14Code | String | False | No | For list fields, this is the list item code. | |
Custom14Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom14Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom15Code | String | False | No | For list fields, this is the list item code. | |
Custom15Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom15Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom16Code | String | False | No | For list fields, this is the list item code. | |
Custom16Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom16Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom17Code | String | False | No | For list fields, this is the list item code. | |
Custom17Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom17Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom18Code | String | False | No | For list fields, this is the list item code. | |
Custom18Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom18Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom19Code | String | False | No | For list fields, this is the list item code. | |
Custom19Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom19Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom1Code | String | False | No | For list fields, this is the list item code. | |
Custom1Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom1Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom20Code | String | False | No | For list fields, this is the list item code. | |
Custom20Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom20Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom21Code | String | False | No | For list fields, this is the list item code. | |
Custom21Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom21Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom22Code | String | False | No | For list fields, this is the list item code. | |
Custom22Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom22Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom23Code | String | False | No | For list fields, this is the list item code. | |
Custom23Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom23Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom24Code | String | False | No | For list fields, this is the list item code. | |
Custom24Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom24Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom25Code | String | False | No | For list fields, this is the list item code. | |
Custom25Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom25Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom2Code | String | False | No | For list fields, this is the list item code. | |
Custom2Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom2Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom3Code | String | False | No | For list fields, this is the list item code. | |
Custom3Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom3Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom4Code | String | False | No | For list fields, this is the list item code. | |
Custom4Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom4Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom5Code | String | False | No | For list fields, this is the list item code. | |
Custom5Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom5Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom6Code | String | False | No | For list fields, this is the list item code. | |
Custom6Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom6Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom7Code | String | False | No | For list fields, this is the list item code. | |
Custom7Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom7Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom8Code | String | False | No | For list fields, this is the list item code. | |
Custom8Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom8Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom9Code | String | False | No | For list fields, this is the list item code. | |
Custom9Type | String | False | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom9Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
FirstName | String | False | No | The attendee's first name. Maximum length: 50 characters | |
HasExceptionsPrevYear | Bool | False | No | Determines whether the attendee had exceptions in the previous year, based on yearly total limits for attendees. Format: true or false | |
HasExceptionsYTD | Bool | False | No | Determines whether the attendee has exceptions in the current year, based on yearly total limits for attendees. Format: true or false | |
LastName | String | False | No | The attendee's last name. Maximum length: 132 characters | |
OwnerName | String | False | No | The name of the user who owns the attendee record. | |
Suffix | String | False | No | The attendee's name suffix. Maximum length: 32 characters | |
Title | String | False | No | The attendee's title. Maximum length: 32 characters | |
TotalAmountPrevYear | Decimal | False | No | The total amount spent on the attendee in the previous calendar year. | |
TotalAmountYTD | Decimal | False | No | The total amount spent on the attendee in the current calendar year. | |
URI | String | False | No | The URI to the resource. | |
VersionNumber | Int | False | No | The attendee's version number. | |
OwnerLoginID | String | False | No | The login ID of the user who owns the attendee record. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
AttendeeFormID | String | False | No | The unique identifier for the attendee form for this attendee type. | |
ConnectorID | String | False | No | The unique identifier for the Application Connector that is the data source for this attendee type. When this field is empty, the Expense database is the data source. | |
AllowAttendeeCountEditing | Bool | False | No | Determines whether users are allowed to edit the count for this attendee type. Format: true or false | |
AllowManuallyEnteredAttendees | Bool | False | No | Determines whether users are allowed to add attendees for this attendee type. Format: true or false | |
Code | String | False | No | A code that indicates the type of attendee. Examples: EMPLOYEE, SPOUSE, BUSGUEST. Maximum length: 40 characters | |
DuplicateSearchFields | String | False | No | The list of Attendee field IDs used by the Add Attendee user interface to alert users that the attendee they want to add is a possible duplicate. This parent element has a DuplicateSearchField child element for each field ID. | |
Name | String | False | No | The name for the attendee type. This name must be unique. Maximum length: 40 characters | |
URI | String | True | No | The URI to the resource. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier for the budget category. | |
Name | String | False | No | The admin-facing name for this category. | |
StatusType | String | False | No | The status of this budget category. Supported values: OPEN, REMOVED | |
Description | String | False | No | The friendly name for this category. | |
ExpenseTypes | String | False | No | The type of feature that this expense type applies to: Purchase Request, Payment Request (Invoice), Expense, or Travel Authorization. Supported values: PURCHASE_REQUEST, PAYMENT_REQUEST, EXPENSE, REQUEST |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | True | No | The budget service's key for this object. If this field is not supplied, the service will use an existing expense type entry if one exists. | |
BudgetCategoryId | String | False | BudgetCategories.Id | No | The unique identifier for the budget category. |
Name | String | True | No | The name for this expense type if it maps to an expense type set up in SAP Concur. | |
ExpenseTypeCode | String | False | No | The alphanumeric code that describes an expense type (Example: MEALS, AC_CATER). Any string may be used, but only expense type codes returned by GET /budgetCategory/expenseType will behave properly in the SAP Concur UI. | |
FeatureTypeCode | String | False | No | The type of feature that this expense type applies to: Purchase Request, Payment Request (Invoice), Expense, or Travel Authorization. Supported values: PURCHASE_REQUEST, PAYMENT_REQUEST, EXPENSE, REQUEST | |
SyncGuid | String | False | No |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The key for this object. | |
Active | Boolean | True | No | Indicates if this budget should be displayed on user screens. | |
AnnualBudget | Decimal | True | No | The total budget amount and accumulated balances for this budget header. | |
BudgetItemStatusType | String | False | No | The status of this budget item. Supported values: OPEN, CLOSED(no spending can be attached to this budget), REMOVED | |
BudgetType | String | False | No | The budget type indicates if the budget item is personal or not. Supported values: PERSONAL_USE, BUDGET, RESTRICTED, TEAM | |
CurrencyCode | String | False | No | The 3-letter ISO 4217 currency code for the budget currency. This is the currency code of the budget amount. Spending Items are converted using yesterday?s closing value. 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. | |
Description | String | False | No | The user-friendly name for this budget. This description is displayed to end users on desktop and mobile. | |
CreatedDate | Date | True | No | The time the budget item header was created. Date in UTC. | |
FiscalYear | String | False | No | The fiscal year for this budget. Only the ID of the fiscal year, which can be retrieved from the Fiscal Year service, is required for creating/updating a budget. | |
IsTest | Boolean | False | No | The test flag for the budget item. If true, this budget will only match spending submitted by test users. | |
Name | String | False | No | The admin-facing name for this budget. | |
Owned | String | True | No | A flag indicating if the current user is the owner of this budget. | |
PeriodType | String | False | No | The type of period within the fiscal year that this budget's details use. | |
UseAdminView | String | False | No | If true, returns all budgets for this entity, if false, returns only the budgets owned by the current user. Default: false | |
BudgetAmounts | String | False | No | The accumulated budget amounts for this budget. | |
BudgetManagers | String | False | No | If managers exist, spend items only matches this budget if one of the managers is in the manager hierarchy of the submitter or approver for the given spend item. | |
BudgetApprovers | String | False | No | The workflow approvers for this budget. | |
BudgetTeamMembers | String | False | No | The team members associated with this budget. | |
BudgetCategory | String | False | No | The budget category for this budget item. If a budget category is present, spending items must match one of the expense types in the budget category in order to match this budget. | |
BudgetItemDetails | String | False | No | Specify the budget information for each fiscal period in the fiscal year. | |
BudgetViewers | String | False | No | The users who can view this budget. | |
CostObjects | String | False | No | The cost object list for matching spending items. | |
Owner | String | False | No | The user who is ultimately responsible for this budget. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
FieldId [KEY] | String | False | No | The budget service's key for this object. | |
BudgetTrackingFieldName | String | False | No | The budget field tracking name. | |
FieldType | String | False | No | he data type of this field or field collection. Supported values: LIST, MLIST, VARCHAR | |
ListSyncGuid | String | False | No | If the dataType of this item is LIST or MLIST, this is the ID of the list definition from the SAP Concur list service. | |
BudgetSequenceNumber | Int | False | No | The sequence or the order in which the budget tracking field appears in the budget UI. This value can be used instead of fieldDefinitionId when importing budgets with POST resource. The budgetSequenceNumber is the the same as the code field when importing budgets. | |
ConnectedListSequenceNumber | Int | False | No | Indicates the level of the budget tracking field in a connected list. | |
FieldDefinitionId | String | False | No | The budget service's key for this object's field definition ID. This value is required when using the Budget Item POST Resource to create or update a new budget using budget tracking fields. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CardNumber | String | False | No | The number of the card, with all but the last four digits obscured. | |
ExpKey | String | False | No | The code for the expense type of the transaction | |
Merchant | String | False | No | The merchant name for the transaction. | |
ExpName | String | False | No | The name of the expense type of the transaction. | |
TransactionAmount | String | False | No | The amount of the card transaction. | |
TransactionCrnCode | String | False | No | The currency code of the transaction amount. | |
TransactionDate | String | False | No | The date of the transaction. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
AccountID | String | True | No | The unique identifier assigned by the validation partner to the Concur client company that owns the digital tax invoices. | |
ConcurReceiptID | String | True | No | The ID of the digital tax invoice in plain text. | |
DocumentID | String | True | No | The ID of the report in plain text. | |
ReceiptData | String | True | No | The digital tax invoice data. | |
URI | String | True | No | The URI to the resource. | |
Modifiedafter | Date | True | No | A modification date for the queue record; this parameter can be used to limit the results of the GET request to the queue items that have been added since the last time the validation company queried the queue. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
CompanyCardTransactionID | String | True | No | The unique identifier for a company card transaction that is associated with this expense. Concur Expense uses the Credit Card Import job to import company card transactions. Use the GET CommpanyCardTransactions function to get information about these card transactions. This element is null when there is no company card transaction associated with this expense. | |
Custom10ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom11ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom12ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom13ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom14ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom15ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom16ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom17ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom18ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom19ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom1ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom20ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom21ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom22ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom23ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom24ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom25ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom26ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom27ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom28ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom29ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom2ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom30ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom31ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom32ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom33ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom34ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom35ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom36ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom37ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom38ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom39ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom3ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom40ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom4ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom5ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom6ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom7ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom8ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom9ListItemID | String | True | No | For list fields, this is the list item ID. | |
ElectronicReceiptID | String | True | No | The unique identifier for an eReceipt that is associated with this expense. Use the GET eReceipts function to get information about this eReceipt. This element is null when there is no eReceipt associated with this expense. | |
EmployeeBankAccountID | String | True | No | The unique identifier of an employee bank account that is associated with this expense. Typically, this element is used when Expense Pay reimburses the employee for this expense. Use the GET BankAccounts function to get information about this bank account. | |
FormID | String | True | No | The ID of the form used by this expense entry. | |
IsPaidByExpensePay | Bool | True | No | Whether the entry is paid using the Expense Pay service. This element has a value if the report has reached the Processing Payment workflow step, because this is when Concur Expense determines whether it will be paid by Expense Pay. Format: true or false | |
JourneyVehicleID | String | False | No | The unique identifier for the vehicle used for this journey. This element is used only with Company Car configuration types. Use the GET Vehicles function to learn the Vehicle ID. | |
LocationID | String | False | No | The unique identifier for the location where the expense was incurred. | |
OrgUnit1ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit2ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit3ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit4ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit5ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit6ListItemID | String | True | No | For list fields, this is the list item ID. | |
PaymentTypeID | String | False | No | The ID of the payment type for the entry. For mileage expenses, use the Cash payment type. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes always use the Cash payment type. | |
ReportID | String | False | ReportsV4.Id | No | The report ID of the report where the entry will be added. |
ReportOwnerID | String | True | No | The login ID of the report owner. | |
TripID | String | True | Trips.Id | No | The unique identifier of a trip in the Itinerary Service that includes a travel booking associated with this expense. Use GET ItineraryDetails to get information about this trip and the travel booking. This element is null when there is no trip associated with the expense. |
VendorListItemID | String | False | No | The unique identifier for a vendor list item. | |
AllocationType | String | True | No | The type of allocations for the expense. Possible values: P - partial allocation, F - full allocation, N - no allocation. | |
ApprovedAmount | Decimal | True | No | The approved amount of the expense entry, in the report currency. | |
Custom10Code | String | True | No | For list fields, this is the list item code. | |
Custom10Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom10Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom11Code | String | True | No | For list fields, this is the list item code. | |
Custom11Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom11Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom12Code | String | True | No | For list fields, this is the list item code. | |
Custom12Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom12Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom13Code | String | True | No | For list fields, this is the list item code. | |
Custom13Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom13Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom14Code | String | True | No | For list fields, this is the list item code. | |
Custom14Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom14Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom15Code | String | True | No | For list fields, this is the list item code. | |
Custom15Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom15Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom16Code | String | True | No | For list fields, this is the list item code. | |
Custom16Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom16Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom17Code | String | True | No | For list fields, this is the list item code. | |
Custom17Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom17Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom18Code | String | True | No | For list fields, this is the list item code. | |
Custom18Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom18Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom19Code | String | True | No | For list fields, this is the list item code. | |
Custom19Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom19Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom1Code | String | True | No | For list fields, this is the list item code. | |
Custom1Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom1Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom20Code | String | True | No | For list fields, this is the list item code. | |
Custom20Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom20Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom21Code | String | True | No | For list fields, this is the list item code. | |
Custom21Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom21Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom22Code | String | True | No | For list fields, this is the list item code. | |
Custom22Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom22Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom23Code | String | True | No | For list fields, this is the list item code. | |
Custom23Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom23Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom24Code | String | True | No | For list fields, this is the list item code. | |
Custom24Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom24Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom25Code | String | True | No | For list fields, this is the list item code. | |
Custom25Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom25Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom26Code | String | True | No | For list fields, this is the list item code. | |
Custom26Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom26Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom27Code | String | True | No | For list fields, this is the list item code. | |
Custom27Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom27Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom28Code | String | True | No | For list fields, this is the list item code. | |
Custom28Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom28Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom29Code | String | True | No | For list fields, this is the list item code. | |
Custom29Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom29Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom2Code | String | True | No | For list fields, this is the list item code. | |
Custom2Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom2Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom30Code | String | True | No | For list fields, this is the list item code. | |
Custom30Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom30Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom31Code | String | True | No | For list fields, this is the list item code. | |
Custom31Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom31Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom32Code | String | True | No | For list fields, this is the list item code. | |
Custom32Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom32Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom33Code | String | True | No | For list fields, this is the list item code. | |
Custom33Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom33Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom34Code | String | True | No | For list fields, this is the list item code. | |
Custom34Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom34Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom35Code | String | True | No | For list fields, this is the list item code. | |
Custom35Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom35Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom36Code | String | True | No | For list fields, this is the list item code. | |
Custom36Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom36Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom37Code | String | True | No | For list fields, this is the list item code. | |
Custom37Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom37Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom38Code | String | True | No | For list fields, this is the list item code. | |
Custom38Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom38Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom39Code | String | True | No | For list fields, this is the list item code. | |
Custom39Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom39Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom3Code | String | True | No | For list fields, this is the list item code. | |
Custom3Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom3Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom40Code | String | True | No | For list fields, this is the list item code. | |
Custom40Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom40Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom4Code | String | True | No | For list fields, this is the list item code. | |
Custom4Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom4Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom5Code | String | True | No | For list fields, this is the list item code. | |
Custom5Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom5Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom6Code | String | True | No | For list fields, this is the list item code. | |
Custom6Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom6Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom7Code | String | True | No | For list fields, this is the list item code. | |
Custom7Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom7Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom8Code | String | True | No | For list fields, this is the list item code. | |
Custom8Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom8Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom9Code | String | True | No | For list fields, this is the list item code. | |
Custom9Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom9Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Description | String | False | No | The description of the expense. Maximum length: 64 characters | |
ExchangeRate | Decimal | False | No | The currency conversion rate that converts the transaction amount that is in the transaction currency into the posted amount that is in the report currency. This element is typically not provided. If this element is empty for transactions in a currency different than the user's reimbursement currency, Expense will use the company's configured exchange rates to determine the posted amount for the transaction. If the system is not able to determine the exchange rate, a value of 1.0 will be used. | |
ExpenseTypeCode | String | False | No | The code for the expense type. | |
ExpenseTypeName | String | True | No | The name of the expense type, localized to the user's language. | |
HasAppliedCashAdvance | Bool | True | No | Whether the entry has a cash advance applied to it. Use the GET ExpenseEntryAccountingCalculations function to get cash advance application information for this entry. Format: true or false | |
HasAttendees | Bool | True | No | Indicates whether the expense has attendees. Format: true or false | |
HasComments | Bool | True | No | Whether the expense has comments. Use the GET ExpenseEntryComments function to get information about this entry's comments. Format: true or false | |
HasExceptions | Bool | True | No | Whether the expense has exceptions. Use the GET ExpenseEntryExceptions function to get information about this entry's exceptions. Format: true or false | |
HasImage | Bool | True | No | Indicates whether there is an entry image attached to the entry. Use the GET Entry Images function to get this entry image. Format: true or false | |
HasItemizations | Bool | True | No | Indicates whether the expense has itemizations. Use the Format: true or false | |
HasVAT | Bool | True | No | Indicates whether the entry has VAT data. Use the GET ExpenseEntryAccountingCalculations function to get VAT information for this entry. Format: true or false | |
IsBillable | Bool | False | No | Indicates whether the expense is billable. Format: true or false | |
IsImageRequired | Bool | True | No | Indicates whether an entry image is required for the entry. Format: true or false | |
IsPersonal | Bool | False | No | Indicates whether the expense is personal (that is, non-reimbursable). Format: true or false | |
IsPersonalCardCharge | Bool | True | No | Indicates whether the expense entry was imported from a personal card feed. Concur Expense uses the Yodlee API to import these card transactions. Format: true or false | |
JourneyBusinessDistance | Int | False | No | The portion of the journey for business use, in the report owner's unit of measure for distances. This element is required in order to post a personal car mileage expense entry, or to post a company car mileage expense when there is no PersonalDistance value. Format: positive integer. When using the Odometer elements, the sum of PersonalDistance and BusinessDistance must equal the difference between OdometerEnd and OdometerStart. | |
JourneyEndLocation | String | False | No | Indicates where the journey ended. This is also known as the | |
JourneyNumberOfPassengers | Int | False | No | The number of people in the vehicle during the journey. Positive Integer. Used with Variable-Rate, Personal or Company Car. | |
JourneyOdometerEnd | Int | False | No | The odometer reading at the end of the journey. Format: positive integer that must be greater than the OdometerStart value. This element is used with Variable-Rate and Company Car configuration types. | |
JourneyOdometerStart | Int | False | No | The odometer reading at the start of the journey. Format: positive integer. This element is used with Variable-Rate and Company Car configuration types. | |
JourneyPersonalDistance | Int | False | No | The portion of the journey for personal use. This element is required in order to post a company car mileage expense when there is no BusinessDistance value. Format: positive integer. When using the Odometer elements, the sum of PersonalDistance and BusinessDistance must equal the difference between OdometerEnd and OdometerStart. Used with Company Car configuration types. | |
JourneyStartLocation | String | False | No | Indicates where the journey started. This is also known as the | |
JourneyUnitOfMeasure | String | False | No | The unit of measure for distance and odometer values. Possible values: M - miles, K - kilometers | |
LastModified | Datetime | True | No | The UTC date when the entry was last modified. | |
LocationCountry | String | True | No | The country where the expense was incurred. Format: 2-letter ISO 3166-1 country code | |
LocationName | String | True | No | The location where the expense was incurred, usually the city name. | |
LocationSubdivision | String | True | No | The state, province, or other country subdivision where the expense was incurred. Format: ISO 3166-2:2007 country subdivision | |
OrgUnit1Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit1Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit1Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit2Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit2Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit2Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit3Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit3Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit3Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit4Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit4Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit4Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit5Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit5Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit5Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit6Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit6Type | String | True | No | The custom field type. Supported values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit6Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
PaymentTypeName | String | True | No | The name of the payment type, localized to the user's language. | |
PostedAmount | Decimal | True | No | The amount of the expense entry, in the report currency. | |
ReceiptReceived | Bool | True | No | Indicates whether this entry has been reviewed by a processor. Format: true or false | |
SpendCategoryCode | String | True | No | The ID of the spending category that is specified for this expense entry. | |
SpendCategoryName | String | True | No | The name of the spending category that is specified for this expense entry, localized to the user's language. | |
TaxReceiptType | String | False | No | The receipt type for this entry. Possible values: T - tax receipt, R - regular receipt, N - no receipt | |
TransactionAmount | Decimal | False | No | The amount of the expense entry, in the transaction currency paid to the vendor. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because these two expense codes use a distance instead of a transaction amount. | |
TransactionCurrencyCode | String | False | No | The 3-letter ISO 4217 currency code for the expense entry transaction amount. This is the currency in which the vendor was paid. For expense types with an expense code that uses a transaction amount instead of a distance, this element is required. This element should not be used for expense types with an expense code for Company Car or Personal Car, because for these two expense codes the currency is always the Report Currency. | |
TransactionDate | Date | False | No | The date when the good or service associated with this expense entry was provided. Format: YYYY-MM-DD | |
URI | String | True | No | The URI to the resource. | |
VendorDescription | String | False | No | The name of the vendor for the expense entry. Maximum length: 64 characters | |
VendorListItemName | String | True | No | The name of an item from a vendor list. | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the entries. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
AttendeeID | String | False | No | The unique identifier of the associated attendee. To obtain the attendee ID value, use the GET /expense/attendees endpoint. The value of the ID element in the response is the attendee ID. | |
EntryID | String | False | No | The unique identifier of the associated entry. To obtain the attendee ID value, use the GET /expense/entries endpoint. The value of the ID element in the response is the entry ID. | |
Amount | Decimal | False | No | The portion of the entry transaction amount assigned to this attendee. | |
AssociatedAttendeeCount | Int | False | No | The count of additional attendees associated with this attendee. A count greater than 1 means there are unnamed attendees associated with this attendee. | |
Custom1 | String | False | No | The details from the Custom fields. These fields may not have data, depending on the configuration. | |
Custom2 | String | False | No | The details from the Custom fields. These fields may not have data, depending on the configuration. | |
Custom3 | String | False | No | The details from the Custom fields. These fields may not have data, depending on the configuration. | |
Custom4 | String | False | No | The details from the Custom fields. These fields may not have data, depending on the configuration. | |
Custom5 | String | False | No | The details from the Custom fields. These fields may not have data, depending on the configuration. | |
URI | String | True | No | null | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | UsersV4.Id | No | Id of the user |
DelegatorEmail | String | False | UsersV4.Username | No | Email of the delegate |
CanApprove | String | False | No | Whether the delegate is granted the right to approve expense reports on behalf of the delegator. | |
CanPrepare | String | False | No | Whether the delegate is granted the right to create expense reports on behalf of the delegator. | |
CanSubmit | String | False | No | Whether the delegate is granted the right to submit expense reports on behalf of the delegator. | |
CanTemporaryApprove | String | False | No | Whether the delegate is granted the same temporary approval rights as the delegator. | |
CanViewReceipts | String | False | No | Whether the delegate is granted the right to view receipts on behalf of the delegator. | |
ReceiveApprovalEmails | String | False | No | Whether the delegate also receives the approval emails sent to the delegator. | |
ReceivesEmails | String | False | No | Whether the delegate also receives the Concur emails sent to the delegator. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ExpenseId [KEY] | String | False | Expenses.ExpenseId | No | The unique identifier for the expense. |
AllocationSetId | String | False | No | The identifier of the allocation set associated with the expense. Allocations that belong to the same set are created at the same time. | |
AllocationState | String | False | No | Allocation state for the expense. Supported values: FULLY_ALLOCATED, NOT_ALLOCATED, PARTIALLY_ALLOCATED | |
ApprovedAmount | Double | False | No | The value for the approved amount of the expense. | |
ApprovedAmountCurrencyCode | String | False | No | The currency for the approved amount of the expense. | |
ApproverAdjustedAmount | Double | False | No | The total amount value adjusted for the expense by the approver. | |
ApproverAdjustedAmountCurrencyCode | String | False | No | The currency code for the expense adjusted by the approver. | |
AttendeeCount | Int | False | No | The total number of attendees associated with the expense. | |
AuthorizationRequestExpenseId | String | False | No | The authorization request expense ID associated with the expense. | |
BudgetAccrualDate | Date | False | No | The budget accrual date of the expense. | |
BusinessPurpose | String | False | No | The text input for the business purpose by the user. | |
CanAllocate | Boolean | False | No | ||
CanDelete | Boolean | False | No | ||
ClaimedAmount | Double | False | No | The total non-personal amount claimed for reimbursement for the expense | |
ClaimedAmountCurrencyCode | String | False | No | The currency code for the claimed amount. | |
ERceiptImageId | String | False | No | The unique identifier of the eReceipt image associated with the expense. | |
ExchangeRateValue | Double | False | No | Exchange rate data for the expense. | |
ExchangeRateOperation | String | False | No | Currency code for the exchange rate | |
ExpenseSourceIdentifiers | String | False | No | The list of expense sources associated with the expense. | |
ExpenseTypeID | String | False | No | The expense type information for the expense. | |
ExpenseTypeCode | String | False | No | The expense type information for the expense. | |
ExpenseTypeIsDeleted | Boolean | False | No | The expense type information for the expense. | |
ExpenseTypeListItemId | String | False | No | The expense type information for the expense. | |
ExpenseTypeName | String | False | No | The expense type information for the expense. | |
FuelTypeListItem | String | False | No | The unique id of Fuel Type. | |
HasBlockingExceptions | Boolean | False | No | Whether the expense has any exceptions that blocks it from being submitted. | |
HasExceptions | Boolean | False | No | Whether the expense has any exceptions. | |
HasMissingReceiptDeclaration | Boolean | False | No | Whether the expense has an affidavit declaration for missing receipt. | |
ImageCertificationStatus | String | False | No | The final status of the receipt image associated with the expense. Supported values: ACCEPTED, PROCESSED, PROCESSING, PDF, FAILED, NO_PROCESSING_REQUIRED | |
IsAutoCreated | Boolean | False | No | Whether the expense is auto created. | |
IsImageRequired | Boolean | False | No | Whether the image is required for the expense. | |
IsPaperReceiptRequired | Boolean | False | No | Whether the paper receipt is required for the expense to be submitted. | |
IsPersonalExpense | Boolean | False | No | Whether the expense is marked as personal (non-reimbursable) by the user. | |
JptRouteId | String | False | No | The unique route ID to identify a Japan rail route. | |
LocationName | String | False | No | The location information of the expense. | |
LocationCity | String | False | No | The location information of the expense. | |
LocationCountryCode | String | False | No | The location information of the expense. | |
LocationCountrySubDivisionCode | String | False | No | The location information of the expense. | |
LocationId | String | False | No | The location information of the expense. | |
MerchantTaxId | String | False | No | Merchant tax ID for the expense. | |
Mileage | String | False | No | The mileage data associated with the expense. | |
ParentExpenseId | String | False | No | Expense ID of the parent expense. | |
PaymentTypeId | String | False | No | The payment type information for the expense. | |
PaymentTypeCode | String | False | No | The payment type information for the expense. | |
PostedAmount | Double | False | No | The PostedAmount value. | |
PostedAmountCode | String | False | No | The PostedAmount code. | |
ReceiptId | String | False | No | The id of the ReceiptType. | |
ReceiptStatus | String | False | No | The status of the ReceiptType | |
TaxRateLocation | String | False | No | 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. | |
TicketNumber | String | False | No | The ticket number associated with the travel. | |
TransactionAmount | Double | False | No | The amount of the expense, in the transaction currency paid to the vendor. | |
TransactionAmountCode | String | False | No | The currency code for the TransactionAmount. | |
TransactionDate | Date | False | No | The transaction date. | |
Travel | String | False | No | The travel data associated with the expense. | |
IsExpensePartOfTravelAllowance | Boolean | False | No | The travel allowance data associated with the expense. | |
TravelAllowanceDailyLimit | String | False | No | The travel allowance data associated with the expense. | |
DailyTravelAllowanceId | String | False | No | The travel allowance data associated with the expense. | |
VendorId | String | False | No | The unique identifier of the vendor. | |
VendorName | String | False | No | The name of the vendor. | |
VendorDescription | String | False | No | The description of the vendor. Maximum length: 64 characters | |
NetAdjustedTaxAmount | Double | False | No | Net adjusted tax amount. | |
NetAdjustedTaxAmountCurrencyCode | String | False | No | Currency code for the net adjusted tax amount. | |
NetReclaimAdjustedAmount | Double | False | No | Net reclaim adjusted amount. | |
NetReclaimAdjustedAmountCurrencyCode | String | False | No | Currency code for the net reclaim adjusted amount. | |
NetReclaimAmount | Double | False | No | Net reclaim amount. | |
NetReclaimAmountCurrencyCode | String | False | No | Currency code for the net reclaim amount. | |
NetTaxAmount | Double | False | No | Net tax amount. | |
NetTaxAmountCurrencyCode | String | False | No | Currency code for the net tax amount. | |
TotalReclaimAdjustedAmount | Double | False | No | Total reclaim adjusted amount. | |
TotalReclaimAdjustedAmountCurrencyCode | String | False | No | Currency code for the total reclaim adjusted amount. | |
TotalReclaimPostedAmount | Double | False | No | Total reclaim posted amount. | |
TotalReclaimPostedAmountCurrencyCode | String | False | No | Currency code for the total reclaim posted amount. | |
TotalTaxAdjustedAmount | Double | False | No | Total tax adjusted amount. | |
TotalTaxAdjustedAmountCurrencyCode | String | False | No | Currency code for the total tax adjusted amount. | |
TotalTaxPostedAmount | Double | False | No | Total tax posted amount. | |
TotalTaxPostedAmountCurrencyCode | String | False | No | Currency code for the total tax posted amount. | |
VatTaxTotal | Double | False | No | VAT tax total amount. | |
VatTaxTotalCurrencyCode | String | False | No | Currency code for the VAT tax total amount. | |
CustomDataId [KEY] | String | False | No | The unique identifier of the custom field. Examples: custom1, orgUnit1 | |
CustomDataIsValid | Boolean | False | No | 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 | |
CustomDataValue | String | False | No | 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 | |
CustomDataItemURL | String | False | No | ||
ReportId | String | False | ReportsV4.Id | No | The unique identifier of the report that is being read. |
UserId | String | False | UsersV4.Id | No | The unique identifier of the SAP Concur user. Query the Identity table to retrieve this value. |
ContextType | String | False | No | The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY. Default value is TRAVELER. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Code | String | False | No | The attendee type code. | |
ExpenseGroupConfigurationId | String | False | ExpenseGroupConfigurations.Id | No | The unique identifier of the Expense Group Configuration. |
Name | String | False | No | The name of the attendee type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | The unique identifier of the payment type. | |
ExpenseGroupConfigurationId | String | False | ExpenseGroupConfigurations.Id | No | The unique identifier of the Expense Group Configuration. |
Name | String | False | No | The name of the payment type. | |
IsDefault | Boolean | False | No | Determines whether this payment type is the default |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | The unique identifier of the policy. | |
ExpenseGroupConfigurationId | String | False | ExpenseGroupConfigurations.Id | No | The unique identifier of the Expense Group Configuration. |
Name | String | False | No | The name of the policy. | |
IsDefault | Boolean | False | No | Indicates whether this policy is the default. | |
IsInheritable | Boolean | False | No | Indicates whether the descendent nodes in the Expense Feature Hierarchy are covered by this policy. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Code | String | False | No | The code of the expense type. | |
ExpenseGroupConfigurationId | String | False | ExpenseGroupConfigurations.Id | No | The unique identifier of the Expense Group Configuration. |
ExpenseCode | String | False | No | The code for the expense category. | |
Name | String | False | No | The name of the policy. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier of the resource. | |
Name | String | False | No | The name of the expense group configuration. | |
AttendeeListFormID | String | False | No | The unique identifier for the attendee list form. | |
AttendeeListFormName | String | False | No | The name of the attendee list form. | |
AllowUserRegisterYodlee | Boolean | False | No | Indicates whether users in the expense group are allowed to register Yodlee credit cards. | |
AllowUserDigitalTaxInvoice | Boolean | False | No | Indicates whether users are allowed to upload digital tax invoices. | |
URI | String | False | No | The URI to the resource. | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the expense group. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ExpenseId [KEY] | String | False | No | The unique identifier for the expense. | |
AllocationSetId | String | False | No | The identifier of the allocation set associated with the expense. Allocations that belong to the same set are created at the same time. | |
AllocationState | String | False | No | Allocation state for the expense. Supported values: FULLY_ALLOCATED, NOT_ALLOCATED, PARTIALLY_ALLOCATED. | |
ApprovedAmount | Double | False | No | The approved amount of the expense, in the report currency. | |
ApprovedAmountCurrencyCode | String | False | No | The currency code for the approved amount of the expense. | |
ApproverAdjustedAmount | Double | False | No | The total amount adjusted for the expense by the approver. | |
ApproverAdjustedAmountCurrencyCode | String | False | No | The currency code for the total amount adjusted for the expense. | |
AttendeeCount | Int | False | No | The total number of attendees associated with the expense. | |
BusinessPurpose | String | False | No | The text input for the business purpose by the user. | |
ClaimedAmount | Double | False | No | The total non-personal amount value claimed for reimbursement for the expense. | |
ClaimedAmountCurrencyCode | String | False | No | The currency code for the claimed amount value. | |
EReceiptImageId | String | False | No | The unique identifier of the eReceipt image associated with the expense. | |
ExchangeRateValue | Double | False | No | Exchange rate data for the expense. | |
ExchangeRateOperation | String | False | No | Currency code for the exchange rate. | |
ExpenseSourceIdentifiers | String | False | No | The list of expense sources associated with the expense. | |
ExpenseTypeID | String | False | No | The expense type information for the expense. | |
ExpenseTypeCode | String | False | No | The expense type information for the expense. | |
ExpenseTypeIsDeleted | Boolean | False | No | The expense type information for the expense. | |
ExpenseTypeListItemId | String | False | No | The expense type information for the expense. | |
ExpenseTypeName | String | False | No | The expense type information for the expense. | |
FuelTypeListItem | String | False | No | The unique id of Fuel Type. | |
HasBlockingExceptions | Boolean | False | No | Whether the expense has any exceptions that block it from being submitted. | |
HasExceptions | Boolean | False | No | Whether the expense has any exceptions. | |
HasMissingReceiptDeclaration | Boolean | False | No | Whether the expense has an affidavit declaration for missing receipt. | |
ImageCertificationStatus | String | False | No | The final status of the receipt image associated with the expense. | |
IsAutoCreated | Boolean | False | No | Whether the expense is auto-created. | |
IsImageRequired | Boolean | False | No | Whether the image is required for the expense. | |
IsPaperReceiptRequired | Boolean | False | No | Whether the paper receipt is required for the expense to be submitted. | |
IsPersonalExpense | Boolean | False | No | Whether the expense is marked as personal (non-reimbursable) by the user. | |
JptRouteId | String | False | No | The unique route ID to identify a Japan rail route. | |
LocationName | String | False | No | The location information of the expense. | |
LocationCity | String | False | No | The location information of the expense | |
LocationCountryCode | String | False | No | The location information of the expense | |
LocationCountrySubDivisionCode | String | False | No | The location information of the expense | |
LocationId | String | False | No | The location information of the expense | |
PaymentTypeId | String | False | No | The payment type information for the expense. | |
PaymentTypeCode | String | False | No | The code for the payment type. | |
PostedAmount | Double | False | No | The amount of the expense, in the report currency. | |
PostedAmountCode | String | False | No | The code for the posted amount. | |
ReceiptImageId | String | False | No | The unique identifier of the image associated with the expense. | |
TicketNumber | String | False | No | The ticket number associated with the travel. | |
TransactionAmount | Double | False | No | The amount of the expense, in the transaction currency paid to the vendor. | |
TransactionAmountCode | String | False | No | Currency code for the transaction ammount | |
TransactionDate | Date | False | No | The transaction date. | |
IsExpensePartOfTravelAllowance | Boolean | False | No | The travel allowance data associated with the expense. | |
TravelAllowanceDailyLimit | String | False | No | The travel allowance data associated with the expense. | |
DailyTravelAllowanceId | String | False | No | The travel allowance data associated with the expense. | |
VendorId | String | False | No | The unique identifier of the vendor. | |
VendorName | String | False | No | The name of the vendor. | |
VendorDescription | String | False | No | The description of the vendor. Maximum length: 64 characters | |
ReportId | String | False | ReportsV4.Id | No | The unique identifier of the report that is being read. |
UserId | String | False | UsersV4.Id | No | The unique identifier of the SAP Concur user. Query the Identity table to retrieve this value. |
ContextType | String | False | No | The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY. Default value is TRAVELER. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier for the document. | |
DocType | String | False | No | Transaction type | |
CompanyId | String | False | No | Unique identifier for the company in SAP Concur. Maximum 32 characters. | |
EntityId | String | False | No | Unique identifier for the entity in SAP Concur. Maximum 32 characters. | |
CompanyUuid | String | False | No | UUID for the company in SAP Concur. Maximum 36 characters. | |
ErpSystemId | String | False | No | The external System ID that processed the document. Maximum 50 characters. | |
Document | String | False | No | The JSON financial document. | |
DocStatus | String | False | No | The financial document status. Supported values: READY, ACKNOWLEDGED, POSTING_CONFIRMED_SUCCESS, POSTING_CONFIRMED_FAILURE. | |
DocId | String | False | No | The transaction unique identifier, it could be expense report ID, payment request ID or cash advance ID. If specified, a single document that matches docId is returned. | |
IgnoreDocumentStatus | String | False | No | Ignores the financial documents status. If yes, a document is returned regardless of status. If no, only documents that have not been acknowledged/confirmed are returned. Supported values: yes, no. | |
SystemId | String | False | No | The external system ID that processed the document. Maximum 50 characters. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The budget service's key for this object. | |
Name | String | True | No | The name of this fiscal period. Must be unique for this entity. | |
StartDate | Date | True | No | The start date for this fiscal period. Must be within the parent fiscal year. | |
EndDate | Date | True | No | The end date for this fiscal period. Must be within the parent fiscal year. | |
Status | String | True | No | The status of this fiscal period. Supported values: OPEN, CLOSED, REMOVED | |
CurrentPeriod | Boolean | True | No | True if this the current fiscal period based on the current date and time, False otherwise. | |
PeriodType | String | True | No | The type of fiscal period. Supported values: MONTHLY | |
FiscalYearId [KEY] | String | True | FiscalYears.Id | No | The key of the parent fiscal year for this fiscal period. |
SpendDate | Date | True | No | If the current date is after this fiscal period's start date, this field shows the current date. | |
IncludeRemoved | Boolean | False | Yes | If true, the service will return all Fiscal Years, including those that were previously removed. If not supplied, this field defaults to false. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The budget service's key for this object. | |
Name | String | False | No | The name of this fiscal year. Must be unique for this entity. | |
Status | String | False | No | The status of this fiscal year. Supported values: OPEN, CLOSED, REMOVED | |
StartDate | Date | False | No | The start date for this fiscal year. The distance between start date and end date may not be more than two years. | |
EndDate | Date | False | No | The end date for this fiscal year. The distance between start date and end date may not be more than two years. | |
CurrentYear | Boolean | False | No | True if this the current fiscal year based on the current date and time, False otherwise. | |
LastModified | Datetime | False | No | The UTC date and time when this object was last changed. | |
DisplayName | String | False | No | Display name for fiscal year. For date range budget item we use this field to display. | |
MonthlyFiscalPeriods | String | False | No | If true, the service will return all Fiscal Years, including those that were previously removed. If not supplied, this field defaults to false. | |
IncludeRemoved | Boolean | False | Yes | If true, the service will return all Fiscal Years, including those that were previously removed. If not supplied, this field defaults to false. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
FormCode [KEY] | String | False | No | The code for the form. | |
Name | String | False | No | The name of the form code. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The form field ID. | |
FormId [KEY] | String | False | Forms.Id | No | The ID of the form. |
Label | String | False | No | The form field label.. | |
ControlType | String | False | No | The type of field. | |
DataType | String | False | No | The type of data accepted by the field. | |
MaxLength | Integer | False | No | The maximum length of the field value. | |
IsRequired | String | False | No | Whether the field is required. | |
ColumnNumber | Integer | False | No | The number of columns the field contains. | |
Access | String | False | No | The access level the specified user has to the field. | |
Width | String | False | No | The width of the field. | |
IsCustom | String | False | No | Whether the field is custom. | |
Sequence | Integer | False | No | The field order on the form. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The id of the form. | |
Code [KEY] | String | False | FormCodes.FormCode | No | The code of the form. |
Name | String | False | No | The name of the form. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AmountWithoutVat | String | False | No | The net amount of the invoice, excluding VAT. | |
Name | String | False | No | The Invoice name. | |
ApprovalStatus | String | False | No | A code which indicates the approval status of the payment request. | |
ApprovedByDelegate | String | False | No | Was the Payment Request approved by a delegate. Format: true/false. | |
AssignedByUsername | String | False | No | Username of the assigning employee. | |
AssignedDate | String | False | No | The date the payment request was assigned to the current owner. | |
BuyerCostCenter | String | False | No | The company defined center responsible for the payment request. | |
CalculatedAmount | String | False | No | The sum of all line item amounts plus shipping amount and tax amount for the payment request. | |
CheckNumber | String | False | No | Check number of the payment made to the vendor. | |
CompanyBillToAddress | String | False | No | ||
CompanyShipToAddress | String | False | No | ||
CountryCode | String | False | No | The country code. | |
CreatedByUsername | String | False | No | Username of the payment request creator. | |
CurrencyCode | String | False | No | The 3-letter ISO 4217 currency code for the expense report currency. Examples: USD - US dollars; BRL - Brazilian real;, etc. | |
Custom1 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom10 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom11 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom12 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom13 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom14 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom15 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom16 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom17 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom18 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom19 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom2 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom20 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom21 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom22 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom23 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom24 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom3 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom4 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom5 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom6 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom7 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom8 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
Custom9 | String | False | No | The details from the Custom fields. These may not have data, depending on configuration. | |
DataSource | String | False | No | A code which indicates the method used to created the Payment Request. Use | |
DeletedDate | String | False | No | The date the user deleted the payment request. | |
DeliverySlipNumber | String | False | No | The delivery slip number associated with receiving receipt. | |
Description | String | False | No | User entered description of the Payment Request. | |
DiscountPercentage | String | False | No | The discount from the supplier if the discount terms are met. | |
DiscountTerms | String | False | No | The NET discount terms with a supplier when discounts apply. | |
EmployeeName | String | False | No | The owner of the Payment Request. | |
ExternalPolicyId | String | False | No | The external policy ID. | |
ExtractDate | String | False | No | The date the payment request was extracted, in order to import it into an accounts payable system and generate a payment. | |
FirstApprovalDate | String | False | No | The date the payment request received its first approval in its approval workflow. | |
FirstSubmitDate | String | False | No | The date the payment request was first submitted. | |
ID [KEY] | String | False | No | The unique identifier of the resource. | |
InvoiceAmount | String | False | No | User-entered value representing the total invoice amount, used to calculate amount remaining on the line item page. | |
InvoiceDate | String | False | No | The date the vendor issued the invoice. | |
InvoiceNumber | String | False | No | The invoice Number from the vendor for the payment request. | |
InvoiceReceivedDate | String | False | No | The date on which the invoice was received. | |
IsAssigned | String | False | No | Whether the payment request is assigned. Format: true/false. | |
IsInvoiceConfirmed | String | False | No | Indicates if the payment request invoice is confirmed or in a different status. Format: true/false. | |
IsPaymentRequestDeleted | String | False | No | Whether the payment request is deleted. Format: true/false. | |
IsPaymentRequestDuplicate | String | False | No | Whether the payment request identified as a duplicate of another existing request. Format | |
IsTestTransaction | String | False | No | Is the payment request a test transaction (true/false). | |
LastSubmitDate | String | False | No | The date the payment request was last submitted. | |
LedgerCode | String | False | No | A code which indicates which company journal the payment request is assigned to. Use | |
EmployeeId | String | False | No | The company ID of the employee to whom the invoice should be assigned. Has precedence over EmployeeEmail; not evaluated if EmployeeLoginId matches an employee. This value is required if none of the following are provided: LedgerCode; EmployeeLoginId; EmployeeEmail; PurchaseOrderNumber; ExternalPolicyId. | |
EmployeeLoginId | String | False | No | The login ID of the employee to whom the invoice should be assigned. Has precedence over EmployeeId and EmployeeEmail. This value is required if none of the following are provided: LedgerCode; EmployeeId; EmployeeEmail; PurchaseOrderNumber; ExternalPolicyId. | |
LineItemsAggr | String | False | No | Aggregate information of line items | |
VendorRemitToIdentifierAgg | String | False | No | Used to identify the vendor location for payment remittance. At a minimum, the VendorCode or the combination of (VendorName, Address1, and PostalCode) are required. Use of as many fields as possible is encouraged to ensure a single vendor can be identified. If more than one vendor matches the information provided, the Invoice creation attempt will fail. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
Custom10ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom11ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom12ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom13ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom14ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom15ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom16ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom17ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom18ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom19ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom1ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom20ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom21ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom22ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom23ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom24ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom25ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom26ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom27ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom28ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom29ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom2ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom30ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom31ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom32ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom33ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom34ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom35ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom36ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom37ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom38ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom39ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom3ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom40ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom4ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom5ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom6ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom7ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom8ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom9ListItemID | String | True | No | For list fields, this is the list item ID. | |
EntryID | String | False | No | The ID of the expense entry that is the parent for the itemization. | |
LocationID | String | True | No | The unique identifier for the location where the expense was incurred. | |
OrgUnit1ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit2ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit3ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit4ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit5ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit6ListItemID | String | True | No | For list fields, this is the list item ID. | |
ReportID | String | True | ReportsV4.Id | No | The ID of the report that is the parent for the itemization. |
ReportOwnerID | String | True | No | The login ID for the report owner. | |
AllocationType | String | True | No | The type of allocation for the itemization. Possible values: P - partial allocation, F - full allocation, N - no allocation. | |
ApprovedAmount | Decimal | True | No | The approved amount of the expense itemization, in the report currency. | |
Custom10Code | String | True | No | For list fields, this is the list item code. | |
Custom10Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom10Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom11Code | String | True | No | For list fields, this is the list item code. | |
Custom11Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom11Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom12Code | String | True | No | For list fields, this is the list item code. | |
Custom12Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom12Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom13Code | String | True | No | For list fields, this is the list item code. | |
Custom13Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom13Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom14Code | String | True | No | For list fields, this is the list item code. | |
Custom14Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom14Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom15Code | String | True | No | For list fields, this is the list item code. | |
Custom15Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom15Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom16Code | String | True | No | For list fields, this is the list item code. | |
Custom16Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom16Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom17Code | String | True | No | For list fields, this is the list item code. | |
Custom17Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom17Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom18Code | String | True | No | For list fields, this is the list item code. | |
Custom18Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom18Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom19Code | String | True | No | For list fields, this is the list item code. | |
Custom19Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom19Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom1Code | String | True | No | For list fields, this is the list item code. | |
Custom1Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom1Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom20Code | String | True | No | For list fields, this is the list item code. | |
Custom20Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom20Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom21Code | String | True | No | For list fields, this is the list item code. | |
Custom21Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom21Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom22Code | String | True | No | For list fields, this is the list item code. | |
Custom22Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom22Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom23Code | String | True | No | For list fields, this is the list item code. | |
Custom23Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom23Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom24Code | String | True | No | For list fields, this is the list item code. | |
Custom24Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom24Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom25Code | String | True | No | For list fields, this is the list item code. | |
Custom25Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom25Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom26Code | String | True | No | For list fields, this is the list item code. | |
Custom26Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom26Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom27Code | String | True | No | For list fields, this is the list item code. | |
Custom27Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom27Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom28Code | String | True | No | For list fields, this is the list item code. | |
Custom28Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom28Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom29Code | String | True | No | For list fields, this is the list item code. | |
Custom29Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom29Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom2Code | String | True | No | For list fields, this is the list item code. | |
Custom2Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom2Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom30Code | String | True | No | For list fields, this is the list item code. | |
Custom30Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom30Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom31Code | String | True | No | For list fields, this is the list item code. | |
Custom31Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom31Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom32Code | String | True | No | For list fields, this is the list item code. | |
Custom32Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom32Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom33Code | String | True | No | For list fields, this is the list item code. | |
Custom33Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom33Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom34Code | String | True | No | For list fields, this is the list item code. | |
Custom34Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom34Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom35Code | String | True | No | For list fields, this is the list item code. | |
Custom35Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom35Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom36Code | String | True | No | For list fields, this is the list item code. | |
Custom36Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom36Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom37Code | String | True | No | For list fields, this is the list item code. | |
Custom37Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom37Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom38Code | String | True | No | For list fields, this is the list item code. | |
Custom38Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom38Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom39Code | String | True | No | For list fields, this is the list item code. | |
Custom39Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom39Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom3Code | String | True | No | For list fields, this is the list item code. | |
Custom3Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom3Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom40Code | String | True | No | For list fields, this is the list item code. | |
Custom40Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom40Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom4Code | String | True | No | For list fields, this is the list item code. | |
Custom4Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom4Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom5Code | String | True | No | For list fields, this is the list item code. | |
Custom5Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom5Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom6Code | String | True | No | For list fields, this is the list item code. | |
Custom6Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom6Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom7Code | String | True | No | For list fields, this is the list item code. | |
Custom7Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom7Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom8Code | String | True | No | For list fields, this is the list item code. | |
Custom8Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom8Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom9Code | String | True | No | For list fields, this is the list item code. | |
Custom9Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom9Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Description | String | False | No | The description of the expense. Maximum length: 64 characters | |
ExpenseTypeCode | String | False | No | The code for the expense type. Use the GET ExpenseGroupConfigurations endpoint to learn the expense type code for expense types that are active for this report's policy. | |
ExpenseTypeName | String | True | No | The name of the expense type, localized to the user's language. | |
HasComments | Bool | True | No | Indicates whether the expense has comments. Use the GET ExpenseEntryComments endpoint to get information about this entry's comments. Format: true or false | |
HasExceptions | Bool | True | No | Indicates whether the expense has exceptions. Format: true or false | |
IsBillable | Bool | False | No | Indicates whether the itemization is billable. Format: true or false | |
IsImageRequired | Bool | True | No | Indicates whether a receipt image is required for the entry. Format: true or false | |
IsPersonal | Bool | False | No | Indicates whether the itemization is personal (that is, non-reimbursable). Format: true or false | |
LastModified | Datetime | True | No | The UTC date when the itemization was last modified. | |
LocationCountry | String | True | No | The country where the expense was incurred. Format: 2-letter ISO 3166-1 country code | |
LocationName | String | True | No | The location where the expense was incurred, usually the city name. | |
LocationSubdivision | String | True | No | The state, province, or other country subdivision where the expense was incurred. Format: ISO 3166-2:2007 country subdivision | |
OrgUnit1Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit1Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit1Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit2Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit2Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit2Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit3Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit3Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit3Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit4Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit4Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit4Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit5Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit5Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit5Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit6Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit6Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit6Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
PostedAmount | Decimal | True | No | The amount of the expense itemization, in the report currency. | |
SpendCategoryCode | String | True | No | The code for the spending category that is specified for this itemization. | |
SpendCategoryName | String | True | No | The name of the spending category that is specified for this itemization, localized to the user's language. | |
TransactionAmount | Decimal | False | No | The amount of the expense itemization, in the transaction currency of the parent expense entry. | |
TransactionDate | Datetime | False | No | The date when the good or service associated with this itemization was provided. Format: YYYY-MM-DD | |
URI | String | True | No | null | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the itemizations. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier of the list item. | |
Code | String | False | No | List item long code. | |
ShortCode | String | False | No | List item short code. | |
Value | String | False | No | List item value. | |
ParentId | String | False | No | The unique identifier of the parent list item. | |
Level | Int | False | No | Level of the list item within the list. | |
HasChildren | Boolean | False | No | If true, the list item has children in this particular list. | |
Lists | String | False | No | The unique identifiers of the lists that contains the list item. The list item may exist under one or more lists. | |
IsDeleted | Boolean | False | No | Indicates the deleted state of the item in a particular list. If false, the list item is not deleted from one or more lists. The lists field will include only the lists that contain the list item in a not-deleted state. isDeleted will only be true when the list item is deleted from all lists. The lists field will include all lists that contain the list item. | |
ListId | String | False | Lists.Id | No | The unique identifier of the list that contains the list item. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier of the list item. | |
Code | String | False | No | List item long code. | |
ShortCode | String | False | No | List item short code. | |
Value | String | False | No | List item value. | |
ParentId | String | False | No | The unique identifier of the parent list item. | |
Level | Int | False | No | Level of the list item within the list. | |
HasChildren | Boolean | False | No | If true, the list item has children in this particular list. | |
IsDeleted | Boolean | False | No | Indicates the deleted state of the item in a particular list. If false, the list item is not deleted from one or more lists. The lists field will include only the lists that contain the list item in a not-deleted state. isDeleted will only be true when the list item is deleted from all lists. The lists field will include all lists that contain the list item. | |
ListId [KEY] | String | False | Lists.Id | No | The unique identifier of the list that contains the list item. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | Unique identifier of a list. | |
Value | String | False | No | Name of the list. | |
LevelCount | Int | False | No | Number of levels in the list. | |
SearchCriteria | String | False | No | What attribute to search by {TEXT, CODE}. | |
DisplayFormat | String | False | No | Whether the code or value is displayed first {(CODE) TEXT, TEXT (CODE)} | |
CategoryId | String | False | No | The category of the list. | |
CategoryType | String | False | No | The category of the list. | |
IsReadOnly | Boolean | False | No | If true, the list is read-only. | |
IsDeleted | Boolean | False | No | If true, the list has been deleted. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Code [KEY] | String | False | No | Localized data code. | |
LocalizedValue | String | False | No | The localized value. | |
Type [KEY] | String | False | No | The type of attribute to request localized info. | |
LangCode [KEY] | String | False | No | Optional. The language code requested. lang codes examples - de, en, es, fr, fr_CA, hu, it, ja, pl, pt_BR. Default is en. Set to '' (empty) to retrieve information for all language codes. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | False | No | The unique identifier of the resource. | |
AdministrativeRegion | String | False | No | The administrative region of the location. | |
Country | String | False | No | The 2-letter ISO 3166-1 country code for the location. | |
CountrySubdivision | String | False | No | The ISO 3166-2:2007 country subdivision code for the location. Example: US-WA | |
IATACode | String | False | No | The International Air Transport Association (IATA) airport code of the location. | |
IsAirport | Boolean | False | No | Indicates whether the location is an airport. Format: true or false | |
IsBookingTool | Boolean | False | No | Indicates whether the location is used by the booking tool. Format: true or false | |
Latitude | String | False | No | The latitude of the geocode for the location. | |
Longitude | String | False | No | The longitude of the geocode for the location. | |
Name | String | False | No | The location name. Maximum length: 64 characters | |
URI | String | False | No | The URI to the resource. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier of the resource. | |
Context | String | False | No | The context of the notification. | |
EventType | String | False | No | The type of the event that triggered the callout. | |
EventDateTime | Datetime | False | No | The date of the event. | |
NotificationURI | String | False | No | The URL that needs to be called to delete a failed notification. | |
ObjectType | String | False | No | The type of object that triggered the notification. | |
ObjectURI | String | False | No | The type of the event. | |
Status | String | False | No | The status of the notification |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | False | No | The unique identifier of the resource. | |
TripId [KEY] | String | False | Trips.Id | No | The trip id of the associated itinerary |
EndCityCode | String | False | No | The city code of the destination city where the opportunity is offered | |
EndDateLocal | Datetime | False | No | The local end date of the location where the opportunity is offered | |
EndPostalCode | String | False | No | The postal code of the destination location where the opportunity is offered | |
IsActive | Bool | False | No | Indicates that the opportunity is currently active | |
StartCityCode | String | False | No | The city code of the originating city where the opportunity is offered | |
StartDateLocal | Datetime | False | No | The local start date of the location where the opportunity is offered | |
StartPostalCode | String | False | No | The postal code of the originating location where the opportunity is offered | |
Type | String | False | No | The type of opportunity | |
URI | String | False | No | The URI to the resource. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The id of the batch. | |
BatchName | String | False | No | The batch name, as it appears in Payment Manager. | |
BatchTotal | Decimal | False | No | The number of payment demands in the batch. | |
Count | Integer | False | No | The name of the form. | |
Currency | String | False | No | The 3-letter ISO 4217 currency code for the batch. | |
PaymentMethod | String | False | No | The reimbursement method for the batch. Either Expense Pay by Concur, Company Check (via Accounts Payable), ADP (via EPIP file), or Other Reimbursement Methods. | |
Type | String | False | No | The payee of the batch. Either Employee or Card Program. | |
BatchUrl | String | False | No | The URL to use as a basis for other actions, such as closing the batch. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID | String | False | No | The unique identifier of the resource. | |
ApprovalStatusCode | String | False | No | A code indicating the request's approval status. | |
CreateDate | Date | False | No | The date the request was created. | |
CurrencyCode | String | False | No | The 3-letter ISO 4217 currency code for the request currency. Examples: USD - US dollars; BRL - Brazilian real; etc. | |
InvoiceNumber | String | False | No | The invoice number of the payment request. | |
IsDeleted | String | False | No | A true/false value which indicates whether the request has been deleted. Deleted requests are retained in the system for historical purposes. | |
OwnerLoginID | String | False | No | The login ID of the payment request owner. | |
OwnerName | String | False | No | The name of the payment request owner. | |
PaidDate | Date | False | No | The date when all journal entries in the request were integrated with or extracted to the financial system. | |
PaymentRequestId | String | False | No | The unique identifier of the payment request summarized in this digest. | |
PaymentRequestUri | String | False | No | The URI of the payment request summarized in this digest. | |
PaymentStatusCode | String | False | No | A code indicating the request's payment status. | |
PurchaseOrderNumber | String | False | No | The purchase order number for the purchase order associated with the invoice. | |
Total | String | False | No | The total amount of the request. | |
URI | String | False | No | The URI to the resource. | |
UserDefinedDate | Date | False | No | The invoice date as assigned by the user. | |
VendorName | String | False | No | The name of the vendor. | |
VendorCode | String | False | No | The name of the vendor. | |
VendorInvoiceNumber | String | False | No | Vendor invoice number tied to invoice. | |
SubmitDate | Date | False | No | The payment request submit date is before this date. Format: YYYY-MM-DD |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique purchase request reference Id. Returned by the Create Purchase Request API call. | |
PurchaseRequestNumber | String | False | No | The unique purchase request identifier which can be used to uniquely identify a purchase request in SAP Concur products. | |
PurchaseRequestQueueStatus | String | False | No | The creation status of the purchase request. Possible values are: PENDING_CREATION, CREATED, CREATE_FAILED. | |
PurchaseRequestWorkflowStatus | String | False | No | The workflow status of the purchase request. Possible values are: Approved, Pending Approval, Pending Cost Object Approval, Sent Back To Employee, Not Submitted, Submitted, Pending Processor Review, Vendor Approval, Approval Time Expired. | |
PurchaseOrders | String | False | No | If the purchase request has been approved and a purchase order generated, this array contains the purchase order details. If empty, this element will not be returned. | |
PurchaseRequestExceptions | String | False | No | An aggregate json object containing all exceptions, if present on the purchase request. If empty, this element will not be returned. | |
Mode | String | True | No | Specifies mode for Get Purchase Request Details. Supported value: COMPACT |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
URI | String | True | No | The URI to the resource. | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user. Optional. The user must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Comment | String | False | No | The comments input on the report by all users. | |
AuthorFirstName | String | False | No | The comment author's first name. | |
AuthorLastName | String | False | No | The comment author's last name. | |
AuthorMiddleInitial | String | False | No | The comment author's middle initial. | |
CreationDate | Datetime | False | No | The UTC datetime when the comment was created on the report or expense. | |
ExpenseId | String | False | Expenses.ExpenseId | No | The unique identifier of the expense. |
IsAuditorComment | Boolean | False | No | If true, this attribute represents whether this comment has been authored by an auditor. | |
IsLatest | Boolean | False | No | If true, this attribute represents the latest comment by the user. | |
StepInstanceId | String | False | No | The unique identifier of the step instance. | |
CreatedForEmployeeId | String | False | No | The unique identifier of the employee the comment was created on behalf of. | |
CreatedForEmployeeFirstName | String | False | No | The first name of the employee the comment was created on behalf of. | |
CreatedForEmployeeLastName | String | False | No | The last name of the employee the comment was created on behalf of. | |
CreatedForEmployeeMiddleInitial | String | False | No | The middle initial of the employee the comment was created on behalf of. | |
ReportId | String | False | ReportsV4.Id | No | The unique identifier of the report that is being read. |
UserId | String | False | UsersV4.Id | No | The unique identifier of the SAP Concur user. Query the Identity table to retrieve this value. |
ContextType | String | False | No | The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY. Default value is TRAVELER. | |
IncludeAllComments | String | False | No | Return all the comments that are present on the report at all levels. Default value: true |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
ApproverLoginID | String | True | No | The Login ID of the report owner's expense approver. | |
Custom10ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom11ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom12ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom13ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom14ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom15ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom16ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom17ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom18ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom19ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom1ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom20ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom2ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom3ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom4ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom5ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom6ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom7ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom8ListItemID | String | True | No | For list fields, this is the list item ID. | |
Custom9ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit1ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit2ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit3ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit4ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit5ListItemID | String | True | No | For list fields, this is the list item ID. | |
OrgUnit6ListItemID | String | True | No | For list fields, this is the list item ID. | |
PaidDate | Datetime | True | No | The date when all journal entries in the report was integrated with or extracted to the financial system. | |
PolicyID | String | False | No | The unique identifier of the policy that applies to this report. Maximum 64 characters. | |
AmountDueCompanyCard | Decimal | True | No | The total amount due to the company card for the report. Maximum 23 characters. | |
AmountDueEmployee | Decimal | True | No | The total amount due to the employee for the report. Maximum 23 characters. | |
ApprovalStatusCode | String | True | No | The approval status code for the report. | |
ApprovalStatusName | String | True | No | The report's approval status, in the OAuth consumer's language. | |
ApproverName | String | True | No | The name of the report owner's expense approver. | |
Country | String | True | No | The report country. Maximum 2 characters. Format: The ISO 3166-1 alpha-2 country code. Example: United States is US. | |
CountrySubdivision | String | True | No | The report country subdivision. Format: ISO 3166-2:2007 country subdivision. | |
CreateDate | Datetime | True | No | The date the report was created. | |
CurrencyCode | String | True | No | The ISO 4217 currency code for the expense report currency. 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. | |
Custom10Code | String | True | No | For list fields, this is the list item code. | |
Custom10Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom10Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom11Code | String | True | No | For list fields, this is the list item code. | |
Custom11Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom11Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom12Code | String | True | No | For list fields, this is the list item code. | |
Custom12Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom12Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom13Code | String | True | No | For list fields, this is the list item code. | |
Custom13Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom13Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom14Code | String | True | No | For list fields, this is the list item code. | |
Custom14Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom14Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom15Code | String | True | No | For list fields, this is the list item code. | |
Custom15Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom15Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom16Code | String | True | No | For list fields, this is the list item code. | |
Custom16Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom16Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom17Code | String | True | No | For list fields, this is the list item code. | |
Custom17Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom17Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom18Code | String | True | No | For list fields, this is the list item code. | |
Custom18Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom18Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom19Code | String | True | No | For list fields, this is the list item code. | |
Custom19Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom19Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom1Code | String | True | No | For list fields, this is the list item code. | |
Custom1Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom1Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom20Code | String | True | No | For list fields, this is the list item code. | |
Custom20Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom20Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom2Code | String | True | No | For list fields, this is the list item code. | |
Custom2Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom2Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom3Code | String | True | No | For list fields, this is the list item code. | |
Custom3Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom3Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom4Code | String | True | No | For list fields, this is the list item code. | |
Custom4Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom4Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom5Code | String | True | No | For list fields, this is the list item code. | |
Custom5Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom5Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom6Code | String | True | No | For list fields, this is the list item code. | |
Custom6Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom6Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom7Code | String | True | No | For list fields, this is the list item code. | |
Custom7Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom7Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom8Code | String | True | No | For list fields, this is the list item code. | |
Custom8Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom8Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
Custom9Code | String | True | No | For list fields, this is the list item code. | |
Custom9Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
Custom9Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
EverSentBack | Bool | True | No | Whether the report has ever been sent back to the employee. Format: Y/N | |
HasException | Bool | True | No | Whether the report has exceptions. Format: Y/N | |
LastComment | String | True | No | The text of the most recent comment on the report. | |
LastModifiedDate | Datetime | True | No | The date the report header was last modified. | |
LedgerName | String | True | No | The name of the expense report ledger. Maximum 20 characters. | |
Name | String | False | No | The name of the report. | |
OrgUnit1Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit1Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit1Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit2Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit2Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit2Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit3Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit3Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit3Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit4Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit4Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit4Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit5Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit5Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit5Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OrgUnit6Code | String | True | No | For list fields, this is the list item code. | |
OrgUnit6Type | String | True | No | The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text | |
OrgUnit6Value | String | False | No | The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters | |
OwnerName | String | True | No | The name of the expense report owner. | |
PaymentStatusCode | String | True | No | The code for the payment status of the report. | |
PaymentStatusName | String | True | No | The report's payment status, in the OAuth consumer's language. | |
PersonalAmount | Decimal | True | No | The total amount of expenses marked as personal. Maximum 23 characters. | |
ProcessingPaymentDate | Datetime | True | No | The date that the report completed all approvals and was ready to be extracted for payment. | |
ReceiptsReceived | Bool | True | No | If Y, then this report has its receipt receipt confirmed by the Expense Processor. Format: Y/N | |
SubmitDate | Datetime | True | No | The date the report was submitted. | |
Total | Decimal | True | No | The total amount of the report. | |
TotalApprovedAmount | Decimal | True | No | The total amount of approved expenses in the report. Maximum 23 characters. | |
TotalClaimedAmount | Decimal | True | No | The total amount of all non-personal expenses in the report. Maximum 23 characters. | |
URI | String | True | No | null | |
UserDefinedDate | Datetime | False | No | The date of the report assigned by the user. | |
WorkflowActionUrl | String | True | No | The URL to post a workflow action to the report using the Post Report Workflow Action function. | |
HasImages | Boolean | False | No | Determines if the report has at least one expense entry with an entry image or if there is a report image for this report. FORMAT: true or false. | |
ExpenseTypeCode | String | False | No | The expense type code that is the expense type for at least one expense entry in the report. Use ExpenseTypeCode from Response of GET Expense Group Configurations V3. | |
LoginId | String | False | UsersV4.UserName | No | Optional. The login ID of the report owner(s) to use when searching for reports. If the value is set to LoginID, reports for the report owner with this login ID value are returned. If the value is set to ALL, reports for all report owners are returned. If this parameter is not specified, reports for the OAuth Consumer are returned. The access token owner (OAuth Consumer) must have the Web Services Admin role to use this parameter. |
PaymentType | String | False | No | The unique identifier for the payment type that is the payment type for at least one expense entry in the report. Use PaymentTypeID from Response of GET Expense Group Configurations V3 to obtain valid payment types. | |
PaidDateBefore_p | String | False | Yes | The report paid date is before this date.Format: YYYY-MM-DD | |
CreateDateBefore_p | String | False | Yes | The report create date is before this date.Format: YYYY-MM-DD | |
ProcessingPaymentDateBefore_p | String | False | Yes | The report processing payment date is before this date.Format: YYYY-MM-DD | |
EntryTransactionDateBefore_p | String | False | Yes | The entry transaction date for at least one expense entry in the report is before this date.Format: YYYY-MM-DD | |
SubmitDateAfter_p | String | False | Yes | The report submit date is after this date.Format: YYYY-MM-DD | |
UserDefinedDateBefore_p | String | False | Yes | The report user defined date is before this date.Format: YYYY-MM-DD | |
BatchID_p | String | False | Yes | The unique identifier for a payment batch where there is at least one report payee within the report. Use the BatchID from Response of GET Payment Batch List. | |
ProcessingPaymentDateAfter_p | String | False | Yes | The report processing payment date is after this date. Format: YYYY-MM-DD | |
ModifiedDateBefore_p | String | False | Yes | The report modified date is before this date.Format: YYYY-MM-DD | |
UserDefinedDateAfter_p | String | False | Yes | The report user defined date is after this date.Format: YYYY-MM-DD | |
HasAttendees_p | String | False | Yes | Determines if the report has at least one expense entry with an attendee. FORMAT: true or false. | |
PaidDateAfter_p | String | False | Yes | The report paid date is after this date.Format: YYYY-MM-DD | |
ExpenseGroupConfigID_p | String | False | Yes | The unique identifier for the expense group configuration associated to the report's expense group. Use the ID from the Response of the Expense Group Configurations V3. | |
IsTestUser_p | String | False | Yes | The report owner is a test user using the report for testing purposes in a non-production envirnment. FORMAT: true or false. | |
HasBillableExpenses_p | String | False | Yes | The IsBillable flag for at least one expense entry in the report. FORMAT: true or false. | |
HasVAT_p | String | False | Yes | Determines if the report has at least one expense entry with VAT details. FORMAT: true or false. | |
ReimbursementMethod_p | String | False | Yes | The method the report owner will be reimbursed. VALUES: ADPPAYR - ADP Payroll; APCHECK - AP (Company Check); CNQRPAY - Expense Pay; PMTSERV - Other Payment Service. NOTE: PAY_PAL is NOT supported. | |
AttendeeTypeCode_p | String | False | Yes | The report contains expense entries that have attendees of the specified type. | |
ModifiedDateAfter_p | String | False | Yes | The report modified date is after this date.Format: YYYY-MM-DD | |
CreateDateAfter_p | String | False | Yes | The report create date is after this date.Format: YYYY-MM-DD | |
SubmitDateBefore_p | String | False | Yes | The report submit date is before this date.Format: YYYY-MM-DD | |
CountryCode_p | String | False | Yes | The report country. Maximum 2 characters. Format: The ISO 3166-1 alpha-2 country code. Example: United States is US. | |
EntryTransactionDateAfter_p | String | False | Yes | The entry transaction date for at least one expense entry in the report is after this date.Format: YYYY-MM-DD | |
VendorName_p | String | False | Yes | The Vendor Description that is the vendor for at least one expense entry in the report. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier of the report that is being read. | |
UserID | String | False | UsersV4.Id | No | The unique identifier of the SAP Concur user. |
ContextType | String | False | No | The access level of the SAP Concur user, which determines the form fields they can view/modify. | |
Name | String | False | No | ||
ApprovalStatus | String | False | No | ||
ApprovalStatusId | String | False | No | ||
Approver | String | False | No | ||
CanAddExpense | Booolean | False | No | ||
CardProgramStatementPeriodId | Booolean | False | No | ||
EndDate | Date | False | No | ||
HasBlockingExceptions | Boolean | False | No | ||
IsApproved | Boolean | False | No | ||
IsEnabledForFinancialIntegration | Boolean | False | No | ||
IsEnabledForReopen | Boolean | False | No | ||
IsPaymentConfirmed | Boolean | False | No | ||
IsPendingApproval | Boolean | False | No | ||
IsPendingDelegatorReview | Boolean | False | No | ||
IsPendingProcessor | Boolean | False | No | ||
IsReopened | Boolean | False | No | ||
IsReportEverSentBack | Boolean | False | No | ||
IsSentBack | Boolean | False | No | ||
IsSentForPayment | Boolean | False | No | ||
IsSubmitted | Boolean | False | No | ||
PaidDate | Datetime | False | No | ||
PaymentStatus | String | False | No | ||
PaymentStatusId | String | False | No | ||
ReportDate | Date | False | No | ||
ReportNumber | String | False | No | ||
ReportType | String | False | No | ||
SentBackDate | Datetime | False | No | ||
SponsorId | String | False | No | ||
StartDate | Date | False | No | ||
SubmitDate | Datetime | False | No |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TravelRequestId [KEY] | String | False | TravelRequests.Id | No | The id of the travel request. Can be found by querying TravelRequests. |
Value [KEY] | String | False | No | The value of the comment. | |
AuthorFirstName | String | False | No | The first name of the employee. | |
AuthorLastName | String | False | No | The last name of the employee. | |
CreationDateTime | Datetime | False | No | Creation date of the comment. | |
IsLatest | Boolean | False | No | If true, the comment has been edited since the last workflow transition. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique identifier of the Request. | |
Name | String | False | No | The name of the Request. | |
Approved | Boolean | False | No | Indicates whether this Request is approved. | |
AllocationFormId | String | False | No | The unique identifier of the allocation form. | |
ApprovalLimitDate | Datetime | False | No | Limit approval date of the proposal. Past this date, the proposal will not be viable any more. Note: Offset MUST be in form YYYY-MM-DDThh:mm | |
AuthorizedDate | Datetime | False | No | For approved Request, the date at which the approval process was completed. | |
BusinessPurpose | String | False | No | The business purpose of the Request. | |
CanceledPostApproval | Boolean | False | No | Indicates whether this Request was canceledPostApproval. | |
Closed | Boolean | False | No | Indicates whether this Request is closed. | |
CreationDate | Datetime | False | No | The date the Request was created. | |
EndDate | Date | False | No | The end date of the Request. | |
EndTime | Time | False | No | The end time of the Request. | |
EverSentBack | Boolean | False | No | Indicates whether the Request has ever been sent back to the employee. | |
HighestExceptionLevel | String | False | No | The highest level of exception contained in this Request. Supported values: WARNING, ERROR, and NONE | |
Href | String | False | No | Hyperlink to the resource for this Request. | |
LastModified | Datetime | False | No | The date the Request was last modified. | |
PendingApproval | Boolean | False | No | Indicates whether this Request is pending approval. | |
PRN | String | False | No | The value of the pnr provided within the agency proposals by the travel agency. | |
RequestId | String | False | No | The public key of the Request (unique per customer). | |
StartDate | Date | False | No | The start date of the Request. | |
StartTime | Time | False | No | The end date of the Request. | |
SubmitDate | Datetime | False | No | The date the Request was submitted (last submit date in case of recall). | |
ApprovalStatusCode | String | False | No | The code for the approval status of the Request. Supported values: NOT_SUBMITTED, SUBMITTED, APPROVED, CANCELED, or SENTBACK | |
ApprovalStatusName | String | False | No | The approval status of the Request in the current user?s language. | |
ApproverId | String | False | No | Unique identifier of the related object. | |
ApproverFirstName | String | False | No | The first name of the employee. | |
ApproverLastName | String | False | No | The last name of the employee. | |
ApproverMiddleInitial | String | False | No | The middle initial of the employee. | |
MainDestinationId | String | False | No | The id of the location. | |
MainDestinationCity | String | False | No | Required for all city location type (not airport, or rail station - except for STD location type) The city name of the location.Note: STD location type for rail is considered as a city location type, city and countryCode fields are required in that case. | |
MainDestinationCountryCode | String | False | No | Required if city or name is used The ISO 3166-1 country code. Max length 2 characters. | |
MainDestinationCountrySubDivisionCode | String | False | No | The ISO 3166-2 country sub code. | |
MainDestinationiataCode | String | False | No | Required if air is used The IATA code of an airport location. | |
MainDestinationLatitude | Integer | False | No | The latitude of the location. | |
MainDestinationLongitude | Integer | False | No | The longitude of the location. | |
MainDestinationLocationCode | String | False | No | Required if rail is used with RAIL_xx locationType The code of the location. Optional for segments based on city locations, will be required in case of duplicate locations within database. If provided (with city and countryCode still required), it will be considered first, and if not found then city and countryCode will be considered. | |
MainDestinationType | String | False | No | Required if rail is used The type of the location. | |
MainDestinationName | String | False | No | The name of the location. Always provide the countryCode value in addition to the name. | |
OwnerId | String | False | No | Unique identifier of the related object. | |
OwnerFirstName | String | False | No | The first name of the employee. | |
OwnerLastName | String | False | No | The last name of the employee. | |
OwnerMiddleInitial | String | False | No | The middle initial of the employee. | |
TotalApprovedAmountValue | Integer | False | No | The amount in the defined currency. | |
TotalApprovedAmountCurrency | String | False | No | The 3-letter ISO 4217 code for the currency in which the amount is expressed. Max length 3 characters. | |
TotalPostedAmountValue | Integer | False | No | The amount in the defined currency. | |
TotalPostedAmountCurrency | String | False | No | The 3-letter ISO 4217 code for the currency in which the amount is expressed. Max length 3 characters. | |
TotalRemainingAmountValue | Integer | False | No | The amount in the defined currency. | |
TotalRemainingAmountCurrency | String | False | No | The 3-letter ISO 4217 code for the currency in which the amount is expressed. Max length 3 characters. | |
RequestTypeCode | String | False | No | The code of the type inherited from the Request Policy type. Possible values: Authorization, Cash Advance, Travel | |
RequestTypeLabel | String | False | No | The label of the type inherited from the Request Policy Type. | |
Custom1Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom1Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom1Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom2Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom2Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom2Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom3Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom3Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom3Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom4Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom4Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom4Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom5Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom5Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom5Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom6Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom6Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom6Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom7Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom7Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom7Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom8Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom8Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom8Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom9Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom9Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom9Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom10Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom10Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom10Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom12ode | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom11Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom1Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom12Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom12Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom12Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom13Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom13Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom13Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom14Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom14Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom14Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom15Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom15Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom15Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom16Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom16Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom16Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom17Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom17Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom17Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom18Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom18Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom18Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom19Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom19Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom19Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
Custom20Code | String | False | No | The short code for the list item. For non-list fields, this value will be blank. | |
Custom20Value | String | False | No | The value of the non-list item. For list fields, this is the unique id of the list item. | |
Custom20Href | String | False | No | The link to get this list item on the list service. Empty for non-list items. | |
CashAdvances | String | False | No | The list of cash advances for this Request. | |
Comments | String | False | No | The list of comments for this Request. | |
Exceptions | String | False | No | The list of exceptions that have been raised to this Request. | |
Expenses | String | False | No | Expected expenses attached to this Request. | |
ExtensionOf | String | False | No | The Request for which this Request is an extension of, or addendum to. | |
EventRequest | String | False | No | The parent Event Request to which this child Request is related. | |
Policy | String | False | No | The policy that applies to the Request. | |
TravelAgency | String | False | No | The travel agency office that is managing the trip associated to this Request. | |
View | String | False | No | Name of the view defining the scope of the Requests to get. Supported values:ALL: Get all existing Requests for a user (relevant only for the traveler).ACTIVE Get all active Requests. Does not include cancelled Requests. Approved Requests included are aged less than three months based on current date and must not be in closed status.ACTIVEAPPROVED Get all active Requests at the Approved status. Those approved Requests are aged less than three months based on current date and must not be in closed status.UNSUBMITTED: Get all the unsubmitted Requests (relevant only for the traveler).PENDING: Get all the Requests that are submitted but not yet approved (relevant only for the traveler).VALIDATED: Get all the approved Requests for a user (relevant only for the traveler). Closed Requests are included in this view.APPROVED: Get all the approved Requests by a user (relevant only for the approver). Closed Requests are included in this view.CANCELED: Get all the cancelled Requests for a user (relevant only for the traveler). Cancelled could include closed/not closed Requests.CLOSED: Get all the closed Requests for a user (relevant only for the traveler). Includes canceled then closed Request as well as approved then closed Requests.SUBMITTED: Get all the submitted Requests for a user (relevant only for the traveler). Submitted does not include cancelled requests.TOAPPROVE: Get all Requests to be approved by the user (relevant only for the approver).PENDINGEBOOKING: Approved Requests awaiting Concur Travel booking(s).PENDINGPROPOSAL: Get all Requests submitted to a Travel Agency (TMC) step (relevant only for the TMC agent), userId is required.PROPOSALAPPROVED: Get all the approved Requests by a user (relevant only for the TMC agent), userId is required.PROPOSALCANCELED: Get all the cancelled Requests for a user (relevant only for the TMC agent), userId is required.If no view value is sent, the default view ALL will be used. | |
UserId | String | False | UsersV4.Id | No | Associated with a traveler view: the unique identifier of the Request owner to use when searching for Requests.Associated with an approver view: the unique identifier of the approver to user when searching for Requests.Associated with a TMC agent view, Required, the unique identifier of the TMC agent to use. This TMC agent user must have a default Travel Agency assigned in its profile corresponding to the Travel Agency assigned to the Requests |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TripId [KEY] | String | False | Trips.Id | No | The id of the trip. |
BookingRecordLocator [KEY] | String | False | No | The record locator of the booking. | |
FirstName | String | False | No | The first name of the passenger. | |
LastName | String | False | No | The last name of the passenger. | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the trip. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
RecordLocator [KEY] | String | False | No | The record locator of the booking. | |
TripId [KEY] | String | False | Trips.Id | No | The id of the trip. |
BookingOwner | String | False | No | The id of the trip. | |
Source | String | False | No | The name of the trip. | |
BookingSource | String | False | No | The record locator of the trip. | |
BookedDate | Datetime | False | No | The first name of the traveler. | |
CreatedDate | Datetime | False | No | The last name of the traveler. | |
ModifiedDate | Datetime | False | No | A comma separated list of passengers. | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the trip. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TripId [KEY] | String | False | Trips.Id | No | The id of the trip. |
BookingRecordLocator [KEY] | String | False | No | The record locator of the booking. | |
SegmentType [KEY] | String | False | No | The type of the segment. | |
ChargeType [KEY] | String | False | No | The type of the charge. | |
Amount | String | False | No | The total amount for the rate for the booking. | |
AllowanceAmount | String | False | No | The cost of overage fees when the allowance is exceeded. | |
Currency | String | False | No | The 3-letter ISO 4217 currency code for the total amount. | |
Description | String | False | No | The description for the rate. | |
IsPaid | Boolean | False | No | Whether the rate has been paid. | |
AllowanceIsUnlimited | Boolean | False | No | Whether the allowance is unlimited. | |
IsPrimary | Boolean | False | No | Indicates whether the charge is the Primary or Main rate. | |
NumUnits | Integer | False | No | The number of units expected for the charge. For instance, 3 days. | |
AllowanceNumUnits | Integer | False | No | The number of units for the allowance associated with the charge. | |
PerUnit | String | False | No | The unit of measure for the charge. Values represent rates like per DAY, WEEK, or MONTH. | |
AllowanceUnit | String | False | No | The unit of measure for the allowance associated with the charge. | |
SemanticsCode | String | False | No | Indicates the charge category for the line item. | |
SemanticsVendorType | String | False | No | The vendor type: H=Hotel, C=Car, A=Air, G=Ground, R=Rail | |
StartDateLocal | Datetime | False | No | The start date of the booking, in the user's local time. | |
Vendor | String | False | No | The vendor for the booking charge. | |
VendorChargeCode | String | False | No | The vendor's code for the charge | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the trip. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TripId [KEY] | String | False | Trips.Id | No | The id of the trip. |
SegmentType [KEY] | String | False | No | The type of the segment. | |
BookingRecordLocator [KEY] | String | False | No | The record locator of the booking. | |
ConfirmationNumber | String | False | No | The record locator or confirmation number for the segment. | |
ClassOfService | String | False | No | The class of the booking. | |
FlightNumber | String | False | No | The flight number for the booking. | |
StartDateLocal | Datetime | False | No | The booking starting time and date | |
EndDateLocal | Datetime | False | No | The booking ending time and date. | |
Vendor | String | False | No | The vendor for the booking charge. | |
Name | String | False | No | The name on the booking. | |
CancellationNumber | String | False | No | The cancellation number from the vendor. | |
CancellationPolicy | String | False | No | The cancellation policy from the vendor. | |
Currency | String | False | No | The 3-letter ISO 4217 currency code for the booking. | |
DailyRate | Decimal | False | No | The daily rate for the booking. | |
EndCityCode | String | False | No | The IATA airport code for the end city of the booking. | |
StartLongitude | String | False | No | The longitude of the starting point of the booking. | |
StartLatitude | String | False | No | The latitude of the starting point of the booking. | |
EndLongitude | String | False | No | The longitude of the ending point of the booking. | |
EndLatitude | String | False | No | The latitude of the ending point of the booking. | |
Notes | String | False | No | Additional information about the booking. | |
PhoneNumber | String | False | No | The ride vendor phone number. | |
Rate | String | False | No | The rate for the booking. | |
RateType | String | False | No | The rate type for the booking. | |
RateCode | String | False | No | The rate code for the booking. | |
RateNotes | String | False | No | The rate notes for the booking. | |
RateDescription | String | False | No | The rate description for the booking. | |
StartCityCode | String | False | No | The starting IATA airport code of the booking. | |
Status | String | False | No | The status of the segment. | |
TimeZone | String | False | No | The time zone of the booking. | |
TotalRate | String | False | No | The total rate amount of the booking. | |
VendorName | String | False | No | The name of the vendor. | |
DateCancelledUtc | Datetime | False | No | The date the booking was cancelled, in UTC. | |
DateCreatedUtc | Datetime | False | No | The date the booking was created, in UTC. | |
DateModifiedUtc | Datetime | False | No | The date the booking was last modified, in UTC. | |
EndDateUtc | Datetime | False | No | The booking ending time and date, in UTC. | |
StartDateUtc | Datetime | False | No | The booking starting time and date, in UTC. | |
StartGate | String | False | No | The departure gate for the booking. | |
EndGate | String | False | No | The arrival gate for the booking. | |
StartTerminal | String | False | No | The departure terminal for the booking. | |
EndTerminal | String | False | No | The arrival terminal for the booking. | |
LegId | Integer | False | No | The trip leg ID. | |
CheckinTime | String | False | No | The check in time for the hotel booking. | |
CheckoutTime | String | False | No | The check out time for the hotel booking. | |
HotelPropertyId | String | False | No | The hotel's property ID. | |
ParkingLocationId | String | False | No | The location of the parking booking. | |
NumRooms | Integer | False | No | The number of rooms the booking is for. | |
RoomDescription | String | False | No | The room description for the booking | |
RoomType | String | False | No | The room type for the booking. | |
RestaurantId | String | False | No | The booking vendor's restaurant ID. | |
AirCondition | String | False | No | The character code that indicates if car has air conditioner. R for AC, N for No AC | |
Body | String | False | No | The character code to indicate how many passengers the car can seat. | |
Class | String | False | No | Character code to indicate the class of the car e.g. if it is economy, full size, compact, etc. Varies by Vendor. | |
DiscountCode | String | False | No | The discount code for the booking. | |
DropoffCollectionAddress1 | String | False | No | The AddressLine1 for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionAddressType | String | False | No | The type of the dropoff address. | |
DropoffCollectionCategory | String | False | No | Thecategory of the dropoff collection. | |
DropoffCollectionCity | String | False | No | City for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionCityCode | String | False | No | The IATA airport code for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionCountry | String | False | No | The country for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionLatitude | String | False | No | The latitude for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionLongitude | String | False | No | The longitude for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionNumber | String | False | No | the dropoff location number. | |
DropoffCollectionPhoneNumber | String | False | No | The phone number for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionPostalCode | String | False | No | The postal code for the dropoff address when the rental service offers dropoff. | |
DropoffCollectionState | String | False | No | The state for the dropoff address when the rental service offers dropoff. | |
EndAddress | String | False | No | The ending address for the booking. | |
EndAddress2 | String | False | No | The ending address for the booking. | |
EndCity | String | False | No | The ending address for the booking. | |
EndCloseTime | String | False | No | The closing time for the dropoff location. | |
EndCountry | String | False | No | The ending address for the booking. | |
EndLocation | String | False | No | The dropoff location. | |
EndOpenTime | String | False | No | The opening time of the dropoff location. | |
EndPhoneNumber | String | False | No | The phone number of the dropoff location. | |
EndPostalCode | String | False | No | The ending address for the booking. | |
EndState | String | False | No | The ending address for the booking. | |
FrequentTravelerId | String | False | No | The loyalty program ID for the user. | |
NumCars | Integer | False | No | The number of cars rented. | |
NumPersons | Integer | False | No | The number of people including the driver that the rental is for. | |
NumberOfHours | Integer | False | No | The number of hours of the booking. | |
PickupDeliveryAddress1 | String | False | No | The AddressLine1 for the pickup address when the rental service offers pickup. | |
PickupDeliveryAddressType | String | False | No | The type of the pickup address when the rental service offers pickup. | |
PickupDeliveryCategory | String | False | No | The category of the pickup address when the rental service offers pickup. | |
PickupDeliveryCity | String | False | No | The city for the pickup address when the rental service offers pickup. | |
PickupDeliveryCityCode | String | False | No | The IATA airport code for the pickup address when the rental service offers pickup. | |
PickupDeliveryCountry | String | False | No | The country for the pickup address when the rental service offers pickup. | |
PickupDeliveryLatitude | String | False | No | The latitude for the pickup address when the rental service offers pickup. | |
PickupDeliveryLongitude | String | False | No | The longitude for the pickup address when the rental service offers pickup. | |
PickupDeliveryNumber | String | False | No | The number of the pickup delivery. | |
PickupDeliveryPhoneNumber | String | False | No | The phone number for the pickup address when the rental service offers pickup. | |
PickupDeliveryPostalCode | String | False | No | The postal code for the pickup address when the rental service offers pickup. | |
PickupDeliveryState | String | False | No | The state for the pickup address when the rental service offers pickup. | |
SpecialEquipment | String | False | No | Any special equipment required by the renter. | |
SpecialInstructions | String | False | No | Additional instructions regarding the booking. | |
MeetingInstructions | String | False | No | The instructions for the meeting location of the booking. | |
PickupInstructions | String | False | No | Instructions regarding the booking. | |
StartAddress | String | False | No | The starting address of the booking. | |
StartAddress2 | String | False | No | The starting address of the booking. | |
StartCity | String | False | No | The starting city of the booking. | |
StartCloseTime | String | False | No | The closing time for the pickup location. | |
StartCountry | String | False | No | The starting country of the booking. | |
StartLocation | String | False | No | The starting location of the booking. | |
StartOpenTime | String | False | No | The opening time for the pickup location. | |
StartPostalCode | String | False | No | The starting postal code for the booking. | |
StartState | String | False | No | The starting state for the booking. | |
Transmission | String | False | No | The character code that indicates if the car has auto-transmission. A for Auto, M for Manual. | |
UpgradedDateTime | Datetime | False | No | The date and time the booking was upgraded. | |
AircraftCode | String | False | No | The code for the aircraft type. | |
Bags | String | False | No | The number of bags included in the booking. | |
Cabin | String | False | No | The cabin for the booking. | |
Amenities | String | False | No | The amenities for the seat. | |
TrainNumber | String | False | No | The number for the booked train. | |
TrainTypeCode | String | False | No | The code for the type of train used in the booking. | |
TrainTypeName | String | False | No | The name of the type of train used in the booking. | |
WagonNumber | String | False | No | The number of the wagon the seat is on. | |
TransportMode | String | False | No | The transport mode of the booking. | |
CarbonEmissionLbs | String | False | No | The pounds of carbon emission for this booking. | |
CarbonModel | String | False | No | The model used to calculate the carbon emissions. | |
CheckedBaggage | Boolean | False | No | Whether the booking includes checked baggage. | |
Duration | String | False | No | The duration of the booked flight. | |
ETicket | String | False | No | Whether the booking has an e-ticket. | |
IsPersonal | Boolean | False | No | Whether the segment is for personal travel. | |
IsOpenSegment | Boolean | False | No | Whether the segment is open. | |
IsPreferredVendor | Boolean | False | No | If the airline is marked as a preferred property by the company. | |
IsUpgradeAllowed | Boolean | False | No | Whether the booking can be upgraded. | |
Meals | String | False | No | The meals included in the booking. | |
Miles | String | False | No | The number of miles included in the booking. | |
OpenSegment | String | False | No | Additional information about the open segment. | |
OperatedByFlightNumber | String | False | No | Flight Number provided by the airline operating the flight on behalf of the booked airline. | |
OperatedByTrainNumber | String | False | No | The train identifier of the operating vendor of the booked trip. | |
OperatedByVendor | String | False | No | The operated by vendor for the booking. | |
OperatedByVendorName | String | False | No | The name of the airline operating the flight on behalf of the booked airline. | |
RouteRestrictCode | String | False | No | The code to restrict the route of the booking. | |
StartPlatform | String | False | No | The starting platform location of the booking. | |
StartRailStation | String | False | No | The code of the starting station of the booking. | |
StartRailStationName | String | False | No | The name of the starting station of the booking. | |
Services | String | False | No | The services included in the booking. | |
HadDeposit | Boolean | False | No | Whether the booking had a deposit. | |
ModificationCode | String | False | No | The code for the modification to the booking. | |
PartnerMembershipId | String | False | No | The membership ID of the partner associated with the booking. | |
PassiveType | String | False | No | The type of the booking. | |
PassiveCityCode | String | False | No | The passive city code of the booking. | |
VendorFlags | String | False | No | Semi-colon-delimited list of flags for free hotel service flags. E.g. free breakfast (FB), internet (FI), Parking (FP), etc. If they were all present they can be concatenated as - FB;FI;FP; | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the trip. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TripId [KEY] | String | False | Trips.Id | No | The id of the trip. |
BookingRecordLocator [KEY] | String | False | No | The record locator of the booking. | |
SegmentType [KEY] | String | False | No | The type of the segment. | |
PassengerRph | String | False | No | Which passenger the seat is assigned to. | |
Amenities | String | False | No | The amenities for the seat. | |
BerthPosition | String | False | No | The berth location of the seat. | |
Deck | String | False | No | Which deck the seat is on. | |
FacingForward | String | False | No | Whether the seat is facing forward. | |
FareSpaceComfort | String | False | No | The space around the seat. | |
SeatNumber | String | False | No | The number of the seat. | |
SeatPosition | String | False | No | The location of the seat. | |
SpaceType | String | False | No | The type of space around the seat. | |
Status | String | False | No | The status of the seat booking. | |
WagonNumber | String | False | No | The number of the wagon the seat is on. | |
WagonType | String | False | No | The type of wagon the seat is on. | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the trip. The user must have the Web Services Admin role to use this parameter. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The id of the trip. | |
TripName | String | False | No | The name of the trip. | |
TravelerFirstName | String | False | No | The first name of the traveler. | |
TravelerLastName | String | False | No | The last name of the traveler. | |
Passengers | String | False | No | A comma separated list of passengers. | |
TripStartDate | Date | False | No | The URL-encoded start date (in Coordinated Universal Time, or UTC) for the trip. Format: YYYY-MM-DD. If no query parameters are provided, the start date is set to today?s date - 30 days. The request will only return trips that are ongoing during the provided dates, either starting on the date, or starting before the date and ongoing during the provided date. | |
TripEndDate | Date | False | No | The URL-encoded UTC end date for the trip. Format: YYYY-MM-DD. If no query parameters are provided, the end date is set to today?s date + 12 months. The request will only return trips that are ongoing during the provided dates, either ending on the date, or starting before the date and ongoing during the provided date. | |
ModifiedDate | Date | False | No | The last modified UTC date of the trips and their associated bookings. This query string will return only the trips where the trip or any of its associated bookings have a last modified date that is greater or equal to the supplied time. The provided date/time can be anytime between now and the first date of trip creation in the database. The format is either the date or the date and time combined. | |
TripStatus | String | False | No | The status of the trip. One of the following: Confirmed; Ticketed; Canceled; Proposal; Booked Proposal. | |
LoginId | String | False | UsersV4.UserName | No | The login ID of the user who owns the trip. The user must have the Web Services Admin role to use this parameter. |
IncludeCancelledTrips | Boolean | False | No | Whether or not the canceled trips should be included in the response | |
BookingType | String | False | No | The trip includes at least one booking of this type. | |
IncludeVirtualTrip | Boolean | False | No | Show virtual trips. Virtual trips are segments booked offline through the Travel Request product. | |
CreatedAfterDate | Date | False | Yes | Date for when the trip was created. The query string will return trips created on or after this date. | |
CreatedBeforeDate | Date | False | Yes | Date for when the trip was created. The query string will return trips created on or before this date. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ID [KEY] | String | True | No | The unique identifier of the resource. | |
EmployeeID | String | True | No | The employee ID of the user. | |
LoginId | String | True | UsersV4.UserName | No | The login ID of the user. |
MiddleName | String | True | No | The middle name of the user. | |
Active | Boolean | True | No | Indicates whether the user is currently active or not. | |
CellPhoneNumber | String | True | No | The cell phone number of the user. | |
FirstName | String | True | No | The first name of the user. | |
LastName | String | True | No | The last name of the user. | |
OrganizationUnit | String | True | No | The organization unit of the user. | |
PrimaryEmail | String | True | No | The primary email of the user. | |
URI | String | True | No | The URI to the resource. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | Unique identifier for the user, also known as the UUID. | |
Active | Boolean | False | No | If true, the user is active. | |
UserName | String | False | No | The name that can be used to login to Concur Travel and Expense. | |
DisplayName | String | False | No | The name of the user, suitable for public display. | |
GivenName | String | False | No | The given or first name of the user. | |
MiddleName | String | False | No | The middle name(s) of the user, if applicable. | |
FamilyName | String | False | No | The family or last name of the user. | |
FormattedName | String | False | No | The full name of the user, formatted for display. | |
NickName | String | False | No | The casual way to address the user. | |
AddressesAggregate | String | False | No | JSON aggregate of a physical mailing address for this user. | |
DateOfBirth | Date | False | No | The user's date of birth. | |
EmailsAggregate | String | False | No | JSON aggregate of the user's email addresses. | |
EmergencyContactsAggregate | String | False | No | JSON aggregate of emergency contact information for the user. | |
Entitlements | String | False | No | The features enabled for the user. Supported values: Expense, Invoice, Locate, Request, Travel. | |
ExternalId | String | False | No | User identifier from the provisioning client. | |
Created | Datetime | False | No | The datetime the user was created. | |
LastModified | Datetime | False | No | The datetime the user was last modified. | |
PhoneNumbersAggregate | String | False | No | JSON aggregate of the user's phone numbers. | |
Timezone | String | False | No | The user's time zone in the Olson time zone database format. | |
Title | String | False | No | The user's job title in the company. | |
CompanyId | String | False | No | The SAP Concur ID of the company. | |
EmployeeNumber | String | False | No | Client supplied employee number within the company, unique for the company. | |
UserStartDate | Datetime | False | No | The user's start date. | |
UserTerminationDate | Datetime | False | No | The user's termination date. | |
CostCenter | String | False | No | The employee cost center for product. | |
PreferredLanguage | String | False | No | Indicates the user's preferred written or spoken language. | |
PreferenceEndDayViewHour | String | False | No | Preferred hour setting for the end of day. | |
PreferenceFirstDayOfWeek | String | False | No | Preferred first day of the week for the user. | |
PreferenceDateFormat | String | False | No | Preferred date format for the user. | |
PreferenceCurrencySymbolLocation | String | False | No | Preferred currency symbol location for the user. Supported values: BeforeAmount, AfterAmount. | |
PreferenceHourMinuteSeparator | String | False | No | Preferred separator between hour and minute. | |
PreferenceDistance | String | False | No | Preferred distance metric. Supported values: mile, km. | |
PreferenceDefaultCalView | String | False | No | Preferred default calendar view for the user. Supported values: day, week, month. | |
Preference24Hour | String | False | No | Preferred 24 hour format for the user. | |
PreferenceNumberFormat | String | False | No | Preferred number format for the user. | |
PreferenceStartDayViewHour | String | False | No | Preferred start of day for the user, from 1. | |
PreferenceNegativeCurrencyFormat | String | False | No | Preferred negative currency format for the user. | |
PreferenceNegativeNumberFormat | String | False | No | Preferred negative number format for the user. | |
SchemasAggregate | String | False | No |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | True | No | The budget service'ss key for this object. If this field is not supplied, the service will use an existing expense type entry if one exists. | |
Name | String | True | No | The name for this expense type if it maps to an expense type set up in SAP Concur. | |
ExpenseTypeCode | String | False | No | The alphanumeric code that describes an expense type (Example: MEALS, AC_CATER). Any string may be used, but only expense type codes returned by GET /budgetCategory/expenseType will behave properly in the SAP Concur UI. | |
FeatureTypeCode | String | False | No | The type of feature that this expense type applies to: Purchase Request, Payment Request (Invoice), Expense, or Travel Authorization. Supported values: PURCHASE_REQUEST, PAYMENT_REQUEST, EXPENSE, REQUEST | |
SyncGuid | String | False | No |