Get all expense entertainment policies

get

/fscmRestApi/resources/11.13.18.05/expenseEntertainmentPolicies

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : expenseEntertainmentPolicies
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseEntertainmentPolicies-item-response
Type: object
Show Source
  • Title: Nonemployee Attendee Types
    Maximum Length: 1
    Indicates whether attendee type is used to determine expense policy rates. Valid values are Yes and No.
  • Read Only: true
    Maximum Length: 64
    User who created the row.
  • Read Only: true
    Date and time when the row was created.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Currency of an entertainment expense policy when rates are defined in a single currency.
  • Title: Currency
    Maximum Length: 15
    Currency code for an entertainment expense policy when rates are defined in a single currency.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Entertainment expense policy defined for a single currency or for multiple currencies.
  • Title: Rate Currency
    Maximum Length: 30
    Indicates the entertainment expense policy defined for a single currency or for multiple currencies. Values are from the lookup EXM_CURRENCY_OPTION.
  • Title: Description
    Maximum Length: 240
    Description of the entertainment expense policy.
  • Title: Display Warning to User
    Maximum Length: 1
    Indicates whether an entertainment expense policy warning is displayed to the user.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether employee attendee amount is required, optional, or hidden.
  • Title: Attendee Amount
    Maximum Length: 30
    Code that indicates whether employee attendee amount is required, optional, or hidden. Values are from the look up EXM_FIELD_BEHAVIOUR.
  • Title: Display employee attendee information
    Maximum Length: 1
    Indicates whether employee attendee-related fields display during entertainment expense entry. Employee attendee-related fields include Employee Name and Title.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether employee is used as the entertainment policy rate determinant.
  • Title: Employee
    Maximum Length: 1
    Indicates whether employee is used as the entertainment policy rate determinant. Values are from the lookup EXM_YES_NO.
  • Title: Require at least one employee as attendee
    Maximum Length: 1
    Indicates whether user needs to enter at least one employee name as attendee while creating an attendee in expense entry.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether user can create nonemployee employer.
  • Title: Enable Employer Creation
    Maximum Length: 1
    Indicates whether user can create nonemployee employer. Values are from the lookup EXM_YES_NO.
  • Title: Enable rate limit
    Maximum Length: 1
    Indicates whether entertainment expense policy rate limits are enforced.
  • The unique identifier of the entertainment expense policy.
  • Title: Error Tolerance Percentage
    Percentage added to the entertainment expense policy amount limit to obtain the maximum allowable limit for expense report submission.
  • Expense Entertainment Policy Lines
    Title: Expense Entertainment Policy Lines
    The expense entertainment policy lines resource is used to view entertainment expense policy line records.
  • Title: Require attendee amount
    Maximum Length: 1
    Indicates whether the employee is required to enter the amount for individual event attendees.
  • Read Only: true
    Date and time when the row was last updated
  • Read Only: true
    Maximum Length: 64
    User who last updated the row.
  • Read Only: true
    Maximum Length: 32
    Session login of user who last updated the row.
  • Links
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether nonemployee employer address is required, optional, or hidden.
  • Title: Employer Address
    Maximum Length: 30
    Code that indicates whether nonemployee employer address is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether nonemployee attendee amount is required, optional, or hidden.
  • Title: Attendee Amount
    Maximum Length: 30
    Code that indicates whether nonemployee attendee amount is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
  • Title: Display nonemployee attendee information
    Maximum Length: 1
    Indicates whether nonemployee attendee-related fields display during entertainment expense entry. Nonemployee attendee-related fields include Name, Employer, and Address.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether nonemployee attendee type is required, optional, or hidden.
  • Title: Attendee Type
    Maximum Length: 30
    Code that indicates whether nonemployee attendee type is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether the user can create a nonemployee.
  • Title: Enable nonemployee creation
    Maximum Length: 1
    Indicates whether the user can create a nonemployee. Values are from the lookup EXM_YES_NO.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether nonemployee job title is required, optional, or hidden.
  • Title: Job Title
    Maximum Length: 30
    Code that indicates whether nonemployee job title is required, optional, or hidden. Values are from the lookup EXM_FIELD_BEHAVIOUR.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether nonemployee is used as the entertainment policy rate determinant.
  • Title: Nonemployee
    Maximum Length: 1
    Indicates whether nonemployee is used to determine the entertainment policy rate. Values are from the lookup EXM_YES_NO.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether the user is required to enter at least one nonemployee as attendee.
  • Title: Require at least one nonemployee as attendee
    Maximum Length: 1
    Indicates whether the user is required to enter at least one nonemployee as attendee. Values are from the lookup EXM_YES_NO.
  • Amount above which capturing the number of attendees is mandatory.
  • Maximum Length: 15
    Currency code for the amount above which capturing the number of attendees is mandatory.
  • Maximum Length: 1
    Indicates whether capturing the number of attendees is mandatory.
  • Title: Period Start Day
    Start date from which entertainment expense policy annual rate limit is counted. Values are from the lookup DAY.
  • Title: Period Start Month
    Maximum Length: 30
    Starting month from which entertainment expense policy annual rate limit is counted. Values are from the lookup MONTH.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Type of entertainment expense policy enforcement applied.
  • Maximum Length: 30
    Indicates the type of entertainment expense policy enforcement applied. Values are from the lookup ORA_EXM_ENTERT_POL_ENFORCEM.
  • Title: Policy Name
    Maximum Length: 60
    Name of the entertainment expense policy.
  • Title: Policy violation warning
    Maximum Length: 1
    Indicates whether employees are warned when they submit expenses that exceed the defined entertainment expense policy rate limit.
  • Title: Prevent report submission
    Maximum Length: 1
    Indicates whether expense report submission is prevented if an entertainment expense policy violation occurs.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Indicates whether policy rate limit is defined per expense type or per attendee.
  • Title: Enable Rate Limit
    Maximum Length: 30
    Code that indicates whether policy rate limit is defined per expense type or per attendee. Values are from the lookup ORA_EXM_LIMIT_TYPE.
  • Title: Single instance limit
    Maximum Length: 1
    Indicates whether entertainment expense policy limits are enforced by each submitted instance of an entertainment expense item.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of entertainment expense policy. Valid values are Draft, Valid, Invalid, and Active.
  • Title: Status
    Maximum Length: 30
    Indicates the status of entertainment expense policy. Values are from lookup EXM_POLICY_STATUS.
  • Title: Warning Tolerance Percentage
    Percentage added to entertainment expense policy amount limit to obtain the maximum allowable limit for a policy warning violation.
  • Title: Yearly limit
    Maximum Length: 1
    Indicates 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: array
Title: Expense Entertainment Policy Lines
The expense entertainment policy lines resource is used to view entertainment expense policy line records.
Show Source
Nested Schema : expenseEntertainmentPolicies-expenseEntertainmentPolicyLines-item-response
Type: object
Show Source
Back to Top