Add Talent Benefit Enrollment

Adds a talent benefit enrollment to configure recurring employee paycheck deductions. The deduction amount (from Benefit Payroll Deduction enrollment data) is applied during payroll processing for all checks with a check date after the deduction start date. All new enrollments are flagged for review during payroll to ensure the setup is verified before the check is finalized.

Body Params
string
required
length ≥ 1

The unique identifier for the talent, formatted as a GUID.

string
length ≥ 1

The unique identifier for the staffing company (supplier), formatted as a GUID. This is used to identify the supplier associated with the talent's benefit.

int32

The unique identifier for the talent benefit transaction type.

benefitPayrollDeduction
object
benefitPayrollContribution
object
partnerTransactionLookupdeprecated
Headers
integer
required

An integer identifier for the tenant which the request is being made for.

uuid
required

The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.

Responses

400

Bad Request

401

Unauthorized

403

Access Denied

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json