Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Talent Tax Details

Returns Tax setup details for the specified talent record for Employers.

get/v1/talent/tax-details

Query parameters

talentGuidstring required

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

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.

Response

200 response

talentTaxGuidstring guid

The unique identifier for the talent tax record, formatted as a GUID. Not applicable for Federal W-4.

federalW4Idinteger

The unique identifier for the talent federal W-4. Only applicable for Federal W-4.

talentGuidstring guid required

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

taxIdinteger required

The unique identifier of the tax record.

taxNamestring

The name of the tax record.

employeeTaxboolean

An indication of whether the tax is Employee Tax or Employer Tax.

stateCodestring

The two-character code for a state or province.

taxTypestring

The type of tax. Possible values include: Federal Income Tax, State Income Tax, FUTA, SUI, FICA, MEDICARE, Local, and others.

taxFilingStatusIdinteger

The unique identifier for the tax filing status.

TaxFilingStatusstring

The tax filing status.

exemptionsnumber

The number of exemptions. Not applicable for Federal W-4.

dependentsnumber

The number of dependents. Not applicable for Federal W-4.

additionalWithholdingnumber

The additional withholding amount.

fixedPercentagenumber

The percentage withholding value. Not applicable for Federal W-4.

fixedAmountnumber

The fixed amount withholding value. Not applicable for Federal W-4.

activeboolean

An indication of whether the tax is active or not.

isTaxExemptboolean

An indication of whether the tax is exempt or not.

exemptionAmountboolean

The exemption amount. Not applicable for Federal W-4.

supplierGuidstring guid

The unique identifier for the staffing company (supplier), formatted as a GUID. Only applicable for Federal W-4.

supplierNamestring

The name of the employer (staffing supplier). Only applicable for Federal W-4.

hasMultipleJobsboolean

An indication of whether the talent has multiple jobs. Only applicable for Federal W-4.

qualifyingChildrennumber

The number of qualifying children. Only applicable for Federal W-4.

otherDependentsnumber

The number of other dependents. Only applicable for Federal W-4.

totalDependentsnumber

The number of total dependents. Only applicable for Federal W-4.

otherIncomenumber

Other income. Only applicable for Federal W-4.

deductionsnumber

Deductions. Only applicable for Federal W-4.

firstWorkedDatestring date-time

The first date the talent worked. Only applicable for Federal W-4. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.

dateCompletedstring date-time

The date the Federal W-4 was completed. Only applicable for Federal W-4. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-30T21:12:54.126Z.

usWithholdingTypestring

The US withholding type. Only applicable for US taxes.