Version: 1.7.0

Get

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

GET FormW2C/Get

Request Params

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.

Request Params

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

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 brief information about a particular submission on the whole. It contains information like Submission ID Tax Year IsPostal IsFederalFiling IsStateFiling 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&quot
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-11
Email	string	Email address of the Business Size Range: ..100
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&quot
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&quot
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&quot
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&quot
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: ..46
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..46
City	string	Employer/Payer's city Size Range: ..50
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&quot
ZipCd	string	Employer/Payer's zip code. Size Range: 5..10
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: ..50
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..50
City	string	Employer/Payer's city Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..50
Country	string	Employer/Payer's country Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code Size Range: ..16
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-11
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&quot
Email	string	Optional Employee's email address. Size Range: 0..100
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: ..46
Address2	string	Employee's suite or apartment Size Range: ..46
City	string	Employee's city Size Range: ..50
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&quot
ZipCd	string	Employee's zip code Size Range: 5..10
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: ..50
Address2	string	Optional Employee's suite or apartment Size Range: ..50
City	string	Employee's city. Size Range: ..50
ProvinceOrStateNm	string	Employee's Province or State Name. Size Range: ..50
Country	string	Employee's country code. Refer Static values. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employee's Postal Code Size Range: ..16
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&quot
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&quot
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&quot
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&quot
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&quot
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&quot
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&quot
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&quot
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&quot
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&quot
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&quot
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

Response JSON

Success Response - This is a sample response for successful API requests.

{
   "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": "Snowdaze LLC",
               "TradeNm": "Brian Corporate Services",
               "IsEIN": true,
               "EINorSSN": "99-1111211",
               "Email": "sample@bodeem.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": "sample@bodeem.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
}

W-9 Automation

BOI Automation New

TIN Matching

1099 Automation

941/940 Automation

W-2 Automation

ACA Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Request Params

Request Params

Response Body

Response JSON