Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Update

Updates the information on Form 940SCHRs by Submission Id and Record Id.

PUT Form940SchR/Update

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
Form940SchRRecordsobject[]Collection of objects to update Form 940SCHR and aggregate Form 940 records.
    SequencestringA unique number given by an inbound application to identify failed records.
Size Range: ..10
    ReturnHeaderobjectIdentifies the supporting details of Form 940/940SCHR
        ReturnTypestringType of the return to be filed. Enter values like.
Allowed values: "FORM940SCHR"
        MoreClientsBooleanWhen MoreClients is true, allows submission for more than 1000 clients . When MoreClients is false, allows a maximum of 1000 clients in one submission. Required only for Form 941SCHR/940SCHR.
        TaxYrstringTax year for which Form 940/940 SCH R needs to be filed.
Allowed values: "2022", "2021", "2020"
        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
            ContactNmstringName of the person who can be contacted by the IRS
Size Range: ..27
            PhonestringContact 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
            BusinessTypestringType of business. Optional for W-2/1099 and mandatory for 94X series.
Size Range: ..4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
            SigningAuthorityobjectDetails of the person who is authorized to sign the return.
                NamestringName of the signing authority.
Size Range: ..35
                PhonestringPhone number of the signing authority.
Size Range: 10
                BusinessMemberTypestringBusiness 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
                StatestringState code of the employer/payer. 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 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"
                PostalCdstringEmployer/Payer's postal code
        IsThirdPartyDesigneeBooleanWhen true, your third-party designee is allowed to discuss the return with the IRS
        ThirdPartyDesigneeobjectThird Party Designee Details
            NamestringThird Party Designee's name.
            PhonestringThird Party Designee's phone number.
            PINstringA 5 digit PIN (Should not contain all zeroes) used when communicating to the IRS.
        SignatureDetailsobjectIdentifies the signature type used in Form 940
            SignatureTypestringType of signature used to sign Form 940
            OnlineSignaturePINobjectA 10-digit signature PIN to become an IRS authorized signer.
                PINstringSign using a 10 digit PIN received from the IRS.
Size Range: 10
            ReportingAgentPINobjectA 5-digit number assigned by the IRS
                PINstringSign using a 5 digit PIN received from the IRS.
Size Range: 5
            Form8453EMPobjectAn alternate option to sign the return using Form 8453 EMP when there is no PIN
                AttachmentNmstringName of the Form 8453EMP attachment
                Attachmentbyte[]Byte array of Form-8453 pdf
                AttachmentFileTypestringType of the file Attachment
                SignedDateDateTimeDate and time on which the Form 8453-EMP was signed
    ReturnDataobjectIdentifies the Form 940SCHR and Aggregate Form 940 data.
        Form940MainFilerDataobjectForm 940 Details of the CPEO or the sec. 3504 Agent's employees for Schedule R
            IsSuccessorEmployerBooleanAre you a successor employer? (Yes / No)
            IsAmendedBooleanIs this an Amended return (Yes / No)
            IsPymtsMadeToEmployeesBooleanHave you made any payments to employees during the filing tax year? (Yes / No)
            IsBusinessClosedBooleanIs this your final return? (Business closed or stopped paying wages) (Yes / No)
            FilerTypestringSection 3504 Agent / CPEO
Allowed values: "SECTION3504AGENT", "CPEO"
            TotTaxableWagesAmtnumberTotal taxable FUTA wages amount
Size Range: 0-9999999999999.99
            FUTAAdjAmtnumberFUTA Adjustment amount
Size Range: 0-9999999999999.99
            TotCrdtRedAmtnumberTotal credit reduction amount. Enter the total from Schedule A (Form 940)
Size Range: 0-9999999999999.99
            FUTATaxAfterAdjAmtnumberTotal FUTA tax after adjustments amount
Size Range: 0-9999999999999.99
            TotDepositAmtnumberFUTA tax deposited for the year, including any overpayment applied from a prior year
Size Range: 0-9999999999999.99
            FUTAStatesobject[]Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
                StateCdstringState code of the employer/client.
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"
                TotTaxableFUTAwagesAmtnumberTotal taxable FUTA wages amount of the state
Size Range: 0-99999999999999.99
                CreditReductionRtnumberCredit Reduction Rate of the state
Size Range: 0-99999999999999.99
                CreditReductionAmtnumberCredit Reduction amount of the state. This will be equal to the Total taxable FUTA wages amount multiplied with the Credit Reduction Rate. (Round of the amount upto 2 digits after decimal point)
Size Range: 0-99999999999999.99
        AddForm940ClientDetailsobject[]Add a Collection of Form 940 Details of each client for Schedule R.
            CSeqIdstringA unique sequence number of a client.
Size Range: ..10
            ClientEINstringGets the client’s Employer identification number (EIN). Schedule R Column a.
Size Range: 9
            StateCdstringState code of the Client. Schedule R Column b.
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"
            WagesTypeCdstringGets the code type of wages,tips, and other compensation (CPEO Use Only). Schedule R Column c.
            TotTaxableWagesAmtnumberGet the total taxable FUTA wages amount. Schedule R Column d.
Size Range: 0-99999999999999.99
            FUTAAdjAmtnumberGet the total adjustments to FUTA tax. Schedule R Column e.
Size Range: 0-99999999999999.99
            TotCrdtRedAmtnumberGet the total credit reduction amount. Schedule R Column f.
Size Range: 0-99999999999999.99
            FUTATaxAfterAdjAmtnumberGet the total FUTA tax after adjustment amount. Schedule R Column g.
Size Range: 0-99999999999999.99
            TotDepositAmtnumberGet the total FUTA tax deposit amount. Schedule R Column h.
Size Range: 0-99999999999999.99
            CRecordIdGuidUnique identifier of a client record.
        UpdateForm940ClientDetailsobject[]Update a Collection of Form 940 Details of each client for Schedule R.
            CSeqIdstringA unique sequence number of a client.
Size Range: ..10
            ClientEINstringGets the client’s Employer identification number (EIN). Schedule R Column a.
Size Range: 9
            StateCdstringState code of the Client. Schedule R Column b.
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"
            WagesTypeCdstringGets the code type of wages,tips, and other compensation (CPEO Use Only). Schedule R Column c.
            TotTaxableWagesAmtnumberGet the total taxable FUTA wages amount. Schedule R Column d.
Size Range: 0-99999999999999.99
            FUTAAdjAmtnumberGet the total adjustments to FUTA tax. Schedule R Column e.
Size Range: 0-99999999999999.99
            TotCrdtRedAmtnumberGet the total credit reduction amount. Schedule R Column f.
Size Range: 0-99999999999999.99
            FUTATaxAfterAdjAmtnumberGet the total FUTA tax after adjustment amount. Schedule R Column g.
Size Range: 0-99999999999999.99
            TotDepositAmtnumberGet the total FUTA tax deposit amount. Schedule R Column h.
Size Range: 0-99999999999999.99
            CRecordIdGuidUnique identifier of a client record.
        DeleteForm940ClientDetailsobject[]Delete a Collection of Form 940 Details of each client for Schedule R.
            ClientRecordIdGuidClient Record Identifier
        Form940TotalobjectAggregate Form 940 (Totals of Clients + the main filer). For Form 940
            IsMultiStateBooleanWhen true, identifies the employer as a multi-state employer.
            WagesAmtnumberGets the amount of the total payments made to all employees. Line 3.
Size Range: 0-99999999999999.99
            ExemptWagesAmtnumberGets the amount of the payments exempt from FUTA tax. Line 4.
Size Range: 0-99999999999999.99
            IsFringeBenfsBooleanWhen true, identifies the payments exempt from FUTA tax has Fringe Benefits.
            IsGrpTermLifeInsBooleanWhen true, identifies the payments exempt from FUTA tax has Group-term life insurance.
            IsRetrmntOrPensionBooleanWhen true, identifies the payments exempt from FUTA tax has Retirement/Pension.
            IsDepCareBooleanWhen true, identifies the payments exempt from FUTA tax has Dependent care.
            IsOtherExemptBooleanWhen true, identifies the payments exempt from FUTA tax has other Exempt.
            WagesOverLmtAmtnumberGets the total amount of the payments made to each employee in excess of $7,000. Line 5
Size Range: 0-99999999999999.99
            TotExemptWagesAmtnumberGets the subtotal amount by adding the amounts on Line 4 and 5 on Line 6.
Size Range: 0-99999999999999.99
            TotTaxableWagesAmtnumberGets the total taxable FUTA wages by subtracting the amount on line 6 from line 3 on line 7.
Size Range: 0-99999999999999.99
            FUTATaxBeforeAdjAmtnumberGets the total FUTA tax before adjustments by multiplying line 7 by 0.006 on line 8.
Size Range: 0-99999999999999.99
            MaxCreditAmtnumberGets the amount by multiplying line 7 by 0.054 on line 9 if all taxable FUTA wages paid were excluded from state unemployment tax. Line 9.
Size Range: 0-99999999999999.99
            FUTAAdjAmtnumberGets some of the taxable FUTA Wages that were excluded from State Unemployment Tax or the late payments that were made for state unemployment tax.
Size Range: 0-99999999999999.99
            TotCrdtRedAmtnumberGets the FUTA taxable wages that were also subject to state unemployment taxes in any states that are subject to credit recuction. Line 11.
Size Range: 0-99999999999999.99
            FUTATaxAfterAdjAmtnumberGets the total FUTA tax after adjustments amount by adding the amounts on Lines 8, 9, 10, 11. Line 12.
Size Range: 0-99999999999999.99
            TotDepositAmtnumberGets the amount of FUTA tax deposited for the year, including any overpayment applied from a prior year. Line 13.
Size Range: 0-99999999999999.99
            FirstQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 1st quarter (January 1 – March 31). Line 16a.
Size Range: 0-99999999999999.99
            secondQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 2nd quarter (April 1 – June 30). Line 16b.
Size Range: 0-99999999999999.99
            ThirdQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 3rd quarter (July 1 – September 30). Line 16c.
Size Range: 0-99999999999999.99
            FourthQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 4th quarter (October 1 – December 31). Line 16d.
Size Range: 0-99999999999999.99
            TotTaxLiabilityAmtnumberGets the total FUTA tax liability amount for the year. Line 17.
Size Range: 0-99999999999999.99
            BalanceDueAmtnumberGets the difference amount of the balance due if line 12 is more than line 13. Line 14
Size Range: 0-99999999999999.99
            OverPaidAmtnumberGets the difference overpayment amount if line 13 is more than line 12. Line 15.
Size Range: 0-99999999999999.99
            OverPaymentRecoveryTypestringGets the overpayment recovery type. Whether to have the IRS refund the excess amount or apply it to next return. Check only one box on line 15.
Allowed values: "REFUND", "APPLYTORETURN"
        IRSPaymentTypestringPayment type to make payments to the IRS. Choose from EFW, EFTPS, Check or Money Order
Allowed values: "EFW", "EFTPS", "CHECK_OR_MO"
        IRSPaymentobjectIdentifies the details of Electronic Funds Withdrawal (EFW) if paying the balance due along with the return
            BankRoutingNumstringBank Routing Number of EFW payment
Size Range: 9
            AccountTypestringAccount Type (Checking or Saving) of EFW payment
            BankAccountNumstringBank Account Number of EFW payment
Size Range: ..17
            PhonestringPhone of EFW payment
Size Range: 10
        FinalPayRollobjectIdentifies name and address of the Record Keeper
            PersonNmstringName of the Record Keeper
Size Range: ..40
            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
                StatestringState code of the employer/payer. 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 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"
                PostalCdstringEmployer/Payer's postal code
        ScheduleAobject[]Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
            StateCdstringState code of the employer/client.
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"
            TotTaxableFUTAwagesAmtnumberTotal taxable FUTA wages amount of the state
Size Range: 0-99999999999999.99
            CreditReductionRtnumberCredit Reduction Rate of the state
Size Range: 0-99999999999999.99
            CreditReductionAmtnumberCredit Reduction amount of the state. This will be equal to the Total taxable FUTA wages amount multiplied with the Credit Reduction Rate. (Round of the amount upto 2 digits after decimal point)
Size Range: 0-99999999999999.99
    RecordIdGuidUnique identifier of a record.

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
Form940SchRRecordsobjectPulls the Form 940SCHR records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 940 Records
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        CreatedTsstringDate and time of return created.
        UpdatedTsstringDate and time of return updated.
        ClientSuccessRecordsobject[]Client Success Status.
            CSeqIdstringThis identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
            CRecordIdstringClient Record Identifier
            RecordStatusstringReturn status details like Processing, Created, Accepted, Rejected.
            CreatedTsstringReturn created date and time
            UpdatedTsstringReturn updated date and time
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 940 Records
        RecordIdGuidUnique identifier of a record
        SequencestringA unique number given by an inbound application to identify failed records.
        Errorsobject[]Shows detailed error information.
            CodestringReturns the validation error code.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
            TypestringType of validation error.
        ClientErrorRecordsobject[]Client Error Status.
            CSeqIdobject[]This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
            CRecordIdobject[]Client Record Identifier
            Errorsobject[]It will show the detailed information about the error.
                CodestringIt will return the validation error code.
                NamestringIt will return the name of the validation error.
                MessagestringIt will return the detailed message of the validation error.
                TypestringIt will show the type of an error.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Request JSON

{   "SubmissionId": "e6e465db-f293-44e6-b659-3e528ea0cec7",   "Form940SchRRecords": [       {           "Sequence": null,           "ReturnHeader": {               "ReturnType": "FORM940SCHR",               "MoreClients": false,               "TaxYr": "2020",               "Business": {                   "BusinessId": null,                   "BusinessNm": "Eastman Kodak Company",                   "TradeNm": null,                   "IsEIN": true,                   "EINorSSN": "107820402",                   "Email": "john@gmail.com",                   "ContactNm": "John",                   "Phone": "1234567890",                   "PhoneExtn": null,                   "Fax": "1234567890",                   "BusinessType": "ESTE",                   "SigningAuthority": {                       "Name": "John",                       "Phone": "1234567890",                       "BusinessMemberType": "ADMINISTRATOR"                   },                   "KindOfEmployer": null,                   "KindOfPayer": null,                   "IsBusinessTerminated": false,                   "IsForeign": false,                   "USAddress": {                       "Address1": "1751 Kinsey Rd",                       "Address2": "Main St",                       "City": "Dothan",                       "State": "SC",                       "ZipCd": "36303"                   },                   "ForeignAddress": {                       "Address1": null,                       "Address2": null,                       "City": null,                       "ProvinceOrStateNm": null,                       "Country": null,                       "PostalCd": null                   }               },               "IsThirdPartyDesignee": false,               "ThirdPartyDesignee": {                   "Name": null,                   "Phone": null,                   "PIN": null               },               "SignatureDetails": {                   "SignatureType": "ONLINE_SIGN_PIN",                   "OnlineSignaturePIN": {                       "PIN": "1234567891"                   },                   "ReportingAgentPIN": {                       "PIN": null                   },                   "Form8453EMP": null               }           },           "ReturnData": {               "Form940MainFilerData": {                   "IsSuccessorEmployer": false,                   "IsAmended": false,                   "IsPymtsMadeToEmployees": true,                   "IsBusinessClosed": false,                   "FilerType": "CPEO",                   "TotTaxableWagesAmt": 7000,                   "FUTAAdjAmt": 58,                   "TotCrdtRedAmt": 210,                   "FUTATaxAfterAdjAmt": 310,                   "TotDepositAmt": 50,                   "FUTAStates": [                       {                           "StateCd": "VI",                           "TotTaxableFUTAwagesAmt": 7000,                           "CreditReductionRt": 0.03,                           "CreditReductionAmt": 210                       }                   ]               },               "AddForm940ClientDetails": null,               "UpdateForm940ClientDetails": [                   {                       "CSeqId": "1",                       "ClientEIN": "008774111",                       "StateCd": "VI",                       "WagesTypeCd": "a",                       "TotTaxableWagesAmt": 7000,                       "FUTAAdjAmt": 58,                       "TotCrdtRedAmt": 210,                       "FUTATaxAfterAdjAmt": 310,                       "TotDepositAmt": 50,                       "CRecordId": "3982d093-1838-404b-8b0c-9bc1491c9701"                   }               ],               "DeleteForm940ClientDetails": null,               "Form940Total": {                   "IsMultiState": false,                   "WagesAmt": 27000,                   "ExemptWagesAmt": 2000,                   "IsFringeBenfs": true,                   "IsGrpTermLifeIns": false,                   "IsRetrmntOrPension": false,                   "IsDepCare": false,                   "IsOtherExempt": false,                   "WagesOverLmtAmt": 4000,                   "TotExemptWagesAmt": 6000,                   "TotTaxableWagesAmt": 21000,                   "FUTATaxBeforeAdjAmt": 126,                   "MaxCreditAmt": 0,                   "FUTAAdjAmt": 174,                   "TotCrdtRedAmt": 630,                   "FUTATaxAfterAdjAmt": 930,                   "TotDepositAmt": 150,                   "FirstQtrTaxLiabilityAmt": 300,                   "secondQtrTaxLiabilityAmt": 200,                   "ThirdQtrTaxLiabilityAmt": 430,                   "FourthQtrTaxLiabilityAmt": 0,                   "TotTaxLiabilityAmt": 930,                   "BalanceDueAmt": 780,                   "OverPaidAmt": 0,                   "OverPaymentRecoveryType": null               },               "IRSPaymentType": "EFTPS",               "IRSPayment": {                   "BankRoutingNum": null,                   "AccountType": null,                   "BankAccountNum": null,                   "Phone": null               },               "FinalPayRoll": null,               "ScheduleA": [                   {                       "StateCd": "VI",                       "TotTaxableFUTAwagesAmt": 21000,                       "CreditReductionRt": 0.03,                       "CreditReductionAmt": 630                   }               ]           },           "RecordId": "b3b9fc3c-6577-418f-bc5e-895b9478ce25"       }   ]}

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "SubmissionId": "e6e465db-f293-44e6-b659-3e528ea0cec7",   "Form940SchRRecords": {       "SuccessRecords": [           {               "Sequence": "01",               "RecordId": "b3b9fc3c-6577-418f-bc5e-895b9478ce25",               "RecordStatus": "Created",               "CreatedTs": "2021-03-29 09:54:08 -04:00",               "UpdatedTs": "2021-03-29 09:59:34 -04:00",               "ClientSuccessRecords": [                   {                       "CSeqId": "1",                       "CRecordId": "3982d093-1838-404b-8b0c-9bc1491c9701",                       "RecordStatus": "Updated",                       "CreatedTs": "2021-03-29 09:54:09 -04:00",                       "UpdatedTs": "2021-03-29 09:59:34 -04:00"                   }               ]           }       ],       "ErrorRecords": null   },   "Errors": null}