v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

TalentBenefits

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.

post/v1/talent-benefit/enroll

Headers

FrontOfficeTenantIdinteger required

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

RequestIdstring uuid required

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

Request body

talentGuidstring guid required

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

supplierGuidstring guid

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.

transactionTypeIdinteger

The unique identifier for the talent benefit transaction type.

Response

200 response