Skip to main content
Version: 1.7.1

Get

Gets information of 940SCHR returns by Submission Id.

GET Form940SchR/Get 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission

Request Params

"Form940SCHR/Get?SubmissionId=e6e465db-f293-44e6-b659-3e528ea0cec7"

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
Form940SchRRecordsobject[]Employer's Form 940SCHR and aggregate Form 940 information.
    RecordIdGuidUnique identifier of a record
    ReturnHeaderobjectIdentifies the supporting details of Form 940SCHR
        ReturnTypestringType of the return to be filed. Enter values like 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 SCH R needs to be filed.
        BusinessobjectBusiness Details
            BusinessNmstringName of the business
            TradeNmstringOptional Name under which the business operates
            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).
            EmailstringEmail address of the Business
            ContactNmstringName of the person who can be contacted by the IRS
            PhonestringContact number of the business with area code
            PhoneExtnstringOptional Extension of the business phone number
            FaxstringOptional Fax number of the Business
            BusinessTypestringType of business. Optional for W-2/1099 and mandatory for 94X series.
            SigningAuthorityobjectDetails of the person who is authorized to sign the return.
                NamestringName of the signing authority.
                PhonestringPhone number of the signing authority.
                BusinessMemberTypestringBusiness title of the signing authority.
            KindOfEmployerstringIdentifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
            KindOfPayerstringIdentifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.
            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: ..46
                Address2stringOptional Employer/Payer's suite or apartment
Size Range: ..46
                CitystringEmployer/Payer's city
Size Range: ..50
                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
Size Range: 5..10
            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: ..50
                Address2stringOptional Employer/Payer's suite or apartment.
Size Range: ..50
                CitystringEmployer/Payer's city.
Size Range: ..50
                ProvinceOrStateNmstringEmployer/Payer's province or state name.
Size Range: ..50
                CountrystringEmployer/Payer country code. Refer Static values.
Size Range: 2
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

                PostalCdstringEmployer/Payer's postal code.
Size Range: ..16
        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.
            ReportingAgentPINobjectA 5-digit number assigned by the IRS
                PINstringSign using a 5 digit PIN received from the IRS.
    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
            TotTaxableWagesAmtnumberTotal taxable FUTA wages amount
            FUTAAdjAmtnumberFUTA Adjustment amount
            TotCrdtRedAmtnumberTotal credit reduction amount. Enter the total from Schedule A (Form 940)
            FUTATaxAfterAdjAmtnumberTotal FUTA tax after adjustments amount
            TotDepositAmtnumberFUTA tax deposited for the year, including any overpayment applied from a prior year
            FUTAStatesobject[]Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
                StateCdstringState code of the employer/client.
                TotTaxableFUTAwagesAmtnumberTotal taxable FUTA wages amount of the state
                CreditReductionRtnumberCredit Reduction Rate of the state
                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)
        Form940ClientDetailsobject[]Collection of Form 940 Details of each client for Schedule R.
            CSeqIdstringA unique sequence number of a client.
            ClientEINstringGets the client’s Employer identification number (EIN). Schedule R Column a.
            StateCdstringState code of the Client. Schedule R Column b.
            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.
            FUTAAdjAmtnumberGet the total adjustments to FUTA tax. Schedule R Column e.
            TotCrdtRedAmtnumberGet the total credit reduction amount. Schedule R Column f.
            FUTATaxAfterAdjAmtnumberGet the total FUTA tax after adjustment amount. Schedule R Column g.
            TotDepositAmtnumberGet the total FUTA tax deposit amount. Schedule R Column h.
            CRecordIdGuidUnique identifier of a client record.
        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.
            ExemptWagesAmtnumberGets the amount of the payments exempt from FUTA tax. Line 4.
            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
            TotExemptWagesAmtnumberGets the subtotal amount by adding the amounts on Line 4 and 5 on Line 6.
            TotTaxableWagesAmtnumberGets the total taxable FUTA wages by subtracting the amount on line 6 from line 3 on line 7.
            FUTATaxBeforeAdjAmtnumberGets the total FUTA tax before adjustments by multiplying line 7 by 0.006 on line 8.
            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.
            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.
            TotCrdtRedAmtnumberGets the FUTA taxable wages that were also subject to state unemployment taxes in any states that are subject to credit recuction. Line 11.
            FUTATaxAfterAdjAmtnumberGets the total FUTA tax after adjustments amount by adding the amounts on Lines 8, 9, 10, 11. Line 12.
            TotDepositAmtnumberGets the amount of FUTA tax deposited for the year, including any overpayment applied from a prior year. Line 13.
            FirstQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 1st quarter (January 1 – March 31). Line 16a.
            secondQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 2nd quarter (April 1 – June 30). Line 16b.
            ThirdQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 3rd quarter (July 1 – September 30). Line 16c.
            FourthQtrTaxLiabilityAmtnumberGets the FUTA Tax Liability amount for 4th quarter (October 1 – December 31). Line 16d.
            TotTaxLiabilityAmtnumberGets the total FUTA tax liability amount for the year. Line 17.
            BalanceDueAmtnumberGets the difference amount of the balance due if line 12 is more than line 13. Line 14
            OverPaidAmtnumberGets the difference overpayment amount if line 13 is more than line 12. Line 15.
            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.
        IRSPaymentTypestringPayment type to make payments to the IRS. Choose from EFW, EFTPS, Check or Money Order
        IRSPaymentobjectIdentifies the details of Electronic Funds Withdrawal (EFW) if paying the balance due along with the return
            BankRoutingNumstringBank Routing Number of EFW payment
            AccountTypestringAccount Type (Checking or Saving) of EFW payment
            BankAccountNumstringBank Account Number of EFW payment
            PhonestringPhone of EFW payment
        FinalPayRollobjectIdentifies name and address of the Record Keeper
            PersonNmstringName of the Record Keeper
            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)
                Address2stringOptional Employer/Payer's suite or apartment
                CitystringEmployer/Payer's city
                StatestringState code of the employer/payer. Refer Static values.
                ZipCdstringEmployer/Payer's zip code.
Size Range: 5..10
            ForeignAddressobjectif IsForeign is true, pass foreign address of the business.
                Address1stringEmployer/Payer's foreign address (street address or post office box of that locality).
                Address2stringOptional Employer/Payer's suite or apartment
                CitystringEmployer/Payer's city
                ProvinceOrStateNmstringEmployer/Payer's province or state name.
            CountrystringEmployer/Payer country code. Refer Static values.
                PostalCdstringEmployer/Payer's postal code
        ScheduleAobject[]Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
            StateCdstringState code of the employer/client.
            TotTaxableFUTAwagesAmtnumberTotal taxable FUTA wages amount of the state
            CreditReductionRtnumberCredit Reduction Rate of the state
            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)
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "e6e465db-f293-44e6-b659-3e528ea0cec7",
"Form940SchRRecords": [
{
"RecordId": "b3b9fc3c-6577-418f-bc5e-895b9478ce25",
"RecordStatus": "Created",
"ReturnHeader": {
"ReturnType": "Form940SCHR",
"MoreClients": false,
"TaxYr": "2022",
"Business": {
"BusinessId": "94cc7c3e-a7be-42c9-acd5-d1c90957e897",
"BusinessNm": "Snowdaze LLC",
"TradeNm": null,
"IsEIN": true,
"EINorSSN": "107820402",
"Email": "sample@bodeem.com",
"ContactNm": "John",
"Phone": "1234567890",
"PhoneExtn": null,
"Fax": "(123) 456-7890",
"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": null,
"SignatureDetails": {
"SignatureType": "ONLINE_SIGN_PIN",
"OnlineSignaturePIN": {
"PIN": "1234567891"
},
"ReportingAgentPIN": null,
"Form8453EMP": null
}
},
"ReturnData": {
"Form940MainFilerData": {
"IsSuccessorEmployer": false,
"IsAmended": false,
"IsPymtsMadeToEmployees": true,
"IsBusinessClosed": false,
"FilerType": "CPEO",
"TotTaxableWagesAmt": 7000.00,
"FUTAAdjAmt": 58.00,
"TotCrdtRedAmt": 210.00,
"FUTATaxAfterAdjAmt": 310.00,
"TotDepositAmt": 50.00,
"FUTAStates": [
{
"StateCd": "VI",
"TotTaxableFUTAwagesAmt": 7000.00,
"CreditReductionRt": 0.030,
"CreditReductionAmt": 210.00
}
]
},
"Form940ClientDetails": [
{
"CSeqId": "1",
"ClientEIN": "00-8774111",
"StateCd": "VI",
"WagesTypeCd": "a",
"TotTaxableWagesAmt": 7000.00,
"FUTAAdjAmt": 58.00,
"TotCrdtRedAmt": 210.00,
"FUTATaxAfterAdjAmt": 310.00,
"TotDepositAmt": 50.00,
"CRecordId": "3982d093-1838-404b-8b0c-9bc1491c9701"
},
{
"CSeqId": "2",
"ClientEIN": "00-1174111",
"StateCd": "VI",
"WagesTypeCd": "c",
"TotTaxableWagesAmt": 7000.00,
"FUTAAdjAmt": 58.00,
"TotCrdtRedAmt": 210.00,
"FUTATaxAfterAdjAmt": 310.00,
"TotDepositAmt": 50.00,
"CRecordId": "da29c3d3-57f5-451a-9d54-06a7a6dc232e"
}
],
"Form940Total": {
"IsMultiState": false,
"WagesAmt": 27000.00,
"ExemptWagesAmt": 2000.00,
"IsFringeBenfs": true,
"IsGrpTermLifeIns": false,
"IsRetrmntOrPension": false,
"IsDepCare": false,
"IsOtherExempt": false,
"WagesOverLmtAmt": 4000.00,
"TotExemptWagesAmt": 6000.00,
"TotTaxableWagesAmt": 21000.00,
"FUTATaxBeforeAdjAmt": 126.00,
"MaxCreditAmt": 0.00,
"FUTAAdjAmt": 174.00,
"TotCrdtRedAmt": 630.00,
"FUTATaxAfterAdjAmt": 930.00,
"TotDepositAmt": 150.00,
"FirstQtrTaxLiabilityAmt": 300.00,
"secondQtrTaxLiabilityAmt": 200.00,
"ThirdQtrTaxLiabilityAmt": 430.00,
"FourthQtrTaxLiabilityAmt": 0.00,
"TotTaxLiabilityAmt": 930.00,
"BalanceDueAmt": 780.00,
"OverPaidAmt": 0.00,
"OverPaymentRecoveryType": null
},
"IRSPaymentType": "EFTPS",
"IRSPayment": {
"BankRoutingNum": null,
"AccountType": null,
"BankAccountNum": null,
"Phone": null
},
"FinalPayRoll": null,
"ScheduleA": [
{
"StateCd": "VI",
"TotTaxableFUTAwagesAmt": 21000.00,
"CreditReductionRt": 0.030,
"CreditReductionAmt": 630.00
}
]
}
}
],
"Errors": null
}