Adds the specified employees to a payroll run and streams progress updates to the client using Server-Sent Events (SSE).

The response is streamed as 'text/event-stream', allowing clients to receive real-time
progress updates. This endpoint is intended for use with clients that support SSE. Response buffering is
disabled when possible to ensure timely delivery of events.

         Progress event payload:
         1. Status enum values - Invalid (0), NotStarted (1), Started (2) , CancelRequested (3), Cancelled (4), Finished (5)
         2. Progress (int) - percentage of completion (0-100)
         3. Errors (list) - each item represents blocking error (Type = HardStopError(2)) or a warning (Type = SoftWarning (1))
        
         Note: HardStopError can stop payroll and it won't be possible to call AddEmployees API enpoint again.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The unique identifier of the company for which employees are being added to the payroll run.

int32
required

The unique identifier of the payroll run to which employees will be added.

Body Params

A list of employee IDs to add to the specified payroll run. Cannot be null or empty.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

OK

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here!