Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Create

The Request Payload has manifest data (describes the Tax Form Type, Tax Year, etc.), business information, and data required to create the tax return. The CREATE endpoint takes in the Request Payload, validates data, applies the business rules, and creates the appropriate tax return. A unique Id called “Submission ID” is created and passed back to the sender when a tax return is created. A “Submission” is used to refer to the transaction between the client and the API server. The API will create a Unique ID for the business data if the EIN (Employer Identification Number) is not in the database. Any subsequent API calls can use the Business ID instead of sending the complete business data every time. Another Unique ID called “Record Id” is created to identify the records inside the submission.When the “Form W2 Create” endpoint is called, that many number of Record Ids are created for each employee record inside the single submission. Of course, one Submission Id is created for the entire transaction.

POST FormW2/Create

Request Body

FieldTypeDescription
SubmissionManifestobjectSubmissionManifest provides the 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.
    SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
    TaxYearstringTax year of Form W2 to be filed.
Allowed values: "2022"
    IsFederalFilingBooleanFederal Filing for the return will be enabled when the value is True. Form W2 will be sent directly to the IRS.
    IsStateFilingBooleanState Filing for the return will be enabled when the value is True. Form W2 will be directly filed with the respective employee states.
Note: State Filing will not be created for the states that do not require State filing.
    IsPostalBooleanPostal Order will be created when the value is set as True. Once the return is Transmitted, Form W2 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 Form W2 employee copies from the portal.
    IsScheduleFilingBooleanWhen true, schedule filing services will be provided for W2 returns under this submission.
    ScheduleFilingobjectContains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True .
        EfileDatestringDate of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2023 or 10-20-2023
ReturnHeaderobjectContains information about the Business details.
    BusinessobjectObject to identify the Business Details.
        BusinessIdGuidOptional 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.
        PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: ..50
        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.
        EINorSSNstringEnter the Employer Identification Number (EIN) as you are filing Form W-2. You can not file Form W-2 with your SSN.
Size Range: 9
        EmailstringEmail address of the Business
Size Range: ..40
        ContactNmstringName 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"
        KindOfEmployerstringIdentifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
        KindOfPayerstringIdentifies the kind of payer. This field is mandatory in W-2 and optional in 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 details.
    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
    RecordIdGuidUnique identifier of a record. Not required when you are creating a return.
    EmployeeobjectObject to identify the employee details.
        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..40
        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
    W2FormDataobjectEmployee's Form W-2 information
        B1WagesnumberGets the 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 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 total wages paid (before payroll deductions) subject to employee social security tax.
Size Range: 0-999999999.99 Social security wage base limit 2022: $147,000.00
        B4SocSecTaxWHnumberGets the total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips.
Size Range: 0-999999999.99
        B5MediWagesnumberGets the 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 amount of taxes withheld from employees for Medicare tax
Size Range: 0-999999999.99
        B7SocSecTipsnumberGets the 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 tips allocated to your employee if you operate a large food or beverage establishment.
Size Range: 0-999999999.99
        B10DependtCareBenefitsnumberGets the 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 amount distributed to an employee from the employer's non-qualified plan
Size Range: 0-999999999.99
        B11NonSec457PlannumberGets the amount distributed to an employee from the employer's non-governmental section 457(b) plan
Size Range: 0-999999999.99
        B12aAmtnumberEnter the amount value for the code selected under Box 12a.
Size Range: 0-999999999.99
        B12bAmtnumberEnter the amount value for the code selected under Box 12b.
Size Range: 0-999999999.99
        B12cAmtnumberEnter the amount value for the code selected under Box 12c.
Size Range: 0-999999999.99
        B12dAmtnumberEnter the amount value for the code selected under Box 12d.
Size Range: 0-999999999.99
        B12aCdstringEnter 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"
        B12bCdstringEnter 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"
        B12cCdstringEnter 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"
        B12dCdstringEnter 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-2 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.
                TaxTypeCdenumEnter the Tax Type Code for the amount entered in "LocalWages" and "LocalTax".
Allowed values: "C City Income Tax", "D County Income Tax", "E School District Income Tax", "F Other Income Tax"
                CountyenumEnter the Indiana County code if the "TaxTypeCd" code is "D" - County Income Tax.
Allowed values: "Adams", "Allen", "Bartholomew", "Benton", "Blackford", "Boone", "Brown", "Carrol", "Cass", "Clark", "Clay", "Clinton", "Crawford", "Daviess", "Dearborn", "Decatur", "DeKalb", "Delaware", "Dubois", "Elkhart", "Fayette", "Floyd", "Fountain", "Franklin", "Fulton", "Gibson", "Grant", "Greene", "Hamilton", "Hancock", "Harrison", "Hendricks", "Henry", "Howard", "Huntington", "Jackson", "Jasper", "Jay", "Jefferson", "Jennings", "Johnson", "Knox", "Kosciusko", "LaGrange", "Lake", "LaPorte", "Lawrence", "Madison", "Marion", "Marshall", "Martin", "Miami", "Monroe", "Montgomery", "Morgan", "Newton", "Noble", "Ohio", "Orange", "Owen", "Parke", "Perry", "Pike", "Porter", "Posey", "Pulaski", "Putnam", "Randolph", "Ripley", "Rush", "St.Joseph", "Scott", "Shelby", "Spencer", "Starke", "Steuben", "Sullivan", "Switzerland", "Tippecanoe", "Tipton", "Union", "Vanderburgh", "Vermillion", "Vigo", "Wabash", "Warren", "Warrick", "Washington", "Wayne", "Wells", "White", "Whitley"
                SchoolDistrictNumstringEnter the School District Number if the "TaxTypeCd" is "E" - School District Income Tax.
        EmployeeStateSpecificDataobjectContains employee specific data for the selected states.
            KSobjectContains employee state specific data for Kansas.
                EmployeeContributionnumberEnter the amount of Employee Contribution to KPERS, KP & F and Judges.
Size Range: 0-999999999.99
            MEobjectContains employee state specific data for Maine.
                MEPERScontributionnumberEnter the amount of pick-up contributions deducted from this employee’s salary and contributed to MEPERS on behalf of the employee.
Size Range: 0-999999999.99
            MDobjectContains employee state specific data for Maryland.
                W4ExemptionCountintEnter the number of exemptions claimed on Form W-4.
            NJobjectContains employee state specific data for New Jersey.
                PvtFmlLeaveInsuranceNumstringEnter the Private Family Leave Insurance Plan Number.
Size Range: ..14
                FmlLeaveInsuranceWHnumberEnter the amount withheld as Family Leave Insurance workers contributions.
Size Range: 0-999.99
                PvtDisabilityPlanNumstringEnter the Private Disability Plan Number.
Size Range: ..14
                DisabilityInsuranceWHnumberEnter the amount withheld as workers’ contributions for Disability Insurance.
Size Range: 0-999.99
                CombNJUnempInsWrkFrceDevProgHCSubWHnumberEnter the amount withheld as workers contributions for Combined NJ unemployment insurance, Workforce Development Program and health Care Subsidy.
Size Range: 0-999.99
                DeffCompAmtnumberEnter the total employee elective deferrals to a Code Section 401(k) plan, made during the year.
Size Range: 0-9999999.99
                IsRetirementPlanBooleanWhen TRUE, identifies that the employee was an active participant (for any part of the year) in a retirement plan.
            ORobjectContains employee state specific data for Oregon.
                DateFirstEmployeddateEnter the date first employed.
                DateOfSeparationdateEnter the date of separation.
                TaxableWagesForStateTransitTaxnumberEnter the State Taxable Wages for Statewide Transit Tax.
Size Range: 0-999999999.99
                StateTransitTaxWHnumberEnter the Statewide Transit Tax Withheld.
Size Range: 0-999999999.99
            MAobjectContains employee state specific data for Massachusetts.
                EeContributionMAPFMLnumberEnter the Employee contribution for Paid Family and Medical Leave.
Size Range: 0-999999999.99
StateReconDataobjectCollects State Recon fields specific for each state. Click here, for the description of each state specific Recon fields.

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of a Payer.
FormW2RecordsobjectPulls the Form W-2 records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2 Records
        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.
        RecordIdGuidAn unique identifier generated by TaxBandits when a W2 return is created.
        EmployeeIdGuidAn unique identifier generated by TaxBandits for a employee when a W2 return is created. You can use this id for your future reference to Update.
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
        StateReturnsobject[]Returns collection of state returns information
            StateCdstringReturns the state code of the state for which the return is filed.
            StatusstringReturns the record status of the state return.
            StatusTsstringDate and time of the return created.
            InfostringReturns the information about the state for which we are not supporting state filing.
            Errorsobject[]Shows error information of state returns of Form W2
                IdstringReturns the validation error Id.
                NamestringName of the validation error.
                MessagestringDescription of the validation error.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form W2.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns the Status of the Online Access.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
        ScheduleFilingobjectReturns the date of the schedule filing.
            ScheduledOnstringDate of the schedule filing to know when the return to be filed to the IRS.
            InfostringInformation about Schedule Filing service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2 Records.
        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.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error Id
            NamestringName of the validation error
            MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Request JSON

{ "SubmissionManifest": {   "SubmissionId": null,   "TaxYear": "2022",   "IsFederalFiling": true,   "IsStateFiling": true,   "IsPostal": false,   "IsOnlineAccess": true,   "IsScheduleFiling": false,   "ScheduleFiling": null }, "ReturnHeader": {   "Business": {     "BusinessId": null,     "PayerRef": "Pe123",     "BusinessNm": "Brian LLC",     "TradeNm": "Brian Corporate Services",     "IsEIN": true,     "EINorSSN": "426482784",     "Email": "brianscott@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": true,     "USAddress": {       "Address1": "1751 Kinsey Rd",       "Address2": "Main St",       "City": "Dothan",       "State": "AL",       "ZipCd": "36303"     },     "ForeignAddress": {       "Address1": "500 Penn Avenue",       "Address2": "Park Street",       "City": "Toronto",       "ProvinceOrStateNm": "Ontario",       "Country": "CA",       "PostalCd": "02452"     }   } }, "ReturnData": [   {     "RecordId": null,     "SequenceId": "001",     "Employee": {       "EmployeeId": null,       "SSN": "412-27-4749",       "FirstNm": "Mianic6",       "MiddleNm": "George",       "LastNm": "Augustin",       "Suffix": "Sr",       "Email": "mike@gmail.com",       "Fax": "4567891234",       "Phone": "4259631478",       "IsForeign": false,       "USAddress": {         "Address1": "1751 Kinsey Rd",         "Address2": "Main St",         "City": "Dothan",         "State": "AL",         "ZipCd": "36303"       },       "ForeignAddress": {         "Address1": "500 Penn Avenue",         "Address2": "Park Street",         "City": "Toronto",         "ProvinceOrStateNm": "Ontario",         "Country": "CA",         "PostalCd": "02452"       }     },     "W2FormData": {       "B1Wages": 50000.65,       "B2FedTaxWH": 5263.32,       "B3SocSecWages": 137000,       "B4SocSecTaxWH": 46.15,       "B5MediWages": 137700,       "B6MediTaxWH": 78.21,       "B7SocSecTips": 700,       "B8AllocatedTips": 45,       "B10DependtCareBenefits": 78,       "B11Sec457Plan": 96,       "B11NonSec457Plan": 0,       "B12aCd": "EE",       "B12aAmt": 32,       "B12bCd": "B",       "B12bAmt": 21,       "B12cCd": "E",       "B12cAmt": 213,       "B12dCd": "H",       "B12dAmt": 210,       "B13IsStatEmp": true,       "B13IsRetPlan": true,       "B13Is3rdPartySickPay": true,       "B14Other": "Real Estate 4500",       "ControlNum": "35231",       "States": [         {           "B15StateCd": "IN",           "B15StateIdNum": "9999999999 999",           "B16StateWages": 1000,           "B17StateTax": 100,           "LocalityData": [             {               "LocalWages": 300.23,               "LocalTax": 100.45,               "LocalityNm": "Pristine",               "County": "adams",               "TaxTypeCd": null,               "SchoolDistrictNum": null             }           ]         },         {           "B15StateCd": "VT",           "B15StateIdNum": "WHT98765121",           "B16StateWages": 500000.65,           "B17StateTax": 5263.32,           "LocalityData": [             {               "LocalWages": 300.23,               "LocalTax": 100.45,               "LocalityNm": "Pristine",               "TaxTypeCd": null,               "County": null,               "SchoolDistrictNum": null             }           ]         },         {           "B15StateCd": "PA",           "B15StateIdNum": "99999999",           "B16StateWages": 1000,           "B17StateTax": 100,           "LocalityData": [             {               "LocalWages": 300.23,               "LocalTax": 100.45,               "LocalityNm": "Pristine",               "TaxTypeCd": null,               "County": null,               "SchoolDistrictNum": null             }           ]         },         {           "B15StateCd": "KS",           "B15StateIdNum": "036499993579F10",           "B16StateWages": 50000.65,           "B17StateTax": 0,           "LocalityData": [             {               "LocalWages": 300.23,               "LocalTax": 100.45,               "LocalityNm": "Pristine",               "TaxTypeCd": null,               "County": null,               "SchoolDistrictNum": null             }           ]         }       ],       "EmployeeStateSpecificData": {         "KS": {           "EmployeeContribution": 251.55         }       }     }   } ], "StateReconData": {   "IN": {     "FormWH3": {       "INWithHoldingID": "4657385932 254",       "NumOfW2WH18W2G1099Forms": 23,       "StateTaxWHW2WH18W2G1099": 100,       "CountyTaxWHW2WH18W2G1099": 100,       "TotTaxWH": 200,       "TotDeposits": 500,       "BalDue": 0,       "OverPayment": 300,       "CountyTaxWH": [         {           "CountyNm": "Adams",           "TaxWH": 50         },         {           "CountyNm": "Decatur",           "TaxWH": 50         }       ],       "TotCountyTaxWH": 100     }   },   "VT": {     "FormWHT434": {       "VTWithHoldingID": "WHT98765101",       "PayFreq": "Quarterly",       "IsBusinessCeasedWantToCloseAcc": "True",       "BusinessCeaseDate": "07/10/2022",       "IsReportingSickPay": "True",       "AggErHealthInsCoverage": 210,       "TotNumOfW2Forms": 15,       "TotWagesPerW2": 1000,       "TaxWHPerW2": 200,       "TotNumOf1099Forms": 16,       "Tot1099Payments": 1000,       "TaxWHPer1099": 201,       "TotTaxWH": 401,       "IsPaidPreparer": "True"     }   },   "PA": {     "FormREV1667": {       "PAWithHoldingID": 45734565,       "TotNumOfW2": 4,       "TotNumOf1099R": 0,       "TotNumOf1099NECMISC": 0,       "TotWagesAndDistribution": 1000,       "TotTaxWH": 0,       "WagesAndDistribution": {         "Qtr1": "100",         "Qtr2": "100",         "Qtr3": "100",         "Qtr4": "700",         "TotWagesAllQtrs": 1000       },       "TaxWH": {         "Qtr1": "0",         "Qtr2": "0",         "Qtr3": "0",         "Qtr4": "0",         "TotTaxWHAllQtrs": 0       }     }   },   "KS": {     "FormKW3": {       "KSWithHoldingID": "036999999999F99",       "WHAccClosedDate": null,       "NumOf1099W2Forms": 1,       "TotTaxWH1099W2": 100,       "WHTaxPaid": 49,       "CreditAvailable": 50,       "TotWHPayment": 99,       "Overpayment": 0,       "BalanceDue": 1,       "Penalty": 0,       "Interest": 0,       "TotTax": 1,       "FilingSchType": "Quarterly",       "Quarterly": {         "Qtr1": 99,         "Qtr2": 0,         "Qtr3": 0,         "Qtr4": 0       },       "Monthly": null,       "SemiMonthly": null,       "QuadMonthly": null,       "Annual": null,       "TotPayments": 99     }   } }}

Response JSON

{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "ef869fda-5562-41c8-b0d2-b61ef19a2f5a", "BusinessId": "668e8869-ef32-4292-a9a7-b44c097647e5", "PayerRef": "Pe123", "FormW2Records": {   "SuccessRecords": [     {       "SequenceId": "001",       "RecordId": "566e1623-3c07-4d15-9fcc-00cad9a3a5d5",       "EmployeeId": "efee6e99-e861-48fb-9c82-61d0f9e0c97f",       "FederalReturn": {         "Status": "CREATED",         "StatusTs": "2022-08-06 10:19:05 -04:00",         "Info": null       },       "StateReturns": [         {           "StateCd": "IN",           "Status": "CREATED",           "StatusTs": "2022-08-06 10:19:05 -04:00",           "Info": null,           "Errors": null         },         {           "StateCd": "VT",           "Status": "CREATED",           "StatusTs": "2022-08-06 10:19:05 -04:00",           "Info": null,           "Errors": null         },         {           "StateCd": "PA",           "Status": "CREATED",           "StatusTs": "2022-08-06 10:19:05 -04:00",           "Info": null,           "Errors": null         },         {           "StateCd": "KS",           "Status": "CREATED",           "StatusTs": "2022-08-06 10:19:05 -04:00",           "Info": null,           "Errors": null         }       ],       "Postal": null,       "OnlineAccess": {           "Status": "CREATED",           "Email": "john@gmail.com",          "Info": null       },       "ScheduleFiling": null     }   ],   "ErrorRecords": null }, "Errors": null}