Get all expense miscellaneous policy lines
get
/fscmRestApi/resources/11.13.18.05/expenseMiscPolicies/{MiscPolicyId}/child/expenseMiscPolicyLines
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 -
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 the expense miscellaneous policy line record that matches the primary key criteria specified.
Finder Variables- PolicyLineId; integer; The unique identifier of the expense miscellaneous policy line record.
- PrimaryKey Finds the expense miscellaneous policy line record 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:- CreatedBy; string; User who created the row.
- CreationDate; string; Date and time when the row was created.
- Currency; string; Currency of a miscellaneous expense policy line.
- CurrencyCode; string; Currency code of a miscellaneous expense policy line.
- DailyLimit; number; Daily reimbursement limit for miscellaneous expenses.
- EndDate; string; Date from which the miscellaneous expense policy rate is no longer applicable.
- GenderCode; string; Gender code for the miscellaneous expense policy.
- GeographyId; integer; The unique identifier of the geography for which the miscellaneous expense policy rate is applicable.
- GeolocName; string; Geographical location for which the miscellaneous expense policy rate is applicable.
- InvalidCode; string; Indicates why the miscellaneous expense policy line has the invalid status.
- LastUpdateDate; string; Date and time when the row was last updated
- LastUpdateLogin; string; Session login of user who last updated the row.
- LastUpdatedBy; string; User who last updated the row.
- MiscPolicyId; integer; The unique identifier of the miscellaneous expense policy.
- PolicyLineId; integer; The unique identifier of the miscellaneous expense policy line.
- RawCity; string; City for which the miscellaneous expense policy rate is applicable.
- RawCountry; string; Country for which the miscellaneous expense policy rate is applicable.
- RawCounty; string; County for which the miscellaneous expense policy rate is applicable.
- RawState; string; State for which the miscellaneous expense policy rate is applicable.
- ReimbursementPercentage; number; Percentage 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; The unique identifier of the role for which the miscellaneous expense policy rate is applicable.
- RoleName; string; Role name for which the miscellaneous expense policy rate is applicable, such as Director or Engineer.
- SingleInstanceLimit; number; Indicates whether miscellaneous expense policy limits are enforced by each submitted instance of a miscellaneous expense item.
- StartDate; string; Date from which the miscellaneous expense policy rate is applicable.
- Status; string; Status of the miscellaneous expense policy line. Valid values are Draft, Valid, Invalid, and Active.
- StatusCode; string; Indicates the status of the miscellaneous expense policy line. Values are from the lookup EXM_POLICY_STATUS.
- TypeOfRateCode; string; Type of rate line, such as base miscellaneous rate or catch all.
- YearlyLimit; number; Annual reimbursement limit for miscellaneous expenses.
- ZoneCode; string; Zone code for which the miscellaneous expense policy rate is applicable, such as geographical locations or zones.
-
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 : expenseMiscPolicies-expenseMiscPolicyLines
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 : expenseMiscPolicies-expenseMiscPolicyLines-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 and time when the row was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Currency of a miscellaneous expense policy line. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code of a miscellaneous expense policy line. -
DailyLimit: number
Title:
Daily sum limit
Daily reimbursement limit for miscellaneous expenses. -
EndDate: string
(date)
Title:
End Date
Date from which the miscellaneous expense policy rate is no longer applicable. -
GenderCode: string
Title:
Gender
Maximum Length:30
Gender 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 Location
Maximum Length:240
Geographical location for which the miscellaneous expense policy rate is applicable. -
InvalidCode: string
Maximum Length:
30
Indicates why the miscellaneous expense policy line has the invalid status. -
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 of user who last updated the row. -
links: array
Links
Title:
Links
The 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:
City
Maximum Length:80
City for which the miscellaneous expense policy rate is applicable. -
RawCountry: string
Title:
Country
Maximum Length:80
Country for which the miscellaneous expense policy rate is applicable. -
RawCounty: string
Title:
County
Maximum Length:80
County for which the miscellaneous expense policy rate is applicable. -
RawState: string
Title:
State
Maximum Length:80
State for which the miscellaneous expense policy rate is applicable. -
ReimbursementPercentage: number
Title:
Percentage Reimbursement
Percentage 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:
Role
Maximum Length:80
Role name for which the miscellaneous expense policy rate is applicable, such as Director or Engineer. -
SingleInstanceLimit: number
Title:
Single instance limit
Indicates whether miscellaneous expense policy limits are enforced by each submitted instance of a miscellaneous expense item. -
StartDate: string
(date)
Title:
Start Date
Date from which the miscellaneous expense policy rate is applicable. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the miscellaneous expense policy line. Valid values are Draft, Valid, Invalid, and Active. -
StatusCode: string
Title:
Status
Maximum Length:30
Indicates the status of the miscellaneous expense policy line. Values are from the lookup EXM_POLICY_STATUS. -
TypeOfRateCode: string
Maximum Length:
30
Type of rate line, such as base miscellaneous rate or catch all. -
YearlyLimit: number
Title:
Yearly limit
Annual reimbursement limit for miscellaneous expenses. -
ZoneCode: string
Title:
Zone
Maximum Length:30
Zone code for which the miscellaneous expense policy rate is applicable, such as geographical locations or zones.
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.