v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Paychecks

Get Details About the Talent Paycheck

Returns detailed information about the specified paycheck for the specified talent.

get/v2/talent/paycheck/{applicantId}/{paymentCheckGuid}/detail

paymentCheckGuidstring required

The unique identifier for the paycheck, formatted as GUID.

applicantIdstring required

The identifier for the talent whose data is being queried.

Tenantstring

Tenant company code for scoped data access during the request.

FrontOfficeTenantIdinteger

An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.

RequestIdstring uuid required

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

200 response

paymentCheckGuidstring guid

Globally unique identifier for the paycheck.

checkNumberstring

The check number.

checkDatestring date-time

The date the check was issued.

grossAmountnumber

The total gross amount of pay for the check.

netAmountnumber

The total net amount of pay for the check.

totalTaxesnumber

The total dollar amount of taxes deducted from the paycheck.

totalDeductionsnumber

The dollar amount of deductions taken out of check.

isDirectDepositboolean

An indication of whether direct deposit was used for a check.

ytdGrossnumber

The dollar amount of total pay earned by an employee when the check was filed.

totalHoursnumber

The total number of hours worked by an employee during the date range.