# Form940SchR

# Create

Creates aggregate Form 940 and Schedule R returns with a unique Submission Id which is further used for all other methods referencing these 940SCHRs.

POST Form940SchR/Create

Request Body

Field	Type	Description
Form940SchRRecords	object[]	Object to create 940SCHRs
Sequence	string	A unique number given by an inbound application to identify failed records. Size Range: ..10
ReturnHeader	object	Identifies the supporting details of Form 940/940SCHR
ReturnType	string	Type of the return to be filed. Enter values like FORM940, FORM940PR, FORM940SS, FORM940SCHR. Allowed values: "FORM941", "FORM941PR", "FORM941SS", "FORM940", "FORM940SCHR", "FORM940PR", "FORM941SCHR"
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/940 SCH R needs to be filed. Allowed values: "2018", "2019", "2020"
Business	object	Object to identify the Business details.
BusinessId	Guid	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.
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	`Optional` Name under which the business operates Size Range: ..75
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). Size Range: ..9
Email	string	Email address of the business Size Range: ..40
ContactNm	string	Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Contact number of the business. Size Range: 10
PhoneExtn	string	`Optional` Extension of the business phone number Size Range: ..5
Fax	string	`Optional` Fax number of the Business Size Range: 10
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series. Size Range: ..4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Name of the signing authority. Size Range: ..35
Phone	string	Phone number of the signing authority. Size Range: 10
BusinessMemberType	string	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"
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series. Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Identifies 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"
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
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
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment. Size Range: ..35
City	string	Employer/Payer's city. Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..30
Country	string	Employer/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"
PostalCd	string	Employer/Payer's postal code
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. Size Range: 10
ReportingAgentPIN	object	A 5-digit number assigned by the IRS
PIN	string	Sign using a 5 digit PIN received from the IRS. Size Range: 5
Form8453EMP	object	An alternate option to sign the return using Form 8453 EMP when there is no PIN
AttachmentNm	string	Name of the Form 8453EMP attachment
Attachment	byte[]	Byte array of Form-8453 pdf
AttachmentFileType	string	Type of the file Attachment
SignedDate	DateTime	Date and time on which the Form 8453-EMP was signed
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 Allowed values: "SECTION3504AGENT", "CPEO"
TotTaxableWagesAmt	number	Total taxable FUTA wages amount Size Range: 0-9999999999999.99
FUTAAdjAmt	number	FUTA Adjustment amount Size Range: 0-9999999999999.99
TotCrdtRedAmt	number	Total credit reduction amount. Enter the total from Schedule A (Form 940) Size Range: 0-9999999999999.99
FUTATaxAfterAdjAmt	number	Total FUTA tax after adjustments amount Size Range: 0-9999999999999.99
TotDepositAmt	number	FUTA tax deposited for the year, including any overpayment applied from a prior year Size Range: 0-9999999999999.99
FUTAStates	object[]	Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
StateCd	string	State 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"
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state Size Range: 0-99999999999999.99
CreditReductionRt	number	Credit Reduction Rate of the state Size Range: 0-99999999999999.99
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) Size Range: 0-99999999999999.99
Form940ClientDetails	object[]	Collection of Form 940 Details of each client for Schedule R.
CSeqId	string	A unique sequence number of a client. Size Range: ..10
ClientEIN	string	Gets the client’s Employer identification number (EIN). Schedule R Column a. Size Range: 9
StateCd	string	State 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"
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. Size Range: 0-99999999999999.99
FUTAAdjAmt	number	Get the total adjustments to FUTA tax. Schedule R Column e. Size Range: 0-99999999999999.99
TotCrdtRedAmt	number	Get the total credit reduction amount. Schedule R Column f. Size Range: 0-99999999999999.99
FUTATaxAfterAdjAmt	number	Get the total FUTA tax after adjustment amount. Schedule R Column g. Size Range: 0-99999999999999.99
TotDepositAmt	number	Get the total FUTA tax deposit amount. Schedule R Column h. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
ExemptWagesAmt	number	Gets the amount of the payments exempt from FUTA tax. Line 4. Size Range: 0-99999999999999.99
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 Size Range: 0-99999999999999.99
TotExemptWagesAmt	number	Gets the subtotal amount by adding the amounts on Line 4 and 5 on Line 6. Size Range: 0-99999999999999.99
TotTaxableWagesAmt	number	Gets the total taxable FUTA wages by subtracting the amount on line 6 from line 3 on line 7. Size Range: 0-99999999999999.99
FUTATaxBeforeAdjAmt	number	Gets the total FUTA tax before adjustments by multiplying line 7 by 0.006 on line 8. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
FUTATaxAfterAdjAmt	number	Gets the total FUTA tax after adjustments amount by adding the amounts on Lines 8, 9, 10, 11. Line 12. Size Range: 0-99999999999999.99
TotDepositAmt	number	Gets the amount of FUTA tax deposited for the year, including any overpayment applied from a prior year. Line 13. Size Range: 0-99999999999999.99
FirstQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 1st quarter (January 1 – March 31). Line 16a. Size Range: 0-99999999999999.99
secondQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 2nd quarter (April 1 – June 30). Line 16b. Size Range: 0-99999999999999.99
ThirdQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 3rd quarter (July 1 – September 30). Line 16c. Size Range: 0-99999999999999.99
FourthQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 4th quarter (October 1 – December 31). Line 16d. Size Range: 0-99999999999999.99
TotTaxLiabilityAmt	number	Gets the total FUTA tax liability amount for the year. Line 17. Size Range: 0-99999999999999.99
BalanceDueAmt	number	Gets the difference amount of the balance due if line 12 is more than line 13. Line 14 Size Range: 0-99999999999999.99
OverPaidAmt	number	Gets the difference overpayment amount if line 13 is more than line 12. Line 15. Size Range: 0-99999999999999.99
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. Allowed values: "REFUND", "APPLYTORETURN"
IRSPaymentType	string	Payment type to make payments to the IRS. Choose from EFW, EFTPS, Check or Money Order Allowed values: "EFW", "EFTPS", "CHECK_OR_MO"
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 Size Range: 9
AccountType	string	Account Type (Checking or Saving) of EFW payment
BankAccountNum	string	Bank Account Number of EFW payment Size Range: ..17
Phone	string	Phone of EFW payment Size Range: 10
FinalPayRoll	object	Identifies name and address of the Record Keeper
PersonNm	string	Name of the Record Keeper Size Range: ..40
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
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.
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..30
Country	string	Employer/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"
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. 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"
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state Size Range: 0-99999999999999.99
CreditReductionRt	number	Credit Reduction Rate of the state Size Range: 0-99999999999999.99
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) Size Range: 0-99999999999999.99

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	Pulls the Form 940SCHR records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 Records
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
CreatedTs	string	Date and time of return created.
UpdatedTs	string	Date and time of return updated.
ClientSuccessRecords	object[]	Client Success Status.
CSeqId	string	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	string	Client Record Identifier
RecordStatus	string	Return status details like Processing, Created, Accepted, Rejected.
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	It will show the detailed information about the error status of Form 940 Records
RecordId	Guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
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.
ClientErrorRecords	object[]	Client Error Status.
CSeqId	object[]	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	object[]	Client Record Identifier
Errors	object[]	It will show the detailed information about the error.
Code	string	It will return the validation error code.
Name	string	It will return the name of the validation error.
Message	string	It will return the detailed message of the validation error.
Type	string	It will show the type of an error.
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.

Request JSON

{
   "Form940SchRRecords": [
       {
           "Sequence": "01",
           "ReturnHeader": {
               "ReturnType": "FORM940SCHR",
               "MoreClients": false,
               "TaxYr": "2020",
               "Business": {
                   "BusinessId": null,
                   "BusinessNm": "Eastman Kodak Company",
                   "TradeNm": "Kodak",
                   "IsEIN": true,
                   "EINorSSN": "107820069",
                   "Email": "john@gmail.com",
                   "ContactNm": "John Parker",
                   "Phone": "1234567890",
                   "PhoneExtn": "32324",
                   "Fax": "3456734567",
                   "BusinessType": "PART",
                   "SigningAuthority": {
                       "Name": "Peter Parker",
                       "Phone": "1234567891",
                       "BusinessMemberType": "MEMBER"
                   },
                   "KindOfEmployer": "STATEORLOCAL501C",
                   "KindOfPayer": "HOUSEHOLD",
                   "IsBusinessTerminated": false,
                   "IsForeign": true,
                   "USAddress": {
                       "Address1": "1751 Kinsey Rd",
                       "Address2": "Main St",
                       "City": "Dothan",
                       "State": "AL",
                       "ZipCd": "36303"
                   },
                   "ForeignAddress": {
                       "Address1": "45 Main St",
                       "Address2": "Crescent Ave",
                       "City": "Toronto",
                       "ProvinceOrStateNm": "ON",
                       "Country": "CA",
                       "PostalCd": "4T3 B5F"
                   }
               },
               "IsThirdPartyDesignee": false,
               "ThirdPartyDesignee": null,
               "SignatureDetails": {
                   "SignatureType": "ONLINE_SIGN_PIN",
                   "OnlineSignaturePIN": {
                       "PIN": "5555577777"
                   },
                   "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
                       }
                   ]
               },
               "Form940ClientDetails": [
                   {
                       "CSeqId": "1",
                       "ClientEIN": "008774111",
                       "StateCd": "VI",
                       "WagesTypeCd": "A",
                       "TotTaxableWagesAmt": 7000,
                       "FUTAAdjAmt": 58,
                       "TotCrdtRedAmt": 210,
                       "FUTATaxAfterAdjAmt": 310,
                       "TotDepositAmt": 50,
                       "CRecordId": null
                   },
                   {
                       "CSeqId": "2",
                       "ClientEIN": "001174111",
                       "StateCd": "VI",
                       "WagesTypeCd": "c",
                       "TotTaxableWagesAmt": 7000,
                       "FUTAAdjAmt": 58,
                       "TotCrdtRedAmt": 210,
                       "FUTATaxAfterAdjAmt": 310,
                       "TotDepositAmt": 50,
                       "CRecordId": null
                   }
               ],
               "Form940Total": {
                   "IsMultiState": true,
                   "WagesAmt": 27000,
                   "ExemptWagesAmt": 2000,
                   "IsFringeBenfs": false,
                   "IsGrpTermLifeIns": false,
                   "IsRetrmntOrPension": false,
                   "IsDepCare": false,
                   "IsOtherExempt": true,
                   "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": {
                   "PersonNm": null,
                   "IsForeign": false,
                   "USAddress": {
                       "Address1": null,
                       "Address2": null,
                       "City": null,
                       "State": null,
                       "ZipCd": null
                   },
                   "ForeignAddress": {
                       "Address1": null,
                       "Address2": null,
                       "City": null,
                       "ProvinceOrStateNm": null,
                       "Country": null,
                       "PostalCd": null
                   }                    
               },
               "ScheduleA": [
                   {
                       "StateCd": "VI",
                       "TotTaxableFUTAwagesAmt": 21000,
                       "CreditReductionRt": 0.03,
                       "CreditReductionAmt": 630
                   },
                   {
                       "StateCd": "CA",
                       "TotTaxableFUTAwagesAmt": 21000,
                       "CreditReductionRt": 0,
                       "CreditReductionAmt": 0
                   },
                   {
                       "StateCd": "MA",
                       "TotTaxableFUTAwagesAmt": 21000,
                       "CreditReductionRt": 0,
                       "CreditReductionAmt": 0
                   }
               ]
           }
       }
   ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

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:54:08 -04:00",
               "ClientSuccessRecords": [
                   {
                       "CSeqId": "1",
                       "CRecordId": "3982d093-1838-404b-8b0c-9bc1491c9701",
                       "RecordStatus": "Created",
                       "CreatedTs": "2021-03-29 09:54:09 -04:00",
                       "UpdatedTs": "2021-03-29 09:54:09 -04:00"
                   },
                   {
                       "CSeqId": "2",
                       "CRecordId": "da29c3d3-57f5-451a-9d54-06a7a6dc232e",
                       "RecordStatus": "Created",
                       "CreatedTs": "2021-03-29 09:54:09 -04:00",
                       "UpdatedTs": "2021-03-29 09:54:09 -04:00"
                   }
               ]
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# Delete

Deletes 940SCHR returns by Submission Ids and Record Ids.

DELETE Form940SchR/Delete

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission
RecordIds	string	Deletes a list of record Ids

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	Pulls the Form 940SCHR records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 Records
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
CreatedTs	string	Date and time of return created.
UpdatedTs	string	Date and time of return updated.
ClientSuccessRecords	object[]	Client Success Status.
CSeqId	string	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	string	Client Record Identifier
RecordStatus	string	Return status details like Processing, Created, Accepted, Rejected.
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	It will show the detailed information about the error status of Form 940 Records
RecordId	Guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
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.
ClientErrorRecords	object[]	Client Error Status.
CSeqId	object[]	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	object[]	Client Record Identifier
Errors	object[]	It will show the detailed information about the error.
Code	string	It will return the validation error code.
Name	string	It will return the name of the validation error.
Message	string	It will return the detailed message of the validation error.
Type	string	It will show the type of an error.
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.

Request JSON

Form940SCHR/Delete?SubmissionId=7dd5c92c-1832-45f8-acbf-748d28f9e4ea&RecordIds=3909399a-7566-4810-9b88-f4442a59a923

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "7dd5c92c-1832-45f8-acbf-748d28f9e4ea",
 "Form940SchRecords": {
   "SuccessRecords": [
     {
       "Sequence": "",
       "RecordId": "3909399a-7566-4810-9b88-f4442a59a923",
       "RecordStatus": "DELETED",
       "CreatedTs": "8/7/2019 3:33:38 AM",
       "UpdatedTs": "8/7/2019 3:36:09 AM",
       "ClientSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# DownloadForm8453EMP

Downloads Form 8453 EMP by Record Id.

POST Form940SchR/DownloadForm8453EMP

Request Body

Field	Type	Description
RecordId	guid	Unique identifier of a record

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.
RecordId	Guid	Unique identifier of a record
Form8453EMPPdf	byte[]	Pulls the byte array of Form-8453 pdf records with Success and Error statuses
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.

Request JSON

{
 "RecordId": "0593adf3-4bcf-4ba6-98f4-1e76805a03e8",
 "Form8453EMPPdf": "QEA="
}

1
2
3
4

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "RecordId": "6dfef967-e3b5-4f53-886f-a52099c72422",
 "Form8453EMPPdf": "We've successfully received your Form 8453 PDF",
 "Errors": null
}

1
2
3
4
5
6
7
8

# Get

Gets information of 940SCHR returns by Submission Id.

GET Form940SchR/Get

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission

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 940/940SCHR
ReturnType	string	Type of the return to be filed. Enter values like FORM940, FORM940PR, FORM940SS, 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/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)
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
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
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.
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.

Request JSON

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

Response JSON

{
   "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": "2020",
               "Business": {
                   "BusinessId": "94cc7c3e-a7be-42c9-acd5-d1c90957e897",
                   "BusinessNm": "Eastman Kodak Company",
                   "TradeNm": null,
                   "IsEIN": true,
                   "EINorSSN": "107820402",
                   "Email": "john@gmail.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
}

# GetPDF

Request a PDF download of forms 940SCHR and 940 to be made available through Webhooks.

GET Form940SchR/GetPDF

Request Body

Field	Type	Description
SubmissionId	string	Unique identifier of a submission
RecordIds	string	Downloads a list of Record IDs

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
Form940pdfRecords	object[]	Form940pdfRecords Object
RecordId	Guid	Unique identifier of a record
Form940pdf	string	Returns the record ID with success message after generating a PDF.
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.

Request JSON

Form940SCHR/GetPDF?SubmissionId=9723f666-c46e-43e6-8c56-8cba391acbf7&RecordIds=554fb9c3-b68b-4a52-9114-792cd4a70433

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
 "Form940pdfRecords": [
   {
     "RecordId": "554fb9c3-b68b-4a52-9114-792cd4a70433",
     "Form940pdf": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
   }
 ],
 "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# List

Lists Form 940SCHRs created for a date range.

GET Form940SchR/List

Request Body

Field	Type	Description
BusinessId	guid	Unique identifier of a business
EIN	string	Employer Identification Number
Page	number	Pulls the page number of the page selected
PageSize	number	Number of 940SCHR records to be listed in each page
EfileStatus	string	List the 940SCHR records based on the status
FromDate	string	List 940SCHR records created from
ToDate	string	List 940SCHR records created up to

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.
Form940SchRRecordList	object[]	Returns detailed information of the Form 940SCHR records.
SubmissionId	guid	Submission Identifier
BusinessId	guid	Business Identifier
BusinessNm	string	Business Name
EIN	string	Employer Identification Number
BusinessType	string	Business Type
RecordId	guid	Record Identifier
TaxYr	string	Tax Year
IRSPaymentType	string	IRS Payment Type
ReturnType	string	Return Type
EFileStatus	string	Efile Status (Created, Transmitted, Accepted, Rejected)
ClientCnt	number
ClientRecordId	guid[]
TotalRecords	number	Total number of Businesses
TotalPages	number	Total number of pages
Page	number	Pulls the page number of the page selected
PageSize	number	Number of 940SCHR records to be listed in each page.
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.

Request JSON

"Form940SCHR/List?BusinessId=e0e21430-ca3a-4573-bb70-f792ff160ca1&EIN=007820414&Page=1&PageSize=10&EfileStatus=null&FromDate=07/01/2021&ToDate=03/31/2021"

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "Form940SchRRecordList": [
   {
     "ClientCnt": 2,
     "ClientRecordId": [
       "3982d093-1838-404b-8b0c-9bc1491c9701",
       "11aa7f66-9bfd-449e-af4c-cdaefd8fc20b"
     ],
     "EFileStatus": "CREATED",
     "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
     "BusinessId": "e0e21430-ca3a-4573-bb70-f792ff160ca1",
     "BusinessNm": "Eastman Kodak Company",
     "EIN": "00-7820414",
     "BusinessType": "Estate",
     "RecordId": "e6e465db-f293-44e6-b659-3e528ea0cec7",
     "TaxYr": "2020",
     "IRSPaymentType": null,
     "ReturnType": "Form940SCHR"
   }
 ],
 "TotalRecords": 1,
 "TotalPages": 1,
 "Page": 1,
 "PageSize": 10,
 "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# Status

Gets the status of the 940SCHR returns by Submission Id and Record Ids.

GET Form940SchR/Status

Request Body

Field	Type	Description
SubmissionId	string	Unique identifier of a submission
RecordIds	string	List of record Ids to get status.
ReturnType	string	Type of the return to be filed. Enter values like FORM940, FORM940PR, FORM940SS, FORM940SCHR
EIN	string	Employer Identification Number
TaxYear	string	The Tax year for which Form 940/940 SCH R needs to be filed.

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	Pulls the Form 940SCHR records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 Records
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
CreatedTs	string	Date and time of return created.
UpdatedTs	string	Date and time of return updated.
ClientSuccessRecords	object[]	Client Success Status.
CSeqId	string	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	string	Client Record Identifier
RecordStatus	string	Return status details like Processing, Created, Accepted, Rejected.
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	It will show the detailed information about the error status of Form 940 Records
RecordId	Guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
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.
ClientErrorRecords	object[]	Client Error Status.
CSeqId	object[]	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	object[]	Client Record Identifier
Errors	object[]	It will show the detailed information about the error.
Code	string	It will return the validation error code.
Name	string	It will return the name of the validation error.
Message	string	It will return the detailed message of the validation error.
Type	string	It will show the type of an error.
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.

Request JSON

Form940SCHR/Status?SubmissionId=9723f666-c46e-43e6-8c56-8cba391acbf7&RecordIds=554fb9c3-b68b-4a52-9114-792cd4a70433&EIN=007820414&TaxYear=2018

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
 "Form940SchRRecords": {
   "SuccessRecords": [
     {
       "Sequence": "",
       "RecordId": "554fb9c3-b68b-4a52-9114-792cd4a70433",
       "RecordStatus": "Created",
       "CreatedTs": "2019-08-07 02:59:41 -04:00",
       "UpdatedTs": "2019-08-07 03:24:00 -04:00",
       "ClientSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# Transmit

Transmits 940SCHR forms to the IRS after validation.

POST Form940SchR/Transmit

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission
RecordIds	guid[]	Transmits a list of Record IDs

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	Pulls the Form 940SCHR records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 Records
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
CreatedTs	string	Date and time of return created.
UpdatedTs	string	Date and time of return updated.
ClientSuccessRecords	object[]	Client Success Status.
CSeqId	string	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	string	Client Record Identifier
RecordStatus	string	Return status details like Processing, Created, Accepted, Rejected.
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	It will show the detailed information about the error status of Form 940 Records
RecordId	Guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
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.
ClientErrorRecords	object[]	Client Error Status.
CSeqId	object[]	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	object[]	Client Record Identifier
Errors	object[]	It will show the detailed information about the error.
Code	string	It will return the validation error code.
Name	string	It will return the name of the validation error.
Message	string	It will return the detailed message of the validation error.
Type	string	It will show the type of an error.
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.

Request JSON

{
 "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
 "RecordIds": [
   "554fb9c3-b68b-4a52-9114-792cd4a70433"
 ]
}

1
2
3
4
5
6

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
 "Form940SchRRecords": {
   "SuccessRecords": [
     {
       "Sequence": null,
       "RecordId": "554fb9c3-b68b-4a52-9114-792cd4a70433",
       "RecordStatus": "Transmitted",
       "CreatedTs": "8/7/2019 2:59:41 AM",
       "UpdatedTs": "8/7/2019 3:53:24 AM",
       "ClientSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 },
 "Errors": []
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# Update

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

PUT Form940SchR/Update

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission.
Form940SchRRecords	object[]	Collection of objects to update Form 940SCHR and aggregate Form 940 records.
Sequence	string	A unique number given by an inbound application to identify failed records. Size Range: ..10
ReturnHeader	object	Identifies the supporting details of Form 940/940SCHR
ReturnType	string	Type of the return to be filed. Enter values like FORM940, FORM940PR, FORM940SS, FORM940SCHR. Allowed values: "FORM941", "FORM941PR", "FORM941SS", "FORM940", "FORM940SCHR", "FORM940PR", "FORM941SCHR"
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/940 SCH R needs to be filed. Allowed values: "2018", "2019", "2020"
Business	object	Object to identify the Business details.
BusinessId	Guid	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.
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	`Optional` Name under which the business operates Size Range: ..75
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). Size Range: ..9
Email	string	Email address of the business Size Range: ..40
ContactNm	string	Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Contact number of the business. Size Range: 10
PhoneExtn	string	`Optional` Extension of the business phone number Size Range: ..5
Fax	string	`Optional` Fax number of the Business Size Range: 10
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series. Size Range: ..4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Name of the signing authority. Size Range: ..35
Phone	string	Phone number of the signing authority. Size Range: 10
BusinessMemberType	string	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"
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series. Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Identifies 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"
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
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
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment. Size Range: ..35
City	string	Employer/Payer's city. Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..30
Country	string	Employer/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"
PostalCd	string	Employer/Payer's postal code
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. Size Range: 10
ReportingAgentPIN	object	A 5-digit number assigned by the IRS
PIN	string	Sign using a 5 digit PIN received from the IRS. Size Range: 5
Form8453EMP	object	An alternate option to sign the return using Form 8453 EMP when there is no PIN
AttachmentNm	string	Name of the Form 8453EMP attachment
Attachment	byte[]	Byte array of Form-8453 pdf
AttachmentFileType	string	Type of the file Attachment
SignedDate	DateTime	Date and time on which the Form 8453-EMP was signed
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 Allowed values: "SECTION3504AGENT", "CPEO"
TotTaxableWagesAmt	number	Total taxable FUTA wages amount Size Range: 0-9999999999999.99
FUTAAdjAmt	number	FUTA Adjustment amount Size Range: 0-9999999999999.99
TotCrdtRedAmt	number	Total credit reduction amount. Enter the total from Schedule A (Form 940) Size Range: 0-9999999999999.99
FUTATaxAfterAdjAmt	number	Total FUTA tax after adjustments amount Size Range: 0-9999999999999.99
TotDepositAmt	number	FUTA tax deposited for the year, including any overpayment applied from a prior year Size Range: 0-9999999999999.99
FUTAStates	object[]	Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
StateCd	string	State 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"
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state Size Range: 0-99999999999999.99
CreditReductionRt	number	Credit Reduction Rate of the state Size Range: 0-99999999999999.99
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) Size Range: 0-99999999999999.99
AddForm940ClientDetails	object[]	Add a Collection of Form 940 Details of each client for Schedule R.
CSeqId	string	A unique sequence number of a client. Size Range: ..10
ClientEIN	string	Gets the client’s Employer identification number (EIN). Schedule R Column a. Size Range: 9
StateCd	string	State 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"
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. Size Range: 0-99999999999999.99
FUTAAdjAmt	number	Get the total adjustments to FUTA tax. Schedule R Column e. Size Range: 0-99999999999999.99
TotCrdtRedAmt	number	Get the total credit reduction amount. Schedule R Column f. Size Range: 0-99999999999999.99
FUTATaxAfterAdjAmt	number	Get the total FUTA tax after adjustment amount. Schedule R Column g. Size Range: 0-99999999999999.99
TotDepositAmt	number	Get the total FUTA tax deposit amount. Schedule R Column h. Size Range: 0-99999999999999.99
CRecordId	guid	Unique identifier of a client record.
UpdateForm940ClientDetails	object[]	Update a Collection of Form 940 Details of each client for Schedule R.
CSeqId	string	A unique sequence number of a client. Size Range: ..10
ClientEIN	string	Gets the client’s Employer identification number (EIN). Schedule R Column a. Size Range: 9
StateCd	string	State 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"
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. Size Range: 0-99999999999999.99
FUTAAdjAmt	number	Get the total adjustments to FUTA tax. Schedule R Column e. Size Range: 0-99999999999999.99
TotCrdtRedAmt	number	Get the total credit reduction amount. Schedule R Column f. Size Range: 0-99999999999999.99
FUTATaxAfterAdjAmt	number	Get the total FUTA tax after adjustment amount. Schedule R Column g. Size Range: 0-99999999999999.99
TotDepositAmt	number	Get the total FUTA tax deposit amount. Schedule R Column h. Size Range: 0-99999999999999.99
CRecordId	guid	Unique identifier of a client record.
DeleteForm940ClientDetails	object[]	Delete a Collection of Form 940 Details of each client for Schedule R.
ClientRecordId	guid	Client Record Identifier
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. Size Range: 0-99999999999999.99
ExemptWagesAmt	number	Gets the amount of the payments exempt from FUTA tax. Line 4. Size Range: 0-99999999999999.99
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 Size Range: 0-99999999999999.99
TotExemptWagesAmt	number	Gets the subtotal amount by adding the amounts on Line 4 and 5 on Line 6. Size Range: 0-99999999999999.99
TotTaxableWagesAmt	number	Gets the total taxable FUTA wages by subtracting the amount on line 6 from line 3 on line 7. Size Range: 0-99999999999999.99
FUTATaxBeforeAdjAmt	number	Gets the total FUTA tax before adjustments by multiplying line 7 by 0.006 on line 8. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
FUTATaxAfterAdjAmt	number	Gets the total FUTA tax after adjustments amount by adding the amounts on Lines 8, 9, 10, 11. Line 12. Size Range: 0-99999999999999.99
TotDepositAmt	number	Gets the amount of FUTA tax deposited for the year, including any overpayment applied from a prior year. Line 13. Size Range: 0-99999999999999.99
FirstQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 1st quarter (January 1 – March 31). Line 16a. Size Range: 0-99999999999999.99
secondQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 2nd quarter (April 1 – June 30). Line 16b. Size Range: 0-99999999999999.99
ThirdQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 3rd quarter (July 1 – September 30). Line 16c. Size Range: 0-99999999999999.99
FourthQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 4th quarter (October 1 – December 31). Line 16d. Size Range: 0-99999999999999.99
TotTaxLiabilityAmt	number	Gets the total FUTA tax liability amount for the year. Line 17. Size Range: 0-99999999999999.99
BalanceDueAmt	number	Gets the difference amount of the balance due if line 12 is more than line 13. Line 14 Size Range: 0-99999999999999.99
OverPaidAmt	number	Gets the difference overpayment amount if line 13 is more than line 12. Line 15. Size Range: 0-99999999999999.99
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. Allowed values: "REFUND", "APPLYTORETURN"
IRSPaymentType	string	Payment type to make payments to the IRS. Choose from EFW, EFTPS, Check or Money Order Allowed values: "EFW", "EFTPS", "CHECK_OR_MO"
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 Size Range: 9
AccountType	string	Account Type (Checking or Saving) of EFW payment
BankAccountNum	string	Bank Account Number of EFW payment Size Range: ..17
Phone	string	Phone of EFW payment Size Range: 10
FinalPayRoll	object	Identifies name and address of the Record Keeper
PersonNm	string	Name of the Record Keeper Size Range: ..40
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
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.
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..30
Country	string	Employer/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"
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. 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"
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state Size Range: 0-99999999999999.99
CreditReductionRt	number	Credit Reduction Rate of the state Size Range: 0-99999999999999.99
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) Size Range: 0-99999999999999.99
RecordId	Guid	Unique identifier of a record.

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	Pulls the Form 940SCHR records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 Records
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
CreatedTs	string	Date and time of return created.
UpdatedTs	string	Date and time of return updated.
ClientSuccessRecords	object[]	Client Success Status.
CSeqId	string	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	string	Client Record Identifier
RecordStatus	string	Return status details like Processing, Created, Accepted, Rejected.
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	It will show the detailed information about the error status of Form 940 Records
RecordId	Guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
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.
ClientErrorRecords	object[]	Client Error Status.
CSeqId	object[]	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	object[]	Client Record Identifier
Errors	object[]	It will show the detailed information about the error.
Code	string	It will return the validation error code.
Name	string	It will return the name of the validation error.
Message	string	It will return the detailed message of the validation error.
Type	string	It will show the type of an error.
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.

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
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# UploadForm8453EMP

Uploads signed Form 8453 EMP by Record Id.

POST Form940SchR/UploadForm8453EMP

Request Body

Field	Type	Description
RecordId	guid	Unique identifier of a record.
Form8453EMPPdf	byte[]	Byte array of Form-8453 pdf

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.
RecordId	Guid	Unique identifier of a record
Form8453EMPPdf	string	Pulls Form 8453 Pdf success and error status messages
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.

Request JSON

{
 "RecordId": "ca1026e6-7aa5-434f-a3b2-329cb76e138f",
 "Form8453EMPPdf": "QEA=="
}

1
2
3
4

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "RecordId": "ca1026e6-7aa5-434f-a3b2-329cb76e138f",
 "Form8453EMPPdf": "Form 8453-EMP is uploaded to the return (record id: ca1026e6-7aa5-434f-a3b2-329cb76e138f)",
 "Errors": null
}

1
2
3
4
5
6
7
8

# Validate

Runs business and data validation checks for the 940 SchR forms already created in API. You must use the Submission ID of the return to Validate.

GET Form940SchR/Validate

Request Body

Field	Type	Description
SubmissionId	string	Unique identifier of a submission.
RecordIds	string	List of Record IDs for Validation.

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	Pulls the Form 940SCHR records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form 940 Records
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
CreatedTs	string	Date and time of return created.
UpdatedTs	string	Date and time of return updated.
ClientSuccessRecords	object[]	Client Success Status.
CSeqId	string	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	string	Client Record Identifier
RecordStatus	string	Return status details like Processing, Created, Accepted, Rejected.
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	It will show the detailed information about the error status of Form 940 Records
RecordId	Guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
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.
ClientErrorRecords	object[]	Client Error Status.
CSeqId	object[]	This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence.
CRecordId	object[]	Client Record Identifier
Errors	object[]	It will show the detailed information about the error.
Code	string	It will return the validation error code.
Name	string	It will return the name of the validation error.
Message	string	It will return the detailed message of the validation error.
Type	string	It will show the type of an error.
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.

Request JSON

Form940SCHR/Validate?SubmissionId=9723f666-c46e-43e6-8c56-8cba391acbf7&RecordIds=554fb9c3-b68b-4a52-9114-792cd4a70433

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
 "Form940SchRRecords": {
   "SuccessRecords": [
     {
       "Sequence": "",
       "RecordId": "554fb9c3-b68b-4a52-9114-792cd4a70433",
       "RecordStatus": "Created",
       "CreatedTs": "2019-08-07 02:59:41 -04:00",
       "UpdatedTs": "2019-08-07 03:24:00 -04:00",
       "ClientSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# ValidateForm

Runs business and data validation checks for 940 SchR forms.

POST Form940SchR/ValidateForm

Request Body

Field	Type	Description
Form940SchRRecords	object[]	Object to create 940SCHRs
Sequence	string	A unique number given by an inbound application to identify failed records. Size Range: ..10
ReturnHeader	object	Identifies the supporting details of Form 940/940SCHR
ReturnType	string	Type of the return to be filed. Enter values like FORM940, FORM940PR, FORM940SS, FORM940SCHR. Allowed values: "FORM941", "FORM941PR", "FORM941SS", "FORM940", "FORM940SCHR", "FORM940PR", "FORM941SCHR"
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/940 SCH R needs to be filed. Allowed values: "2018", "2019", "2020"
Business	object	Object to identify the Business details.
BusinessId	Guid	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.
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	`Optional` Name under which the business operates Size Range: ..75
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). Size Range: ..9
Email	string	Email address of the business Size Range: ..40
ContactNm	string	Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Contact number of the business. Size Range: 10
PhoneExtn	string	`Optional` Extension of the business phone number Size Range: ..5
Fax	string	`Optional` Fax number of the Business Size Range: 10
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series. Size Range: ..4 Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Name of the signing authority. Size Range: ..35
Phone	string	Phone number of the signing authority. Size Range: 10
BusinessMemberType	string	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"
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series. Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Identifies 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"
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
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
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment. Size Range: ..35
City	string	Employer/Payer's city. Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..30
Country	string	Employer/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"
PostalCd	string	Employer/Payer's postal code
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. Size Range: 10
ReportingAgentPIN	object	A 5-digit number assigned by the IRS
PIN	string	Sign using a 5 digit PIN received from the IRS. Size Range: 5
Form8453EMP	object	An alternate option to sign the return using Form 8453 EMP when there is no PIN
AttachmentNm	string	Name of the Form 8453EMP attachment
Attachment	byte[]	Byte array of Form-8453 pdf
AttachmentFileType	string	Type of the file Attachment
SignedDate	DateTime	Date and time on which the Form 8453-EMP was signed
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 Allowed values: "SECTION3504AGENT", "CPEO"
TotTaxableWagesAmt	number	Total taxable FUTA wages amount Size Range: 0-9999999999999.99
FUTAAdjAmt	number	FUTA Adjustment amount Size Range: 0-9999999999999.99
TotCrdtRedAmt	number	Total credit reduction amount. Enter the total from Schedule A (Form 940) Size Range: 0-9999999999999.99
FUTATaxAfterAdjAmt	number	Total FUTA tax after adjustments amount Size Range: 0-9999999999999.99
TotDepositAmt	number	FUTA tax deposited for the year, including any overpayment applied from a prior year Size Range: 0-9999999999999.99
FUTAStates	object[]	Schedule A (Form 940), Multi-State Employer and Credit Reduction Information
StateCd	string	State 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"
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state Size Range: 0-99999999999999.99
CreditReductionRt	number	Credit Reduction Rate of the state Size Range: 0-99999999999999.99
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) Size Range: 0-99999999999999.99
Form940ClientDetails	object[]	Collection of Form 940 Details of each client for Schedule R.
CSeqId	string	A unique sequence number of a client. Size Range: ..10
ClientEIN	string	Gets the client’s Employer identification number (EIN). Schedule R Column a. Size Range: 9
StateCd	string	State 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"
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. Size Range: 0-99999999999999.99
FUTAAdjAmt	number	Get the total adjustments to FUTA tax. Schedule R Column e. Size Range: 0-99999999999999.99
TotCrdtRedAmt	number	Get the total credit reduction amount. Schedule R Column f. Size Range: 0-99999999999999.99
FUTATaxAfterAdjAmt	number	Get the total FUTA tax after adjustment amount. Schedule R Column g. Size Range: 0-99999999999999.99
TotDepositAmt	number	Get the total FUTA tax deposit amount. Schedule R Column h. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
ExemptWagesAmt	number	Gets the amount of the payments exempt from FUTA tax. Line 4. Size Range: 0-99999999999999.99
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 Size Range: 0-99999999999999.99
TotExemptWagesAmt	number	Gets the subtotal amount by adding the amounts on Line 4 and 5 on Line 6. Size Range: 0-99999999999999.99
TotTaxableWagesAmt	number	Gets the total taxable FUTA wages by subtracting the amount on line 6 from line 3 on line 7. Size Range: 0-99999999999999.99
FUTATaxBeforeAdjAmt	number	Gets the total FUTA tax before adjustments by multiplying line 7 by 0.006 on line 8. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
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. Size Range: 0-99999999999999.99
FUTATaxAfterAdjAmt	number	Gets the total FUTA tax after adjustments amount by adding the amounts on Lines 8, 9, 10, 11. Line 12. Size Range: 0-99999999999999.99
TotDepositAmt	number	Gets the amount of FUTA tax deposited for the year, including any overpayment applied from a prior year. Line 13. Size Range: 0-99999999999999.99
FirstQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 1st quarter (January 1 – March 31). Line 16a. Size Range: 0-99999999999999.99
secondQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 2nd quarter (April 1 – June 30). Line 16b. Size Range: 0-99999999999999.99
ThirdQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 3rd quarter (July 1 – September 30). Line 16c. Size Range: 0-99999999999999.99
FourthQtrTaxLiabilityAmt	number	Gets the FUTA Tax Liability amount for 4th quarter (October 1 – December 31). Line 16d. Size Range: 0-99999999999999.99
TotTaxLiabilityAmt	number	Gets the total FUTA tax liability amount for the year. Line 17. Size Range: 0-99999999999999.99
BalanceDueAmt	number	Gets the difference amount of the balance due if line 12 is more than line 13. Line 14 Size Range: 0-99999999999999.99
OverPaidAmt	number	Gets the difference overpayment amount if line 13 is more than line 12. Line 15. Size Range: 0-99999999999999.99
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. Allowed values: "REFUND", "APPLYTORETURN"
IRSPaymentType	string	Payment type to make payments to the IRS. Choose from EFW, EFTPS, Check or Money Order Allowed values: "EFW", "EFTPS", "CHECK_OR_MO"
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 Size Range: 9
AccountType	string	Account Type (Checking or Saving) of EFW payment
BankAccountNum	string	Bank Account Number of EFW payment Size Range: ..17
Phone	string	Phone of EFW payment Size Range: 10
FinalPayRoll	object	Identifies name and address of the Record Keeper
PersonNm	string	Name of the Record Keeper Size Range: ..40
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
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.
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: ..35
Address2	string	`Optional` Employer/Payer's suite or apartment Size Range: ..35
City	string	Employer/Payer's city Size Range: ..27
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..30
Country	string	Employer/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"
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. 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"
TotTaxableFUTAwagesAmt	number	Total taxable FUTA wages amount of the state Size Range: 0-99999999999999.99
CreditReductionRt	number	Credit Reduction Rate of the state Size Range: 0-99999999999999.99
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) Size Range: 0-99999999999999.99

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.
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.

Request JSON

 {
 "Form940SchRRecords": [
{
   "Form940SchRRecords": [
       {
           "Sequence": "01",
           "ReturnHeader": {
               "ReturnType": "FORM940SCHR",
               "MoreClients": false,
               "TaxYr": "2020",
               "Business": {
                   "BusinessId": null,
                   "BusinessNm": "Eastman Kodak Company",
                   "TradeNm": "Kodak",
                   "IsEIN": true,
                   "EINorSSN": "107820069",
                   "Email": "john@gmail.com",
                   "ContactNm": "John Parker",
                   "Phone": "1234567890",
                   "PhoneExtn": "32324",
                   "Fax": "3456734567",
                   "BusinessType": "PART",
                   "SigningAuthority": {
                       "Name": "Peter Parker",
                       "Phone": "1234567891",
                       "BusinessMemberType": "MEMBER"
                   },
                   "KindOfEmployer": "STATEORLOCAL501C",
                   "KindOfPayer": "HOUSEHOLD",
                   "IsBusinessTerminated": false,
                   "IsForeign": true,
                   "USAddress": {
                       "Address1": "1751 Kinsey Rd",
                       "Address2": "Main St",
                       "City": "Dothan",
                       "State": "AL",
                       "ZipCd": "36303"
                   },
                   "ForeignAddress": {
                       "Address1": "45 Main St",
                       "Address2": "Crescent Ave",
                       "City": "Toronto",
                       "ProvinceOrStateNm": "ON",
                       "Country": "CA",
                       "PostalCd": "4T3 B5F"
                   }
               },
               "IsThirdPartyDesignee": false,
               "ThirdPartyDesignee": null,
               "SignatureDetails": {
                   "SignatureType": "ONLINE_SIGN_PIN",
                   "OnlineSignaturePIN": {
                       "PIN": "5555577777"
                   },
                   "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
                       }
                   ]
               },
               "Form940ClientDetails": [
                   {
                       "CSeqId": "1",
                       "ClientEIN": "008774111",
                       "StateCd": "VI",
                       "WagesTypeCd": "A",
                       "TotTaxableWagesAmt": 7000,
                       "FUTAAdjAmt": 58,
                       "TotCrdtRedAmt": 210,
                       "FUTATaxAfterAdjAmt": 310,
                       "TotDepositAmt": 50,
                       "CRecordId": null
                   },
                   {
                       "CSeqId": "2",
                       "ClientEIN": "001174111",
                       "StateCd": "VI",
                       "WagesTypeCd": "c",
                       "TotTaxableWagesAmt": 7000,
                       "FUTAAdjAmt": 58,
                       "TotCrdtRedAmt": 210,
                       "FUTATaxAfterAdjAmt": 310,
                       "TotDepositAmt": 50,
                       "CRecordId": null
                   }
               ],
               "Form940Total": {
                   "IsMultiState": true,
                   "WagesAmt": 27000,
                   "ExemptWagesAmt": 2000,
                   "IsFringeBenfs": false,
                   "IsGrpTermLifeIns": false,
                   "IsRetrmntOrPension": false,
                   "IsDepCare": false,
                   "IsOtherExempt": true,
                   "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": {
                   "PersonNm": null,
                   "IsForeign": false,
                   "USAddress": {
                       "Address1": null,
                       "Address2": null,
                       "City": null,
                       "State": null,
                       "ZipCd": null
                   },
                   "ForeignAddress": {
                       "Address1": null,
                       "Address2": null,
                       "City": null,
                       "ProvinceOrStateNm": null,
                       "Country": null,
                       "PostalCd": null
                   }                    
               },
               "ScheduleA": [
                   {
                       "StateCd": "VI",
                       "TotTaxableFUTAwagesAmt": 21000,
                       "CreditReductionRt": 0.03,
                       "CreditReductionAmt": 630
                   },
                   {
                       "StateCd": "CA",
                       "TotTaxableFUTAwagesAmt": 21000,
                       "CreditReductionRt": 0,
                       "CreditReductionAmt": 0
                   },
                   {
                       "StateCd": "MA",
                       "TotTaxableFUTAwagesAmt": 21000,
                       "CreditReductionRt": 0,
                       "CreditReductionAmt": 0
                   }
               ]
           }
       }
   ]
}

Response JSON

  {
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "Errors": null
}

1
2
3
4
5
6

← Form940 Form941 →