1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Payroll Relationships

Get all payroll relationships

get

/hcmRestApi/resources/11.13.18.05/payrollRelationships

Request

Query Parameters
  • 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
  • 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).
  • 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
  • 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;
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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.
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : payrollRelationships
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : payrollRelationships-item-response
Type: object
Show Source
Nested Schema : PayRelationshipsDDF
Type: array
Show Source
  • 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 : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFAEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFSAVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipInformation_view_PayRelationshipsDDFUSVO-item-response
Type: object
Show Source
Nested Schema : payrollRelationships-payrollAssignments-item-response
Type: object
Show Source
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 : 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: array
Show Source
  • 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: object
Show Source
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 : payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-response
Type: object
Show Source
Nested Schema : payrollRelationships-payrollAssignments-payrollAssignmentDates-item-response
Type: object
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: object
Show Source
Nested Schema : oracle_apps_hcm_payrolls_registrations_flex_payrollRelationshipGroupInformation_view_PayrollRelationshipGroupsDDFUSVO-item-response
Type: object
Show Source
Nested Schema : payrollRelationships-payrollRelationshipDates-item-response
Type: object
Show Source
Back to Top

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": [
           {
            ...}
    ]
}
Back to Top