--- title: "Add Federal W-4 2020" method: POST path: "/v2/talent/{talentId}/form-w4-2020" tags: ["Taxes"] --- # Add Federal W-4 2020 `POST /v2/talent/{talentId}/form-w4-2020` ## Request - Base URL: `https://api.avionte.com/talent` - URL: `https://api.avionte.com/talent/v2/talent/{talentId}/form-w4-2020` - Auth: API key in header `x-api-key` Initializes tax info from answers provided on the federal form W-4 2020. This is disallowed if the talent has existing tax configurations. ## Path parameters - `talentId` string, required ## Headers - `RequestId` string - `Tenant` string, required - `Authorization` string, required ## Request body - object - `Type` 'None' | 'Federal' | 'State' | 'Both', required: Form W-4 types available for selection. - `Federal` object: Details about the talent's federal Form W-4 2020. - `TaxFilingStatusId` 'None' | 'Single' | 'Married' | 'HeadOfHousehold' | 'MarriedFilingJointly' | 'SingleOrMarriedFilingSeparately': Form W-4 filing statuses available for selection. - `HasMultipleJobs` boolean: An indication of whether the talent has multiple jobs or not. - `QualifyingChildren` number: The number of qualifying children. - `OtherDependents` number: The number of other dependents. - `TotalDependents` number: A total number of dependents. - `OtherIncome` number: The amount from other income. - `Deductions` number: The amount of deductions. - `ExtraWithholding` number: Additional amount to be withheld. - `DateCompleted` string, date-time: The date when the form was completed. - `FirstWorkDate` string, date-time: The date of the first workday. - `IsTaxExempt` boolean: An indicator of whether the talent is exempt from withholding tax. - `StaffingSupplier` string, guid: The global unique identifier for staffing supplier. - `State` object[]: Details about the talent's state Form W-4. - `TaxFilingStatusId` 'None' | 'Single' | 'Married' | 'HeadOfHousehold' | 'MarriedFilingJointly' | 'SingleOrMarriedFilingSeparately': Form W-4 filing statuses available for selection. - `Exemptions` integer: The amount of exemptions. - `Dependents` integer: The number of dependents. - `AddWh` number: The amount of additional withholdings. - `IsTaxExempt` boolean: An indication of whether the talent is exempt from withholding tax. - `StateCode` string: The code of the state. ## Response `201` The talent. - object - `Id` integer: The identifier for the talent. - `ExternalId` string: An external ID for the talent. - `ExternalDb` string: The external system name referencing the talent by the external ID. - `FirstName` string: The talent's first name. - `MiddleName` string: The talent's middle name. - `LastName` string: The talent's last name. - `TaxIdNumber` string: The talent's Taxpayer Identification Number. May be either the US SSN or the Canadian SIN. - `Birthday` string, date-time: The talent's birthday. - `Gender` string: The talent's gender. - `Email` string: The talent's email. - `HomePhone` string: The talent's home phone number. - `CellPhone` string: The talent's cell phone number. - `SmsCarrier` string: SMS service provider. - `EmergencyPhone` string: The talent's emergency phone number. - `HireDate` string, date-time: The talent's date of hire, this is the start date of the first placement. - `ResidentAddress` object: The talent's home address. - `Id` integer: Identifier for the address. - `Street1` string: Street address, line 1. - `Street2` string: Street address, line 2. - `City` string: City. - `State` string: Province, state or region. - `PostalCode` string: Postal/ZIP code. - `County` string: County. - `Country` string: Country. - `MailingAddress` object: The talent's mailing address. - `Id` integer: Identifier for the address. - `Street1` string: Street address, line 1. - `Street2` string: Street address, line 2. - `City` string: City. - `State` string: Province, state or region. - `PostalCode` string: Postal/ZIP code. - `County` string: County. - `Country` string: Country. - `PayrollAddress` object: The talent's payroll mailing address. - `Id` integer: Identifier for the address. - `Street1` string: Street address, line 1. - `Street2` string: Street address, line 2. - `City` string: City. - `State` string: Province, state or region. - `PostalCode` string: Postal/ZIP code. - `County` string: County. - `Country` string: Country. - `PreviousAddresses` object[]: A list of the talent's previous addresses. - `Id` integer: Identifier for the address. - `Street1` string: Street address, line 1. - `Street2` string: Street address, line 2. - `City` string: City. - `State` string: Province, state or region. - `PostalCode` string: Postal/ZIP code. - `County` string: County. - `Country` string: Country. - `BranchId` string, guid: The identifier for the branch. - `BranchName` string: The name of the branch. - `Status` string: The talent's status. - `FilingStatus` 'None' | 'Single' | 'Married' | 'HeadOfHousehold' | 'MarriedFilingJointly' | 'SingleOrMarriedFilingSeparately': Form W-4 filing statuses available for selection. - `FederalAllowances` integer: Federal withholding exemptions. - `StateAllowances` integer: State withholding exemptions. - `AdditionalFederalWithholding` number: Additional amount of money that is withheld from the talent's each paycheck based on the talent's request. - `I9ValidatedDate` string, date-time: The date talent's I-9 document was verified. - `Skills` object[]: A list of talent's skills. - `SkillCode` string: The code for the skill. - `ValidatedDate` string, date-time: The date the skill was verified. - `Strength` string: A configurable skill level. - `Note` string: A commentary regarding the skill. - `Unit` number, double: The number of units of time the employee has exercised the skill. - `UnitType` string: The type of the unit. - `Competencies` object[]: A list of talent's competencies. - `Name` string: The name of the competency. - `Type` string: The type of the competency. - `SubType` string: The subtype of the competency. - `MonthsOfExperience` integer: Duration of professional experience in months. - `Weight` integer: A numerical indicator of proficiency of the specified competency. - `Proficiency` string: The level of proficiency of the specified competency. - `Requirements` object[]: A list of configurable requirements that need to be met for a talent record to be considered valid. - `Name` string: The name of the requirement. - `Value` string: The value of the requirement. It indicates whether the requirement has been met by the talent. - `ValueType` string: The type of the value to be fulfilled. - `Note` string: Commentary regarding the specific requirement. - `SortOrder` integer: The position of the requirement in relation to other requirements. Used if one requirement needs to be done before another. - `NumericValue` number, double: The numeric value for the requirement for a numeric ValueType. - `DateValue` string, date-time: The date value for the requirement for a Date ValueType. - `Qualifications` object[]: A list of talent's qualifications. - `Name` string: The name of the qualification. - `Weight` integer: A numerical indicator of proficiency of the specified qualification. - `ExternalReferences` object[]: A list of external references. - `ExternalSystemName` string: The name of an external system that needs to reference the talent. - `ExternalSystemId` string: The identifier for the talent in the external system. - `Certifications` object[]: A list of talent's certifications. - `CertificationType` string: The type of certification. - `IssuingAuthority` string: The entity that issued the certification. - `CertificationNumber` string: The certification number. - `IssueDate` string, date-time: The date the certification was issued. - `ExpirationDate` string, date-time: The date the certification expires. - `ValidatedDate` string, date-time: The date the certification was validated. - `W4` object: Form W-4 details. - `Type` 'None' | 'Federal' | 'State' | 'Both', required: Form W-4 types available for selection. - `Federal` object: Details about the talent's federal Form W-4 2020. - `TaxFilingStatusId` 'None' | 'Single' | 'Married' | 'HeadOfHousehold' | 'MarriedFilingJointly' | 'SingleOrMarriedFilingSeparately': Form W-4 filing statuses available for selection. - `HasMultipleJobs` boolean: An indication of whether the talent has multiple jobs or not. - `QualifyingChildren` number: The number of qualifying children. - `OtherDependents` number: The number of other dependents. - `TotalDependents` number: A total number of dependents. - `OtherIncome` number: The amount from other income. - `Deductions` number: The amount of deductions. - `ExtraWithholding` number: Additional amount to be withheld. - `DateCompleted` string, date-time: The date when the form was completed. - `FirstWorkDate` string, date-time: The date of the first workday. - `IsTaxExempt` boolean: An indicator of whether the talent is exempt from withholding tax. - `StaffingSupplier` string, guid: The global unique identifier for staffing supplier. - `State` object[]: Details about the talent's state Form W-4. - `TaxFilingStatusId` 'None' | 'Single' | 'Married' | 'HeadOfHousehold' | 'MarriedFilingJointly' | 'SingleOrMarriedFilingSeparately': Form W-4 filing statuses available for selection. - `Exemptions` integer: The amount of exemptions. - `Dependents` integer: The number of dependents. - `AddWh` number: The amount of additional withholdings. - `IsTaxExempt` boolean: An indication of whether the talent is exempt from withholding tax. - `StateCode` string: The code of the state. - `Interviews` object[]: A list of talent interview questions. - `Id` integer: The identifier for the interview question. - `Name` string: The name of the interview question. - `Question` string: The wording of the interview question. - `Answer` string: The talent's answer. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Access Denied - `406`: Unsupported format(s) indicated by Accept header - `409`: The talent's W4 has already been processed. - `415`: Unsupported format(s) indicated by the Content-Type header - `429`: Too many requests - `500`: An unexpected error occurred - `502`: The request could not be completed because an error occurred in an upstream service --- [API](https://skmtc.dev/avionte/apis/aviont-talent-api.md) - [All operations](https://skmtc.dev/avionte/apis/aviont-talent-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/aviont-talent-api/revisions/41cf396009af?raw)