latestOpenAPI 3.0.12026-07-243124341009.5 KB

846b33e4e71b

Taxes

Update Talent Tax

Updates the setup of the specified talent's tax record.

patch/v3/talent/update-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.

federalW4Idinteger

The unique identifier for a federal W-4 tax record.

employeeTaxGuidstring uuid

The unique identifier for a talent tax record, formatted as a UUID.

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

ArrayOfPatchOperations required— unresolved $ref

Response

Record modified successfully.