Retrieve Payroll Relationship Details

To retrieve the payroll relationship details:

1. Perform a GET operation on the payrollRelationships API using a finder.
2. Verify the details returned in the response.

Example URL

Use this resource URL format.

GET

/hcmRestApi/resources/11.13.18.05/payrollRelationships?finder=findByAssignmentNumberPersonNumber;AssignmentNumber=E955160008191542&expand=payrollAssignments.assignedPayrolls

Example Response

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "PayrollRelationshipId": 300100180001242,
            "PayrollRelationshipNumber": "955160008191542",
            "StartDate": "2019-06-02",
            "EndDate": "4712-12-31",
            "PersonNumber": "955160008191542",
            "Country": "US",
            "PartyId": 300100180002427,
            "PartyNumber": "CDRM_856705",
            "EffectiveEndDate": "4712-12-31",
            "EffectiveStartDate": "2019-06-02",
            "OverridingPeriodId": null,
            "payrollAssignments": [
                {
                    "RelationshipGroupId": 300100180001247,
                    "AssignmentNumber": "E955160008191542",
                    "EffectiveStartDate": "2019-06-11",
                    "EffectiveEndDate": "2019-06-24",
                    "TimeCardRequired": null,
                    "OverridingPeriodId": null,
                    "assignedPayrolls": [],
                    "links": [
                               ...]
               }
    ]
}