Get an expense miscellaneous policy
get
/fscmRestApi/resources/11.13.18.05/expenseMiscPolicies/{MiscPolicyId}
Request
Path Parameters
-
MiscPolicyId(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: string
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: string
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 : expenseMiscPolicies-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
Currency: string
Title:
DescriptionRead Only:trueMaximum Length:240Currency of a miscellaneous expense policy when rates are defined in a single currency. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Currency code for miscellaneous expense policy. -
CurrencyOption: string
Title:
MeaningRead Only:trueMaximum Length:80Miscellaneous expense policy defined for a single currency or for multiple currencies. -
CurrencyOptionCode: string
Title:
Rate CurrencyMaximum Length:30Miscellaneous expense policy defined for a single currency or for multiple currencies. Values are from the lookup EXM_CURRENCY_OPTION. -
DailyLimitFlag: boolean
Title:
Daily sum limitMaximum Length:1Indicates whether the daily amount limit of miscellaneous expenses is enforced. Valid values are Yes and No. -
DaysBasedItemParentFlag: boolean
Title:
Based on Number of Days in Parent Line During ItemizationMaximum Length:1Indicates whether eligibility for miscellaneous expense reimbursement is based on number of days specified in parent line during itemization in expense entry. -
Description: string
Title:
DescriptionMaximum Length:240Description of miscellaneous expense policy. -
DispWarningToUserFlag: boolean
Title:
Display Warning to UserMaximum Length:1Indicates whether miscellaneous expense policy warning is displayed to user. -
EligibilityDays: integer
(int32)
Title:
DaysMinimum number of days before miscellaneous expense is eligible for reimbursement. -
EnabledEligibilityFlag: boolean
Title:
Minimum Number of Days for Miscellaneous Expense ReimbursementMaximum Length:1Indicates whether a minimum number of days are required for the miscellaneous expense to be eligible for expense reimbursement. -
EnabledGenderFlag: boolean
Title:
GenderMaximum Length:1Indicates whether miscellaneous expense policy rates vary based on the gender of an employee. -
EnabledLocationFlag: boolean
Title:
LocationMaximum Length:1Indicates whether miscellaneous expense policy rates vary by location. -
EnabledRoleFlag: boolean
Title:
RoleMaximum Length:1Indicates whether miscellaneous expense policy rates vary based on employee role. -
ErrorTolerance: number
Title:
Error Tolerance PercentagePercentage added to the miscellaneous expense policy amount limit to obtain the maximum allowable limit for expense report submission. -
expenseMiscPolicyLines: array
Expense Miscellaneous Policy Lines
Title:
Expense Miscellaneous Policy LinesThe expense miscellaneous policy lines resource is used to view miscellaneous expense policy line records. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login of user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationType: string
Title:
MeaningRead Only:trueMaximum Length:80The type of location that determines miscellaneous expense policy rates, such as Geographical Location or Zone. -
LocationTypeCode: string
Maximum Length:
30Indicates the location type that determines miscellaneous expense policy rates. Valid values are from the lookup EXM_LOCATION_TYPE. -
MiscPolicyId: integer
(int64)
The unique identifier of the miscellaneous expense policy.
-
PeriodDay: integer
(int32)
Title:
Period Start DayStart date from which miscellaneous expense policy annual rate limit is counted. Values are from the lookup DAY. -
PeriodMonth: string
Title:
Period Start MonthMaximum Length:30Starting month from which miscellaneous expense policy annual rate limit is counted. Values are from the lookup MONTH. -
PolicyEnforcement: string
Title:
MeaningRead Only:trueMaximum Length:80Type of miscellaneous expense policy enforcement applied. -
PolicyEnforcementCode: string
Maximum Length:
30Indicates the type of miscellaneous expense policy enforcement applied. Values are from the lookup EXM_POLICY_ENFORCEMENT. -
PolicyName: string
Title:
Policy NameMaximum Length:60Name of the miscellaneous expense policy. -
PolicyRole: string
Title:
MeaningRead Only:trueMaximum Length:80Role type that determines the miscellaneous expense policy rate, such as Job, Grade, or Position. -
PolicyRoleCode: string
Title:
Role TypeMaximum Length:30Indicates the role type that determines the miscellaneous expense policy rate, such as Job, Grade, or Position. Values are from the lookup EXM_POLICY_ROLE. -
PolicyViolationFlag: boolean
Title:
Policy violation warningMaximum Length:1Indicates whether employees are warned when they submit expenses that exceed the defined miscellaneous expense policy rate limit. -
PreventSubmissionFlag: boolean
Title:
Prevent report submissionMaximum Length:1Indicates whether expense report submission is prevented if a miscellaneous expense policy violation occurs. -
RateType: string
Title:
MeaningRead Only:trueMaximum Length:80Policy rate type of the miscellaneous expense policy, such as rate limit, percentage reimbursement, or percentage reimbursement with upper limit. -
RateTypeCode: string
Title:
Rate TypeMaximum Length:30Indicates the policy rate type of the miscellaneous expense policy, such as rate limit, percentage reimbursement, or percentage reimbursement with upper limit. Values are from the lookup EXM_RATE_TYPE. -
SingleInstanceLimitFlag: boolean
Title:
Single instance limitMaximum Length:1Indicates whether miscellaneous expense policy limits are enforced by each submitted instance of the miscellaneous expense item. -
Status: string
Title:
MeaningRead Only:trueMaximum Length:80Status of the miscellaneous expense policy, Valid values are Draft, Valid, Invalid, and Active. -
StatusCode: string
Title:
StatusMaximum Length:30Indicates the status of the miscellaneous expense policy. Values are from the lookup EXM_POLICY_STATUS. -
WarningTolerance: number
Title:
Warning Tolerance PercentagePercentage added to miscellaneous expense policy amount limit to obtain the maximum allowable limit for a policy warning violation. -
YearlyLimitFlag: boolean
Title:
Yearly limitMaximum Length:1Indicates whether miscellaneous expense policy limits are enforced by maximum permitted annual amount. Valid values are Yes and No. -
ZoneType: string
Title:
MeaningRead Only:trueMaximum Length:80Lookup that defines zone types for the miscellaneous expense policy. -
ZoneTypeCode: string
Title:
Zone TypeMaximum Length:30Indicates the lookup that defines zone types for the miscellaneous expense policy. Values are from the lookup EXM_ZONE_TYPE.
Nested Schema : Expense Miscellaneous Policy Lines
Type:
arrayTitle:
Expense Miscellaneous Policy LinesThe expense miscellaneous policy lines resource is used to view miscellaneous expense policy line records.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : expenseMiscPolicies-expenseMiscPolicyLines-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
Currency: string
Title:
DescriptionRead Only:trueMaximum Length:240Currency of a miscellaneous expense policy line. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Currency code of a miscellaneous expense policy line. -
DailyLimit: number
Title:
Daily sum limitDaily reimbursement limit for miscellaneous expenses. -
EndDate: string
(date)
Title:
End DateDate from which the miscellaneous expense policy rate is no longer applicable. -
GenderCode: string
Title:
GenderMaximum Length:30Gender code for the miscellaneous expense policy. -
GeographyId: integer
(int64)
The unique identifier of the geography for which the miscellaneous expense policy rate is applicable.
-
GeolocName: string
Title:
Geographical LocationMaximum Length:240Geographical location for which the miscellaneous expense policy rate is applicable. -
InvalidCode: string
Maximum Length:
30Indicates why the miscellaneous expense policy line has the invalid status. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login of user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MiscPolicyId: integer
(int64)
The unique identifier of the miscellaneous expense policy.
-
PolicyLineId: integer
(int64)
The unique identifier of the miscellaneous expense policy line.
-
RawCity: string
Title:
CityMaximum Length:80City for which the miscellaneous expense policy rate is applicable. -
RawCountry: string
Title:
CountryMaximum Length:80Country for which the miscellaneous expense policy rate is applicable. -
RawCounty: string
Title:
CountyMaximum Length:80County for which the miscellaneous expense policy rate is applicable. -
RawState: string
Title:
StateMaximum Length:80State for which the miscellaneous expense policy rate is applicable. -
ReimbursementPercentage: number
Title:
Percentage ReimbursementPercentage of the expense amount that's reimbursed when the submitted expense amount exceeds the limit and the rate type is percentage reimbursement or percentage reimbursement with upper limit. -
RoleId: integer
(int64)
The unique identifier of the role for which the miscellaneous expense policy rate is applicable.
-
RoleName: string
Title:
RoleMaximum Length:80Role name for which the miscellaneous expense policy rate is applicable, such as Director or Engineer. -
SingleInstanceLimit: number
Title:
Single instance limitIndicates whether miscellaneous expense policy limits are enforced by each submitted instance of a miscellaneous expense item. -
StartDate: string
(date)
Title:
Start DateDate from which the miscellaneous expense policy rate is applicable. -
Status: string
Title:
MeaningRead Only:trueMaximum Length:80Status of the miscellaneous expense policy line. Valid values are Draft, Valid, Invalid, and Active. -
StatusCode: string
Title:
StatusMaximum Length:30Indicates the status of the miscellaneous expense policy line. Values are from the lookup EXM_POLICY_STATUS. -
TypeOfRateCode: string
Maximum Length:
30Type of rate line, such as base miscellaneous rate or catch all. -
YearlyLimit: number
Title:
Yearly limitAnnual reimbursement limit for miscellaneous expenses. -
ZoneCode: string
Title:
ZoneMaximum Length:30Zone code for which the miscellaneous expense policy rate is applicable, such as geographical locations or zones.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- expenseMiscPolicyLines
-
Operation: /fscmRestApi/resources/11.13.18.05/expenseMiscPolicies/{MiscPolicyId}/child/expenseMiscPolicyLinesParameters:
- MiscPolicyId:
$request.path.MiscPolicyId
The expense miscellaneous policy lines resource is used to view miscellaneous expense policy line records. - MiscPolicyId: