Get an assigned payroll
get
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}
Request
Path Parameters
-
assignedPayrollsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Assigned Payrolls resource and used to uniquely identify an instance of Assigned Payrolls. The client should not generate the hash key value. Instead, the client should query on the Assigned Payrolls collection resource in order to navigate to a specific instance of Assigned Payrolls to get the hash key.
-
payrollAssignmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Payroll Assignments resource and used to uniquely identify an instance of Payroll Assignments. The client should not generate the hash key value. Instead, the client should query on the Payroll Assignments collection resource in order to navigate to a specific instance of Payroll Assignments to get the hash key.
-
payrollRelationshipsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Payroll Relationships resource and used to uniquely identify an instance of Payroll Relationships. The client should not generate the hash key value. Instead, the client should query on the Payroll Relationships collection resource in order to navigate to a specific instance of Payroll Relationships to get the hash key.
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : payrollRelationships-payrollAssignments-assignedPayrolls-item-response
Type:
Show Source
object
-
assignedPayrollDates: array
Assigned Payroll Dates
Title:
Assigned Payroll Dates
The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll. -
AssignedPayrollId: integer
(int64)
Unique identifier used to retrieve the assigned payroll record for an assignment.
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the payroll is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll is effective. -
EndDate: string
(date)
Title:
End Date
End date of the payroll assigned to the assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lsed: string
(date)
Title:
Close Date
Last standard earning date of the payroll assigned to the assignment. -
OverridingPeriodId: integer
(int64)
Title:
Overtime Period
Overtime period for all assignments associated to the payroll, such as the FLSA period for US employees. -
PayrollId: integer
(int64)
Unique identifier for the payroll, such as the weekly payroll.
-
StartDate: string
(date)
Title:
Start Date
Start date of the payroll assigned to the assignment. -
TimeCardRequired: string
Title:
Time Card Required
Maximum Length:30
Associated with all assignments for a given payroll. Indicates whether the assignment must submit time cards for payroll purposes.
Nested Schema : Assigned Payroll Dates
Type:
array
Title:
Assigned Payroll Dates
The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-response
Type:
Show Source
object
-
DateValue: string
(date)
Title:
Termination Rule
The date for the given time definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayDateId: integer
(int64)
Unique identifier used to retrieve a date, such as the payroll's last standard earnings date. The date is derived based on a time definition.
-
ShortName: string
Read Only:
true
Maximum Length:30
Short name of the time definition.
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
- TimeCardRequiredLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: TimeCardRequired; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- assignedPayrollDates
-
Parameters:
- assignedPayrollsUniqID:
$request.path.assignedPayrollsUniqID
- payrollAssignmentsUniqID:
$request.path.payrollAssignmentsUniqID
- payrollRelationshipsUniqID:
$request.path.payrollRelationshipsUniqID
The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll. - assignedPayrollsUniqID:
- transferPayroll
-
Parameters:
- assignedPayrollsUniqID:
$request.path.assignedPayrollsUniqID
- payrollAssignmentsUniqID:
$request.path.payrollAssignmentsUniqID
- payrollRelationshipsUniqID:
$request.path.payrollRelationshipsUniqID
Assigns the payroll of a person with the new payroll passed. The existing payroll assigned to the person is closed. - assignedPayrollsUniqID: