Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
TalentBenefits

Get Talent Benefit YTD Summaries

Returns year-to-date benefit summaries for the specified talents for a given year. Includes gross wages, hours worked, payroll deductions, and employer contributions. Accepts up to 100 talent GUIDs per request.

post/v1/talent-benefit/ytd/{yearId}

Path parameters

yearIdstring required

The year ID in yyyy format.

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

string[] required

Response

200 response

talentGuidstring guid

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.

grossWagesYtdnumber double

The total gross wages earned year-to-date by the talent.

hoursYtdnumber double

The total hours worked year-to-date by the talent.