Get an expense per diem policy line
get
/fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies/{PerDiemPolicyId}/child/expensePerDiemPolLines/{PolicyLineId}
Request
Path Parameters
-
PerDiemPolicyId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
PolicyLineId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : expensePerDiemPolicies-expensePerDiemPolLines-item-response
Type:
Show Source
object
-
AccommodationDeduction: number
Title:
Accommodations Deduction
Accommodations deduction entered in spreadsheet based on per diem determinants. -
AccommodationType: string
Read Only:
true
Maximum Length:255
Type of accommodation, such as Hotel, No Receipts, Private, Private No Cooking, or Private Cooking. -
AccommodationTypeCode: string
Title:
Accommodation Type
Maximum Length:30
Code That indicates the type of accommodation. Values are from the lookup ORA_EXM_PD_ACCOM_TYPE. -
AccomNightRate: number
Title:
Accommodations Rate
Accommodations allowance rate that's applicable to each night. -
BaseRate: number
Title:
Standard Daily Rate
Rate entered in the rates spreadsheet based on per diem determinants. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the row was created. -
Currency: string
Read Only:
true
Maximum Length:255
Name of the currency code of a rate. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code of a rate. -
EndDate: string
(date)
Title:
End Date
Date after which this policy rate is no longer applicable. -
FirstDayRate: number
Title:
First Day Rate
First day rate entered in the rates spreadsheet based on per diem determinants. -
GeographyId: integer
(int64)
Unique identifier of the geographical location for which the rate is applicable.
-
GeoLocName: string
Title:
Geographical Location
Maximum Length:240
Geographical location for which the rate is applicable. -
HolidayRate: number
Title:
Holiday
Holidays rate entered in spreadsheet based on per diem determinants. -
Invalid: string
Read Only:
true
Maximum Length:255
Indicates the reason for failed validation of the rate record entered in the rates spreadsheet. -
InvalidCode: string
Maximum Length:
30
Code that indicates the reason for failed validation of the rate record entered in the rates spreadsheet. Values are from the lookup EXM_POLICY_INVALID_CODE. -
LastDayRate: number
Title:
Last Day Rate
Last day rate entered in the rates spreadsheet based on per diem determinants. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated with the user who last updated the row. -
LineHours: integer
Title:
Hours
Time threshold hours of a per diem rate. -
LineMinutes: integer
Title:
Minutes
Time threshold minutes of a per diem rate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LowerLineHours: integer
(int32)
Lower end of the time threshold hours of a per diem rate.
-
LowerLineMinutes: integer
(int32)
Lower end of the time threshold minutes of a per diem rate.
-
LowerRoleThreshold: integer
(int32)
Low end of the salary threshold range.
-
LowerTripExceedDays: number
Value that indicates the previous lower end of a range for long term travel duration.
-
MealsBreakfastDeduction: number
Title:
Breakfast Deduction
Deduction for free breakfast entered in spreadsheet based on per diem determinants. -
MealsBreakfastRate: number
Title:
Breakfast Rate
Breakfast meal allowance when a breakfast expense is eligible for per diem reimbursement. -
MealsDailyDeduction: number
Title:
Daily Deduction
Daily free meals deduction entered in spreadsheet based on per diem determinants. -
MealsDinnerDeduction: number
Title:
Dinner Deduction
Deduction for free dinner entered in spreadsheet based on per diem determinants. -
MealsDinnerRate: number
Title:
Dinner Rate
Dinner meal allowance when a dinner expense is eligible for per diem reimbursement. -
MealsLunchDeduction: number
Title:
Lunch Deduction
Deduction for free lunch entered in spreadsheet based on per diem determinants. -
MealsLunchRate: number
Title:
Lunch Rate
Lunch meal allowance when a lunch expense is eligible for per diem reimbursement. -
MealsOneMealDeduction: number
Title:
One Ineligible Meal Deduction
Single free meals deduction entered in spreadsheet based on per diem determinants. -
MealsOneMealRate: number
Title:
Rate for One Meal
Meal allowance when one meal expense is incurred in a day on a trip. -
MealsThreeMealsDeduction: number
Title:
Three Ineligible Meals Deduction
Deduction for three free meals entered in spreadsheet based on per diem determinants. -
MealsThreeMealsRate: number
Title:
Rate for Three Meals
Meal allowance when three meals are incurred in a day on a trip. -
MealsTwoMealsDeduction: number
Title:
Two Ineligible Meals Deduction
Deduction for two free meals entered in spreadsheet based on per diem determinants. -
MealsTwoMealsRate: number
Title:
Rate for Two Meals
Meal allowance when two meals are incurred in a day on a trip. -
ObjectVersionNumber: integer
(int32)
Number used to implement optimistic locking for an expense miscellaneous policy line. The number increments every time the row is updated. The value of the object version number at the start and end of a transaction are compared to detect whether another session has updated the row since it was queried.
-
OthersFirstDayRate: number
Title:
First Day Rate
First day incidentals rate entered in spreadsheet based on per diem determinants. -
OthersLastDayRate: number
Title:
Last Day Rate
Last day incidentals rate entered in spreadsheet based on per diem determinants. -
OthersStandardRate: number
Title:
Incidentals Rate
Daily incidentals rate entered in spreadsheet based on per diem determinants. -
PerDiemPolicyId: integer
(int64)
Unique identifier of the per diem policy of this line.
-
PolicyLineId: integer
(int64)
Unique identifier of a per diem policy line.
-
RawCity: string
Title:
City
Maximum Length:80
City for which the rate is applicable. -
RawCountry: string
Title:
Country
Maximum Length:80
Country for which the rate is applicable. -
RawCounty: string
Title:
County
Maximum Length:80
County for which the rate is applicable. -
RawState: string
Title:
State
Maximum Length:80
State for which the rate is applicable. -
RoleThreshold: integer
(int32)
Title:
Role
Role threshold determinant of a per diem rate, such as Job Management Level or Salary Threshold value. -
RoleThresholdCode: string
Title:
Role
Maximum Length:30
Code that indicates the role threshold determinant of a per diem rate such as job management level or salary threshold value. -
SeasonEndDay: integer
(int32)
Title:
Season End Day
Ending day for which a seasonal rate is applicable. -
SeasonEndMonth: integer
(int32)
Title:
Season End Month
Ending month for which a seasonal rate is applicable. -
SeasonStartDay: integer
(int32)
Title:
Season Start Day
Starting day for which a seasonal rate is applicable. -
SeasonStartMonth: integer
(int32)
Title:
Season Start Month
Starting month for which a seasonal rate is applicable. -
StartDate: string
(date)
Title:
Start Date
Date from which this policy rate is applicable. -
Status: string
Maximum Length:
30
Code for the status of the rate record entered in the rates spreadsheet based on per diem determinant. Values are from the lookup EXM_POLICY_STATUS. -
StatusMeaning: string
Read Only:
true
Maximum Length:255
Status of the rate record entered in the rates spreadsheet based on per diem determinants such as Valid, Active, or Invalid. -
TripExceedDays: number
Title:
Trip Days Greater Than or Equal To
Value that indicates the lower end of a range for long term travel duration to receive different rates when a trip exceeds a certain number of days. -
TypeOfLineCode: string
Maximum Length:
30
Code that identifies the type of policy rules or rates such as ROLEBASED, WEEKEND_HOLIDAY, or TIME_MODEL_STANDARD. -
WeekendDay1Rate: number
Title:
Weekend and Holiday
Per diem or meals allowance in the spreadsheet that's applicable to the first weekend day for a specific geographic region based on determinants. For example, the first weekend day for a specific geographic region may not be Saturday because it's in the United States. -
WeekendDay2Rate: number
Title:
Weekend and Holiday
Per diem or meals allowance in the spreadsheet that's applicable to the second weekend day for a specific geographic region based on determinants. For example, the first weekend day for a specific geographic region may not be Sunday because it's in the United States. -
ZoneCode: string
Title:
Zone
Maximum Length:30
Zone code for which this 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.