Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Taxes

Get Talent Tax History

Returns tax history for the specified talent.

get/v3/talent/tax-history

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
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.

Response

Successfully retrieved talent tax history.

employeeGuidstring uuid

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

officeDivisionstring

The name of the division associated with the tax history data.

officestring

The name of the office associated with the tax history data.

officeIdinteger nullable

The identifier for the Office associated with the tax history data.

yearinteger

The check date’s year for the tax history data.

taxNamestring

The name of the tax.

taxCategory'Employee Portion' | 'Employer Portion'
subjectGrossnumber

The total amount of subject gross for this tax, grouped by talent, supplier, and year.

taxableGrossnumber nullable

The total amount of taxable gross for this tax, grouped by talent, supplier, and year.

taxAmountnumber nullable

The total amount of tax withheld for this tax, grouped by talent, supplier, and year.