v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Taxes

Get a List of Available Tax Filing Statuses

Returns a list of available filing statuses for the specified tax.

get/v3/talent/tax-options/tax-filing-status

Query parameters

taxIdinteger

The unique identifier for a Tax record.

effectiveDatestring date-time

A general use datetime value representing a specific point in time, used to compare against a date range. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.

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 filing status options.

taxFilingStatusIdinteger

The unique identifier for the Tax Filing Status.

taxIdinteger

The unique identifier for the Tax record.

filingStatusNamestring

The name of the filing status.

defaultMaritalStatusinteger

The default marital status associated with this filing status.