v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Taxes

Get Talent Tax County

Returns the county setup for Indiana withholding.

get/v3/talent/tax-county

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.

yearinteger

A general-use integer value representing a year.

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 tax county details.

employeeTaxCountyIdinteger nullable

The unique identifier for the Talent Tax County Setup data.

yearinteger

The year associated with the tax county data.

residentCountyGeocodestring

The first five digits of the geocode that represents the selected county.

worksiteCountyGeocodestring

The first five digits of the geocode that represents the selected county.

residentCountyNamestring

The plain-text name of the resident county.

worksiteCountyNamestring

The plain-text name of the worksite county.