Get a single expense mileage policy record for a given mileage policy identifier
get
/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/{MileagePolicyId}
Request
Path Parameters
-
MileagePolicyId(required): integer(int64)
Meals policy identifier.
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 : expenseMileagePolicies-item-response
Type:
Show Source
object
-
AdditionalRatesListCode: string
Maximum Length:
30
Lookup representing the additional rate types applicable for this mileage policy. Valid values are from the lookup EXM_ADDITIONAL_RATES. -
ApplyThresholdBy: string
Title:
Meaning
Read Only:true
Maximum Length:80
Date when a threshold is applied to a trip distance to determine mileage rates, such as By trip or By cumulative mileage. Valid values are from the lookup EXM_THRESHOLD_PERIOD. -
ApplyThresholdByCode: string
Maximum Length:
30
Code that is associated with a threshold date that is applied to a trip distance to determine mileage rates. -
CalculationPassRateByDistFlag: boolean
Maximum Length:
1
Indicates whether passenger rate must be calculated by the distance traveled by each passenger. -
CapturePassNamesFlag: boolean
Maximum Length:
1
Indicates whether passenger names must be captured in expense report. -
CommuteDistanceRequiredFlag: boolean
Maximum Length:
1
Indicates whether the commute distance is required. -
Country: string
Title:
Territory Name
Read Only:true
Maximum Length:80
Country where a mileage expense policy is applicable. -
CountryCode: string
Maximum Length:
30
Code associated with a country. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the mileage policy record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the mileage policy record was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Currency of the mileage expense policy when rates are defined in 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. -
Description: string
Maximum Length:
240
Description for this expense policy of mileage category. -
DisplayAllUnitsFlag: boolean
Maximum Length:
1
Indicates whether expense entry preparers can select any unit of measure in an expense report for a mileage expense associated with this expense policy. -
DistanceThresholdFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary by distance threshold. -
EligibilityDistance: number
Minimum trip distance to be eligible for mileage reimbursement.
-
EnabledAdditnlRatesFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary by additional rate types. -
EnabledDeductCommuteFlag: boolean
Maximum Length:
1
Indicates whether the user can deduct the commute distance. -
EnabledEligibilityFlag: boolean
Maximum Length:
1
Indicates whether there is a minimum distance requirement for mileage eligibility. -
EnabledFuelTypeFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary by fuel type. -
EnabledGenderFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary based on the gender of an employee. -
EnabledLocationFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary by location. -
EnabledMaximumPassFlag: boolean
Maximum Length:
1
Indicates whether a limit exists for number of passengers eligible to be included in mileage reimbursement calculation. -
EnabledPassengerFlag: boolean
Maximum Length:
1
Indicates whether passenger rates are applicable for this policy. -
EnabledRoleFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary based on the role of an employee. -
EnabledStandardDeductionFlag: boolean
Maximum Length:
1
Indicates whether standard mileage deduction is applicable for this policy. -
EnabledVehCategoryFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary by vehicle category. -
EnabledVehTypeFlag: boolean
Maximum Length:
1
Indicates whether mileage rates vary by vehicle type. -
expenseMileagePolicyLines: array
Expense Mileage Policy Lines
Title:
Expense Mileage Policy Lines
The expense mileage policy lines resource is used to get all records related to mileage policy lines. -
FuelTypeListCode: string
Maximum Length:
30
Code that is associated with the fuel type list. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the expense mileage policy record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the mileage policy record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login of the user who last updated the mileage policy record. -
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 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 a location type. -
MaximumPassengers: integer
(int32)
Maximum number of passengers eligible for inclusion in mileage reimbursement calculation.
-
MileageDeduction: number
Distance that must be subtracted from the total distance traveled before mileage calculation.
-
MileagePolicyId: integer
(int64)
Meals policy identifier.
-
PassengerRule: string
Title:
Meaning
Read Only:true
Maximum Length:80
Passenger rate type, such as Single, Range, or Specific. Valid values are from the lookup EXM_PASSENGER_RULE. -
PassengerRuleCode: string
Maximum Length:
30
Code that is associated with a passenger rule. -
PolicyName: string
Maximum Length:
60
Name of this expense policy of mileage category. -
PolicyRole: string
Title:
Meaning
Read Only:true
Maximum Length:80
Role type that determines the policy rate, such as Job, Grade, and Position. Values are from the lookup EXM_POLICY_ROLE. -
PolicyRoleCode: string
Maximum Length:
30
Code that is associated with a mileage expense policy role. -
StandardDeductionCode: string
Maximum Length:
30
Indicates which type of standard mileage deduction is applicable. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the mileage 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 a mileage expense policy status, such as Draft or Active. Valid values are from the lookup EXM_POLICY_STATUS. -
UnitOfMeasure: string
Title:
Meaning
Read Only:true
Maximum Length:80
Unit in which distance is measured for mileage calculation. Values are from the lookup EXM_UNIT_OF_MEASURE. -
UnitOfMeasureCode: string
Maximum Length:
30
Code that is associated with a unit of measure. -
VehicleCategoryListCode: string
Maximum Length:
30
Code that is associated with a vehicle category list. -
VehicleTypeListCode: string
Maximum Length:
30
Code that is associated with a vehicle type list. -
ZoneType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of zone for a mileage expense policy. Valid values are from the lookup EXM_ZONE_TYPE. -
ZoneTypeCode: string
Maximum Length:
30
Code that is associated with a zone type.
Nested Schema : Expense Mileage Policy Lines
Type:
array
Title:
Expense Mileage Policy Lines
The expense mileage policy lines resource is used to get all records related to mileage policy lines.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseMileagePolicies-expenseMileagePolicyLines-item-response
Type:
Show Source
object
-
AdditionalRate: string
Read Only:
true
Additional rate code for which a rate is applicable. Valid values are from the lookup defined in the mileage expense policy. -
AdditionalRateCode: string
Maximum Length:
30
Code that is associated with an additional mileage rate. -
CalculationMethod: string
Title:
Meaning
Read Only:true
Maximum Length:80
Calculation method for deriving a passenger rate or an additional rate. Valid values are from the lookup EXM_CALCULATION_METHOD. -
CalculationMethodCode: string
Maximum Length:
30
Code that is associated with a calculation method. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the mileage policy rate line record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the mileage policy record rate line was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Description associated with a currency code. -
CurrencyCode: string
Maximum Length:
15
Code of the currency in which a mileage rate is defined. -
DistanceThreshold: number
Highest threshold value in the distance range for which this rate is applicable. For example, for a distance range of 0 - 4000 miles, the value 4000 is stored.
-
EndDate: string
(date)
Date from which the rate is no longer applicable.
-
FuelType: string
Read Only:
true
Type of fuel for which a mileage rate is applicable. Valid values are from the lookup defined in the mileage expense policy. -
FuelTypeCode: string
Maximum Length:
30
Code that is associated with a type of fuel. -
GeographyId: integer
(int64)
Geography for which this rate is applicable.
-
GeolocName: string
Maximum Length:
240
Geographical location for which this rate is applicable. -
InvalidCode: string
Maximum Length:
30
Code that is associated with an invalid attribute. -
InvalidDescription: string
Title:
Meaning
Read Only:true
Maximum Length:80
Reason a rate line failed validation. Valid values are from the lookup EXM_POLICY_INVALID_CODE. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the expense mileage policy rate line record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the mileage policy rate line record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login of the user who last updated the mileage policy rate line record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MileagePolicyId: integer
(int64)
Policy identifier for which rates are defined.
-
PassengerThreshold: integer
(int32)
Indicates number of passengers when rates by number range of passengers is selected.
-
PolicyLineId: integer
(int64)
Mileage policy rate line identifier.
-
Rate: number
Reimbursable amount for mileage, passenger, or additional rate that is determined by specific criteria.
-
RawCity: string
Maximum Length:
80
City of the location for which the rate is applicable. -
RawCountry: string
Maximum Length:
80
Country of the location for which the rate is applicable. -
RawCounty: string
Maximum Length:
80
County of the location for which the rate is applicable. -
RawState: string
Maximum Length:
80
State of the location for which the rate is applicable. -
RoleId: integer
(int64)
Role for which this rate is applicable.
-
RoleName: string
Maximum Length:
80
Role name for which this rate is applicable, such as Director or Engineer. -
StartDate: string
(date)
Date from which the rate is applicable.
-
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of a rate line, such as Valid, Active, and Invalid. Valid values are from the lookup EXM_POLICY_STATUS. -
StatusCode: string
Maximum Length:
30
Code that is associated with the status of a rate line. -
VehicleCategory: string
Read Only:
true
Category of a vehicle for which a rate is applicable. Valid values are from the lookup defined in the mileage expense policy. -
VehicleCategoryCode: string
Maximum Length:
30
Code that is associated with a vehicle category. -
VehicleType: string
Read Only:
true
Type of vehicle for which a rate is applicable. Valid values are from the lookup defined in the expense policy. -
VehicleTypeCode: string
Maximum Length:
30
Code that is associated with a type of vehicle. -
Zone: string
Read Only:
true
Zone for which a rate is applicable, such as Geographical Location or Zone. -
ZoneCode: string
Maximum Length:
30
Code associated with a 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
- expenseMileagePolicyLines
-
Parameters:
- MileagePolicyId:
$request.path.MileagePolicyId
The expense mileage policy lines resource is used to get all records related to mileage policy lines. - MileagePolicyId:
Examples
The following example shows how to retrieve an expense mileage 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/expenseMileagePolicies/300100031584792
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AdditionalRatesListCode": null, "ApplyThresholdByCode": null, "ApplyThresholdBy": null, "CalculationPassRateByDistFlag": false, "CapturePassNamesFlag": false, "CommuteDistanceRequiredFlag": null, "CountryCode": null, "Country": null, "CreatedBy": "EXPENSE_MANAGER", "CreationDate": "2013-12-19T16:08:44.752+00:00", "CurrencyCode": "JPY", "Currency": "Japanese yen", "CurrencyOptionCode": "SINGLE", "CurrencyOption": "Single currency", "Description": "MP5: Single Currency other than functional", "DisplayAllUnitsFlag": false, "DistanceThresholdFlag": false, "EligibilityDistance": null, "EnabledAdditnlRatesFlag": false, "EnabledDeductCommuteFlag": null, "EnabledEligibilityFlag": false, "EnabledFuelTypeFlag": false, "EnabledGenderFlag": false, "EnabledLocationFlag": false, "EnabledMaximumPassFlag": null, "EnabledPassengerFlag": false, "EnabledRoleFlag": false, "EnabledStandardDeductionFlag": false, "EnabledVehCategoryFlag": false, "EnabledVehTypeFlag": false, "FuelTypeListCode": null, "LastUpdateDate": "2013-12-19T16:10:48.195+00:00", "LastUpdateLogin": "EDECAC6A2DB33DAAE0432620F00AE079", "LastUpdatedBy": "EXPENSE_MANAGER", "LocationTypeCode": null, "LocationType": null, "MaximumPassengers": null, "MileageDeduction": null, "MileagePolicyId": 300100031584792, "PassengerRuleCode": null, "PassengerRule": null, "PolicyName": "MP5: Single Currency JPY", "PolicyRoleCode": null, "PolicyRole": null, "StatusCode": "ACTIVE", "Status": "Active", "StandardDeductionCode": null, "UnitOfMeasureCode": "KILOMETER", "UnitOfMeasure": "Kilometer", "VehicleCategoryListCode": null, "VehicleTypeListCode": null, "ZoneTypeCode": null, "ZoneType": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792", "name": "expenseMileagePolicies", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792", "name": "expenseMileagePolicies", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792/child/expenseMileagePolicyLines", "name": "expenseMileagePolicyLines", "kind": "collection" } ] }