Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Get

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

GET FormW2C/Get

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]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

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
FormW2CRecordsobjectPulls the submission and record details.
SubmissionManifestobjectSubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsOnlineAccess service details.
    SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form W2-C to be filed.
Allowed values: "2021"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. Form W2-C will be e-filed to the IRS.
    IsPostalBoolean"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.
    IsOnlineAccessBooleanOnline 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.
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidUse 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.
        BusinessNmstringName of the business
Size Range: ..75
        TradeNmstringOptional Name under which the business operates
Size Range: ..75
        IsEINBooleanWhen true, identifies the business with an EIN.
        EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
Size Range: 9
        EmailstringEmail address of the Business
Size Range: ..100
        ContactNmstringOptional Name of the person who can be contacted by the IRS
Size Range: ..27
        PhonestringPhone number of the business
Size Range: 10
        PhoneExtnstringOptional Extension of the business phone number
Size Range: ..5
        FaxstringOptional Fax number of the Business
Size Range: 10
        BusinessTypestringOptional Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: 4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
        SigningAuthorityobjectOptional Details of the person who is authorized to sign the return
            NamestringOptional Name of the signing authority
Size Range: ..35
            PhonestringOptional Phone number of the signing authority
Size Range: 10
            BusinessMemberTypestringOptional 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"
        KindOfEmployerstringOptional 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"
        KindOfPayerstringOptional 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"
        IsBusinessTerminatedBooleanWhen true, identifies the business as terminated.
        IsForeignBooleanWhen true, identifies the business address with a foreign address.
        USAddressobjectIf IsForeign is false, pass US address of the business
            Address1stringEmployer/Payer's US address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            StatestringEmployer/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"
            ZipCdstringEmployer/Payer's zip code
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the business
            Address1stringEmployer/Payer's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..35
            CitystringEmployer/Payer's city
Size Range: ..27
            ProvinceOrStateNmstringEmployer/Payer's province or state name
Size Range: ..30
            CountrystringEmployer/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"
            PostalCdstringEmployer/Payer's postal code
ReturnDataobject[]Contains information about the Employee details and Form W2 C details.
    ManifestobjectCollects the Record id, Sequence Id and Correction Type information
        SequenceIdstringAn 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
        PrevReportedRecordIdGuidIf 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
        RecordIdGuidThis Record ID is for the W2-C. It will be generated and provide in the Response after you create the correction form.
        IsEmployeeSSNNameCorrectionBooleanWhen True, Identifies that you are correcting the SSN or Name of the employee.
    PrevReportedEmployeeDataobjectEnter the Employee information that was submitted in the Original Form W2-C. The information is not required if you have provided the PrevReportedRecordId.
        EmployeeIdGuidAn 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.
        SSNstringEmployee's Social Security Number (SSN)
Size Range: 9
        FirstNmstringEmployee's first name.
        MiddleNmstringOptional Employee's middle name.
        LastNmstringEmployee's last name.
        SuffixstringOptional Employee's suffix.
Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
        EmailstringOptional Employee's email address.
Size Range: 0..100
        FaxstringOptional Employee's fax number.
Size Range: 10
        PhonestringOptional Employee's phone number
Size Range: 10
        IsForeignBooleanWhen true, identifies the employee address with a foreign address.
        USAddressobjectObject to identify the employee's US address
            Address1stringEmployee's US address (street address or post office box of that locality)
Size Range: ..35
            Address2stringEmployee's suite or apartment
Size Range: ..35
            CitystringEmployee's city
Size Range: ..27
            StatestringEmployee'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"
            ZipCdstringEmployee's zip code
        ForeignAddressobjectIf IsForeign is true, pass foreign address of the employee
            Address1stringEmployee's foreign address (street address or post office box of that locality)
Size Range: ..35
            Address2stringOptional Employee's suite or apartment
Size Range: ..35
            CitystringEmployee's city.
Size Range: ..27
            ProvinceOrStateNmstringEmployee's Province or State Name.
Size Range: ..30
            CountrystringEmployee'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"
            PostalCdstringEmployee's Postal Code
    CorrectedEmployeeDataobjectEnter 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.
        FirstNmstringCorrected Employee's first name.
        MiddleNmstringOptional Corrected Employee's middle name.
        LastNmstringCorrected Employee's last name.
        SuffixstringOptional Corrected Employee's suffix.
Allowed values: "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
    PrevReportedW2FormDataobjectEmployee's previously reported Form W-2 information.
        B1WagesnumberGets 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
        B2FedTaxWHnumberGets 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
        B3SocSecWagesnumberGets the previously reported total wages paid (before payroll deductions) subject to employee social security tax.
Size Range: 0-999999999.99
        B4SocSecTaxWHnumberGets 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
        B5MediWagesnumberGets 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
        B6MediTaxWHnumberGets the previously reported amount of taxes withheld from employees for Medicare tax
Size Range: 0-999999999.99
        B7SocSecTipsnumberGets 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
        B8AllocatedTipsnumberGets the previously reported tips allocated to your employee if you operate a large food or beverage establishment.
Size Range: 0-999999999.99
        B10DependtCareBenefitsnumberGets 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
        B11Sec457PlannumberGets the previously reported amount distributed to an employee from the employer's non-qualified plan
Size Range: 0-999999999.99
        B11NonSec457PlannumberGets the previously reported amount distributed to an employee from the employer's non-governmental section 457(b) plan
Size Range: 0-999999999.99
        B12aAmtnumberGets the amount value for the code selected under Box 12a.
Size Range: 0-999999999.99
        B12bAmtnumberGets the amount value for the code selected under Box 12b.
Size Range: 0-999999999.99
        B12cAmtnumberGets the amount value for the code selected under Box 12c.
Size Range: 0-999999999.99
        B12dAmtnumberGets the amount value for the code selected under Box 12d.
Size Range: 0-999999999.99
        B12aCdstringGets 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"
        B12bCdstringGets 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"
        B12cCdstringGets 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"
        B12dCdstringGets 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"
        B13IsStatEmpBooleanWhen 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.
        B13IsRetPlanBooleanWhen true, identifies if the employee is an active participant of a retirement plan.
        B13Is3rdPartySickPayBooleanWhen true, identifies if the business reports third-party sick pay.
        B14OtherstringGets 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
        ControlNumstringIdentifies individual Forms W-2C and this box is optional.
        Statesobject[]Contains list of state returns information.
            B15StateCdstringState 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"
            B15StateIdNumstringIdentification Number of Employer's State.
Size Range: ..20
            B16StateWagesnumberAmount of Wages, tips, etc for State.
Size Range: 0-999999999.99
            B17StateTaxnumberIncome Tax of State.
Size Range: 0-999999999.99
            LocalityDataobject[]Contains list of locality information about the state.
                LocalWagesnumberAmount of Local Wages, tips, etc for State.
Size Range: 0-999999999.99
                LocalTaxnumberLocal Income Tax of State.
Size Range: 0-999999999.99
                LocalityNmstringLocality name of State.
    CorrectedW2FormDataobjectEmployee's corrected Form W-2 information
        B1WagesnumberGets 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
        B2FedTaxWHnumberGets 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
        B3SocSecWagesnumberGets the corrected total wages paid (before payroll deductions) subject to employee social security tax.
Size Range: 0-999999999.99
        B4SocSecTaxWHnumberGets the corrected total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips.
Size Range: 0-999999999.99
        B5MediWagesnumberGets 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
        B6MediTaxWHnumberGets the corrected amount of taxes withheld from employees for Medicare tax
Size Range: 0-999999999.99
        B7SocSecTipsnumberGets 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
        B8AllocatedTipsnumberGets the corrected tips allocated to your employee if you operate a large food or beverage establishment.
Size Range: 0-999999999.99
        B10DependtCareBenefitsnumberEnter 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
        B11Sec457PlannumberGets the corrected amount distributed to an employee from the employer's non-qualified plan
Size Range: 0-999999999.99
        B11NonSec457PlannumberGets the corrected amount distributed to an employee from the employer's non-governmental section 457(b) plan
Size Range: 0-999999999.99
        B12aAmtnumberGets the corrected amount value for the code selected under Box 12a.
Size Range: 0-999999999.99
        B12bAmtnumberGets the corrected amount value for the code selected under Box 12b.
Size Range: 0-999999999.99
        B12cAmtnumberGets the corrected amount value for the code selected under Box 12c.
Size Range: 0-999999999.99
        B12dAmtnumberGets the corrected amount value for the code selected under Box 12d.
Size Range: 0-999999999.99
        B12aCdstringGets 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"
        B12bCdstringGets 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"
        B12cCdstringGets 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"
        B12dCdstringGets 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"
        B13IsStatEmpBooleanWhen 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.
        B13IsRetPlanBooleanWhen true, identifies if the employee is an active participant of a retirement plan.
        B13Is3rdPartySickPayBooleanWhen true, identifies if the business reports third-party sick pay.
        B14OtherstringGets 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
        ControlNumstringIdentifies individual Forms W-2C and this box is optional.
        Statesobject[]Contains list of state returns information.
            B15StateCdstringState 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"
            B15StateIdNumstringIdentification Number of Employer's State.
Size Range: ..20
            B16StateWagesnumberAmount of Wages, tips, etc for State.
Size Range: 0-999999999.99
            B17StateTaxnumberIncome Tax of State.
Size Range: 0-999999999.99
            LocalityDataobject[]Contains list of locality information about the state.
                LocalWagesnumberAmount of Local Wages, tips, etc for State.
Size Range: 0-999999999.99
                LocalTaxnumberLocal Income Tax of State.
Size Range: 0-999999999.99
                LocalityNmstringLocality name of State.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription 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
}