Create Additional Talent Tax

post

https://api.avionte.com/bo-prod/v3/talent/additional-tax

Creates an additional tax for the talent record.

Query Params

talentGuid

uuid

The unique identifier of a Talent record, formatted as a UUID.

talentExternalId

string

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.

Body Params

taxId

int32 | null

The unique identifier for the Tax.

taxFilingStatusId

int32 | null

The unique identifier for the selected Filing Status.

dependents

int32 | null

The number of dependents to set up for this tax.

exemptions

int32

The number of exemptions to set up for this tax.

AdditionalWithholding

number

A fixed amount of additional funds to withhold from the talent for this tax.

hasMultipleJobs

boolean

An indication of whether this talent has multiple jobs.

qualifyingChildren

number

A monetary amount associated with the number of qualifying children

otherDependents

number | null

A monetary amount associated with the number of other dependents for the talent.

otherIncome

number

The amount of the talent record's other income.

deductions

number

The amount of deductions for the talent.

Headers

FrontOfficeTenantId

integer

required

An integer identifier for the tenant that the request is being made for.

RequestOrigin

string

required

length between 1 and 100

The string source name (such as application or function name) that indicates the origin of the request.

RequestId

uuid

required

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

ExternalIdSource

string

enum

required

The external ID source that determines which external reference source is used to perform an external ID lookup.

Allowed:

RequestUserExternalId

string

required

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.

Responses

405

Unsupported method

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

200Talent tax detail created successfully.

400Bad Request

402Additional subscription required.

403Access Denied

404Not found

409Duplicate conflict