FormW2C

Create

Creates W2-C returns in TaxBandits. You can send multiple W2-C forms in a single request for the same Payer. In response, a SubmissionId is created which is further used as a reference for all other methods of Form W2C API

If a W-2 form was successfully processed by the SSA and you identify an error after the SSA accepted the file, you need to file a corrected form. Do not file the Original file again as this may result in duplicate reporting.

Information that can be corrected using our W-2 Correction Endpoints:

• Incorrect Employee Details (Name and TIN).
• Incorrect Amounts, Check Boxes, and Codes.
• The Form shouldn't have been filed (VOID).

If an error is discovered in reporting the Tax Year, Employer Name and/or EIN, you need to contact the SSA.

Key Points

• You can file a correction only if the SSA has Accepted the original form.
• TaxBandits supports correction for the forms originally filed with TaxBandits and also the forms that were filed elsewhere (Paper or Other Third-Party Software).
• If you are filing a correction for the forms originally filed with TaxBandits, retrieve the specific form SubmissionId and RecordId.
• Taxbandits currently does not support direct state filing for Form W-2 correction. After transmitting the forms, you can download the Form W-2c, Form W-3c and send it to the respective state DOR.
• If you want to correct employee's address alone, then you do not have to file Form W-2c to the SSA. Instead, Issue a new Form W-2 containing the correct address. Write “REISSUED STATEMENT” on the new employee copy.
• You can not correct the Employee Suffix alone using W-2c.
• You can not correct 14 Other value alone using W-2c.

POST FormW2C/Create

Request Body

Field	Type	Description
SubmissionManifest	object	SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsOnlineAccess service details.
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form W2-C to be filed. Allowed values: "2021"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form W2-C will be e-filed to the IRS.
IsPostal	Boolean	"Postal Order will be created when the value is set as True. Once the return is Transmitted, the W2-C Employee copies will be postal mailed to the Employee's address via USPS. Note: Postal Orders for Foreign Address will not be created.
IsOnlineAccess	Boolean	Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the employee. The Employee can provide consent and download the W2-C Employee copies on the portal.
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	Optional Name under which the business operates Size Range: ..75
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9
Email	string	Email address of the Business Size Range: ..40
ContactNm	string	Optional Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional Business title of the signing authority Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional Identifies the kind of payer. This field is Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..30
Country	string	Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object[]	Contains information about the Employee details and Form W2 C details.
Manifest	object	Collects the Record id, Sequence Id and Correction Type information
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
PrevReportedRecordId	Guid	If you are correcting a W2 that was originally filed with TaxBandits. Provide the Record ID of the original Form W2 here. The PrevReportedEmployee and PrevReportedW2FormData Objects are not required if you provide the PrevReportedRecordID
RecordId	Guid	This Record ID is for the W2-C. It will be generated and provide in the Response after you create the correction form.
IsEmployeeSSNNameCorrection	Boolean	When True, Identifies that you are correcting the SSN or Name of the employee.
PrevReportedEmployeeData	object	Enter the Employee information that was submitted in the Original Form W2-C. The information is not required if you have provided the PrevReportedRecordId.
EmployeeId	Guid	An unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to Update.
SSN	string	Employee's Social Security Number (SSN) Size Range: 9
FirstNm	string	Employee's first name.
MiddleNm	string	Optional Employee's middle name.
LastNm	string	Employee's last name.
Suffix	string	Optional Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
Email	string	Optional Employee's email address. Size Range: 0..40
Fax	string	Optional Employee's fax number. Size Range: 10
Phone	string	Optional Employee's phone number Size Range: 10
IsForeign	Boolean	When true, identifies the employee address with a foreign address.
USAddress	object	Object to identify the employee's US address
Address1	string	Employee's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Employee's suite or apartment Size Range: ..35
City	string	Employee's city Size Range: ..27
State	string	Employee's State code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employee's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the employee
Address1	string	Employee's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employee's suite or apartment Size Range: ..35
City	string	Employee's city. Size Range: ..27
ProvinceOrStateNm	string	Employee's Province or State Name. Size Range: ..30
Country	string	Employee's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employee's Postal Code
CorrectedEmployeeData	object	Enter the corrected Employee Name and SSN value. This Object is required, when the IsEmployeeSSNNameCorrection is true. The object should be "null", when the IsEmployeeSSNNameCorrection is false.
FirstNm	string	Corrected Employee's first name.
MiddleNm	string	Optional Corrected Employee's middle name.
LastNm	string	Corrected Employee's last name.
Suffix	string	Optional Corrected Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PrevReportedW2FormData	object	Employee's previously reported Form W-2 information.
B1Wages	number	Enter the previously reported total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Enter the previously reported total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Enter the previously reported total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Enter the previously reported total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Enter the previously reported amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Enter the previously reported amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Enter the previously reported tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Enter the previously reported tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Enter the previously reported total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Enter the previously reported amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Enter the previously reported amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Enter the amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Enter the amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Enter the amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Enter the amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Enter the Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Enter the Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Enter the Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Enter the Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Enter any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.
CorrectedW2FormData	object	Employee's corrected Form W-2 information
B1Wages	number	Enter the corrected total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Enter the corrected total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Enter the corrected total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Enter the corrected total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Enter the corrected amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Enter the corrected amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Enter the corrected tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Enter the corrected tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Enter the corrected total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Enter the corrected amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Enter the corrected amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Enter the corrected amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Enter the corrected amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Enter the corrected amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Enter the corrected amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Enter the corrected Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Enter the corrected Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Enter the corrected Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Enter the corrected Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Enter any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a Business.
FormW2cRecords	object	Pulls Form W2-C records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2 C Records
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
PrevReportedRecordId	Guid	Record ID of the original Form W2-C which is given while creating Form W2.
RecordId	Guid	An unique identifier generated by TaxBandits when a W2-C return is created.
EmployeeId	Guid	An unique identifier generated by TaxBandits for a Employee when a W2-C return is created. You can use this id for your future reference to Update.
FederalReturn	object	Returns the record status and StatusTs of federal return.
Status	string	Returns the record status.
StatusTs	string	Returns date and time of return created.
Info	string	Returns information about the Federal Filing service.
StateReturns	object[]	Returns collection of state returns information
StateCd	string	Returns the state code of the state for which the return is filed.
Status	string	Returns the record status of the state return.
StatusTs	string	Date and time of the return created.
Info	string	Returns the information about the state for which we are not supporting state filing.
Errors	object[]	Shows error information of state returns of Form W2 C
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Postal	object	Returns the status and StatusTs of postal mailing service for Form W2-C.
Status	string	Returns the status of postal order.
StatusTs	string	Returns the date and time of the postal order created.
Info	string	Returns the information about Postal mailing service.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns status of online access for Form W2 C return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2-C Records.
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	Unique identifier of a record
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

{
 "SubmissionManifest": {
   "SubmissionId": null,
   "TaxYear": "2021",
   "IsFederalFiling": true,
   "IsPostal": true,
   "IsOnlineAccess": true
 },
 "ReturnHeader": {
   "Business": {
     "BusinessId": null,
     "BusinessNm": "Brian LLC",
     "TradeNm": "Brian Corporate Services",
     "IsEIN": true,
     "EINorSSN": "997771111",
     "Email": "test@gmail.com",
     "ContactNm": "Brian O Relly",
     "Phone": "1234447890",
     "PhoneExtn": "12345",
     "Fax": "4567893120",
     "BusinessType": "ESTE",
     "SigningAuthority": {
       "Name": "Altof",
       "Phone": "1234578960",
       "BusinessMemberType": "ADMINISTRATOR"
     },
     "KindOfEmployer": "FEDERALGOVT",
     "KindOfPayer": "REGULAR941",
     "IsBusinessTerminated": true,
     "IsForeign": false,
     "USAddress": {
       "Address1": "1751 Kinsey Rd",
       "Address2": "Main St",
       "City": "Dothan",
       "State": "AL",
       "ZipCd": "36303"
     },
     "ForeignAddress": {
       "Address1": null,
       "Address2": null,
       "City": null,
       "ProvinceOrStateNm": null,
       "Country": null,
       "PostalCd": null
     }
   }
 },
 "ReturnData": [
   {
     "Manifest": {
       "SequenceId": "001",
       "PrevReportedRecordId": null,
       "RecordId": null,
       "IsEmployeeSSNNameCorrection": true
     },
     "PrevReportedEmployeeData": {
       "SSN": "112-23-6003",
       "FirstNm": "Michael",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr",
       "Email": "test@gmail.com",
       "Fax": "4567891234",
       "Phone": "4259631478",
       "IsForeign": false,
       "USAddress": {
         "Address1": "1751 Kinsey Rd",
         "Address2": "Main St",
         "City": "Dothan",
         "State": "AL",
         "ZipCd": "36303"
       },
       "ForeignAddress": {
         "Address1": null,
         "Address2": null,
         "City": null,
         "ProvinceOrStateNm": null,
         "Country": null,
         "PostalCd": null
       }
     },
     "CorrectedEmployeeData": {
       "SSN": "112-23-6003",
       "FirstNm": "George",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr"
     },
     "PrevReportedW2FormData": {
       "B1Wages": 50000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     },
     "CorrectedW2FormData": {
       "B1Wages": 55000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     }
   }
 ]
}

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "f763c84f-aca7-4a86-9360-ef40c594dcc6",
   "BusinessId": "c38459b3-abbe-40ca-a4a2-ff6e3eea7795",
   "FormW2cRecords": {
       "SuccessRecords": [
           {
               "SequenceId": "001",
               "PrevReportedRecordId": null,
               "RecordId": "9795cba6-06b7-4cba-b74b-b3a3098343ce",
               "EmployeeId": "abedf4be-4b9c-4912-aae4-c6d70311f4a0",
               "FederalReturn": {
                   "Status": "CREATED",
                   "StatusTs": "2021-01-11 20:23:11 +05:30",
                   "Info": null
               },
               "StateReturns": [
                   {
                       "StateCd": "PA",
                       "Status": "NA",
                       "StatusTs": null,
                       "Info": "We do not support State filing corrections. It is your responsibility to file to the state, if there are any state specific information to be corrected.",
                       "Errors": null
                   },
                   {
                       "StateCd": "AZ",
                       "Status": "NA",
                       "StatusTs": null,
                       "Info": "We do not support State filing corrections. It is your responsibility to file to the state, if there are any state specific information to be corrected.",
                       "Errors": null
                   }
               ],
               "Postal": {
                   "Status": "CREATED",
                   "StatusTs": "2021-01-11 20:23:23 +05:30",
                   "Info": null
               },
               "OnlineAccess": {
                   "Status": "CREATED",
                   "Email": "john@gmail.com",
                   "Info": null
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}

Delete

Delete API Endpoint, as the name suggests, is used to delete the Tax Return that was created. Once the return is transmitted, the tax return can not be deleted.

DELETE FormW2C/Delete

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a W2C return is created. Mention the W2C return's Record ID that you want to delete.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
FormW2CRecords	object	Pulls the Form W-2C records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2C Records
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	Unique identifier of a record
Status	string	Returns the status of the records.
StatusTs	string	Date and time of return deleted.
StateReturns	object[]	Returns the state code and return status.
StateCode	string	Returns the code of the state.
RecordStatus	string	Returns the status of the records.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2C Records.
RecordId	Guid	Unique identifier of a record
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

FormW2C/Delete?SubmissionId=3cf6c6a3-2e91-4906-8f90-4bcc1b0c5465&RecordIds=212a2a80-f74a-4af9-b034-782e8650fe37,50013b2d-01ff-41b1-b08b-dbf8940a8a7c

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "3cf6c6a3-2e91-4906-8f90-4bcc1b0c5465",
   "FormW2CRecords": {
       "SuccessRecords": [
           {
               "SequenceId": "1",
               "RecordId": "212a2a80-f74a-4af9-b034-782e8650fe37",
               "Status": "DELETED",
               "StatusTs": "2019-08-05 09:53:23 -04:00",
               "StateReturns": null
           },
           {
               "SequenceId": "1",
               "RecordId": "50013b2d-01ff-41b1-b08b-dbf8940a8a7c",
               "Status": "DELETED",
               "StatusTs": "2019-08-05 09:53:23 -04:00",
               "StateReturns": null
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}

Get

Retrieves the W-2 Correction return information based on the Submission ID given in the request.

GET FormW2C/Get

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a W2C return is created. Mention the W2C return's Record ID that you want to fetch data.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message.
FormW2CRecords	object	Pulls the submission and record details.
SubmissionManifest	object	SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsOnlineAccess service details.
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form W2-C to be filed. Allowed values: "2021"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form W2-C will be e-filed to the IRS.
IsPostal	Boolean	"Postal Order will be created when the value is set as True. Once the return is Transmitted, the W2-C Employee copies will be postal mailed to the Employee's address via USPS. Note: Postal Orders for Foreign Address will not be created.
IsOnlineAccess	Boolean	Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the employee. The Employee can provide consent and download the W2-C Employee copies on the portal.
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	Optional Name under which the business operates Size Range: ..75
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9
Email	string	Email address of the Business Size Range: ..40
ContactNm	string	Optional Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional Business title of the signing authority Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional Identifies the kind of payer. This field is Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..30
Country	string	Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object[]	Contains information about the Employee details and Form W2 C details.
Manifest	object	Collects the Record id, Sequence Id and Correction Type information
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
PrevReportedRecordId	Guid	If you are correcting a W2 that was originally filed with TaxBandits. Provide the Record ID of the original Form W2 here. The PrevReportedEmployee and PrevReportedW2FormData Objects are not required if you provide the PrevReportedRecordID
RecordId	Guid	This Record ID is for the W2-C. It will be generated and provide in the Response after you create the correction form.
IsEmployeeSSNNameCorrection	Boolean	When True, Identifies that you are correcting the SSN or Name of the employee.
PrevReportedEmployeeData	object	Enter the Employee information that was submitted in the Original Form W2-C. The information is not required if you have provided the PrevReportedRecordId.
EmployeeId	Guid	An unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to Update.
SSN	string	Employee's Social Security Number (SSN) Size Range: 9
FirstNm	string	Employee's first name.
MiddleNm	string	Optional Employee's middle name.
LastNm	string	Employee's last name.
Suffix	string	Optional Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
Email	string	Optional Employee's email address. Size Range: 0..40
Fax	string	Optional Employee's fax number. Size Range: 10
Phone	string	Optional Employee's phone number Size Range: 10
IsForeign	Boolean	When true, identifies the employee address with a foreign address.
USAddress	object	Object to identify the employee's US address
Address1	string	Employee's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Employee's suite or apartment Size Range: ..35
City	string	Employee's city Size Range: ..27
State	string	Employee's State code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employee's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the employee
Address1	string	Employee's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employee's suite or apartment Size Range: ..35
City	string	Employee's city. Size Range: ..27
ProvinceOrStateNm	string	Employee's Province or State Name. Size Range: ..30
Country	string	Employee's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employee's Postal Code
CorrectedEmployeeData	object	Enter the corrected Employee Name and SSN value. This Object is required, when the IsEmployeeSSNNameCorrection is true. The object should be "null", when the IsEmployeeSSNNameCorrection is false.
FirstNm	string	Corrected Employee's first name.
MiddleNm	string	Optional Corrected Employee's middle name.
LastNm	string	Corrected Employee's last name.
Suffix	string	Optional Corrected Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PrevReportedW2FormData	object	Employee's previously reported Form W-2 information.
B1Wages	number	Gets the previously reported total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Gets the previously reported total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Gets the previously reported total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Gets the previously reported total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Gets the previously reported amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Gets the previously reported amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Gets the previously reported tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Gets the previously reported tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Gets the previously reported total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Gets the previously reported amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Gets the previously reported amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Gets the amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Gets the amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Gets the amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Gets the amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Gets the Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Gets the Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Gets the Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Gets the Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Gets any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.
CorrectedW2FormData	object	Employee's corrected Form W-2 information
B1Wages	number	Gets the corrected total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Gets the corrected total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Gets the corrected total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Gets the corrected total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Gets the corrected amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Gets the corrected amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Gets the corrected tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Gets the corrected tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Enter the corrected total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Gets the corrected amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Gets the corrected amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Gets the corrected amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Gets the corrected amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Gets the corrected amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Gets the corrected amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Gets the corrected Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Gets the corrected Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Gets the corrected Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Gets the corrected Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Gets any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

FormW2C/Get?SubmissionId=d1f9cb0a-912f-4105-8bcf-059af43d2b31&RecordIds=63842ea1-93ac-4e5f-a3b2-df59c2d147c5

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "FormW2CRecords": {
       "SubmissionManifest": {
           "SubmissionId": "4cff2037-1b19-41c9-88c5-09227435c720",
           "TaxYear": "2021",
           "IsFederalFiling": true,
           "IsPostal": false,
           "IsOnlineAccess": true
       },
       "ReturnHeader": {
           "Business": {
               "BusinessId": "5c1262a2-1365-45c2-9cb5-47dca2e95148",
               "BusinessNm": "Brian LLC",
               "TradeNm": "Brian Corporate Services",
               "IsEIN": true,
               "EINorSSN": "99-1111211",
               "Email": "brianscott@gmail.com",
               "ContactNm": "Brian O Relly",
               "Phone": "(123) 444-7890",
               "PhoneExtn": "12345",
               "Fax": "(456) 789-3120",
               "BusinessType": "ESTE",
               "SigningAuthority": {
                   "Name": "Altof",
                   "Phone": "(123) 457-8960",
                   "BusinessMemberType": "ADMINISTRATOR"
               },
               "KindOfEmployer": "FEDERALGOVT",
               "KindOfPayer": "REGULAR941",
               "IsBusinessTerminated": true,
               "IsForeign": false,
               "USAddress": {
                   "Address1": "1751 Kinsey Rd",
                   "Address2": "Main St",
                   "City": "Dothan",
                   "State": "AL",
                   "ZipCd": "36303"
               },
               "ForeignAddress": null
           }
       },
 "ReturnData": [
   {
     "Manifest": {
       "SequenceId": "001",
       "PrevReportedRecordId": null,
       "RecordId": "c8c563b5-41bc-4e14-a920-c4932a09e455",
       "IsEmployeeSSNNameCorrection": false
     },
     "PrevReportedEmployeeData": {
       "SSN": "112-23-6003",
       "FirstNm": "Michael",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr",
       "Email": "test@gmail.com",
       "Fax": "4567891234",
       "Phone": "4259631478",
       "IsForeign": false,
       "USAddress": {
         "Address1": "1751 Kinsey Rd",
         "Address2": "Main St",
         "City": "Dothan",
         "State": "AL",
         "ZipCd": "36303"
       },
       "ForeignAddress": {
         "Address1": null,
         "Address2": null,
         "City": null,
         "ProvinceOrStateNm": null,
         "Country": null,
         "PostalCd": null
       }
     },
     "CorrectedEmployeeData": {
       "SSN": "112-23-6003",
       "FirstNm": "Michael",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr"
     },
     "PrevReportedW2FormData": {
       "B1Wages": 50000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     },
     "CorrectedW2FormData": {
       "B1Wages": 50000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     }
   }
 ]
   },
   "Errors": null
}

GetPDF

TaxBandits provides PDF copies of the tax Return using this API Endpoint. The PDFs can be used for any additional review and approval from your business’ side and it can be distributed to the Employees before the SSA accepts them.

GET FormW2C/GetPDF

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	Optional Unique identifier of a records.
TINMaskType	string	Optional Choose the masking type of your Employee's SSN on the W-2C PDF. MASKED - The Employee's SSN will be masked in the PDF. Only last 4 digits of the SSN can be read. UNMASKED - The Employee's SSN will not be masked in the PDF. To protect the PII information of the Employee, the PDF with Unmasked SSN is password protected. Use the Employee's SSN (password) to open the protected file. BOTH - Two PDF's will be delivered for each Employee. One with Masked SSN and the other with Unmasked SSN. The PDF with Unmasked SSN will be password protected. Allowed values: "MASKED", "UNMASKED", "BOTH"

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
FormW2CRecords	object[]	Collection of Form W-2C records for which the PDF will be successfully delivered
RecordId	guid	Unique identifier of a record
Message	string	Provides additional information regarding the PDF delivery.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

FormW2C/GetPDF?SubmissionId=000e9b21-c0fd-421c-867e-93ef54d37b33&RecordIds=f03875e4-e6b5-4cf4-828e-8ca026f0e5e0&TINMaskType=UNMASKED

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "000e9b21-c0fd-421c-867e-93ef54d37b33",
 "FormW2CRecords": [
   {
     "RecordId": "f03875e4-e6b5-4cf4-828e-8ca026f0e5e0",
     "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
   }
 ],
 "Errors": null
}

List

LIST endpoint lets you list the basic details of all the returns irrespective of their record status. List can be customized by sending values corresponding to its optional parameters, which gets applied as filters to the list.

GET FormW2C/List

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a business
EIN	string	Employer Identification Number
TaxYear	string	List the W2C records based on the given taxyear.
Page	number	Pulls the records listed in the page selected
PageSize	number	Number of W-2C records to be listed in each page
EfileStatus	string	List the W-2C records based on the status ("CREATED, UNDERPROCESS, TRANSMITTED, ACCEPTED, REJECTED")
FromDate	string	List W-2C records created from
ToDate	string	List W-2C records created up to

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message.
FormW2CRecords	object[]	Returns detailed information of the Form W-2C records
SubmissionId	guid	Unique identifier of a submission
BusinessId	guid	Unique identifier of a business
BusinessNm	string	Name of the business
EINorSSN	string	Employer Identification Number or Social Security Number
ContactName	string	Name of the person who can be contacted by the IRS.
TaxYear	string	Tax year of W-2Cs to be filed.
Employee	object	Returns the employee details.
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	An unique identifier generated by TaxBandits when a W2C return is created.
EmployeeId	Guid	An unique identifier generated by TaxBandits for a employee when a W2C return is created. You can use this id for your future reference to Update.
EmployeeName	Boolean	Name of the employee.
SSN	string	SSN of the employee.
Status	string	The status of Form W2.
TotalRecords	number	Total number of records listed in the response.
TotalPages	number	Total number of pages
Page	number	Returns the page number in which the records are listed
PageSize	number	Number of records listed in each page.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

FormW2C/List?SubmissionId=08a8d549-2d78-4feb-b18d-f4aded533ab3&BusinessId=5607b044-6809-4399-9645-d20d761b5dcb&EIN=441111211&TaxYear=2021&Page=1&PageSize=10&EfileStatus=ALL&FromDate=11-01-2021&ToDate=11-30-2021

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "FormW2CRecords": [
       {
           "SubmissionId": "08a8d549-2d78-4feb-b18d-f4aded533ab3",
           "BusinessId": "5607b044-6809-4399-9645-d20d761b5dcb",
           "BusinessNm": "Brian LLC",
           "EIN": "44-1111211",
           "ContactName": "Brian O Relly",
           "TaxYear": "2021",
           "Employee": {
               "SequenceId": "001",
               "RecordId": "ae53c621-ea01-4cb5-9e4e-a96987a4eeb1",
               "EmployeeId": "8957652a-7877-4db8-80a5-b555e44c7354",
               "EmployeeName": "Michael John Augustin",
               "SSN": "112-23-6003",
               "Status": "CREATED"
           }
       }
   ],
   "TotalRecords": 1,
   "TotalPages": 1,
   "Page": 1,
   "PageSize": 100,
   "Errors": null
}

RequestDraftPdfUrl

The response of the API request will return the Draft PDF for review purpose.This method can be used to retrieve PDF for a single record/form.

The PDF will be returned in the response for the Forms that are not yet Transmitted in TaxBandits.

This method will only provide the Copy A of the Form W2C and it will have a watermark "For Review only" on it.

How does it work?

1. The first step is to call the Auth method to get the access token. This access token must be supplied in the request header as the 'Bearer' token. Refer to OAuth 2.0 Authentication for more information on JWT authentication and how to integrate with the subsequent requests.

2. The second step is to call the Create endpoint FormW2C/Create to create a return in TaxBandits. Store the RecordId of the W2C form that is generated by TaxBandits and returned in the Response.

3. Next, call the [POST] FormW2C/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:

   • Access Token in the header as Bearer Token (Generated using TaxBandits OAuth Authentication API)

   • Form reference (RecordId) - Specify the RecordId for the form you need the Draft PDF form. If you do not have the RecordId, then you request the PDF using the following parameters

     • Business Reference - Use the business reference PayerRef or Businessid or TIN
     • Employee Reference - Use the employee reference PayeeRef or EmployeeId or TIN
     • Tax Year - Tax year of the form you are requesting the PDF for.

POST FormW2C/RequestDraftPdfUrl

Request Body

Field	Type	Description
RecordId	Guid	Optional Specify the RecordId of the return
TINMaskType	string	Optional TIN Mask type on the TIN printed on the PDF Allowed values: "MASKED", "UNMASKED"
TaxYear	string	Optional Tax Year of the return. Specify only if you do not have the RecordId
Business	object	Optional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId
BusinessId	Guid	Optional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint.
PayerRef	string	Optional Unique payer identifier assigned by the client. Size Range: 1 to 50
EIN	string	Optional Employer Identification Number. Use this as an alternative for BusinessId or PayerRef. Size Range: 9 to 11
Employee	object	Optional Collects the employee's unique identifier. This object information is required only if you do not have the RecordId
EmployeeId	Guid	Optional Unique Employee Identifier generated by TaxBandits
SSN	string	Optional Social Security Number. Use this as an alternative for EmployeeIds. Size Range: 9 to 11

Response Body

Field	Type	Description
RecordId	Guid	Unique identifier of the record
EmployeeId	Guid	Unique Employee Identifier generated by TaxBandits
DraftPdfUrl	string	URL of the Draft PDF
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error code
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON 1: With just the RecordId

{
 "TaxYear": null,
 "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
 "TINMaskType":"Masked",
 "Business": null,
 "Employee": null
}

Response JSON 1

{
   "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
   "EmployeeId": "bd2221f7-4be6-4cc7-813c-6346e23b9f63",
   "DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/a570efbd-740f-4ae2-bfe7-26356cd85148/3e99f728-e9d4-4d88-99b6-e00638da7a5b/W-2c/221556/dcopy_tbs_wm_1up_221556.pdf",
   "Error": null
}

Request JSON 2: With just the RecordId

{
 "TaxYear": "2021",
 "RecordId": null,
 "TINMaskType":"Unmasked",
 "Business": {
   "BusinessId": "94B6214D-8DCA-490C-8FC3-602840B439B5",
   "PayerRef": null,
   "EIN": null
 },
 "Employee": {
   "EmployeeId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
   "SSN": null
 }
}

Response JSON 2

{
   "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
   "EmployeeId": "bd2221f7-4be6-4cc7-813c-6346e23b9f63",
   "DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/a570efbd-740f-4ae2-bfe7-26356cd85148/3e99f728-e9d4-4d88-99b6-e00638da7a5b/W-2/221556/d/copy_tbs_wm_1up_221556.pdf",
   "Error": null
}

RequestPdfURLs

This method can be used to retrieve PDFs for single or multiple recipients. The PDF URL will be returned in the response only if it is already generated by us. You can use the SubmissionId or RecordIds to request the pdf URLs.

Note: The PDF URL will be returned in response only after the return is transmitted in the API. This method will not work for Inprogress returns.

How does it work?

1. The first step is to call the Auth method to get the access token. This access token must be supplied in the request header as the 'Bearer' token. Refer to OAuth 2.0 Authentication for more information on JWT authentication and how to integrate with the subsequent requests.

2. The second step is to call the Create call for the particular Form endpoint and then call the Transmit call. Once the return is in Transmitted status, you can call this method to get the PDF.

3. Next, call the [POST] FormW2C/RequestPDFURLs endpoint. You will need to supply the following parameters:

   • Access Token in the header as Bearer Token (Generated using TaxBandits OAuth Authentication API)

   • Form reference (SubmissionId or RecordIds) - You can either request all the PDFs for a submission or specify RecordIs (Across submissions) of the forms you need the PDF.

   • TINMaskType - Mention whether you want the TIN (SSN) to be masked in the PDF. Only the last digits of the SSN will be visible and the rest of the digits will be crossed (xxx-xx-1234). The values for this node are,

     • Masked
     • Unmasked
     • Both (Both Masked and Unmasked copies will be returned in the URL)

POST FormW2C/RequestPdfURLs

Request Body

Field	Type	Description
SubmissionId	Guid	Optional Unique identifier of an API submission. Use this node to request the PDFs under a particular submission. If you are going to request the PDFs using the RecordIds, you can leave the SubmissionId blank or null.
RecordIds	object[]	Specify the list of RecordIds under this Array
RecordId	Guid	Unique identifier of the return.
Customization	object	Includes PDF customizations
TINMaskType	string	Optional Mention whether you want the TIN to be masked in the PDF. If masked, only the last digits of the SSN will be visible and the rest of the digits will be crossed (xxx-xx-1234). Allowed values: "MASKED", "UNMASKED", "BOTH"

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
FormW2CRecords	object	Contains PDF URLs of the forms requested in the API request.
SuccessRecords	object[]	Shows the successful records for the given submission request.
RecordId	Guid	Unique identifier of the return.
Status	string	Status of the PDF in TaxBandits. Success - The PDF is generated and you can download it.
Files	object	Contains multiple copies of a particular return.
Copy1	object	Copy 1: For State, City, or Local Tax Department
Unmasked	string	Link to download the Unmasked copy
Masked	string	Link to download the Masked copy
Copy2	object	Copy 2: To Be Filed With Employee's State, City, or Local Income Tax Return
Unmasked	string	Link to download the Unmasked copy
Masked	string	Link to download the Masked copy
CopyB	object	Copy B: To Be Filed With Employee's FEDERAL Tax Return.
Unmasked	string	Link to download the Unmasked copy
Masked	string	Link to download the Masked copy
CopyC	object	Copy C: For EMPLOYEE'S RECORDS
Unmasked	string	Link to download the Unmasked copy
Masked	string	Link to download the Masked copy
CopyD	object	Copy D: For Employer
Unmasked	string	Link to download the Unmasked copy
Masked	string	Link to download the Masked copy
ErrorRecords	object[]	Contains records that are errored
RecordId	Guid	Unique identification of the record.
Status	string	Status of the error record. PDF_Not_Generated - PDF is yet to be generated. You will have to wait and send a new API request to get the PDF. Not Transmitted - The return is not transmitted yet. Invalid RecordId - Given record id is invalid
Message	string	Description of each statuses
Errors	object[]	Lists the errors in the API call
Id	string	Returns the error Id.
Name	string	Name of the validation error
Message	string	Gives the detailed status message.

Sample Request JSON 1

{
  "SubmissionId": "03f83fe9-05ca-41f0-86c3-00d073528712",
  "RecordIds": [
    {
      "RecordId": "2388983e-0215-4c99-8033-951dee1ccfef"
    }
  ],
  "Customization": {
    "TINMaskType": "Masked"
  }
}

Sample Response JSON 1

{
   "SubmissionId": "03f83fe9-05ca-41f0-86c3-00d073528712",
   "FormW2CRecords": {
       "SuccessRecords": [
           {
               "RecordId": "2388983e-0215-4c99-8033-951dee1ccfef",
               "Status": "Success",
               "Files": {
                   "Copy1": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15-b887-4d64-a50f-444ab16f50d0/d59cd157-4a07-4832-9390-2704a65de1b8/w2c/7d42c237-01ae-442f-b669-69ac174f50ab/m/copy1_1up_5989647027.pdf"
                   },
                   "Copy2": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15-b887-4d64-a50f-444ab16f50d0/d59cd157-4a07-4832-9390-2704a65de1b8/w2c/7d42c237-01ae-442f-b669-69ac174f50ab/m/copy2_1up_9886910187.pdf"
                   },
                   "CopyB": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15-b887-4d64-a50f-444ab16f50d0/d59cd157-4a07-4832-9390-2704a65de1b8/w2c/7d42c237-01ae-442f-b669-69ac174f50ab/m/copyb_1up_8292618360.pdf"
                   },
                   "CopyC": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15-b887-4d64-a50f-444ab16f50d0/d59cd157-4a07-4832-9390-2704a65de1b8/w2c/7d42c237-01ae-442f-b669-69ac174f50ab/m/copyc_1up_2897463954.pdf"
                   },
                   "CopyD": {
                       "Unmasked": null,
                       "Masked": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/769e7c15-b887-4d64-a50f-444ab16f50d0/d59cd157-4a07-4832-9390-2704a65de1b8/w2c/7d42c237-01ae-442f-b669-69ac174f50ab/m/copyd_1up_4876050156.pdf"
                   }
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}

Sample Request JSON 2

{
 "SubmissionId": "a863c015-91f1-4128-84fc-bb38922b80f9",
 "RecordIds": [
   {
     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
   },
   {
     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
   }
 ],
 "Customization": {
   "TINMaskType": "Masked"
 }
}

Sample Response JSON 2

{
   "SubmissionId": null,
   "FormW2CRecords": {
       "SuccessRecords": null,
       "ErrorRecords": [
           {
               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
               "Status": "PDF_Not_Generated",
               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
           },
           {
               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
               "Status": "Not Transmitted",
               "Message": "Given RecordId is not transmitted"
           }
       ]
   },
   "Errors": null
}

Sample Request JSON 3

{
   "RecordIds": [
   {
     "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267"
   },
   {
     "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e"
   }
 ]

}

Sample Response JSON 3

{
   "SubmissionId": null,
   "FormW2CRecords": {
       "SuccessRecords": null,
       "ErrorRecords": [
           {
               "RecordId": "c4446e74-ee11-43e4-b9db-a7e870714267",
               "Status": "PDF_Not_Generated",
               "Message": "Your PDF request is prioritized in the queue.Please try again after sometime"
           },
           {
               "RecordId": "f11413f7-3fe3-4d55-9e87-66b687bc404e",
               "Status": "Not Transmitted",
               "Message": "Given RecordId is not transmitted"
           }
       ]
   },
   "Errors": null
}

Status

Status endpoint is used to get the current status of the Tax Return on-demand. It requires Submission ID as a parameter and Record IDs as an optional parameter.

GET FormW2C/Status

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission
RecordIds	Guid[]	Number of record Ids to get status.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a Business.
FormW2CRecords	object	Pulls the Form W-2C records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2C Records
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	An unique identifier generated by TaxBandits when a W2C return is created.
EmployeeId	Guid	An unique identifier generated by TaxBandits for a employee when a W2C return is created. You can use this id for your future reference to Update.
FederalReturn	object	Returns the record status and StatusTs of federal return.
Status	string	Returns the record status.
StatusTs	string	Returns date and time of return created.
Info	string	Returns information about the Federal Filing service.
StateReturns	object[]	Returns collection of state returns information
StateCd	string	Returns the state code of the state for which the return is filed.
Status	string	Returns the record status of the state return.
StatusTs	string	Date and time of the return created.
Info	string	Returns the information about the state for which we are not supporting state filing.
Errors	object[]	Shows error information of state returns of Form W2C
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Postal	object	Returns the status and StatusTs of postal mailing service for Form W2C.
Status	string	Returns the status of postal order.
StatusTs	string	Returns the date and time of the postal order created.
Info	string	Returns the information about Postal mailing service.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns the Status of the Online Access.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2C Records.
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	Unique identifier of a record
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

FormW2C/Status?SubmissionId=d1f9cb0a-912f-4105-8bcf-059af43d2b31&RecordIds=63842ea1-93ac-4e5f-a3b2-df59c2d147c5

Response JSON

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "d1f9cb0a-912f-4105-8bcf-059af43d2b31",
  "BusinessId": "62ac9c76-4fa8-4459-8a7d-e9763862d5fa",
  "FormW2CRecords": {
      "SuccessRecords": [
          {
              "SequenceId": "001",
              "RecordId": "63842ea1-93ac-4e5f-a3b2-df59c2d147c5",
              "EmployeeId": "ad035610-bfc0-494b-a3f0-5eeaf51408ec",
              "FederalReturn": {
                  "Status": "CREATED",
                  "StatusTs": "2021-01-11 15:02:51 +05:30",
                  "Info": null
              },
              "StateReturns": [
                  {
                      "StateCd": "DE",
                      "Status": "CREATED",
                      "StatusTs": "2021-01-11 15:02:51 +05:30",
                      "Info": null,
                      "Errors": null
                  },
                  {
                      "StateCd": "SC",
                      "Status": "CREATED",
                      "StatusTs": "2021-01-11 15:02:51 +05:30",
                      "Info": null,
                      "Errors": null
                  }
              ],
              "Postal": {
                  "Status": "NOTCREATED",
                  "StatusTs": null,
                  "Info": "Postal Alert cannot be opted for the return, when the employee (or) business has foreign address"
              },
               "OnlineAccess": {
                   "Status": "CREATED",
                   "Email": "john@gmail.com",
                   "Info": null
               }
          }
      ],
      "ErrorRecords": null
  },
  "Errors": null
}

Transmit

Transmit API Endpoint is used to “E-File” the Tax return with the SSA/State Agencies. This endpoint applies the same data validation checks and business rules as CREATE and VALIDATE endpoints. This endpoint can not be called without calling the CREATE endpoint as this endpoint will not create the Tax Return. Once “Transmitted”, based on the options selected, the tax return will be E-Filed with the Federal and/or state agencies and also will be postal mailed to the employees.

POST FormW2C/Transmit

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a W2C return is created. Mention the W2C return's Record ID that you want to transmit.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
FormW2CRecords	object	Pulls the Form W-2C records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2 Records
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	Unique identifier of a record
Status	string	Returns the status of the records.
StatusTs	string	Date and time of return created.
StateReturns	object[]	Returns the state code and return status.
StateCode	string	Returns the code of the state.
RecordStatus	string	Returns the status of the records.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns status of online access for Form W2 correction return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2C Records.
RecordId	Guid	Unique identifier of a record
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RejectedBy	string	Returns the information of who rejected the return.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

{
 "SubmissionId": "f6683d71-448c-4a69-aa17-e58c6ef085ab",
 "RecordIds": [
   "a4718eab-e144-4c54-b502-3c00c3dd61b9",
   "8e0db3cb-965e-4618-a36d-75684501d38f"
 ]
}

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "f6683d71-448c-4a69-aa17-e58c6ef085ab",
 "FormW2CRecords": {
   "SuccessRecords": [
     {
       "SequenceId": "1",
       "RecordId": "a4718eab-e144-4c54-b502-3c00c3dd61b9",
       "Status": "Transmitted",
       "StatusTs": "2019-08-05 09:10:45 -04:00",
       "StateReturns": [
         {
           "StateCode": "SC",
           "RecordStatus": "Transmitted"
         },
         {
           "StateCode": "DE",
           "RecordStatus": "Transmitted"
         }
       ],
       "OnlineAccess": {
            "Status": "ORDER_CREATED",
            "Email": "john@gmail.com",
            "Info": "Employee will receive an email with an unique URL to access their form online"
        }
     },
     {
       "SequenceId": "2",
       "RecordId": "8e0db3cb-965e-4618-a36d-75684501d38f",
       "Status": "Transmitted",
       "StatusTs": "2019-08-05 09:10:45 -04:00",
       "StateReturns": [
         {
           "StateCode": "SC",
           "RecordStatus": "Transmitted"
         },
         {
           "StateCode": "DE",
           "RecordStatus": "Transmitted"
         }
       ],
      "OnlineAccess": {
            "Status": "ORDER_CREATED",
            "Email": "john@gmail.com",
            "Info": "Employee will receive an email with an unique URL to access their form online"
        }
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}

Update

Updates the existing return created in TaxBandits. Use the unique identifiers to refer a particular return, payer, or recipient. You can not UPDATE a return that is already Transmitted return.

PUT FormW2C/Update

Request Body

Field	Type	Description
SubmissionManifest	object	SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsOnlineAccess, IsScheduleFiling & ScheduleFiling service details.
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form W2-C to be filed. Allowed values: "2021"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form W2-C will be e-filed to the IRS.
IsPostal	Boolean	"Postal Order will be created when the value is set as True. Once the return is Transmitted, the W2-C Employee copies will be postal mailed to the Employee's address via USPS. Note: Postal Orders for Foreign Address will not be created.
IsOnlineAccess	Boolean	Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the employee. The Employee can provide consent and download the W2-C Employee copies on the portal.
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	Optional Name under which the business operates Size Range: ..75
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9
Email	string	Email address of the Business Size Range: ..40
ContactNm	string	Optional Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional Business title of the signing authority Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional Identifies the kind of payer. This field is Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..30
Country	string	Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object[]	Contains information about the Employee details and Form W2 C details.
Manifest	object	Collects the Record id, Sequence Id and Correction Type information
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
PrevReportedRecordId	Guid	If you are correcting a W2 that was originally filed with TaxBandits. Provide the Record ID of the original Form W2 here. The PrevReportedEmployee and PrevReportedW2FormData Objects are not required if you provide the PrevReportedRecordID
RecordId	Guid	Unique Identifier of the Record. Mention the Form W2C return's Record ID that you want to update. If you do not provide the Record ID, then a new record will be added to the submission.
IsEmployeeSSNNameCorrection	Boolean	When True, Identifies that you are correcting the SSN or Name of the employee.
PrevReportedEmployeeData	object	Enter the Employee information that was submitted in the Original Form W2-C. The information is not required if you have provided the PrevReportedRecordId.
EmployeeId	Guid	An unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to Update.
SSN	string	Employee's Social Security Number (SSN) Size Range: 9
FirstNm	string	Employee's first name.
MiddleNm	string	Optional Employee's middle name.
LastNm	string	Employee's last name.
Suffix	string	Optional Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
Email	string	Optional Employee's email address. Size Range: 0..40
Fax	string	Optional Employee's fax number. Size Range: 10
Phone	string	Optional Employee's phone number Size Range: 10
IsForeign	Boolean	When true, identifies the employee address with a foreign address.
USAddress	object	Object to identify the employee's US address
Address1	string	Employee's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Employee's suite or apartment Size Range: ..35
City	string	Employee's city Size Range: ..27
State	string	Employee's State code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employee's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the employee
Address1	string	Employee's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employee's suite or apartment Size Range: ..35
City	string	Employee's city. Size Range: ..27
ProvinceOrStateNm	string	Employee's Province or State Name. Size Range: ..30
Country	string	Employee's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employee's Postal Code
CorrectedEmployeeData	object	Enter the corrected Employee Name and SSN value. This Object is required, when the IsEmployeeSSNNameCorrection is true. The object should be "null", when the IsEmployeeSSNNameCorrection is false.
FirstNm	string	Corrected Employee's first name.
MiddleNm	string	Optional Corrected Employee's middle name.
LastNm	string	Corrected Employee's last name.
Suffix	string	Optional Corrected Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PrevReportedW2FormData	object	Employee's previously reported Form W-2 information.
B1Wages	number	Enter the previously reported total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Enter the previously reported total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Enter the previously reported total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Enter the previously reported total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Enter the previously reported amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Enter the previously reported amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Enter the previously reported tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Enter the previously reported tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Enter the previously reported total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Enter the previously reported amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Enter the previously reported amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Enter the amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Enter the amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Enter the amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Enter the amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Enter the Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Enter the Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Enter the Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Enter the Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Enter any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.
CorrectedW2FormData	object	Employee's corrected Form W-2 information
B1Wages	number	Enter the corrected total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Enter the corrected total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Enter the corrected total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Enter the corrected total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Enter the corrected amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Enter the corrected amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Enter the corrected tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Enter the corrected tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Enter the corrected total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Enter the corrected amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Enter the corrected amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Enter the corrected amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Enter the corrected amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Enter the corrected amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Enter the corrected amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Enter the corrected Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Enter the corrected Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Enter the corrected Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Enter the corrected Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Enter any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a Business.
FormW2CRecords	object	Pulls Form W2-C records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2 C Records
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
PrevReportedRecordId	Guid	Record ID of the original Form W2-C which is given while creating Form W2.
RecordId	Guid	An unique identifier generated by TaxBandits when a W2-C return is created.
EmployeeId	Guid	An unique identifier generated by TaxBandits for a Employee when a W2-C return is created. You can use this id for your future reference to Update.
FederalReturn	object	Returns the record status and StatusTs of federal return.
Status	string	Returns the record status.
StatusTs	string	Returns date and time of return created.
Info	string	Returns information about the Federal Filing service.
StateReturns	object[]	Returns collection of state returns information
StateCd	string	Returns the state code of the state for which the return is filed.
Status	string	Returns the record status of the state return.
StatusTs	string	Date and time of the return created.
Info	string	Returns the information about the state for which we are not supporting state filing.
Errors	object[]	Shows error information of state returns of Form W2 C
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Postal	object	Returns the status and StatusTs of postal mailing service for Form W2-C.
Status	string	Returns the status of postal order.
StatusTs	string	Returns the date and time of the postal order created.
Info	string	Returns the information about Postal mailing service.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns status of online access for Form W2 C return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2-C Records.
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	Unique identifier of a record
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

{
 "SubmissionManifest": {
   "SubmissionId": "b2a56bb1-6a73-48d1-bb99-b229f70fb93f",
   "TaxYear": "2021",
   "IsFederalFiling": true,
   "IsPostal": true,
   "IsOnlineAccess": true
 },
 "ReturnHeader": {
   "Business": {
     "BusinessId": "f90f38c0-3316-4f37-aafe-a4e6af99c445",
     "BusinessNm": "Brian LLC",
     "TradeNm": "Brian Corporate Services",
     "IsEIN": true,
     "EINorSSN": "311111211",
     "Email": "brianscott@gmail.com",
     "ContactNm": "Brian O Relly",
     "Phone": "1234447890",
     "PhoneExtn": "12345",
     "Fax": null,
     "BusinessType": "ESTE",
     "SigningAuthority": {
       "Name": "Altof",
       "Phone": "1234578960",
       "BusinessMemberType": "ADMINISTRATOR"
     },
     "KindOfEmployer": "FEDERALGOVT",
     "KindOfPayer": "REGULAR941",
     "IsBusinessTerminated": true,
     "IsForeign": false,
     "USAddress": {
       "Address1": "1751 Kinsey Rd",
       "Address2": "Main St",
       "City": "Dothan",
       "State": "AL",
       "ZipCd": "36303"
     },
     "ForeignAddress": null
   }
 },
 "ReturnData": [
   {
     "Manifest": {
       "SequenceId": "001",
       "PrevReportedRecordId": null,
       "RecordId": "c8c563b5-41bc-4e14-a920-c4932a09e455",
       "IsEmployeeSSNNameCorrection": false
     },
     "PrevReportedEmployeeData": {
       "SSN": "112-23-6003",
       "FirstNm": "Michael",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr",
       "Email": "test@gmail.com",
       "Fax": "4567891234",
       "Phone": "4259631478",
       "IsForeign": false,
       "USAddress": {
         "Address1": "1751 Kinsey Rd",
         "Address2": "Main St",
         "City": "Dothan",
         "State": "AL",
         "ZipCd": "36303"
       },
       "ForeignAddress": {
         "Address1": null,
         "Address2": null,
         "City": null,
         "ProvinceOrStateNm": null,
         "Country": null,
         "PostalCd": null
       }
     },
     "CorrectedEmployeeData": {
       "SSN": "112-61-6003",
       "FirstNm": "George",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr"
     },
     "PrevReportedW2FormData": {
       "B1Wages": 50000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     },
     "CorrectedW2FormData": {
       "B1Wages": 55000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     }
   }
 ]
}

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4cff2037-1b19-41c9-88c5-09227435c720",
   "BusinessId": "5c1262a2-1365-45c2-9cb5-47dca2e95148",
   "FormW2CRecords": {
       "SuccessRecords": [
           {
               "SequenceId": "001",
               "RecordId": "c8c563b5-41bc-4e14-a920-c4932a09e455",
               "EmployeeId": "6eb65f6e-a2e5-4877-ac17-d47cc7faa58b",
               "FederalReturn": {
                   "Status": "CREATED",
                   "StatusTs": "2021-01-11 06:46:30 -05:00",
                   "Info": null
               },
               "StateReturns": [
                   {
                       "StateCd": "DE",
                       "Status": "CREATED",
                       "StatusTs": "2021-01-11 06:46:30 -05:00",
                       "Info": null,
                       "Errors": null
                   },
                   {
                       "StateCd": "SC",
                       "Status": "CREATED",
                       "StatusTs": "2021-01-11 06:46:30 -05:00",
                       "Info": null,
                       "Errors": null
                   }
               ],
               "Postal": null,
               "OnlineAccess": {
                   "Status": "CREATED",
                   "Email": "john@gmail.com",
                   "Info": null
               }
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}

Validate

VALIDATE being an optional endpoint, can be used prior transmitting the returns to validate those returns against the business rules. This endpoint requires the Submission ID & Record ID(s) to be sent in the request.

GET FormW2C/Validate

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	An unique identifier generated by TaxBandits when a W2 return is created. Mention the W2 return's Record ID that you want to Validate.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
FormW2CRecords	object	Pulls the Form W-2C records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2C Records
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	Unique identifier of a record
Status	string	Returns the status of the records.
StatusTs	string	Date and time of return created.
StateReturns	object[]	Returns the state code and return status.
StateCode	string	Returns the code of the state.
RecordStatus	string	Returns the status of the records.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2C Records.
RecordId	Guid	Unique identifier of a record
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RejectedBy	string	Returns the information of who rejected the return.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information
Code	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

FormW2C/Validate?SubmissionId=d1f9cb0a-912f-4105-8bcf-059af43d2b31&RecordIds=a4718eab-e144-4c54-b502-3c00c3dd61b9,8e0db3cb-965e-4618-a36d-75684501d38f

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "f6683d71-448c-4a69-aa17-e58c6ef085ab",
 "FormW2CRecords": {
   "SuccessRecords": [
     {
       "SequenceId": "1",
       "RecordId": "a4718eab-e144-4c54-b502-3c00c3dd61b9",
       "Status": "Created",
       "StatusTs": "2019-08-05 09:10:45 -04:00",
       "StateReturns": [
         {
           "StateCode": "SC",
           "RecordStatus": "Created"
         },
         {
           "StateCode": "DE",
           "RecordStatus": "Created"
         }
       ]
     },
     {
       "SequenceId": "1",
       "RecordId": "8e0db3cb-965e-4618-a36d-75684501d38f",
       "Status": "Created",
       "StatusTs": "2019-08-05 09:10:45 -04:00",
       "StateReturns": [
         {
           "StateCode": "SC",
           "RecordStatus": "Created"
         },
         {
           "StateCode": "DE",
           "RecordStatus": "Created"
         }
       ]
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}

ValidateForm

An optional API Endpoint to validate a Tax Return. The API Endpoints “CREATE” and “TRANSMIT” also do the same validation functionality. One important difference is that the ValidateForm Endpoint does not require the Tax Return to be created. You can validate the tax data and then call the create or transmit endpoints to create the tax return.

POST FormW2C/ValidateForm

Request Body

Field	Type	Description
SubmissionManifest	object	SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsOnlineAccess service details.
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form W2-C to be filed. Allowed values: "2021"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form W2-C will be e-filed to the IRS.
IsPostal	Boolean	"Postal Order will be created when the value is set as True. Once the return is Transmitted, the W2-C Employee copies will be postal mailed to the Employee's address via USPS. Note: Postal Orders for Foreign Address will not be created.
IsOnlineAccess	Boolean	Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the employee. The Employee can provide consent and download the W2-C Employee copies on the portal.
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	Optional Name under which the business operates Size Range: ..75
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9
Email	string	Email address of the Business Size Range: ..40
ContactNm	string	Optional Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Phone number of the business Size Range: 10
PhoneExtn	string	Optional Extension of the business phone number Size Range: ..5
Fax	string	Optional Fax number of the Business Size Range: 10
BusinessType	string	Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Optional Details of the person who is authorized to sign the return
Name	string	Optional Name of the signing authority Size Range: ..35
Phone	string	Optional Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Optional Business title of the signing authority Size Range: 5..29 Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
KindOfEmployer	string	Optional Identifies the kind of employer. Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional Identifies the kind of payer. This field is Mandatory for W-2 and W2-C, optional for 1099 misc and 94X series Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..30
Country	string	Employer/Payer's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object[]	Contains information about the Employee details and Form W2 C details.
Manifest	object	Collects the Record id, Sequence Id and Correction Type information
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
PrevReportedRecordId	Guid	If you are correcting a W2 that was originally filed with TaxBandits. Provide the Record ID of the original Form W2 here. The PrevReportedEmployee and PrevReportedW2FormData Objects are not required if you provide the PrevReportedRecordID
RecordId	Guid	This Record ID is for the W2-C. It will be generated and provide in the Response after you create the correction form.
IsEmployeeSSNNameCorrection	Boolean	When True, Identifies that you are correcting the SSN or Name of the employee.
PrevReportedEmployeeData	object	Enter the Employee information that was submitted in the Original Form W2-C. The information is not required if you have provided the PrevReportedRecordId.
EmployeeId	Guid	An unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this id for your future reference to Update.
SSN	string	Employee's Social Security Number (SSN) Size Range: 9
FirstNm	string	Employee's first name.
MiddleNm	string	Optional Employee's middle name.
LastNm	string	Employee's last name.
Suffix	string	Optional Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
Email	string	Optional Employee's email address. Size Range: 0..40
Fax	string	Optional Employee's fax number. Size Range: 10
Phone	string	Optional Employee's phone number Size Range: 10
IsForeign	Boolean	When true, identifies the employee address with a foreign address.
USAddress	object	Object to identify the employee's US address
Address1	string	Employee's US address (street address or post office box of that locality) Size Range: ..35
Address2	string	Employee's suite or apartment Size Range: ..35
City	string	Employee's city Size Range: ..27
State	string	Employee's State code. Refer Static values. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employee's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the employee
Address1	string	Employee's foreign address (street address or post office box of that locality) Size Range: ..35
Address2	string	Optional Employee's suite or apartment Size Range: ..35
City	string	Employee's city. Size Range: ..27
ProvinceOrStateNm	string	Employee's Province or State Name. Size Range: ..30
Country	string	Employee's country code. Refer Static values. Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employee's Postal Code
CorrectedEmployeeData	object	Enter the corrected Employee Name and SSN value. This Object is required, when the IsEmployeeSSNNameCorrection is true. The object should be "null", when the IsEmployeeSSNNameCorrection is false.
FirstNm	string	Corrected Employee's first name.
MiddleNm	string	Optional Corrected Employee's middle name.
LastNm	string	Corrected Employee's last name.
Suffix	string	Optional Corrected Employee's suffix. Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PrevReportedW2FormData	object	Employee's previously reported Form W-2 information.
B1Wages	number	Enter the previously reported total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Enter the previously reported total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Enter the previously reported total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Enter the previously reported total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Enter the previously reported amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Enter the previously reported amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Enter the previously reported tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Enter the previously reported tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Enter the previously reported total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Enter the previously reported amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Enter the previously reported amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Enter the amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Enter the amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Enter the amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Enter the amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Enter the Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Enter the Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Enter the Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Enter the Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Enter any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.
CorrectedW2FormData	object	Employee's corrected Form W-2 information
B1Wages	number	Enter the corrected total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Enter the corrected total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Enter the corrected total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Enter the corrected total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Enter the corrected amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Enter the corrected amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Enter the corrected tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Enter the corrected tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Enter the corrected total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Enter the corrected amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Enter the corrected amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	Enter the corrected amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	Enter the corrected amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	Enter the corrected amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	Enter the corrected amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	Enter the corrected Box 12a Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12bCd	string	Enter the corrected Box 12b Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12cCd	string	Enter the corrected Box 12c Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B12dCd	string	Enter the corrected Box 12d Code. Allowed values: "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH"
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Enter any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2C and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error id
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

{
 "SubmissionManifest": {
   "SubmissionId": null,
   "TaxYear": "2021",
   "IsFederalFiling": true,
   "IsPostal": true,
   "IsOnlineAccess": true
 },
 "ReturnHeader": {
   "Business": {
     "BusinessId": null,
     "BusinessNm": "Brian LLC",
     "TradeNm": "Brian Corporate Services",
     "IsEIN": true,
     "EINorSSN": "997771111",
     "Email": "test@gmail.com",
     "ContactNm": "Brian O Relly",
     "Phone": "1234447890",
     "PhoneExtn": "12345",
     "Fax": "4567893120",
     "BusinessType": "ESTE",
     "SigningAuthority": {
       "Name": "Altof",
       "Phone": "1234578960",
       "BusinessMemberType": "ADMINISTRATOR"
     },
     "KindOfEmployer": "FEDERALGOVT",
     "KindOfPayer": "REGULAR941",
     "IsBusinessTerminated": true,
     "IsForeign": false,
     "USAddress": {
       "Address1": "1751 Kinsey Rd",
       "Address2": "Main St",
       "City": "Dothan",
       "State": "AL",
       "ZipCd": "36303"
     },
     "ForeignAddress": {
       "Address1": null,
       "Address2": null,
       "City": null,
       "ProvinceOrStateNm": null,
       "Country": null,
       "PostalCd": null
     }
   }
 },
 "ReturnData": [
   {
     "Manifest": {
       "SequenceId": "001",
       "PrevReportedRecordId": null,
       "RecordId": null,
       "IsEmployeeSSNNameCorrection": true
     },
     "PrevReportedEmployeeData": {
       "SSN": "112-23-6003",
       "FirstNm": "Michael",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr",
       "Email": "test@gmail.com",
       "Fax": "4567891234",
       "Phone": "4259631478",
       "IsForeign": false,
       "USAddress": {
         "Address1": "1751 Kinsey Rd",
         "Address2": "Main St",
         "City": "Dothan",
         "State": "AL",
         "ZipCd": "36303"
       },
       "ForeignAddress": {
         "Address1": null,
         "Address2": null,
         "City": null,
         "ProvinceOrStateNm": null,
         "Country": null,
         "PostalCd": null
       }
     },
     "CorrectedEmployeeData": {
       "SSN": "112-23-6003",
       "FirstNm": "George",
       "MiddleNm": "John",
       "LastNm": "Augustin",
       "Suffix": "Sr"
     },
     "PrevReportedW2FormData": {
       "B1Wages": 50000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     },
     "CorrectedW2FormData": {
       "B1Wages": 55000.65,
       "B2FedTaxWH": 5263.32,
       "B3SocSecWages": 137000,
       "B4SocSecTaxWH": 46.15,
       "B5MediWages": 137700,
       "B6MediTaxWH": 78.21,
       "B7SocSecTips": 700,
       "B8AllocatedTips": 45.24,
       "B10DependtCareBenefits": 78.55,
       "B11Sec457Plan": 96.32,
       "B11NonSec457Plan": 0,
       "B12aCd": "EE",
       "B12aAmt": 32.52,
       "B12bCd": "B",
       "B12bAmt": 21.41,
       "B12cCd": "E",
       "B12cAmt": 213.47,
       "B12dCd": "H",
       "B12dAmt": 210.36,
       "B13IsStatEmp": true,
       "B13IsRetPlan": true,
       "B13Is3rdPartySickPay": true,
       "B14Other": "Others 4500",
       "ControlNum": "35231",
       "States": [
         {
           "B15StateCd": "DE",
           "B15StateIdNum": "9-999999999-123",
           "B16StateWages": 50000.65,
           "B17StateTax": 5263.32,
           "LocalityData": [
             {
               "LocalWages": 300.23,
               "LocalTax": 100.45,
               "LocalityNm": "Pristine"
             }
           ]
         },
         {
           "B15StateCd": "SC",
           "B15StateIdNum": "123456789",
           "B16StateWages": 5000.65,
           "B17StateTax": 523.32,
           "LocalityData": null
         }
       ]
     }
   }
 ]
}

Response JSON

 {
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "Errors": null
}