1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Expense Accommodations Polices

Get all accommodations expense policy records

get

/fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies

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 an accommodations expense policy record using an accommodations expense policy identifier that matches the primary key criteria specified.
      Finder Variables:
      • AccommodationsPolicyId; integer; Identifier of an accommodations expense policy for an accommodations expense 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:
    • AccommodationsPolicyId; integer; Value that uniquely identifies an accommodations expense policy.
    • CreatedBy; string; User who created the accommodations expense policy.
    • CreationDate; string; Date the user created the accommodations expense policy.
    • Currency; string; Currency of the accommodations expense policy when rates are defined for a single currency.
    • CurrencyCode; string; Code that is associated with a currency.
    • CurrencyOption; string; Currency option selected for the rate definition, such as single or multiple currency. Valid values are from the lookup EXM_CURRENCY_OPTION.
    • CurrencyOptionCode; string; Code that is associated with a currency option.
    • Description; string; Description of an accommodations expense policy.
    • DispWarningToUserFlag; boolean; Indicates whether an accommodations expense policy warning is displayed to a user.
    • EnabledGenderFlag; boolean; Indicates whether accommodations expense policy rates vary based on the gender of an employee.
    • EnabledLocationFlag; boolean; Indicates whether accommodations expense policy rates vary by location.
    • EnabledRoleFlag; boolean; Indicates whether accommodation rates vary based on the role of an employee.
    • EnabledSeasonRateFlag; boolean; Indicates whether an accommodations expense policy rate will be defined by different seasonal periods.
    • ErrorTolerance; number; Percentage that, when added to the accommodations expense policy amount limit, defines the maximum allowable limit, which prevents the expense report submission.
    • LastUpdateDate; string; Date and time when the accommodations expense policy was last updated.
    • LastUpdateLogin; string; User who last updated the accommodations expense policy.
    • LastUpdatedBy; string; Date when the user last updated the accommodations expense policy.
    • LocationType; string; Type of location that determines accommodations expense policy rates, such as Geographical Location and Zone. Valid values are from the lookup EXM_LOCATION_TYPE.
    • LocationTypeCode; string; Code that is associated with the location type.
    • PolicyEnforcement; string; Type of accommodations expense policy enforcement applied. Values are from lookup EXM_POLICY_ENFORCEMENT.
    • PolicyEnforcementCode; string; Code that is associated with the enforcement of an accommodations expense policy.
    • PolicyName; string; Name of an accommodations expense policy.
    • PolicyRole; string; Role type that determines the accommodations expense policy rate, such as Job, Grade, or Position. Values are from the lookup EXM_POLICY_ROLE.
    • PolicyRoleCode; string; Code that is associated with an accommodations expense policy role.
    • PolicyViolationFlag; boolean; Indicates whether employees are warned when they submit expenses that exceed the defined accommodations expense policy rate limit.
    • PreventSubmissionFlag; boolean; Indicates whether an expense report submission is prevented if an accommodations expense policy violation occurs.
    • Status; string; Status of an accommodations expense policy, such as Draft or Active. Valid values are from the lookup EXM_POLICY_STATUS.
    • StatusCode; string; Code associated with the status of an accommodations expense policy.
    • WarningTolerance; number; Percentage that, when added to an accommodations expense policy amount limit, defines the maximum allowable limit, resulting in a policy warning violation.
    • ZoneType; string; Zone types for an accommodations expense policy. Values are from the lookup EXM_ZONE_TYPE.
    • ZoneTypeCode; string; Code associated with the zone type.
  • 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 : expenseAccommodationsPolicies
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseAccommodationsPolicies-item-response
Type: object
Show Source
  • Value that uniquely identifies an accommodations expense policy.
  • Read Only: true
    Maximum Length: 64
    User who created the accommodations expense policy.
  • Read Only: true
    Date the user created the accommodations expense policy.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Currency of the accommodations expense policy when rates are defined for a single currency.
  • Maximum Length: 15
    Code that is associated with a currency.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Currency option selected for the rate definition, such as single or multiple currency. Valid values are from the lookup EXM_CURRENCY_OPTION.
  • Maximum Length: 30
    Code that is associated with a currency option.
  • Maximum Length: 240
    Description of an accommodations expense policy.
  • Maximum Length: 1
    Indicates whether an accommodations expense policy warning is displayed to a user.
  • Maximum Length: 1
    Indicates whether accommodations expense policy rates vary based on the gender of an employee.
  • Maximum Length: 1
    Indicates whether accommodations expense policy rates vary by location.
  • Maximum Length: 1
    Indicates whether accommodation rates vary based on the role of an employee.
  • Maximum Length: 1
    Indicates whether an accommodations expense policy rate will be defined by different seasonal periods.
  • Percentage that, when added to the accommodations expense policy amount limit, defines the maximum allowable limit, which prevents the expense report submission.
  • Expense Accommodations Policy Lines
    Title: Expense Accommodations Policy Lines
    The expense accommodations policy lines resource is used to contain details of an accommodations expense policy.
  • Read Only: true
    Date and time when the accommodations expense policy was last updated.
  • Read Only: true
    Maximum Length: 64
    Date when the user last updated the accommodations expense policy.
  • Read Only: true
    Maximum Length: 32
    User who last updated the accommodations expense policy.
  • Links
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Type of location that determines accommodations expense policy rates, such as Geographical Location and Zone. Valid values are from the lookup EXM_LOCATION_TYPE.
  • Maximum Length: 30
    Code that is associated with the location type.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Type of accommodations expense policy enforcement applied. Values are from lookup EXM_POLICY_ENFORCEMENT.
  • Maximum Length: 30
    Code that is associated with the enforcement of an accommodations expense policy.
  • Maximum Length: 60
    Name of an accommodations expense policy.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Role type that determines the accommodations expense policy rate, such as Job, Grade, or Position. Values are from the lookup EXM_POLICY_ROLE.
  • Maximum Length: 30
    Code that is associated with an accommodations expense policy role.
  • Maximum Length: 1
    Indicates whether employees are warned when they submit expenses that exceed the defined accommodations expense policy rate limit.
  • Maximum Length: 1
    Indicates whether an expense report submission is prevented if an accommodations expense policy violation occurs.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of an accommodations expense policy, such as Draft or Active. Valid values are from the lookup EXM_POLICY_STATUS.
  • Maximum Length: 30
    Code associated with the status of an accommodations expense policy.
  • Percentage that, when added to an accommodations expense policy amount limit, defines the maximum allowable limit, resulting in a policy warning violation.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Zone types for an accommodations expense policy. Values are from the lookup EXM_ZONE_TYPE.
  • Maximum Length: 30
    Code associated with the zone type.
Nested Schema : Expense Accommodations Policy Lines
Type: array
Title: Expense Accommodations Policy Lines
The expense accommodations policy lines resource is used to contain details of an accommodations expense policy.
Show Source
Nested Schema : expenseAccommodationsPolicies-expenseAccommodationsPolicyLines-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the accommodations expense policy records by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "items" : [ {
    "AccommodationsPolicyId" : 300100036631004,
    "PolicyName" : "AP02: PV + Grade",
    "Description" : null,
    "StatusCode" : "ACTIVE",
    "Status" : "Active",
    "CurrencyOptionCode" : "SINGLE",
    "CurrencyOption" : "Single currency",
    "CurrencyCode" : "USD",
    "Currency" : "US Dollar",
    "EnabledSeasonRateFlag" : false,
    "EnabledRoleFlag" : true,
    "PolicyRoleCode" : "GRADE",
    "PolicyRole" : "Grade",
    "EnabledLocationFlag" : false,
    "LocationTypeCode" : null,
    "LocationType" : null,
    "ZoneTypeCode" : null,
    "ZoneType" : null,
    "PolicyEnforcementCode" : "VIOLATION",
    "PolicyEnforcement" : "Generate policy violation when expense exceeds defined rate",
    "PolicyViolationFlag" : true,
    "WarningTolerance" : 10,
    "DispWarningToUserFlag" : true,
    "PreventSubmissionFlag" : false,
    "ErrorTolerance" : null,
    "CreationDate" : "2014-07-29T17:20:11.252+00:00",
    "CreatedBy" : "EXPENSE_MANAGER",
    "LastUpdateDate" : "2014-07-29T17:22:24.040+00:00",
    "LastUpdatedBy" : "EXPENSE_MANAGER",
    "LastUpdateLogin" : "FF39C987C87C71F0E0435060F00A079D",
    "EnabledGenderFlag" : false,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies/300100036631004",
      "name" : "expenseAccommodationsPolicies",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies/300100036631004",
      "name" : "expenseAccommodationsPolicies",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies/300100036631004/child/expenseAccommodationsPolicyLines",
      "name" : "expenseAccommodationsPolicyLines",
      "kind" : "collection"
    } ]
  }, 
  ...
  ],
  "count" : 10,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies",
    "name" : "expenseAccommodationsPolicies",
    "kind" : "collection"
  } ]
}
Back to Top