Concurrent employers

This topic documents the Cloud API for concurrent employers in ClaimCenter. It provides instructions and examples for how to use the endpoints, as well as some common business flows.

When a worker has concurrent employers, this means that the worker has more than one job or employer at the same time. This is meaningful in workers' compensation claims because the calculation of a worker's lost wages would possibly have to include wages from the worker's concurrent employers.

To learn more about how concurrent employment is handled in workers' compensation claims in ClaimCenter, refer to the Application Guide

Querying for concurrent employers

To retrieve concurrent employers associated with a claim, use the following endpoints:

GET /claim/v1/claims/{claimId}/concurrent-employers
GET /claim/v1/claims/{claimId}/concurrent-employers/{concurrentEmployerId}

Retrieve all concurrent employers

The first endpoint retrieves a collection of all concurrent employers associated with a claim, along with their details. For example, the following request retrieves all concurrent employers associated with a claim:

Command

GET /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers

Response

{
    "count": 2,
    "data": [
        {
            "attributes": {
                "companyName": "XYZ Construction",
                "contactNumber": "201-545-4321",
                "endDate": "2026-03-10T00:00:00.000Z",
                "fullTime": false,
                "id": "xc:SLWx-y6477Gv9Rw5PKv5P",
                "jobTitle": "Painter",
                "startDate": "2017-03-14T00:00:00.000Z",
                "weeklyWage": {
                    "amount": "1000.00",
                    "currency": "usd"
                }
            }
        },
        {
            "attributes": {
                "companyName": "ABC Construction",
                "contactNumber": "201-555-0123",
                "fullTime": true,
                "id": "xc:SW2UgyNraK7Canp4augIZ",
                "jobTitle": "Builder",
                "startDate": "2021-03-02T00:00:00.000Z",
                "weeklyWage": {
                    "amount": "3000.00",
                    "currency": "usd"
                }
            }
        }
    ]
}

Retrieve a concurrent employer by ID

The second endpoint retrieves a specific concurrent employer by its id.

If you don't know the ID of the concurrent employer you want to retrieve, you can use the first endpoint to get the id. Then you can retrieve the concurrent employer by that id. For example, the following request retrieves 'XYZ Construction' by its id:

Command

GET /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers/xc:SLWx-y6477Gv9Rw5PKv5P

Response

{
    "data": {
        "attributes": {
            "companyName": "XYZ Construction",
            "contactNumber": "201-545-4321",
            "endDate": "2026-03-10T00:00:00.000Z",
            "fullTime": false,
            "id": "xc:SLWx-y6477Gv9Rw5PKv5P",
            "jobTitle": "Painter",
            "startDate": "2017-03-14T00:00:00.000Z",
            "weeklyWage": {
                "amount": "1000.00",
                "currency": "usd"
            }
        }
    }
}

The API responds with only the details for 'XYZ Construction'.

Creating concurrent employers

Use the following endpoint to create a concurrent employer for a claim:

POST /claim/v1/claims/{claimId}/concurrent-employers

Required fields

The following field is required to create a concurrent employer for a claim:

companyName: This string represents the name of the concurrent employer.

Minimal concurrent employer

The following request includes only the one required field, companyName, to create a concurrent employer:

Command

POST /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers

Request

{
    "data": {
        "attributes": {
            "companyName": "Sun Construction"
        }
    }
}

Response

{
    "data": {
        "attributes": {
            "companyName": "Sun Construction",
            "id": "xc:SPi-vQtGtOV8CAD-zzFoT"
        }
    }
}

When the request is successful, the API responds with the created concurrent employer and its details.

Typical concurrent employer

A typical concurrent employer would include more details than only the companyName, such as the employee's jobTitle and weeklyWage, and the employer's contactNumber. For example, the following request creates a typical concurrent employer:

Command

POST /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers

Request

{
    "data": {
        "attributes": {
            "companyName": "Moon Construction",
            "endDate": "2026-03-10T00:00:00.000Z",
            "fullTime": false,
            "jobTitle": "Mover",
            "startDate": "2021-03-14T00:00:00.000Z",
            "weeklyWage": {
                    "amount": "1000.00",
                    "currency": "usd"
                }
        }
    }
}

Response

{
    "data": {
        "attributes": {
            "companyName": "Moon Construction",
            "endDate": "2026-03-10T00:00:00.000Z",
            "fullTime": false,
            "id": "xc:S7FPdziYpgCxwpq0yvTC6",
            "jobTitle": "Mover",
            "startDate": "2021-03-14T00:00:00.000Z",
            "weeklyWage": {
                "amount": "1000.00",
                "currency": "usd"
            }
        }
    }
}

Modifying concurrent employers

Use the following endpoint to modify an existing concurrent employer associated with a claim:

PATCH /claim/v1/claims/{claimId}/concurrent-employers/{concurrentEmployerId}

You can modify any attribute for a concurrent employer, except for its id.

Concurrent employer modification examples

The first example request updates the endDate, a date-time, for the employee with the claim:

Command

PATCH /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers/xc:S7FPdziYpgCxwpq0yvTC6

Request

{
    "data": {
        "attributes": {
            "endDate": "2026-03-13T00:00:00.000Z"
        }
    }
}

When the request is successful, the API responds with the updated concurrent employer and its details, including the new endDate.

The second example request updates the fullTime status, a Boolean, for the employee with the claim:

Command

PATCH /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers/xc:S7FPdziYpgCxwpq0yvTC6

Request

{
    "data": {
        "attributes": {
            "fullTime": true
        }
    }
}

When the request is successful, the API responds with the updated concurrent employer and its details, including the new fullTime status.

The third example request updates the weeklyWage, an object, for the employee with the claim:

Command

PATCH /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers/xc:S7FPdziYpgCxwpq0yvTC6

Request

{
    "data": {
        "attributes": {
            "weeklyWage": {
                "amount": "1200.00",
                "currency": "usd"
            }
        }
    }
}

When the request is successful, the API resopnds with the updated concurrent employer and its details, including the new weeklyWage.

Deleting concurrent employers

Use the following endpoint to delete a concurrent employer by its id:

DELETE /claim/v1/claims/{claimId}/concurrent-employers/{concurrentEmployerId}

For example, the following request deletes 'XYZ Construction' by its id:

Command

DELETE /claim/v1/claims/xc:SA8X3UDjExJWX-5UrDfI4/concurrent-employers/xc:SLWx-y6477Gv9Rw5PKv5P

When the request is successful, the API responds with an empty body. You can then verify that the concurrent employer has been successfully deleted.