v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Taxes

Get a List of Available Taxes

Returns a list of taxes available to set up for the talent record.

get/v3/talent/tax-options/tax

Query parameters

searchTermstring

A general-use string value representing a value to be searched for.

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.

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

taxIdinteger

The unique identifier for the Tax.

taxNamestring

The name of the tax.

geocodestring

A unique nine-digit number that corresponds to a specific locality.