Get all payroll relationships
get
/hcmRestApi/resources/11.13.18.05/payrollRelationships
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 all payroll relationship attributes that match the specified primary key criteria.
Finder Variables- EffectiveEndDate; string; Date at the end of the date range within which the payroll relationship is effective.
- EffectiveStartDate; string; Date at the beginning of the date range within which the payroll relationship is effective.
- PayrollRelationshipId; integer; Unique identifier for the payroll relationship that's used to retrieve the payroll relationship record.
- findByAssignmentNumberPersonNumber Finds all payroll relationships based on the assignment number or person number.
Finder Variables- AssignmentNumber; string; Assignment number used to retrieve payroll relationships.
- PersonNumber; string; Person number used to retrieve payroll relationships.
- SysEffectiveDate; object;
- findByPayrollRelationshipId Finds all payroll relationships based on the payroll relationship identifier.
Finder Variables- PayrollRelationshipId; integer; Unique identifier used to retrieve the payroll relationship.
- SysEffectiveDate; object;
- PrimaryKey Finds all payroll relationship attributes that match the specified primary key criteria.
-
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:- Country; string; Country of the person associated with the payroll relationship. This is derived based on the person's legislative data group.
- EffectiveEndDate; string; Date at the end of the date range within which the payroll relationship is effective.
- EffectiveStartDate; string; Date at the beginning of the date range within which the payroll relationship is effective.
- EndDate; string; End date of the payroll relationship's date-effective record.
- OverridingPeriodId; integer; Overtime period associated with the payroll relationship, such as the FLSA period for US employees.
- PartyId; integer; Unique identifier used to capture the payment details for the person, such as bank account information. The party identifier is an entity of the trading community model.
- PartyNumber; string; Unique identifier used to capture the payment details for the person, such as bank account information. The registry identifier is an entity of the trading community model.
- PayrollRelationshipId; integer; Unique identifier used to retrieve the payroll relationship.
- PayrollRelationshipNumber; string; Number assigned to a payroll relationship.
- PersonNumber; string; Number of the person associated with the payroll relationship.
- StartDate; string; Start date of the payroll relationship's date-effective record.
-
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
-
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
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 : payrollRelationships-item-response
Type:
Show Source
object
-
Country: string
Title:
Country
Read Only:true
Maximum Length:2
Country of the person associated with the payroll relationship. This is derived based on the person's legislative data group. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
Date at the end of the date range within which the payroll relationship is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the payroll relationship is effective. -
EndDate: string
(date)
Title:
End Date
Read Only:true
End date of the payroll relationship's date-effective record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverridingPeriodId: integer
(int64)
Title:
Overtime Period
Overtime period associated with the payroll relationship, such as the FLSA period for US employees. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Unique identifier used to capture the payment details for the person, such as bank account information. The party identifier is an entity of the trading community model. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
Unique identifier used to capture the payment details for the person, such as bank account information. The registry identifier is an entity of the trading community model. -
PayRelationshipsDDF: array
PayRelationshipsDDF
-
payrollAssignments: array
Payroll Assignments
Title:
Payroll Assignments
The payrollAssignments resource is a child of the payrollRelationships resource.It includes a list of all payroll assignments for a given payroll relationship. -
payrollRelationshipDates: array
Payroll Relationship Dates
Title:
Payroll Relationship Dates
The payrollRelationshipDates resource is a child of the payrollRelationships resource. It includes a list of all element duration dates for the given payroll relationship. -
PayrollRelationshipId: integer
(int64)
Unique identifier used to retrieve the payroll relationship.
-
PayrollRelationshipNumber: string
Title:
Relationship Number
Read Only:true
Maximum Length:30
Number assigned to a payroll relationship. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Number of the person associated with the payroll relationship. -
StartDate: string
(date)
Title:
Start Date
Start date of the payroll relationship's date-effective record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : PayRelationshipsDDF
Type:
Show Source
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "AE":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response", "SA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response" } }
Nested Schema : Payroll Assignments
Type:
array
Title:
Payroll Assignments
The payrollAssignments resource is a child of the payrollRelationships resource.It includes a list of all payroll assignments for a given payroll relationship.
Show Source
Nested Schema : Payroll Relationship Dates
Type:
array
Title:
Payroll Relationship Dates
The payrollRelationshipDates resource is a child of the payrollRelationships resource. It includes a list of all element duration dates for the given payroll relationship.
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.
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
AE -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response
-
SA -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response
-
US -
object
oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:AE
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
_ACCOMMODATION_PROVIDED: string
Title:
Accommodation Provided
Maximum Length:150
-
_ACCOMMODATION_PROVIDED_Display: string
Title:
Accommodation Provided
-
_ORA_HRX_AE_MOL_EMPLOYEE_ID: string
Title:
MOHRE Employee ID
Maximum Length:150
-
_ORA_HRX_AE_WPS_ACCOUNT_NUMBER: string
Title:
WPS Account Number
Maximum Length:150
-
_TRANSPORTATION_PROVIDED: string
Title:
Transportation Provided
Maximum Length:150
-
_TRANSPORTATION_PROVIDED_Display: string
Title:
Transportation Provided
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelationshipId: integer
(int64)
-
wpsAgentEmployeeId: string
Title:
WPS Agent Employee ID
Maximum Length:150
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:SA
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
_ACCOMMODATION_PROVIDED: string
Title:
Accommodation Provided
Maximum Length:150
-
_ACCOMMODATION_PROVIDED_Display: string
Title:
Accommodation Provided
-
_TRANSPORTATION_PROVIDED: string
Title:
Transportation Provided
Maximum Length:150
-
_TRANSPORTATION_PROVIDED_Display: string
Title:
Transportation Provided
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelationshipId: integer
(int64)
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:US
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
overtimeStatus: string
Title:
Overtime Status
Maximum Length:150
-
overtimeStatus_Display: string
Title:
Overtime Status
-
PayrollRelationshipId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payrollRelationships-payrollAssignments-item-response
Type:
Show Source
object
-
assignedPayrolls: array
Assigned Payrolls
Title:
Assigned Payrolls
The assignedPayrolls resource is a child of the payrollAssignments resource.It includes a list of all payrolls assigned for a given assignment. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Number assigned to an assignment record. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
Date at the end of the date range within which the assignment is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the assignment is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverridingPeriodId: integer
(int64)
Title:
Overtime Period
Overtime period associated with the assignment, such as the FLSA period for US employees. -
payrollAssignmentDates: array
Payroll Assignment Dates
Title:
Payroll Assignment Dates
The payrollAssignmentDates resource is a child of the payrollAssignments resource. It includes a list of all element duration dates for a given payroll assignment. -
PayrollRelationshipGroupsDDF: array
PayrollRelationshipGroupsDDF
-
RelationshipGroupId: integer
(int64)
Read Only:
true
Unique identifier used to retrieve the assignment record. -
TimeCardRequired: string
Title:
Time Card Required
Maximum Length:20
Indicates whether the assignment must submit time cards for payroll purposes.
Nested Schema : Assigned Payrolls
Type:
array
Title:
Assigned Payrolls
The assignedPayrolls resource is a child of the payrollAssignments resource.It includes a list of all payrolls assigned for a given assignment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payroll Assignment Dates
Type:
array
Title:
Payroll Assignment Dates
The payrollAssignmentDates resource is a child of the payrollAssignments resource. It includes a list of all element duration dates for a given payroll assignment.
Show Source
Nested Schema : PayrollRelationshipGroupsDDF
Type:
Show Source
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "CA":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFCAVO-item-response", "US":"#/components/schemas/oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFUSVO-item-response" } }
Nested 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 : payrollRelationships-payrollAssignments-payrollAssignmentDates-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 that's used to retrieve a date, such as the assignment'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 : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFCAVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:CA
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
_INDIAN: string
Title:
Indian Exempt Status
Maximum Length:150
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
oraHrxCaPmAsgAcct: string
Title:
Provincial Medical Account Override
Maximum Length:150
-
oraHrxCaPmAsgAcct_Display: string
Title:
Provincial Medical Account Override
-
oraHrxCaPmAsgProv: number
Title:
Provincial Medical Province Override
-
oraHrxCaPmAsgProv_Display: string
Title:
Provincial Medical Province Override
-
oraHrxCaPmExempt: string
Title:
Provincial Medical Exempt
Maximum Length:150
-
oraHrxCaVacLiaAsgProv: number
Title:
Vacation Liability Province Override
-
oraHrxCaVacLiaAsgProv_Display: string
Title:
Vacation Liability Province Override
-
oraHrxCaWcAsgAcct: string
Title:
Workers Compensation Account Override
Maximum Length:150
-
oraHrxCaWcAsgAcct_Display: string
Title:
Workers Compensation Account Override
-
oraHrxCaWcAsgClUnit: string
Title:
Workers Compensation Classification Unit Override
Maximum Length:150
-
oraHrxCaWcAsgClUnit_Display: string
Title:
Workers Compensation Classification Unit Override
-
oraHrxCaWcAsgProv: number
Title:
Workers Compensation Province Override
-
oraHrxCaWcAsgProv_Display: string
Title:
Workers Compensation Province Override
-
oraHrxCaWcExempt: string
Title:
Workers Compensation Exempt
Maximum Length:150
-
RelationshipGroupId: integer
(int64)
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFUSVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Default Value:US
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
overtimeStatus: string
Title:
Overtime Status
Maximum Length:150
-
overtimeStatus_Display: string
Title:
Overtime Status
-
RelationshipGroupId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payrollRelationships-payrollRelationshipDates-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 relationship's last standard earnings date. This 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
Examples
The following example shows how to retrieve all the payroll relationships by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET http://<host>:<port>/hcmRestApi/resources/11.13.18.05/payrollRelationships
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "PayrollRelationshipId" : 300100023226139, "PayrollRelationshipNumber" : "955160008174698", "StartDate" : "2012-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174698", "Country" : null, "PartyId" : 300100023226777, "PartyNumber" : "CDRM_66822", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2012-01-01", "OverridingPeriodId" : 300100118612058, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023180432, "PayrollRelationshipNumber" : "955160008174689", "StartDate" : "2013-08-13", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174689", "Country" : null, "PartyId" : 300100023168795, "PartyNumber" : "CDRM_66812", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2013-08-13", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023404660, "PayrollRelationshipNumber" : "955160008174728", "StartDate" : "2010-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174728", "Country" : null, "PartyId" : 300100023306833, "PartyNumber" : "CDRM_66905", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2010-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023407735, "PayrollRelationshipNumber" : "955160008174731", "StartDate" : "2010-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174731", "Country" : null, "PartyId" : 300100023311834, "PartyNumber" : "CDRM_66908", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2010-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023403273, "PayrollRelationshipNumber" : "955160008174726", "StartDate" : "2010-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174726", "Country" : null, "PartyId" : 300100023311825, "PartyNumber" : "CDRM_66903", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2010-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023406355, "PayrollRelationshipNumber" : "955160008174729", "StartDate" : "2010-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174729", "Country" : null, "PartyId" : 300100023311831, "PartyNumber" : "CDRM_66906", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2010-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023177534, "PayrollRelationshipNumber" : "955160008174688", "StartDate" : "2013-08-13", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174688", "Country" : null, "PartyId" : 300100023168790, "PartyNumber" : "CDRM_66811", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2013-08-13", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023411139, "PayrollRelationshipNumber" : "955160008174733", "StartDate" : "2011-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174733", "Country" : null, "PartyId" : 300100023311837, "PartyNumber" : "CDRM_66910", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2011-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100023411828, "PayrollRelationshipNumber" : "955160008174734", "StartDate" : "2011-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "955160008174734", "Country" : null, "PartyId" : 300100023306842, "PartyNumber" : "CDRM_66911", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2011-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100010027583116, "PayrollRelationshipNumber" : "10024203730", "StartDate" : "2009-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "10024200130", "Country" : "US", "PartyId" : 100010025532120, "PartyNumber" : "100010025532120", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100010027583116, "PayrollRelationshipNumber" : "10024203730", "StartDate" : "2009-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "10024200130", "Country" : null, "PartyId" : 100010037456631, "PartyNumber" : "100010037456631", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100010027583120, "PayrollRelationshipNumber" : "10024203734", "StartDate" : "2009-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "10024200146", "Country" : "US", "PartyId" : 100010025531706, "PartyNumber" : "100010025531706", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100010027583124, "PayrollRelationshipNumber" : "10024203738", "StartDate" : "2009-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "10024200162", "Country" : "US", "PartyId" : 100010025532714, "PartyNumber" : "100010025532714", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100010027583128, "PayrollRelationshipNumber" : "10024203741", "StartDate" : "2009-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "10024200178", "Country" : "US", "PartyId" : 100010025532132, "PartyNumber" : "100010025532132", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100010027583132, "PayrollRelationshipNumber" : "10024203745", "StartDate" : "2009-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "10024200194", "Country" : "US", "PartyId" : 100010025532834, "PartyNumber" : "100010025532834", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100010027583136, "PayrollRelationshipNumber" : "10024203748", "StartDate" : "2009-01-01", "EndDate" : "4712-12-31", "PersonNumber" : "10024200210", "Country" : "US", "PartyId" : 100010025532990, "PartyNumber" : "100010025532990", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-01-01", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100000013571206, "PayrollRelationshipNumber" : "100000013571206", "StartDate" : "2009-10-26", "EndDate" : "4712-12-31", "PersonNumber" : "8153756", "Country" : null, "PartyId" : 100010025533008, "PartyNumber" : "100010025533008", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-10-26", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100000013571206, "PayrollRelationshipNumber" : "100000013571206", "StartDate" : "2009-10-26", "EndDate" : "4712-12-31", "PersonNumber" : "8153756", "Country" : "US", "PartyId" : 100010037456271, "PartyNumber" : "100010037456271", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-10-26", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100000013571250, "PayrollRelationshipNumber" : "100000013571250", "StartDate" : "2009-10-26", "EndDate" : "4712-12-31", "PersonNumber" : "8153756", "Country" : null, "PartyId" : 100010025533008, "PartyNumber" : "100010025533008", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-10-26", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 100000013571250, "PayrollRelationshipNumber" : "100000013571250", "StartDate" : "2009-10-26", "EndDate" : "4712-12-31", "PersonNumber" : "8153756", "Country" : "US", "PartyId" : 100010037456271, "PartyNumber" : "100010037456271", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2009-10-26", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100122691120, "PayrollRelationshipNumber" : "CAND-25946", "StartDate" : "2017-08-25", "EndDate" : "4712-12-31", "PersonNumber" : "8153757", "Country" : null, "PartyId" : 100010025532240, "PartyNumber" : "100010025532240", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2017-08-25", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100122691120, "PayrollRelationshipNumber" : "CAND-25946", "StartDate" : "2017-08-25", "EndDate" : "4712-12-31", "PersonNumber" : "8153757", "Country" : null, "PartyId" : 100010037456769, "PartyNumber" : "100010037456769", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2017-08-25", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100122537856, "PayrollRelationshipNumber" : "CAND-25964", "StartDate" : "2017-08-24", "EndDate" : "4712-12-31", "PersonNumber" : "8153775", "Country" : null, "PartyId" : 100010025532912, "PartyNumber" : "100010025532912", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2017-08-24", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100122537856, "PayrollRelationshipNumber" : "CAND-25964", "StartDate" : "2017-08-24", "EndDate" : "4712-12-31", "PersonNumber" : "8153775", "Country" : null, "PartyId" : 100010037456697, "PartyNumber" : "100010037456697", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2017-08-24", "OverridingPeriodId" : null, "links": [ { ...} }, { "PayrollRelationshipId" : 300100010479512, "PayrollRelationshipNumber" : "8153804", "StartDate" : "2012-05-21", "EndDate" : "4712-12-31", "PersonNumber" : "8153804", "Country" : null, "PartyId" : 100010032635687, "PartyNumber" : "100010032635687", "EffectiveEndDate" : "4712-12-31", "EffectiveStartDate" : "2012-05-21", "OverridingPeriodId" : null, "links": [ { ...} ] }