v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Taxes

Create Additional Talent Tax

Creates an additional tax for the talent record.

post/v3/talent/additional-tax

Query parameters

talentGuidstring uuid

The unique identifier of a Talent record, formatted as a UUID.

talentExternalIdstring

The external ID of the Talent entity, used as an alternative to the TalentGuid query parameter. When provided with a valid ExternalIdSource header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an ExternalEntityNotFound error is returned. If a match is found, the response includes a TalentGuid header containing the classic entity record ID.

Headers

FrontOfficeTenantIdinteger required

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

RequestOriginstring required

The string source name (such as application or function name) that indicates the origin of the request.

RequestIdstring uuid required

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

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

ExternalIdSource'BOLD' required
Example:BOLD

The external ID source that determines which external reference source is used to perform an external ID lookup.

RequestUserExternalIdstring required
Example:ABC123

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Request body

taxIdinteger nullable

The unique identifier for the Tax.

taxFilingStatusIdinteger nullable

The unique identifier for the selected Filing Status.

dependentsinteger nullable

The number of dependents to set up for this tax.

exemptionsinteger

The number of exemptions to set up for this tax.

AdditionalWithholdingnumber

A fixed amount of additional funds to withhold from the talent for this tax.

hasMultipleJobsboolean

An indication of whether this talent has multiple jobs.

qualifyingChildrennumber

A monetary amount associated with the number of qualifying children

otherDependentsnumber nullable

A monetary amount associated with the number of other dependents for the talent.

otherIncomenumber

The amount of the talent record's other income.

deductionsnumber

The amount of deductions for the talent.

Response

Talent tax detail created successfully.

employeeGuidstring uuid

The unique identifier for the Talent record, formatted as a UUID.

talentExternalIdinteger

The unique identifier for the Talent record in the external system, formatted as an integer.

employeeTaxGuidstring uuid nullable

The unique identifier for the Talent Tax record, formatted as a UUID. Null for federal W-4 tax records.

taxIdinteger nullable

The unique identifier for the Tax Record.

taxNamestring

The name of the tax record.

taxTypeIdinteger nullable

The unique identifier for the Tax Type record.

taxTypestring

The type of tax, either federal or state.

vertexTaxIdinteger nullable

The unique identifier for the Vertex Tax record.

taxFilingStatusIdinteger nullable

The unique identifier for the Tax Filing Status.

taxFilingStatusNamestring

The name of the tax filing status.

exemptionsinteger nullable

The number of exemptions configured for this tax.

dependentsinteger nullable

The number of dependents configured for this tax.

additionalWithholdingnumber

A fixed amount of additional funds to withhold from the talent paycheck for this tax.

fixedPercentagenumber nullable

A fixed percentage amount to use for calculating the amount withheld for this tax.

fixedAmountnumber nullable

A fixed amount to withhold for this tax.

activeboolean nullable

An indication of whether this tax is currently active.

isTaxExemptboolean

An indication of whether the talent is exempt from this tax.

nrCertboolean nullable

An indication of whether the talent has a non-resident certificate for this tax.

exemptionAmountnumber nullable

The exemption amount for this tax. This value is only used for Canadian taxes.

useDefaultExemptionAmountboolean nullable

An indication of whether the talent will use the default exemption amount or the amount configured in the exemptionAmount field. This value is only used for Canadian taxes.

prescribedZonenumber nullable

The prescribed zone for the tax record. Applicable only to Canadian taxes.

hasLockInLetterboolean

An indication of whether the talent has an IRS lock-in letter.

residentboolean nullable

An indication of whether the talent is a resident of the state associated with this tax.

nonResidentboolean nullable

An indication of whether the talent is a non-resident of the state associated with this tax.

officeDivisionstring

The name of the division associated with this tax setup.

federalW4Idinteger nullable

The unique identifier for the federal W-4 row. This value will be non-null if the current tax record is U.S. federal income tax.

hasMultipleJobsboolean nullable

An indication of whether this talent has multiple jobs.

qualifyingChildrennumber nullable

The monetary amount associated with the number of qualifying children.

otherDependentsnumber nullable

The monetary amount associated with the number of other dependents for the talent.

totalDependentsnumber nullable

The monetary amount representing the total number of dependents across all sources.

otherIncomenumber nullable

The amount of other income recorded for the talent.

deductionsnumber nullable

The amount of deductions for the talent.

firstWorkedDatestring date-time nullable

The date the talent first worked at the current supplier. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

usWithholdingTypestring

The withholding type for U.S. taxes, either nonresident alien or citizen.

dateCompletedstring date-time nullable

The date the federal W-4 form was submitted by the talent. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

dateEnteredstring date-time nullable

The date the talent tax row was entered into the Back Office database. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

stateCodestring

The state code associated with this tax record.

revisionYearnumber

The W4 revision year for this tax record.