Get all expense entertainment policies
get
/fscmRestApi/resources/11.13.18.05/expenseEntertainmentPolicies
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the expense entertainment policy record that matches the primary key criteria specified.
Finder Variables- EntertainmentPolicyId; integer; The unique identifier of the expense entertainment policy record.
- PrimaryKey Finds the expense entertainment policy record that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AttendeeTypesFlag; boolean; Indicates whether attendee type is used to determine expense policy rates. Valid values are Yes and No.
- CreatedBy; string; User who created the row.
- CreationDate; string; Date and time when the row was created.
- Currency; string; Currency of an entertainment expense policy when rates are defined in a single currency.
- CurrencyCode; string; Currency code for an entertainment expense policy when rates are defined in a single currency.
- CurrencyOption; string; Entertainment expense policy defined for a single currency or for multiple currencies.
- CurrencyOptionCode; string; Indicates the entertainment expense policy defined for a single currency or for multiple currencies. Values are from the lookup EXM_CURRENCY_OPTION.
- Description; string; Description of the entertainment expense policy.
- DispWarningToUserFlag; boolean; Indicates whether an entertainment expense policy warning is displayed to the user.
- EmployeeAttendeeAmount; string; Indicates whether employee attendee amount is required, optional, or hidden.
- EmployeeAttendeeAmountCode; string; Code that indicates whether employee attendee amount is required, optional, or hidden. Values are from the look up EXM_FIELD_BEHAVIOUR.
- EmployeeAttendeeInformationFlag; boolean; Indicates whether employee attendee-related fields display during entertainment expense entry. Employee attendee-related fields include Employee Name and Title.
- EmployeeRateDeterminant; string; Indicates whether employee is used as the entertainment policy rate determinant.
- EmployeeRateDeterminantFlag; boolean; Indicates whether employee is used as the entertainment policy rate determinant. Values are from the lookup EXM_YES_NO.
- EmployeeRequiredAsAttendeeFlag; boolean; Indicates whether user needs to enter at least one employee name as attendee while creating an attendee in expense entry.
- EmployerCreation; string; Indicates whether user can create nonemployee employer.
- EmployerCreationFlag; boolean; Indicates whether user can create nonemployee employer. Values are from the lookup EXM_YES_NO.
- EnabledRateLimitFlag; boolean; Indicates whether entertainment expense policy rate limits are enforced.
- EntertainmentPolicyId; integer; The unique identifier of the entertainment expense policy.
- ErrorTolerance; number; Percentage added to the entertainment expense policy amount limit to obtain the maximum allowable limit for expense report submission.
- IndividAttendeeAmountFlag; boolean; Indicates whether the employee is required to enter the amount for individual event attendees.
- LastUpdateDate; string; Date and time when the row was last updated
- LastUpdateLogin; string; Session login of user who last updated the row.
- LastUpdatedBy; string; User who last updated the row.
- NonEmployeeAttendeeAddrs; string; Indicates whether nonemployee employer address is required, optional, or hidden.
- NonEmployeeAttendeeAddrsCode; string; Code that indicates whether nonemployee employer address is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
- NonEmployeeAttendeeAmount; string; Indicates whether nonemployee attendee amount is required, optional, or hidden.
- NonEmployeeAttendeeAmountCode; string; Code that indicates whether nonemployee attendee amount is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
- NonEmployeeAttendeeInformationFlag; boolean; Indicates whether nonemployee attendee-related fields display during entertainment expense entry. Nonemployee attendee-related fields include Name, Employer, and Address.
- NonEmployeeAttendeeType; string; Indicates whether nonemployee attendee type is required, optional, or hidden.
- NonEmployeeAttendeeTypeCode; string; Code that indicates whether nonemployee attendee type is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
- NonEmployeeCreation; string; Indicates whether the user can create a nonemployee.
- NonEmployeeCreationFlag; boolean; Indicates whether the user can create a nonemployee. Values are from the lookup EXM_YES_NO.
- NonEmployeeJobTitle; string; Indicates whether nonemployee job title is required, optional, or hidden.
- NonEmployeeJobTitleCode; string; Code that indicates whether nonemployee job title is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
- NonEmployeeRateDeterminant; string; Indicates whether nonemployee is used as the entertainment policy rate determinant.
- NonEmployeeRateDeterminantFlag; boolean; Indicates whether nonemployee is used to determine the entertainment policy rate. Values are from the lookup EXM_YES_NO.
- NonEmployeeRequiredAttendee; string; Indicates whether the user is required to enter at least one nonemployee as attendee.
- NonEmployeeRequiredAttendeeFlag; boolean; Indicates whether the user is required to enter at least one nonemployee as attendee. Values are from the lookup EXM_YES_NO.
- NumberOfAttendeesAmount; number; Amount above which capturing the number of attendees is mandatory.
- NumberOfAttendeesCurrencyCode; string; Currency code for the amount above which capturing the number of attendees is mandatory.
- NumberOfAttendeesFlag; boolean; Indicates whether capturing the number of attendees is mandatory.
- PeriodDay; integer; Start date from which entertainment expense policy annual rate limit is counted. Values are from the lookup DAY.
- PeriodMonth; string; Starting month from which entertainment expense policy annual rate limit is counted. Values are from the lookup MONTH.
- PolicyEnforcement; string; Type of entertainment expense policy enforcement applied.
- PolicyEnforcementCode; string; Indicates the type of entertainment expense policy enforcement applied. Values are from the lookup ORA_EXM_ENTERT_POL_ENFORCEM.
- PolicyName; string; Name of the entertainment expense policy.
- PolicyViolationFlag; boolean; Indicates whether employees are warned when they submit expenses that exceed the defined entertainment expense policy rate limit.
- PreventSubmissionFlag; boolean; Indicates whether expense report submission is prevented if an entertainment expense policy violation occurs.
- RateLimitType; string; Indicates whether policy rate limit is defined per expense type or per attendee.
- RateLimitTypeCode; string; Code that indicates whether policy rate limit is defined per expense type or per attendee. Values are from the lookup ORA_EXM_LIMIT_TYPE.
- SingleInstanceLimitFlag; boolean; Indicates whether entertainment expense policy limits are enforced by each submitted instance of an entertainment expense item.
- Status; string; Status of entertainment expense policy. Valid values are Draft, Valid, Invalid, and Active.
- StatusCode; string; Indicates the status of entertainment expense policy. Values are from lookup EXM_POLICY_STATUS.
- WarningTolerance; number; Percentage added to entertainment expense policy amount limit to obtain the maximum allowable limit for a policy warning violation.
- YearlyLimitFlag; boolean; Indicates whether entertainment expense policy limits are enforced by maximum permitted annual amount. Valid values are Yes and No.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : expenseEntertainmentPolicies
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : expenseEntertainmentPolicies-item-response
Type:
Show Source
object-
AttendeeTypesFlag: boolean
Title:
Nonemployee Attendee TypesMaximum Length:1Indicates whether attendee type is used to determine expense policy rates. Valid values are Yes and No. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
Currency: string
Title:
DescriptionRead Only:trueMaximum Length:240Currency of an entertainment expense policy when rates are defined in a single currency. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Currency code for an entertainment expense policy when rates are defined in a single currency. -
CurrencyOption: string
Title:
MeaningRead Only:trueMaximum Length:80Entertainment expense policy defined for a single currency or for multiple currencies. -
CurrencyOptionCode: string
Title:
Rate CurrencyMaximum Length:30Indicates the entertainment expense policy defined for a single currency or for multiple currencies. Values are from the lookup EXM_CURRENCY_OPTION. -
Description: string
Title:
DescriptionMaximum Length:240Description of the entertainment expense policy. -
DispWarningToUserFlag: boolean
Title:
Display Warning to UserMaximum Length:1Indicates whether an entertainment expense policy warning is displayed to the user. -
EmployeeAttendeeAmount: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether employee attendee amount is required, optional, or hidden. -
EmployeeAttendeeAmountCode: string
Title:
Attendee AmountMaximum Length:30Code that indicates whether employee attendee amount is required, optional, or hidden. Values are from the look up EXM_FIELD_BEHAVIOUR. -
EmployeeAttendeeInformationFlag: boolean
Title:
Display employee attendee informationMaximum Length:1Indicates whether employee attendee-related fields display during entertainment expense entry. Employee attendee-related fields include Employee Name and Title. -
EmployeeRateDeterminant: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether employee is used as the entertainment policy rate determinant. -
EmployeeRateDeterminantFlag: boolean
Title:
EmployeeMaximum Length:1Indicates whether employee is used as the entertainment policy rate determinant. Values are from the lookup EXM_YES_NO. -
EmployeeRequiredAsAttendeeFlag: boolean
Title:
Require at least one employee as attendeeMaximum Length:1Indicates whether user needs to enter at least one employee name as attendee while creating an attendee in expense entry. -
EmployerCreation: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether user can create nonemployee employer. -
EmployerCreationFlag: boolean
Title:
Enable Employer CreationMaximum Length:1Indicates whether user can create nonemployee employer. Values are from the lookup EXM_YES_NO. -
EnabledRateLimitFlag: boolean
Title:
Enable rate limitMaximum Length:1Indicates whether entertainment expense policy rate limits are enforced. -
EntertainmentPolicyId: integer
(int64)
The unique identifier of the entertainment expense policy.
-
ErrorTolerance: number
Title:
Error Tolerance PercentagePercentage added to the entertainment expense policy amount limit to obtain the maximum allowable limit for expense report submission. -
expenseEntertainmentPolicyLines: array
Expense Entertainment Policy Lines
Title:
Expense Entertainment Policy LinesThe expense entertainment policy lines resource is used to view entertainment expense policy line records. -
IndividAttendeeAmountFlag: boolean
Title:
Require attendee amountMaximum Length:1Indicates whether the employee is required to enter the amount for individual event attendees. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login of user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NonEmployeeAttendeeAddrs: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether nonemployee employer address is required, optional, or hidden. -
NonEmployeeAttendeeAddrsCode: string
Title:
Employer AddressMaximum Length:30Code that indicates whether nonemployee employer address is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR. -
NonEmployeeAttendeeAmount: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether nonemployee attendee amount is required, optional, or hidden. -
NonEmployeeAttendeeAmountCode: string
Title:
Attendee AmountMaximum Length:30Code that indicates whether nonemployee attendee amount is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR. -
NonEmployeeAttendeeInformationFlag: boolean
Title:
Display nonemployee attendee informationMaximum Length:1Indicates whether nonemployee attendee-related fields display during entertainment expense entry. Nonemployee attendee-related fields include Name, Employer, and Address. -
NonEmployeeAttendeeType: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether nonemployee attendee type is required, optional, or hidden. -
NonEmployeeAttendeeTypeCode: string
Title:
Attendee TypeMaximum Length:30Code that indicates whether nonemployee attendee type is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR. -
NonEmployeeCreation: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether the user can create a nonemployee. -
NonEmployeeCreationFlag: boolean
Title:
Enable nonemployee creationMaximum Length:1Indicates whether the user can create a nonemployee. Values are from the lookup EXM_YES_NO. -
NonEmployeeJobTitle: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether nonemployee job title is required, optional, or hidden. -
NonEmployeeJobTitleCode: string
Title:
Job TitleMaximum Length:30Code that indicates whether nonemployee job title is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR. -
NonEmployeeRateDeterminant: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether nonemployee is used as the entertainment policy rate determinant. -
NonEmployeeRateDeterminantFlag: boolean
Title:
NonemployeeMaximum Length:1Indicates whether nonemployee is used to determine the entertainment policy rate. Values are from the lookup EXM_YES_NO. -
NonEmployeeRequiredAttendee: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether the user is required to enter at least one nonemployee as attendee. -
NonEmployeeRequiredAttendeeFlag: boolean
Title:
Require at least one nonemployee as attendeeMaximum Length:1Indicates whether the user is required to enter at least one nonemployee as attendee. Values are from the lookup EXM_YES_NO. -
NumberOfAttendeesAmount: number
Amount above which capturing the number of attendees is mandatory.
-
NumberOfAttendeesCurrencyCode: string
Maximum Length:
15Currency code for the amount above which capturing the number of attendees is mandatory. -
NumberOfAttendeesFlag: boolean
Maximum Length:
1Indicates whether capturing the number of attendees is mandatory. -
PeriodDay: integer
(int32)
Title:
Period Start DayStart date from which entertainment expense policy annual rate limit is counted. Values are from the lookup DAY. -
PeriodMonth: string
Title:
Period Start MonthMaximum Length:30Starting month from which entertainment expense policy annual rate limit is counted. Values are from the lookup MONTH. -
PolicyEnforcement: string
Title:
MeaningRead Only:trueMaximum Length:80Type of entertainment expense policy enforcement applied. -
PolicyEnforcementCode: string
Maximum Length:
30Indicates the type of entertainment expense policy enforcement applied. Values are from the lookup ORA_EXM_ENTERT_POL_ENFORCEM. -
PolicyName: string
Title:
Policy NameMaximum Length:60Name of the entertainment expense policy. -
PolicyViolationFlag: boolean
Title:
Policy violation warningMaximum Length:1Indicates whether employees are warned when they submit expenses that exceed the defined entertainment expense policy rate limit. -
PreventSubmissionFlag: boolean
Title:
Prevent report submissionMaximum Length:1Indicates whether expense report submission is prevented if an entertainment expense policy violation occurs. -
RateLimitType: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether policy rate limit is defined per expense type or per attendee. -
RateLimitTypeCode: string
Title:
Enable Rate LimitMaximum Length:30Code that indicates whether policy rate limit is defined per expense type or per attendee. Values are from the lookup ORA_EXM_LIMIT_TYPE. -
SingleInstanceLimitFlag: boolean
Title:
Single instance limitMaximum Length:1Indicates whether entertainment expense policy limits are enforced by each submitted instance of an entertainment expense item. -
Status: string
Title:
MeaningRead Only:trueMaximum Length:80Status of entertainment expense policy. Valid values are Draft, Valid, Invalid, and Active. -
StatusCode: string
Title:
StatusMaximum Length:30Indicates the status of entertainment expense policy. Values are from lookup EXM_POLICY_STATUS. -
WarningTolerance: number
Title:
Warning Tolerance PercentagePercentage added to entertainment expense policy amount limit to obtain the maximum allowable limit for a policy warning violation. -
YearlyLimitFlag: boolean
Title:
Yearly limitMaximum Length:1Indicates whether entertainment expense policy limits are enforced by maximum permitted annual amount. Valid values are Yes and No.
Nested Schema : Expense Entertainment Policy Lines
Type:
arrayTitle:
Expense Entertainment Policy LinesThe expense entertainment policy lines resource is used to view entertainment expense policy line records.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : expenseEntertainmentPolicies-expenseEntertainmentPolicyLines-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
Currency: string
Title:
DescriptionRead Only:trueMaximum Length:240Currency of an entertainment expense policy line. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Currency code for entertainment expense policies with multiple currencies. -
EndDate: string
(date)
Title:
End DateEnd date of entertainment expense policy line. -
EntertainmentPolicyId: integer
(int64)
The unique identifier of the entertainment expense policy.
-
InvalidCode: string
Maximum Length:
30Indicates why an entertainment expense policy line has the invalid status. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login of user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PolicyLineId: integer
(int64)
The unique identifier of the entertainment expense policy line.
-
SingleInstanceLimit: number
Title:
Single instance limitSingle instance reimbursement limit for entertainment expenses. -
StartDate: string
(date)
Title:
Start DateStart date of the entertainment expense policy line. -
Status: string
Title:
MeaningRead Only:trueMaximum Length:80Status of the entertainment expense policy line. Valid values are draft, valid, and invalid. -
StatusCode: string
Title:
StatusMaximum Length:30Indicates the status of the entertainment expense policy line. Values are from the lookup EXM_POLICY_STATUS. -
TypeOfAttende: string
Title:
MeaningRead Only:trueMaximum Length:80Type of event attendee for this entertainment policy line. -
TypeOfAttendeCode: string
Title:
Nonemployee Attendee TypesMaximum Length:30Indicates the type of event attendee for this entertainment policy line. Values are from the lookup EXM_ATTENDEE_TYPES. -
YearlyLimit: number
Title:
Yearly limitAnnual reimbursement limit for entertainment expenses.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.