Get a single expense meals policy record for a meals policy identifier
get
/fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/{MealsPolicyId}
Request
Path Parameters
-
MealsPolicyId(required): integer(int64)
Value that uniquely identifies a meals expense policy.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : expenseMealsPolicies-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Date when the meals expense policy record was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Currency of a meals expense policy when rates are defined in a single currency. -
CurrencyCode: string
Maximum Length:
15
Code 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 associated with a currency option. -
DailyLimitFlag: boolean
Maximum Length:
1
Indicates whether daily amount limit of meals expenses is enforced. Possible values are Yes or No. -
Description: string
Maximum Length:
240
Description of the meals expense policy. -
DispWarningToUserFlag: boolean
Maximum Length:
1
Indicates whether a meals expense policy warning is displayed to the user. -
EnabledLocationFlag: boolean
Maximum Length:
1
Indicates whether meal rates vary by location. -
EnabledRoleFlag: boolean
Maximum Length:
1
Indicates whether meal rates vary based on the role of an employee. -
ErrorTolerance: number
Percentage that, when added to a meals expense policy amount limit, defines the maximum allowable limit that results in prevention of the expense report submission.
-
expenseMealsPolicyLines: array
Expense Meals Policy Lines
Title:
Expense Meals Policy Lines
The expense meals policy lines resource is used to get all meals expense policy line records. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the meals expense policy row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the meals expense policy row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login that is associated with the user who last updated the meals expense policy row. -
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 meal rates, such as Geographical Location and Zone. Valid values are from the lookup EXM_LOCATION_TYPE. -
LocationTypeCode: string
Maximum Length:
30
Code associated with the location type. -
MealsPolicyId: integer
(int64)
Value that uniquely identifies a meals expense policy.
-
MealsRateSource: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meal rates that are based on local rates or proportional rates. -
MealsRateSourceCode: string
Maximum Length:
30
Code associated with the meals rate source. -
PolicyEnforcement: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of meals expense policy enforcement applied. Values are from lookup EXM_POLICY_ENFORCEMENT. -
PolicyEnforcementCode: string
Maximum Length:
30
Code associated with the enforcement of a meals expense policy. -
PolicyName: string
Maximum Length:
60
Name of the meals expense policy. -
PolicyRole: string
Title:
Meaning
Read Only:true
Maximum Length:80
Role type that determines the policy rate, such as Job, Grade, or Position. Values are from the lookup EXM_POLICY_ROLE. -
PolicyRoleCode: string
Maximum Length:
30
Code associated with a policy role. -
PolicyViolationFlag: boolean
Maximum Length:
1
Indicates whether employees are warned when they submit expenses that exceed the meals expense policy rate limit. -
PreventSubmissionFlag: boolean
Maximum Length:
1
Indicates whether an expense report submission is prevented if a meals expense policy violation occurs. -
RateIncludeMealsFlag: boolean
Maximum Length:
1
Indicates whether the meals allowance defined for the meals expense policy includes meals. -
RateIncludeOtherFlag: boolean
Maximum Length:
1
Indicates whether the meals reimbursement defined for the meals expense policy includes other expenses. -
RatesSourceCode: string
Maximum Length:
30
Code that is associated with a meals expense policy based on rates entered by the user or from rates uploaded from a CONUS or OCONUS file. -
SingleInstanceLimitFlag: boolean
Maximum Length:
1
Indicates whether meals expense policy limits are enforced by each submitted instance of a meals expense item. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the meals expense policy, such as Draft or Active. Valid values are from the lookup EXM_POLICY_STATUS. -
StatusCode: string
Maximum Length:
30
Code that is associated with the status of a meals expense policy. -
WarningTolerance: number
Percentage that, when added to a meals expense policy amount limit, defines the maximum allowable limit that results in a policy warning violation.
-
ZoneType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Applicable zone types for this meals expense policy. Values are from the lookup EXM_ZONE_TYPE. -
ZoneTypeCode: string
Maximum Length:
30
Code associated with a zone type.
Nested Schema : Expense Meals Policy Lines
Type:
array
Title:
Expense Meals Policy Lines
The expense meals policy lines resource is used to get all meals expense policy line records.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseMealsPolicies-expenseMealsPolicyLines-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the meals expense policy rate line. -
CreationDate: string
(date-time)
Read Only:
true
Date when the meals expense policy rate line record was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the currency code. -
CurrencyCode: string
Maximum Length:
15
Code that is associated with a currency for a meals expense policy. -
DailyLimit: number
Daily amount limit of meals expenses. Possible values are Yes or No.
-
EndDate: string
(date)
Date when the meals rate ends.
-
GeographyId: integer
(int64)
Value that uniquely identifies a geography for which a meals rate is applicable.
-
GeolocName: string
Maximum Length:
240
Name of the geographic location for which the meals rate is applicable. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the meals expense policy rate line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the meals expense policy rate line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login that is associated with the user who last updated the meals expense policy rate line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MealsPolicyId: integer
(int64)
Value that uniquely identifies a meals expense policy for which rates are defined.
-
PolicyLineId: integer
(int64)
Value that uniquely identifies a policy rate line.
-
RawCity: string
Maximum Length:
80
City where the meals rate is applicable. -
RawCountry: string
Maximum Length:
80
Country where the meals rate is applicable. -
RawCounty: string
Maximum Length:
80
County where the meals rate is applicable. -
RawState: string
Maximum Length:
80
State where the meals rate is applicable. -
RoleId: integer
(int64)
Value that uniquely identifies a role for which a meals rate is applicable.
-
RoleName: string
Maximum Length:
80
Name of role for which the meals rate is applicable, such as Director or Engineer. -
SingleInstanceLimit: number
A meals expense policy limit that is enforced by each submitted instance of a meals expense item.
-
StartDate: string
(date)
Date when the meals rate starts.
-
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the meals rate, such as Valid, Active, or Invalid. Values are from the lookup EXM_POLICY_STATUS. -
StatusCode: string
Maximum Length:
30
Code that is associated with the status of a meals expense policy line rate. -
TypeOfRateCode: string
Maximum Length:
30
Code associated with a type of rate, such as a base meals rate. -
Zone: string
Read Only:
true
Maximum Length:255
Description of a zone code. -
ZoneCode: string
Maximum Length:
30
Zone code for which a meals 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.
Links
- expenseMealsPolicyLines
-
Parameters:
- MealsPolicyId:
$request.path.MealsPolicyId
The expense meals policy lines resource is used to get all meals expense policy line records. - MealsPolicyId:
Examples
The following example shows how to retrieve an expense meals policy record by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/300100048526158
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "MealsPolicyId": 300100048526158, "PolicyName": "Meals02: Limit Single Daily 100 250", "Description": null, "StatusCode": "ACTIVE", "Status": "Active", "SingleInstanceLimitFlag": true, "DailyLimitFlag": true, "CurrencyOptionCode": "SINGLE", "CurrencyOption": "Single currency", "CurrencyCode": "USD", "Currency": "US Dollar", "EnabledRoleFlag": false, "PolicyRoleCode": null, "PolicyRole": null, "EnabledLocationFlag": false, "LocationTypeCode": null, "LocationType": null, "ZoneTypeCode": null, "ZoneType": null, "PolicyEnforcementCode": "UPPER", "PolicyEnforcement": "Reimburse upper limit when expense exceeds defined rate", "PolicyViolationFlag": false, "WarningTolerance": null, "DispWarningToUserFlag": false, "PreventSubmissionFlag": false, "ErrorTolerance": null, "CreationDate": "2014-08-08T12:51:39.763+00:00", "CreatedBy": "APP_IMPL_CONSULTANT", "LastUpdateDate": "2014-08-08T12:52:54.657+00:00", "LastUpdatedBy": "APP_IMPL_CONSULTANT", "LastUpdateLogin": "0020BEB2BFF9429CE0535160F00A4433", "RatesSourceCode": null, "RateIncludeMealsFlag": false, "RateIncludeOtherFlag": false, "MealsRateSourceCode": null, "MealsRateSource": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/300100048526158", "name": "expenseMealsPolicies", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/300100048526158", "name": "expenseMealsPolicies", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/300100048526158/child/expenseMealsPolicyLines", "name": "expenseMealsPolicyLines", "kind": "collection" } ] }