Get all accommodations expense policy records
get
/fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies
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 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.
- PrimaryKey: Finds an accommodations expense policy record using an accommodations expense policy identifier 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:- 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.
-
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:
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.
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 : expenseAccommodationsPolicies
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:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseAccommodationsPolicies-item-response
Type:
Show Source
object
-
AccommodationsPolicyId: integer
(int64)
Value that uniquely identifies an accommodations expense policy.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the accommodations expense policy. -
CreationDate: string
(date-time)
Read Only:
true
Date the user created the accommodations expense policy. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Currency of the accommodations expense policy when rates are defined for a single currency. -
CurrencyCode: string
Maximum Length:
15
Code that is associated with a currency. -
CurrencyOption: string
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. -
CurrencyOptionCode: string
Maximum Length:
30
Code that is associated with a currency option. -
Description: string
Maximum Length:
240
Description of an accommodations expense policy. -
DispWarningToUserFlag: boolean
Maximum Length:
1
Indicates whether an accommodations expense policy warning is displayed to a user. -
EnabledGenderFlag: boolean
Maximum Length:
1
Indicates whether accommodations expense policy rates vary based on the gender of an employee. -
EnabledLocationFlag: boolean
Maximum Length:
1
Indicates whether accommodations expense policy rates vary by location. -
EnabledRoleFlag: boolean
Maximum Length:
1
Indicates whether accommodation rates vary based on the role of an employee. -
EnabledSeasonRateFlag: boolean
Maximum Length:
1
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.
-
expenseAccommodationsPolicyLines: array
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. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the accommodations expense policy was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date when the user last updated the accommodations expense policy. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
User who last updated the accommodations expense policy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationType: string
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. -
LocationTypeCode: string
Maximum Length:
30
Code that is associated with the location type. -
PolicyEnforcement: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of accommodations expense policy enforcement applied. Values are from lookup EXM_POLICY_ENFORCEMENT. -
PolicyEnforcementCode: string
Maximum Length:
30
Code that is associated with the enforcement of an accommodations expense policy. -
PolicyName: string
Maximum Length:
60
Name of an accommodations expense policy. -
PolicyRole: string
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. -
PolicyRoleCode: string
Maximum Length:
30
Code that is associated with an accommodations expense policy role. -
PolicyViolationFlag: boolean
Maximum Length:
1
Indicates whether employees are warned when they submit expenses that exceed the defined accommodations expense policy rate limit. -
PreventSubmissionFlag: boolean
Maximum Length:
1
Indicates whether an expense report submission is prevented if an accommodations expense policy violation occurs. -
Status: string
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. -
StatusCode: string
Maximum Length:
30
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
Title:
Meaning
Read Only:true
Maximum Length:80
Zone types for an accommodations expense policy. Values are from the lookup EXM_ZONE_TYPE. -
ZoneTypeCode: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseAccommodationsPolicies-expenseAccommodationsPolicyLines-item-response
Type:
Show Source
object
-
AccommodationsPolicyId: integer
(int64)
Value that uniquely identifies an accommodations expense policy for which rates are defined.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the accommodations expense policy rate line. -
CreationDate: string
(date-time)
Read Only:
true
Date the user created the accommodations expense policy rate line. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Description of a currency code. -
CurrencyCode: string
Maximum Length:
15
Code that is associated with a currency of an accommodations expense policy. -
DailyLimit: number
Daily reimbursement limit for accommodations expenses.
-
EndDate: string
(date)
Date at the end of the date range within which the accommodations expense policy line rate is valid.
-
GeographyId: integer
(int64)
Value that uniquely identifies a geography for which an accommodations expense policy line rate is applicable.
-
GeolocName: string
Maximum Length:
240
Geographical location for which an accommodations expense policy line rate is applicable. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the accommodations expense policy rate line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date when the user last updated the accommodations expense policy rate line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
User who last updated the accommodations expense policy rate line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PolicyLineId: integer
(int64)
Value that uniquely identifies an accommodations expense policy rate line.
-
RawCity: string
Maximum Length:
80
City where the accommodations expense policy line rate is applicable. -
RawCountry: string
Maximum Length:
80
Country where the accommodations expense policy line rate is applicable. -
RawCounty: string
Maximum Length:
80
County where the accommodations expense policy line rate is applicable. -
RawState: string
Maximum Length:
80
State where the accommodations expense policy line rate is applicable. -
RoleId: integer
(int64)
Value that uniquely identifies a role for which an accommodations expense policy line rate is applicable.
-
RoleName: string
Maximum Length:
80
Name of the role for which this accommodations expense policy line rate is applicable, such as Director or Engineer. -
SeasonEndDay: integer
(int32)
Last day of the season.
-
SeasonEndMonth: integer
(int32)
Last month of the season.
-
SeasonStartDay: integer
(int32)
First day of the season.
-
SeasonStartMonth: integer
(int32)
The start month of the season.
-
StartDate: string
(date)
Date at the beginning of the date range within which the accommodations expense policy line rate is valid.
-
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description that is associated with the status of an accommodations expense policy rate line. -
StatusCode: string
Maximum Length:
30
Code that is associated with the status of an accommodations expense policy rate line, such as Valid, Active, or Invalid. Values are from the lookup EXM_POLICY_STATUS. -
TypeOfRateCode: string
Maximum Length:
30
Code that is associated with a type of rate line, such as a base accommodations expense policy rate. -
Zone: string
Read Only:
true
Maximum Length:255
Description associated with a zone code. -
ZoneCode: string
Maximum Length:
30
Zone code for which this accommodations expense policy line rate is applicable, such as Geographical Location or Zone.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.
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" } ] }