Get

Gets information of 940SCHR returns by Submission Id.

GET Form940SchR/Get 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission

Request Params

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

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message.
SubmissionId	Guid	Unique identifier of a submission
Form940SchRRecords	object[]	Employer's Form 940SCHR and aggregate Form 940 information.
RecordId	Guid	Unique identifier of a record
ReturnHeader	object	Identifies the supporting details of Form 940SCHR
ReturnType	string	Type of the return to be filed. Enter values like FORM940SCHR.
MoreClients	Boolean	When 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.
TaxYr	string	Tax year for which Form 940 SCH R needs to be filed.
Business	object	Business Details
BusinessNm	string	Name of the business
TradeNm	string	Optional Name under which the business operates
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN).
Email	string	Email address of the Business
ContactNm	string	Name of the person who can be contacted by the IRS
Phone	string	Contact number of the business with area code
PhoneExtn	string	Optional Extension of the business phone number
Fax	string	Optional Fax number of the Business
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series.
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Name of the signing authority.
Phone	string	Phone number of the signing authority.
BusinessMemberType	string	Business title of the signing authority.
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
KindOfPayer	string	Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Employer/Payer's suite or apartment Size Range: ..46
City	string	Employer/Payer's city Size Range: ..50
State	string	State 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"
ZipCd	string	Employer/Payer's zip code Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Employer/Payer's suite or apartment. Size Range: ..50
City	string	Employer/Payer's city. Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..50
Country	string	Employer/Payer country code. Refer Static values. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code. Size Range: ..16
IsThirdPartyDesignee	Boolean	When true, your third-party designee is allowed to discuss the return with the IRS
ThirdPartyDesignee	object	Third Party Designee Details
Name	string	Third Party Designee's name.
Phone	string	Third Party Designee's phone number.
PIN	string	A 5 digit PIN (Should not contain all zeroes) used when communicating to the IRS.
SignatureDetails	object	Identifies the signature type used in Form 940
SignatureType	string	Type of signature used to sign Form 940
OnlineSignaturePIN	object	A 10-digit signature PIN to become an IRS authorized signer.
PIN	string	Sign using a 10 digit PIN received from the IRS.
ReportingAgentPIN	object	A 5-digit number assigned by the IRS
PIN	string	Sign using a 5 digit PIN received from the IRS.
ReturnData	object	Identifies the Form 940SCHR and Aggregate Form 940 data.
Form940MainFilerData	object	Form 940 Details of the CPEO or the sec. 3504 Agent's employees for Schedule R
IsSuccessorEmployer	Boolean	Are you a successor employer? (Yes / No)
IsAmended	Boolean	Is this an Amended return (Yes / No)
IsPymtsMadeToEmployees	Boolean	Have you made any payments to employees during the filing tax year? (Yes / No)
IsBusinessClosed	Boolean	Is this your final return? (Business closed or stopped paying wages) (Yes / No)
FilerType	string	Section 3504 Agent / CPEO
TotTaxableWagesAmt	number	Total taxable FUTA wages amount
FUTAAdjAmt	number	FUTA Adjustment amount
TotCrdtRedAmt	number	Total credit reduction amount. Enter the total from Schedule A (Form 940)
FUTATaxAfterAdjAmt	number	Total FUTA tax after adjustments amount
TotDepositAmt	number	FUTA tax deposited for the year, including any overpayment applied from a prior year
FUTAStates	object[]	Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
StateCd	string	State code of the employer/client.
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state
CreditReductionRt	number	Credit Reduction Rate of the state
CreditReductionAmt	number	Credit 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)
Form940ClientDetails	object[]	Collection of Form 940 Details of each client for Schedule R.
CSeqId	string	A unique sequence number of a client.
ClientEIN	string	Gets the client’s Employer identification number (EIN). Schedule R Column a.
StateCd	string	State code of the Client. Schedule R Column b.
WagesTypeCd	string	Gets the code type of wages,tips, and other compensation (CPEO Use Only). Schedule R Column c.
TotTaxableWagesAmt	number	Get the total taxable FUTA wages amount. Schedule R Column d.
FUTAAdjAmt	number	Get the total adjustments to FUTA tax. Schedule R Column e.
TotCrdtRedAmt	number	Get the total credit reduction amount. Schedule R Column f.
FUTATaxAfterAdjAmt	number	Get the total FUTA tax after adjustment amount. Schedule R Column g.
TotDepositAmt	number	Get the total FUTA tax deposit amount. Schedule R Column h.
CRecordId	Guid	Unique identifier of a client record.
Form940Total	object	Aggregate Form 940 (Totals of Clients + the main filer). For Form 940
IsMultiState	Boolean	When true, identifies the employer as a multi-state employer.
WagesAmt	number	Gets the amount of the total payments made to all employees. Line 3.
ExemptWagesAmt	number	Gets the amount of the payments exempt from FUTA tax. Line 4.
IsFringeBenfs	Boolean	When true, identifies the payments exempt from FUTA tax has Fringe Benefits.
IsGrpTermLifeIns	Boolean	When true, identifies the payments exempt from FUTA tax has Group-term life insurance.
IsRetrmntOrPension	Boolean	When true, identifies the payments exempt from FUTA tax has Retirement/Pension.
IsDepCare	Boolean	When true, identifies the payments exempt from FUTA tax has Dependent care.
IsOtherExempt	Boolean	When true, identifies the payments exempt from FUTA tax has other Exempt.
WagesOverLmtAmt	number	Gets the total amount of the payments made to each employee in excess of $7,000. Line 5
TotExemptWagesAmt	number	Gets the subtotal amount by adding the amounts on Line 4 and 5 on Line 6.
TotTaxableWagesAmt	number	Gets the total taxable FUTA wages by subtracting the amount on line 6 from line 3 on line 7.
FUTATaxBeforeAdjAmt	number	Gets the total FUTA tax before adjustments by multiplying line 7 by 0.006 on line 8.
MaxCreditAmt	number	Gets 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.
FUTAAdjAmt	number	Gets some of the taxable FUTA Wages that were excluded from State Unemployment Tax or the late payments that were made for state unemployment tax.
TotCrdtRedAmt	number	Gets the FUTA taxable wages that were also subject to state unemployment taxes in any states that are subject to credit recuction. Line 11.
FUTATaxAfterAdjAmt	number	Gets the total FUTA tax after adjustments amount by adding the amounts on Lines 8, 9, 10, 11. Line 12.
TotDepositAmt	number	Gets the amount of FUTA tax deposited for the year, including any overpayment applied from a prior year. Line 13.
FirstQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 1st quarter (January 1 – March 31). Line 16a.
secondQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 2nd quarter (April 1 – June 30). Line 16b.
ThirdQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 3rd quarter (July 1 – September 30). Line 16c.
FourthQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 4th quarter (October 1 – December 31). Line 16d.
TotTaxLiabilityAmt	number	Gets the total FUTA tax liability amount for the year. Line 17.
BalanceDueAmt	number	Gets the difference amount of the balance due if line 12 is more than line 13. Line 14
OverPaidAmt	number	Gets the difference overpayment amount if line 13 is more than line 12. Line 15.
OverPaymentRecoveryType	string	Gets 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.
IRSPaymentType	string	Payment type to make payments to the IRS. Choose from EFW, EFTPS, Check or Money Order
IRSPayment	object	Identifies the details of Electronic Funds Withdrawal (EFW) if paying the balance due along with the return
BankRoutingNum	string	Bank Routing Number of EFW payment
AccountType	string	Account Type (Checking or Saving) of EFW payment
BankAccountNum	string	Bank Account Number of EFW payment
Phone	string	Phone of EFW payment
FinalPayRoll	object	Identifies name and address of the Record Keeper
PersonNm	string	Name of the Record Keeper
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	if IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality)
Address2	string	Optional Employer/Payer's suite or apartment
City	string	Employer/Payer's city
State	string	State code of the employer/payer. Refer Static values.
ZipCd	string	Employer/Payer's zip code. Size Range: 5..10
ForeignAddress	object	if IsForeign is true, pass foreign address of the business.
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality).
Address2	string	Optional Employer/Payer's suite or apartment
City	string	Employer/Payer's city
ProvinceOrStateNm	string	Employer/Payer's province or state name.
Country	string	Employer/Payer country code. Refer Static values.
PostalCd	string	Employer/Payer's postal code
ScheduleA	object[]	Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
StateCd	string	State code of the employer/client.
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state
CreditReductionRt	number	Credit Reduction Rate of the state
CreditReductionAmt	number	Credit 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)
Errors	object[]	Shows detailed error information.
Code	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Type	string	Type 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
}