# StateWH

# Create

Creates State WH returns with a unique Submission Id which is further used for all other methods referencing these State WH forms.

POST StateWH/Create

Request Body

Field	Type	Description
StateWHRecords	object	Object to create State Withholding Forms
ReturnHeader	object	Identifies the supporting details of State Withholding Forms.
Forms	object[]	Type of Statewithholding forms and state to be filed.
State	string	State for which Statewithholding forms to be filed. Allowed values: "SC", "IL", "GA", "NJ"
Form	string	Type of Statewithholding forms to be filed. Allowed values: "FormIL941", "FormWH1605", "FormG7", "FormNJ927", "FormNJ927W"
Business	object	Business Details
BusinessId	guid	Business Identifier (Autogenerated).
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 with area code 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	Kind Of Payer based on the Employer's Federal Tax Return. Allowed values: "REGULARW9", "REGULAR944", "AGRICULTURALW9", "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	Employer/Payer's state Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
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's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object	Identifies the State Withholding Forms data.
NJ	object	Forms to be filed for New Jersey State.
FormNJ927	string	Form NJ 927, New Jersey withholding quarterly tax return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form NJ 927 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form NJ 927 needs to be filed. Allowed values: "2020"
TPID	string	TaxPayer ID Size Range: 13
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
MonthlyGITAmtWithheld	object	Enter the Monthly withheld details.
Month1Withheld	number	The amount of withholding for Month 1. Size Range: 0-999999999999.99
Month2Withheld	number	The amount of withholding for Month 2. Size Range: 0-999999999999.99
Month3Withheld	number	The amount of withholding for Month 3. Size Range: 0-999999999999.99
Line1TotalWages	number	GIT Wages Subject to Gross Income Tax Withholding to the employees. Size Range: 0-999999999999.99
Line2TotalAmtDue	number	GIT total amount due for Quarter/Year (If filing NJ927H) to the employess. Size Range: 0-9999999999.99
Line3TotalRemittedCredits	number	Total contributions paid prior to this filing. Size Range: 0-999999999999.99
Line4BalanceDue	number	GIT amount for balance due for the employees. Size Range: 0-999999999999.99
OverPaymentType	string	Enter the Over Payment Type. Allowed values: "REFUND", "APPLYTORETURN"
Line5OverPaymentAmt	number	GIT amount for overpayment for the employees. Size Range: 0-999999999999.99
DirectDebitIndicator	string	Enter the Direct Debit Indicator Type. Allowed values: "ECHECK", "EFT"
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
FormNJ927W	string	Form NJ 927W, New Jersey withholding quarterly tax return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form NJ 927W needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form NJ 927 needs to be filed. Allowed values: "2020"
TPID	string	TaxPayer ID Size Range: 13
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
WeeklyGITAmtWithheld	object[]	Enter the Weekly withheld details.
Week	number	Enter the Week for which withheld to be Filed. Allowed values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14"
AmtWithheld	number	The amount of withholding for Week. Size Range: 0-999999999999.99
Line1TotalWages	number	GIT Wages Subject to Gross Income Tax Withholding to the employees. Size Range: 0-999999999999.99
Line2TotalAmtDue	number	GIT total amount due for Quarter/Year (If filing NJ927H) to the employess. Size Range: 0-9999999999.99
Line3TotalRemittedCredits	number	Total contributions paid prior to this filing. Size Range: 0-999999999999.99
Line4BalanceDue	number	GIT amount for balance due for the employees. Size Range: 0-999999999999.99
OverPaymentType	string	Enter the Over Payment Type. Allowed values: "REFUND", "APPLYTORETURN"
Line5OverPaymentAmt	number	GIT amount for overpayment for the employees. Size Range: 0-999999999999.99
DirectDebitIndicator	string	Enter the Direct Debit Indicator Type. Allowed values: "ECHECK", "EFT"
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
GA	object	Forms to be filed for Georgia State.
FormG7	object	Form G7, Georgia withholding quarterly tax return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form G7 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form G7 needs to be filed. Allowed values: "2020"
ReturnType	string	The type of return being filed. Allowed values: "Annual", "Monthly", "Quarterly", "Semiweekly"
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
GAWHId	string	Withholding Account ID. Size Range: ..7
TotalTaxWithheld	number	Total Tax Withheld from employees. Size Range: 0-9999999999.99
TotalAdjustmentsTax	number	Total Credits available. Size Range: -9999999999.99 to 9999999999.99
TotalTaxPaid	number	Total Tax Paid. Size Range: 0-9999999999.99
TotalTaxDue	number	Total Tax due. Size Range: -9999999999.99 to 9999999999.99
BalanceDue	number	Balance Due. Size Range: 0-9999999999.99
AdjustmentsTaxCredits	object[]	Type of credit Details.
AdjustmentCreditType	string	Type of credit. Allowed values: "JOBTAXCRD(Job Tax Credit),HDQTRSCRD(Headquarter Job Tax Credit),FLMTAXCRD(Film Tax Credit),CLNNRGCRD(Clean Energy Property Tax Credit),QLJOBSCRD(Quality Jobs Tax Credit),ADDTAXCRD(Additional Tax),OVRPYMCRD(Over Payment),RSCHTXCRD(Research Tax Credit.)"
AdjustmentCreditMonth	string	Enter the month of the quarter for the Adjustment Credit. Allowed values: "1,2,3"
AdjustmentCreditAmount	number	Adjustment Credit Amount. Size Range: -9999999999.99 to 9999999999.99
MonthlyTaxLiability	object	If your return type is monthly, enter the monthly liability and deposit details here.
TaxwithheldMonth1	number	Tax Withheld for Month 1. Size Range: 0-9999999999.99
TaxDepositedMonth1	number	Tax Deposited for Month 1. Size Range: 0-9999999999.99
TaxDueMonth1	number	Tax Due for Month 1. Size Range: -9999999999.99 to 9999999999.99
TaxwithheldMonth2	number	Tax Withheld for Month 2. Size Range: 0-9999999999.99
TaxDepositedMonth2	number	Tax Deposited for Month 2. Size Range: 0-9999999999.99
TaxDueMonth2	number	Tax Due for Month 2. Size Range: -9999999999.99 to 9999999999.99
TaxwithheldMonth3	number	Tax Withheld for Month 3. Size Range: 0-9999999999.99
TaxDepositedMonth3	number	Tax Deposited for Month 3. Size Range: 0-9999999999.99
TaxDueMonth3	number	Tax Due for Month 3. Size Range: -9999999999.99 to 9999999999.99
SemiWeeklyTaxLiability	object	If your return type is semiweekly, enter the liability and deposit details for the days of the quarter.
ScheduleBMonth1Liability	object[]	Tax liability for Day (1 - 31) For Month 1.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth1	number	Tax Withheld for Month 1. Size Range: 0-9999999999.99
TaxDepositedMonth1	number	Tax Deposited for Month 1. Size Range: 0-9999999999.99
TaxDueMonth1	number	Tax Due for Month 1. Size Range: -9999999999.99 to 9999999999.99
ScheduleBMonth2Liability	object[]	Tax liability for Day (1 - 31) For Month 2.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth2	number	Tax Withheld for Month 2. Size Range: 0-9999999999.99
TaxDepositedMonth2	number	Tax Deposited for Month 2. Size Range: 0-9999999999.99
TaxDueMonth2	number	Tax Due for Month 2. Size Range: -9999999999.99 to 9999999999.99
ScheduleBMonth3Liability	object[]	Tax liability for Day (1 - 31) For Month 3.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth3	number	Tax Withheld for Month 3. Size Range: 0-9999999999.99
TaxDepositedMonth3	number	Tax Deposited for Month 3. Size Range: 0-9999999999.99
TaxDueMonth3	number	Tax Due for Month 3. Size Range: -9999999999.99 to 9999999999.99
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
SC	object	Forms to be filed for South Carolina State.
FormWH1605	object	Form WH-1605, SC withholding quarterly tax return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form WH1605 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form WH1605 needs to be filed. Allowed values: "2020"
WithholdingNmbr	string	SC withholding file number of the business. Size Range: 9
IsAmendedReturn	Boolean	When True, identifies the return is amended.
Line1IncomeTaxWithheld	number	The quarterly SC income tax withheld . Size Range: 0-999999999.99
Line2IncomeTaxDeposits	number	The quarterly SC income tax deposits made. Size Range: 0-999999999.99
Line3Refund	number	Refund amount if Deposit amount is greater than tax withheld. Size Range: 0-999999999.99
Line4TaxDue	number	Balance amount if Deposit amount is lesser than tax withheld. Size Range: 0-999999999.99
Line5Penalty	number	Penalty amount for tax not paid. Size Range: 0-999999999.99
Line5Interest	number	Interest amount for tax not paid Size Range: 0-999999999.99
Line5Total	number	Total Amount of Line 5 Size Range: 0-999999999.99
Line6BalanceDue	number	The total balance amount to be paid to the state. Size Range: 0-999999999.99
IL	object	Forms to be filed for Illinois State.
FormIL941	object	Form IL-941, Illinois Withholding Income Tax Return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form IL941 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form IL941 needs to be filed. Allowed values: "2020"
IlSeqNumber	number	"The 3 digit sequence number assigned to the taxpayer by the state of Illinois. Your sequence number should be “000” unless you have been assigned a different sequence number when you registered.".
IsFirstReturn	Boolean	When True, identifies the business as a new business.
IsAddressChanged	Boolean	When True, identifies the that the business address has changed.
LineA1W2sIssuedNum	number	The total number of W-2s issues for the entire year. Required only when you filing for the 4th quarter.
LineA2Number1099sIssuedNum	number	The total number of 1099s issued for the entire year. Required only when you filing for the 4th quarter.
LineBIsBusinessClosed	Boolean	When True, identifies the business has closed.
LineBDateFinalWagesPaid	string	The date that the employer has last paid wages. Required only if your business is closed.
Line1WHTaxableWages	number	The total of all amounts subject to Illinois withholding income tax. Size Range: 0-9999999999.99
Line2TotalQtrLiability	number	The total tax liability for the quarter. Should be equal to the sum of Line2aTotalMonth1Liability, Line2cTotalMonth1Liability, & Line2dTotalMonth1Liability,. Size Range: 0-9999999999.99
Line3CreditAmt	number	The amount of credit from Schedule WC, Line 7. Size Range: 0-9999999999.99
Line4WHPaymentsOrDeposits	number	"The total amount of withholding payments you have made during this period. This includes all IL-501 payments(electronic and paper coupons).". Size Range: 0-9999999999.99
Line5WHTotalPayments	number	The total amount by adding Form IL-941 line 3 and 4. Size Range: 0-9999999999.99
Line6WHAmountDue	number	The difference amount to be paid to the Illinois Department of Revenue if line 2 is greater than line 5. If the Line 2 is lessser than line 5, enter 0. Size Range: 0-9999999999.99
PaymentSchedule	object	Tax Liability Information of the Quarter.
Month1Liabilities	object[]	Tax Liability Information for Month 1.
Month2Liabilities	object[]	Tax Liability Information for Month 2.
Month3Liabilities	object[]	Tax Liability Information for Month 3.
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Line2aTotalMonth1Liability	number	Tax Liability for Month 1. Size Range: 0-9999999999.99
Line2cTotalMonth1Liability	number	Tax Liability for Month 2. Size Range: 0-9999999999.99
Line2dTotalMonth1Liability	number	Tax Liability for Month 3. Size Range: 0-9999999999.99
ScheduleWC	number	Schedule WC Details.
YearsLeftToCarry	number	The total number of years left to carry forward the credit from Schedule WC-I. Size Range: 0-5
CreditCode	number	The credit code for the withholding income tax credit. Size Range: 4 Allowed values: "0900", "5900", "5910"
QtrEndingCreditEarned	string	"The Four-digit year and two-digit month of the quarter ending during which the credit was first earned".
IdentifyingNum	number	The certificate number listed on the tax credit certificate. For the ILSBJC credit, enter the certificate number listed on the Tax Credit Certificate received from the Illinois Department of Commerce and Economic Opportunity (DCEO). For all other credits, leave the column blank.
CreditsEarned	number	The value of the credits earned. Enter the amount from Schedule WC-I. Size Range: 0-9999999999.99
CreditsCarried	number	The value of the credits carried from a previous quarter. Size Range: 0-9999999999.99
TotalCredits	number	The value of the total credits. The total of CreditsEarned & CreditsCarried. Size Range: 0-9999999999.99
Line5	number	The sum of credits by adding column G, lines 1 through 4. Size Range: 0-9999999999.99
Line6	number	The total tax amount from Form IL-941, Step 4, line 2. Size Range: 0-9999999999.99
Line7	number	The available credit amount. Enter the sane value on Form IL-941, Line 3. Size Range: 0-9999999999.99
ScheduleP	object[]	Schedule P Details .
SchPSeqId	string	A unique number given by an inbound application to identify failed schedule P records.
FirstNm	number	First name of the employee.
LastNm	number	Last name of the employee.
SSN	string	The employee's SSN. Size Range: 9
TaxableWages	number	The employee's income for the quarter. Size Range: 0-9999999999.99
TaxWithheld	number	The amount withheld from the employee for the quarter. Size Range: 0-9999999999.99
ThirdPartyAuthorization	object[]	Third Party Designee Details of Form IL-941.
IsAuthorizeThirdParty	Boolean	When true, your third-party designee is allowed to discuss the return with the IRS.
DesigneeName	string	Third Party Designee's name.
DesigneePhone	string	Third Party Designee's phone number.
StatePayment	object[]	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17

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.
StateWHRecords	object	Pulls the State withholding Form records with Success and Error statuses.
IL	object	Pulls the Illinois State withholding Form records with Success and Error statuses.
GA	object	Pulls the Georgia State withholding Form records with Success and Error statuses.
SC	object	Pulls the South Carolina State withholding Form records with Success and Error statuses.
NJ	object	Pulls the New Jersey State withholding Form records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of State WH Records.
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
FormType	string	Type of State withholding Form Filed.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of return.
SchPSuccessRecords	object[]	It will show the detailed information about the success status of Schedule P Records.
SchPSeqId	string	A unique number given by an inbound application to identify schedule P records.
SchPRecordId	Guid	Unique identifier of a Schedule P record.
StatusTs	string	Date and time of SChedule P Records
AdjustmentsCreditsSuccessRecords	object[]	It will show the detailed information about the success status of AdjustmentsCredits Records.
RecordStatus	string	Status of the AdjustmentsCredits Records.
AdjustmentsCreditsRecordId	Guid	Unique identifier of a AdjustmentsCredits record.
StatusTs	string	Date and time of AdjustmentsCredits Records
ErrorRecords	object[]	It will show the detailed information about the error status of State WH 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.
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

{
 "StateWHRecords": {
   "ReturnHeader": {
     "Forms": [
       {
         "State": "IL",
         "Form": "FormIL941"
       },
       {
         "State": "SC",
         "Form": "FormWH1605"
       },
       {
         "State": "GA",
         "Form": "FormG7"
       },
       {
         "State": "NJ",
         "Form": "FormNJ927"
       },
       {
         "State": "NJ",
         "Form": "FormNJ927W"
       }
     ],
     "Business": {
       "BusinessId": null,
       "BusinessNm": "John LLC",
       "TradeNm": null,
       "IsEIN": true,
       "EINorSSN": "01-8978355",
       "Email": "john@gmail.com",
       "ContactNm": "John",
       "Phone": "7879879879",
       "PhoneExtn": null,
       "Fax": "7897897987",
       "BusinessType": "ESTE",
       "SigningAuthority": {
         "Name": "John",
         "Phone": "7897897987",
         "BusinessMemberType": "ADMINISTRATOR"
       },
       "KindOfEmployer": "NONGOVT501C",
       "KindOfPayer": "REGULAR941",
       "IsBusinessTerminated": false,
       "IsForeign": false,
       "USAddress": {
         "Address1": "12 main st",
         "Address2": null,
         "City": "Rock Hill",
         "State": "SC",
         "ZipCd": "29730"
       },
       "ForeignAddress": {
         "Address1": null,
         "Address2": null,
         "City": null,
         "ProvinceOrStateNm": null,
         "Country": null,
         "PostalCd": null
       }
     }
   },
   "ReturnData": {
     "IL": {
       "FormIL941": {
         "Sequence": null,
         "Qtr": "Q1",
         "TaxYr": "2020",
         "ILSeqNumber": "123",
         "IsFirstReturn": false,
         "IsAddressChanged": false,
         "LineA1W2sIssuedNum": 0,
         "LineA2Number1099sIssuedNum": 0,
         "LineBIsBusinessClosed": false,
         "LineBDateFinalWagesPaid": null,
         "Line1WHTaxableWages": 20000,
         "Line2TotalQtrLiability": 2000,
         "Line3CreditAmt": 0,
         "Line4WHPaymentsOrDeposits": 2000,
         "Line5WHTotalPayments": 2000,
         "Line6WHAmountDue": 0,
         "PaymentSchedule": {
           "Month1Liabilities": [
             {
               "Day": 1,
               "Amt": 500
             }
           ],
           "Line2aTotalMonth1Liability": 500,
           "Month2Liabilities": [
             {
               "Day": 1,
               "Amt": 500
             }
           ],
           "Line2cTotalMonth2Liability": 500,
           "Month3Liabilities": [
             {
               "Day": 1,
               "Amt": 1000
             }
           ],
           "Line2dTotalMonth3Liability": 1000
         },
         "ScheduleWC": {
           "Line1": {
             "YearsLeftToCarry": 0,
             "CreditCode": null,
             "QtrEndingCreditEarned": null,
             "IdentifyingNum": null,
             "CreditsEarned": 0,
             "CreditsCarried": 0,
             "TotalCredits": 0
           },
           "Line2": {
             "YearsLeftToCarry": 0,
             "CreditCode": null,
             "QtrEndingCreditEarned": null,
             "IdentifyingNum": null,
             "CreditsEarned": 0,
             "CreditsCarried": 0,
             "TotalCredits": 0
           },
           "Line3": {
             "YearsLeftToCarry": 0,
             "CreditCode": null,
             "QtrEndingCreditEarned": null,
             "IdentifyingNum": null,
             "CreditsEarned": 0,
             "CreditsCarried": 0,
             "TotalCredits": 0
           },
           "Line4": {
             "YearsLeftToCarry": 0,
             "CreditCode": null,
             "QtrEndingCreditEarned": null,
             "IdentifyingNum": null,
             "CreditsEarned": 0,
             "CreditsCarried": 0,
             "TotalCredits": 0
           },
           "Line5": 0,
           "Line6": 0,
           "Line7": 0
         },
         "ScheduleP": [
           {
             "FirstNm": "John",
             "LastNm": "K",
             "SSN": "789456123",
             "TaxableWages": 20000,
             "TaxWithheld": 2000
           }
         ],
         "ThirdPartyAuthorization": {
           "IsAuthorizeThirdParty": false,
           "DesigneeName": null,
           "DesigneePhone": null
         },
         "StatePayment": {
           "AccountType": "Checking",
           "RoutingTransitNumber": "217555555",
           "BankAccountNumber": "Business",
           "AccountHolderName": "Debbie Monkman",
           "AccountHolderType": "Business"
         }
       }
     },
     "SC": {
       "FormWH1605": {
         "RecordId": null,
         "Sequence": "WH-1605",
         "Qtr": "Q1",
         "TaxYr": "2020",
         "WithholdingNmbr": "124588229",
         "IsAmendedReturn": false,
         "Line1IncomeTaxWithheld": 5000,
         "Line2IncomeTaxDeposits": 4000,
         "Line3Refund": 0,
         "Line4TaxDue": 1000,
         "Line5Penalty": 300,
         "Line5Interest": 300,
         "Line5Total": 600,
         "Line6BalanceDue": 1600
       }
     },
     "GA": {
       "FormG7": {
         "RecordId": null,
         "Sequence": null,
         "Qtr": "Q1",
         "TaxYr": "2020",
         "ReturnType": "Monthly",
         "IsAmendedReturn": false,
         "GAWHId": "787987",
         "TotalTaxWithheld": 10000,
         "TotalAdjustmentsTax": 2000,
         "TotalTaxDue": 12000,
         "TotalTaxPaid": 12000,
         "BalanceDue": 0,
         "AdjustmentsTaxCredits": [
           {
             "AdjustmentCreditRecordId": null,
             "AdjustmentCreditType": "ADDTAXCRD",
             "AdjustmentCreditMonth": 1,
             "AdjustmentCreditAmount": 4000
           },
           {
             "AdjustmentCreditRecordId": null,
             "AdjustmentCreditType": "JOBTAXCRD",
             "AdjustmentCreditMonth": 1,
             "AdjustmentCreditAmount": -2000
           }
         ],
         "MonthlyTaxLiability": {
           "TaxwithheldMonth1": 5000,
           "TaxDepositedMonth1": 4000,
           "TaxDueMonth1": 7000,
           "TaxwithheldMonth2": 2500,
           "TaxDepositedMonth2": 4000,
           "TaxDueMonth2": 2500,
           "TaxwithheldMonth3": 2500,
           "TaxDepositedMonth3": 4000,
           "TaxDueMonth3": 2500
         },
         "SemiWeeklyTaxLiability": {
           "ScheduleBMonth1Liability": [
             {
               "Day": 0,
               "Amt": 0
             }
           ],
           "TaxwithheldMonth1": 0,
           "TaxDepositedMonth1": 0,
           "TaxDueMonth1": 0,
           "ScheduleBMonth2Liability": [
             {
               "Day": 0,
               "Amt": 0
             }
           ],
           "TaxwithheldMonth2": 0,
           "TaxDepositedMonth2": 0,
           "TaxDueMonth2": 0,
           "ScheduleBMonth3Liability": [
             {
               "Day": 0,
               "Amt": 0
             }
           ],
           "TaxwithheldMonth3": 0,
           "TaxDepositedMonth3": 0,
           "TaxDueMonth3": 0
         },
         "StatePayment": {
           "AccountType": "Checking",
           "RoutingTransitNumber": "217555555",
           "BankAccountNumber": "Business",
           "AccountHolderName": "Debbie Monkman",
           "AccountHolderType": "Business"
         }
       }
     },
      "NJ": {
   "FormNJ927": {
     "Sequence": "001",
     "Qtr": "Q1",
     "TaxYr": "2020",
     "TPID": "B123456789000",
     "IsAmendedReturn": true,
     "MonthlyGITAmtWithheld":  {
      "Month1Withheld":2000,
      "Month2Withheld":1000,
      "Month3Withheld":2000
    },
     "Line1TotalWages": 30000,
     "Line2TotalAmtDue": 5000,
     "Line3TotalRemittedCredits": 2000,
     "Line4BalanceDue": 3000,
     "OverPaymentType": null,
     "Line5OverPaymentAmt": 0,
     "DirectDebitIndicator": "Echeck",
     "StatePayment": {
       "AccountType": "Checking",
       "RoutingTransitNumber": "217555555",
       "BankAccountNumber": "0000000001",
       "AccountHolderName": "John Smith",
       "AccountHolderType": "Business"
     }
   },
  "FormNJ927W": {
    "Sequence": "001",
    "Qtr": "Q2",
    "TaxYr": "2020",
    "TPID": "B123456789000",
    "IsAmendedReturn": true,
    "WeeklyGITAmtWithheld": [
      {
        "Week": 1,
        "AmtWithheld": 2500
      },
      {
        "Week": 2,
        "AmtWithheld": 2500
      }
    ],
    "Line1TotalWages": 30000,
    "Line2TotalAmtDue": 5000,
    "Line3TotalRemittedCredits": 2000,
    "Line4BalanceDue": 3000,
    "OverPaymentType": null,
    "Line5OverPaymentAmt": 0,
    "DirectDebitIndicator": "Echeck",
    "StatePayment": {
      "AccountType": "Checking",
      "RoutingTransitNumber": "217555555",
      "BankAccountNumber": "0000000001",
      "AccountHolderName": "John Smith",
      "AccountHolderType": "Business"
    }
  }
}
   }
 }
}

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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "fb1d9aaf-aff2-48a0-9860-bb70421ac3c6",
 "StateWHRecords": {
   "IL": {
     "SuccessRecords": [
       {
         "Sequence": null,
         "FormType": "FormIL941",
         "RecordId": "77658850-3429-4ea3-b389-b8eeb575d78a",
         "RecordStatus": "Created",
         "StatusTs": "2020-05-13 01:52:48 -04:00",
         "SchPSuccessRecords": [
           {
             "SchPSeqId": null,
             "SchPRecordId": "af48940e-8f65-4eaf-b6a0-0aed2dd686fb",
             "RecordStatus": "Added",
             "StatusTs": "2020-05-13 01:52:49 -04:00"
           }
         ]
       }
     ],
     "ErrorRecords": null
   },
   "SC": {
     "SuccessRecords": [
       {
         "Sequence": "WH-1605",
         "FormType": "FORMWH1605",
         "RecordId": "cd27a7e7-b129-4f4c-a3f1-819d67b14ab3",
         "RecordStatus": "Created",
         "StatusTs": "2020-05-13 01:52:49 -04:00"
       }
     ],
     "ErrorRecords": null
   },
   "GA": {
     "SuccessRecords": [
       {
         "Sequence": null,
         "FormType": "FormG7",
         "RecordId": "b5089735-f5c9-4e9f-bec4-9a4576d99f01",
         "RecordStatus": "Created",
         "StatusTs": "2020-05-13 01:52:50 -04:00",
         "AdjustmentsCreditsSuccessRecords": [
           {
             "AdjustmentCreditRecordId": "cd87508f-0925-4d24-9891-360a2c5eaff1",
             "RecordStatus": "Added",
             "StatusTs": "2020-05-13 01:52:50 -04:00"
           },
           {
             "AdjustmentCreditRecordId": "669e391c-919c-4d6f-88a7-32ccd50a510a",
             "RecordStatus": "Added",
             "StatusTs": "2020-05-13 01:52:50 -04:00"
           }
         ]
       }
     ],
     "ErrorRecords": null
   },
   "NJ": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "WHFORMNJ927",
       "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:14 -04:00"
     },
     {
       "Sequence": "002",
       "FormType": "WHFORMNJ927W",
       "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:32 -04:00"
     }
   ],
   "ErrorRecords": null
 }
 },
 "Errors": null
}
*

# Delete

Deletes SC,NC, GA,NJ and IL returns by Submission Ids and Record Ids.

DELETE StateWH/Delete

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
RecordIds	Guid[]	List of record Ids to be deleted.

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.
StateWHRecords	object	Pulls the State WH records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of StateWH 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.
StatusTs	string	Date and time of return.
ErrorRecords	object[]	It will show the detailed information about the error status of StateWH 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.
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

StateWH/Delete?SubmissionId=2906a6ab-cc63-459e-b96d-bd46c4165cfb&RecordIds=c12d2be4-6f84-4cc2-b6b1-20b6dc026750,929c889a-ad5e-4328-b9b3-3d1772dfdedc,344e11d2-375d-48a2-a93a-0222e453a7b7,f5f9f082-b99e-4456-98f7-a64482dee418

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "2906a6ab-cc63-459e-b96d-bd46c4165cfb",
"StateWHRecords": {
   "IL": {
       "SuccessRecords": [
           {
               "Sequence": "001",
               "FormType": "FormIL941",
               "RecordId": "c12d2be4-6f84-4cc2-b6b1-20b6dc026750",
               "RecordStatus": "DELETED",
               "StatusTs": "4/4/2020 3:42:27 PM"
           }
       ],
       "ErrorRecords": null
   },
   "SC": {
       "SuccessRecords": [
           {
               "Sequence": "222",
               "FormType": "FORMWH1605",
               "RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
               "RecordStatus": "DELETED",
               "StatusTs": "4/4/2020 3:42:27 PM"
           }
       ],
       "ErrorRecords": null
   },
   "GA": {
       "SuccessRecords": [
           {
               "Sequence": "002",
               "FormType": "FormG7",
               "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
               "RecordStatus": "DELETED",
               "StatusTs": "4/4/2020 3:42:27 PM"
           }
       ],
       "ErrorRecords": null
   },
   "NJ": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "WHFORMNJ927",
       "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
       "RecordStatus": "DELETED",
       "StatusTs": "2020-05-23 10:27:14 -04:00"
     },
     {
       "Sequence": "002",
       "FormType": "WHFORMNJ927W",
       "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
       "RecordStatus": "DELETED",
       "StatusTs": "2020-05-23 10:27:32 -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
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

# Get

Gets information of State WH returns by Submission Id.

GET StateWH/Get

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	Gets List of Record Id Information .

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
StateWHRecords	object	Object to create State Withholding Forms
ReturnHeader	object	Identifies the supporting details of State Withholding Forms.
Forms	object[]	Type of Statewithholding forms and state to be filed.
State	string	State for which Statewithholding forms to be filed. Allowed values: "SC", "IL", "GA", "NJ"
Form	string	Type of Statewithholding forms to be filed. Allowed values: "FormIL941", "FormWH1605", "FormG7", "FormNJ927", "FormNJ927W"
Business	object	Business Details
BusinessId	guid	Business Identifier (Autogenerated).
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 with area code 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	Kind Of Payer based on the Employer's Federal Tax Return. Allowed values: "REGULARW9", "REGULAR944", "AGRICULTURALW9", "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	Employer/Payer's state Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
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's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object	Identifies the State Withholding Forms data
NJ	object	Forms to be filed for New Jersey State.
FormNJ927	string	Form NJ 927, New Jersey withholding quarterly tax return.
RecordId	guid	Unique identifier of a record.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form NJ 927 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form NJ 927 needs to be filed. Allowed values: "2020"
TPID	string	TaxPayer ID Size Range: 13
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
MonthlyGITAmtWithheld	object	Enter the Monthly withheld details.
Month1Withheld	number	The amount of withholding for Month 1. Size Range: 0-999999999999.99
Month2Withheld	number	The amount of withholding for Month 2. Size Range: 0-999999999999.99
Month3Withheld	number	The amount of withholding for Month 3. Size Range: 0-999999999999.99
Line1TotalWages	number	GIT Wages Subject to Gross Income Tax Withholding to the employees. Size Range: 0-999999999999.99
Line2TotalAmtDue	number	GIT total amount due for Quarter/Year (If filing NJ927H) to the employess. Size Range: 0-9999999999.99
Line3TotalRemittedCredits	number	Total contributions paid prior to this filing. Size Range: 0-999999999999.99
Line4BalanceDue	number	GIT amount for balance due for the employees. Size Range: 0-999999999999.99
OverPaymentType	string	Enter the Over Payment Type. Allowed values: "REFUND", "APPLYTORETURN"
Line5OverPaymentAmt	number	GIT amount for overpayment for the employees. Size Range: 0-999999999999.99
DirectDebitIndicator	string	Enter the Direct Debit Indicator Type. Allowed values: "ECHECK", "EFT"
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
FormNJ927W	string	Form NJ 927W, New Jersey withholding quarterly tax return.
RecordId	guid	Unique identifier of a record.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form NJ 927W needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form NJ 927 needs to be filed. Allowed values: "2020"
TPID	string	TaxPayer ID Size Range: 13
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
WeeklyGITAmtWithheld	object[]	Enter the Weekly withheld details.
Week	number	Enter the Week for which withheld to be Filed. Allowed values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14"
AmtWithheld	number	The amount of withholding for Week. Size Range: 0-999999999999.99
Line1TotalWages	number	GIT Wages Subject to Gross Income Tax Withholding to the employees. Size Range: 0-999999999999.99
Line2TotalAmtDue	number	GIT total amount due for Quarter/Year (If filing NJ927H) to the employess. Size Range: 0-9999999999.99
Line3TotalRemittedCredits	number	Total contributions paid prior to this filing. Size Range: 0-999999999999.99
Line4BalanceDue	number	GIT amount for balance due for the employees. Size Range: 0-999999999999.99
OverPaymentType	string	Enter the Over Payment Type. Allowed values: "REFUND", "APPLYTORETURN"
Line5OverPaymentAmt	number	GIT amount for overpayment for the employees. Size Range: 0-999999999999.99
DirectDebitIndicator	string	Enter the Direct Debit Indicator Type. Allowed values: "ECHECK", "EFT"
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
GA	object	Forms to be filed for Georgia State.
FormG7	object	Form G7, Georgia withholding quarterly tax return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form G7 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form G7 needs to be filed. Allowed values: "2020"
ReturnType	string	The type of return being filed. Allowed values: "Annual", "Monthly", "Quarterly", "Semiweekly"
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
GAWHId	string	Withholding Account ID. Size Range: ..7
TotalTaxWithheld	number	Total Tax Withheld from employees. Size Range: 0-9999999999.99
TotalAdjustmentsTax	number	Total Credits available. Size Range: -9999999999.99 to 9999999999.99
TotalTaxPaid	number	Total Tax Paid. Size Range: 0-9999999999.99
TotalTaxDue	number	Total Tax due. Size Range: -9999999999.99 to 9999999999.99
BalanceDue	number	Balance Due. Size Range: 0-9999999999.99
AdjustmentsTaxCredits	object[]	Type of credit Details.
AdjustmentCreditType	string	Type of credit. Allowed values: "JOBTAXCRD(Job Tax Credit),HDQTRSCRD(Headquarter Job Tax Credit),FLMTAXCRD(Film Tax Credit),CLNNRGCRD(Clean Energy Property Tax Credit),QLJOBSCRD(Quality Jobs Tax Credit),ADDTAXCRD(Additional Tax),OVRPYMCRD(Over Payment),RSCHTXCRD(Research Tax Credit.)"
AdjustmentCreditMonth	string	Enter the month of the quarter for the Adjustment Credit. Allowed values: "1", "2", "3"
AdjustmentCreditAmount	number	Adjustment Credit Amount. Size Range: -9999999999.99 to 9999999999.99
MonthlyTaxLiability	object	If your return type is monthly, enter the monthly liability and deposit details here.
TaxwithheldMonth1	number	Tax Withheld for Month 1. Size Range: 0-9999999999.99
TaxDepositedMonth1	number	Tax Deposited for Month 1. Size Range: 0-9999999999.99
TaxDueMonth1	number	Tax Due for Month 1. Size Range: -9999999999.99 to 9999999999.99
TaxwithheldMonth2	number	Tax Withheld for Month 2. Size Range: 0-9999999999.99
TaxDepositedMonth2	number	Tax Deposited for Month 2. Size Range: 0-9999999999.99
TaxDueMonth2	number	Tax Due for Month 2. Size Range: -9999999999.99 to 9999999999.99
TaxwithheldMonth3	number	Tax Withheld for Month 3. Size Range: 0-9999999999.99
TaxDepositedMonth3	number	Tax Deposited for Month 3. Size Range: 0-9999999999.99
TaxDueMonth3	number	Tax Due for Month 3. Size Range: -9999999999.99 to 9999999999.99
SemiWeeklyTaxLiability	object	If your return type is semiweekly, enter the liability and deposit details for the days of the quarter.
ScheduleBMonth1Liability	object[]	Tax liability for Day (1 - 31) For Month 1.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth1	number	Tax Withheld for Month 1. Size Range: 0-9999999999.99
TaxDepositedMonth1	number	Tax Deposited for Month 1. Size Range: 0-9999999999.99
TaxDueMonth1	number	Tax Due for Month 1. Size Range: -9999999999.99 to 9999999999.99
ScheduleBMonth2Liability	object[]	Tax liability for Day (1 - 31) For Month 2.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth2	number	Tax Withheld for Month 2. Size Range: 0-9999999999.99
TaxDepositedMonth2	number	Tax Deposited for Month 2. Size Range: 0-9999999999.99
TaxDueMonth2	number	Tax Due for Month 2. Size Range: -9999999999.99 to 9999999999.99
ScheduleBMonth3Liability	object[]	Tax liability for Day (1 - 31) For Month 3.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth3	number	Tax Withheld for Month 3. Size Range: 0-9999999999.99
TaxDepositedMonth3	number	Tax Deposited for Month 3. Size Range: 0-9999999999.99
TaxDueMonth3	number	Tax Due for Month 3. Size Range: -9999999999.99 to 9999999999.99
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
SC	object	Forms to be filed for South Carolina State.
FormWH1605	object	Form WH-1605, SC withholding quarterly tax return.
Sequence	string	A unique number given by an inbound application to identify failed records.
Qtr	string	The Quarter for which, Form WH1605 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form WH1605 needs to be filed. Allowed values: "2020"
WithholdingNmbr	string	SC withholding file number of the business. Size Range: 9
IsAmendedReturn	Boolean	When True, identifies the return is amended.
Line1IncomeTaxWithheld	number	The quarterly SC income tax withheld . Size Range: 0-999999999.99
Line2IncomeTaxDeposits	number	The quarterly SC income tax deposits made. Size Range: 0-999999999.99
Line3Refund	number	Refund amount if Deposit amount is greater than tax withheld. Size Range: 0-999999999.99
Line4TaxDue	number	Balance amount if Deposit amount is lesser than tax withheld. Size Range: 0-999999999.99
Line5Penalty	number	Penalty amount for tax not paid. Size Range: 0-999999999.99
Line5Interest	number	Interest amount for tax not paid Size Range: 0-999999999.99
Line5Total	number	Total Amount of Line 5 Size Range: 0-999999999.99
Line6BalanceDue	number	The total balance amount to be paid to the state. Size Range: 0-999999999.99
IL	object	Forms to be filed for Illinois State.
FormIL941	object	Form IL-941, Illinois Withholding Income Tax Return.
RecordId	guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify failed records.
Qtr	string	The Quarter for which, Form IL941 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form IL941 needs to be filed. Allowed values: "2020"
IlSeqNumber	number	"The 3 digit sequence number assigned to the taxpayer by the state of Illinois. Your sequence number should be “000” unless you have been assigned a different sequence number when you registered.".
IsFirstReturn	Boolean	When True, identifies the business as a new business.
IsAddressChanged	Boolean	When True, identifies the that the business address has changed.
LineA1W2sIssuedNum	number	The total number of W-2s issues for the entire year. Required only when you filing for the 4th quarter.
LineA2Number1099sIssuedNum	number	The total number of 1099s issued for the entire year. Required only when you filing for the 4th quarter.
LineBIsBusinessClosed	Boolean	When True, identifies the business has closed.
LineBDateFinalWagesPaid	string	The date that the employer has last paid wages. Required only if your business is closed.
Line1WHTaxableWages	number	The total of all amounts subject to Illinois withholding income tax. Size Range: 0-9999999999.99
Line2TotalQtrLiability	number	The total tax liability for the quarter. Should be equal to the sum of Line2aTotalMonth1Liability, Line2cTotalMonth1Liability, & Line2dTotalMonth1Liability,. Size Range: 0-9999999999.99
Line3CreditAmt	number	The amount of credit from Schedule WC, Line 7. Size Range: 0-9999999999.99
Line4WHPaymentsOrDeposits	number	"The total amount of withholding payments you have made during this period. This includes all IL-501 payments(electronic and paper coupons).". Size Range: 0-9999999999.99
Line5WHTotalPayments	number	The total amount by adding Form IL-941 line 3 and 4. Size Range: 0-9999999999.99
Line6WHAmountDue	number	The difference amount to be paid to the Illinois Department of Revenue if line 2 is greater than line 5. If the Line 2 is lessser than line 5, enter 0. Size Range: 0-9999999999.99
PaymentSchedule	object	Tax Liability Information of the Quarter.
Month1Liabilities	object[]	Tax Liability Information for Month 1.
Month2Liabilities	object[]	Tax Liability Information for Month 2.
Month3Liabilities	object[]	Tax Liability Information for Month 3.
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Line2aTotalMonth1Liability	number	Tax Liability for Month 1. Size Range: 0-9999999999.99
Line2cTotalMonth1Liability	number	Tax Liability for Month 2. Size Range: 0-9999999999.99
Line2dTotalMonth1Liability	number	Tax Liability for Month 3. Size Range: 0-9999999999.99
ScheduleWC	number	Schedule WC Details.
YearsLeftToCarry	number	The total number of years left to carry forward the credit from Schedule WC-I. Size Range: 0-5
CreditCode	number	The credit code for the withholding income tax credit. Size Range: 4 Allowed values: "0900", "5900", "5910"
QtrEndingCreditEarned	string	"The Four-digit year and two-digit month of the quarter ending during which the credit was first earned".
IdentifyingNum	number	The certificate number listed on the tax credit certificate. For the ILSBJC credit, enter the certificate number listed on the Tax Credit Certificate received from the Illinois Department of Commerce and Economic Opportunity (DCEO). For all other credits, leave the column blank.
CreditsEarned	number	The value of the credits earned. Enter the amount from Schedule WC-I. Size Range: 0-9999999999.99
CreditsCarried	number	The value of the credits carried from a previous quarter. Size Range: 0-9999999999.99
TotalCredits	number	The value of the total credits. The total of CreditsEarned & CreditsCarried. Size Range: 0-9999999999.99
Line5	number	The sum of credits by adding column G, lines 1 through 4. Size Range: 0-9999999999.99
Line6	number	The total tax amount from Form IL-941, Step 4, line 2. Size Range: 0-9999999999.99
Line7	number	The available credit amount. Enter the sane value on Form IL-941, Line 3. Size Range: 0-9999999999.99
ScheduleP	object[]	Schedule P Details .
SchPSeqId	string	A unique number given by an inbound application to identify failed schedule P records.
SchPRecordId	guid	Unique identifier of a Schedule P record.
FirstNm	number	First name of the employee.
LastNm	number	Last name of the employee.
SSN	string	The employee's SSN. Size Range: 9
TaxableWages	number	The employee's income for the quarter. Size Range: 0-9999999999.99
TaxWithheld	number	The amount withheld from the employee for the quarter. Size Range: 0-9999999999.99
ThirdPartyAuthorization	object[]	Third Party Designee Details of Form IL-941.
IsAuthorizeThirdParty	Boolean	When true, your third-party designee is allowed to discuss the return with the IRS.
DesigneeName	string	Third Party Designee's name.
DesigneePhone	string	Third Party Designee's phone number.
StatePayment	object[]	Payment Details .
AccountType	string	Account Type (Checking or Saving) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
AccountHolderName	string	Name of the account holder.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
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

"StateWH/Get?SubmissionId=a4ea750f-40c5-46bd-9f48-2928dd24e708&RecordIds=fe17d02e-11ca-4980-a125-330aef375d51,4f710c2a-c534-405f-b230-ee45c6225055,929c889a-ad5e-4328-b9b3-3d1772dfdedc,344e11d2-375d-48a2-a93a-0222e453a7b7,f5f9f082-b99e-4456-98f7-a64482dee418"

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "a4ea750f-40c5-46bd-9f48-2928dd24e708",
"StateWHRecords": {
  "ReturnHeader": {
    "Forms": [
      {
        "State": "IL",
        "Form": "FormIL941"
      },
      {
        "State": "SC",
        "Form": "FormWH1605"
      },
      {
        "State": "GA",
        "Form": "FormG7"
      },
       {
         "State": "NJ",
         "Form": "FormNJ927"
       },
       {
         "State": "NJ",
         "Form": "FormNJ927W"
       }
    ],
    "Business": {
      "BusinessId": null,
      "BusinessNm": "JS Corp",
      "TradeNm": null,
      "IsEIN": true,
      "EINorSSN": "980365121",
      "Email": "john@jscorpllc.com",
      "ContactNm": "John",
      "Phone": "8765468768",
      "PhoneExtn": null,
      "Fax": "8765435787",
      "BusinessType": "CORP",
      "SigningAuthority": {
        "Name": "John Smith",
        "Phone": "9876545687",
        "BusinessMemberType": "CHIEFACCOUNTINGOFFICER"
      },
      "KindOfEmployer": "NONGOVT501C",
      "KindOfPayer": "AGRICULTURAL943",
      "IsBusinessTerminated": false,
      "IsForeign": false,
      "USAddress": {
        "Address1": "123 Main St",
        "Address2": "Suite 123",
        "City": "Rockhill",
        "State": "SC",
        "ZipCd": "29730"
      },
      "ForeignAddress": {
        "Address1": null,
        "Address2": null,
        "City": null,
        "ProvinceOrStateNm": null,
        "Country": null,
        "PostalCd": null
      }
    }
  },
  "ReturnData": {
    "IL": {
      "FormIL941": {
        "RecordId": "fe17d02e-11ca-4980-a125-330aef375d51",
        "Sequence": null,
        "Qtr": "Q1",
        "TaxYr": "2020",
        "ILSeqNumber": "123",
        "IsFirstReturn": false,
        "IsAddressChanged": false,
        "LineA1W2sIssuedNum": 0,
        "LineA2Number1099sIssuedNum": 0,
        "LineBIsBusinessClosed": false,
        "LineBDateFinalWagesPaid": null,
        "Line1WHTaxableWages": 10000,
        "Line2TotalQtrLiability": 8000,
        "Line3CreditAmt": 5000,
        "Line4WHPaymentsOrDeposits": 2000,
        "Line5WHTotalPayments": 7000,
        "Line6WHAmountDue": 1000,
        "PaymentSchedule": {
          "Month1Liabilities": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            }
          ],
          "Line2aTotalMonth1Liability": 2000,
          "Month2Liabilities": [
            {
              "Day": 1,
              "Amt": 2000
            },
            {
              "Day": 2,
              "Amt": 2000
            }
          ],
          "Line2cTotalMonth2Liability": 4000,
          "Month3Liabilities": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            }
          ],
          "Line2dTotalMonth3Liability": 2000
        },
        "ScheduleWC": {
          "Line1": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 1000,
            "CreditsCarried": 1000,
            "TotalCredits": 2000
          },
          "Line2": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 1000,
            "CreditsCarried": 1000,
            "TotalCredits": 2000
          },
          "Line3": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 1000,
            "CreditsCarried": 1000,
            "TotalCredits": 2000
          },
          "Line4": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 1000,
            "CreditsCarried": 1000,
            "TotalCredits": 2000
          },
          "Line5": 8000,
          "Line6": 8000,
          "Line7": 8000
        },
        "ScheduleP": [
          {
            "SchPSeqId": null,
            "SchPRecordId": "359394f8-de10-42fa-afb1-5ccc94ae2a9f",
            "FirstNm": "Adam",
            "LastNm": "Smith",
            "SSN": "009876545",
            "TaxableWages": 10000,
            "TaxWithheld": 8000
          }
        ],
        "ThirdPartyAuthorization": {
          "IsAuthorizeThirdParty": false,
          "DesigneeName": null,
          "DesigneePhone": null
        },
        "StatePayment": {
          "AccountType": "Checking",
          "RoutingTransitNumber": "217555555",
          "BankAccountNumber": "0000000001",
          "AccountHolderName": "John Smith",
          "AccountHolderType": "Business"
        }
      }
    },
    "SC": {
      "FormWH1605": {
        "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
        "Sequence": "222",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "WithholdingNmbr": "124563101",
        "IsAmendedReturn": true,
        "Line1IncomeTaxWithheld": 5000,
        "Line2IncomeTaxDeposits": 6000,
        "Line3Refund": 1000,
        "Line4TaxDue": 0,
        "Line5Penalty": 0,
        "Line5Interest": 0,
        "Line5Total": 0,
        "Line6BalanceDue": 0
      },
      "FormWH1606": null
    },
    "GA": {
      "FormG7": {
        "Sequence": "001",
        "RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "ReturnType": "SEMIWEEKLY",
        "IsAmendedReturn": false,
        "GAWHId": 25,
        "TotalTaxWithheld": 100,
        "TotalAdjustmentsTax": 100,
        "TotalTaxDue": 100,
        "TotalTaxPaid": 100,
        "BalanceDue": 100,
        "AdjustmentsTaxCredits": [
          {
            "AdjustmentCreditType": "Overpayment",
            "AdjustmentCreditMonth": 1,
            "AdjustmentCreditAmount": 100.22
          }
        ],
        "MonthlyTaxLiability": {
          "TaxwithheldMonth1": 0,
          "TaxDepositedMonth1": 0,
          "TaxDueMonth1": 0,
          "TaxwithheldMonth2": 0,
          "TaxDepositedMonth2": 0,
          "TaxDueMonth2": 0,
          "TaxwithheldMonth3": 0,
          "TaxDepositedMonth3": 0,
          "TaxDueMonth3": 0,
        },
        "SemiWeeklyTaxLiability": {
          "ScheduleBMonth1Liability": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            },
            {
              "Day": 10,
              "Amt": 1000
            }
          ],
          "TaxWithheldMonth1": 4000,
          "TaxDepositedMonth1": 9000,
          "TaxDueMonth1": 8500,
          "ScheduleBMonth2Liability": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            },
            {
              "Day": 10,
              "Amt": 1000
            }
          ],
          "TaxWithheldMonth2": 5000,
          "TaxDepositedMonth2": 8000,
          "TaxDueMonth2": 9000,
          "ScheduleBMonth3Liability": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            },
            {
              "Day": 10,
              "Amt": 1000
            }
          ],
          "TaxWithheldMonth3": 3000,
          "TaxDepositedMonth3": 5000,
          "TaxDueMonth3": 5500,
        },
        "StatePayment": {
          "AccountType": "Checking",
          "RoutingTransitNumber": "217555555",
          "BankAccountNumber": "0000000001",
          "AccountHolderName": "John Smith",
          "AccountHolderType": "Business"
        }
      }
    },
 "NJ": {
   "FormNJ927": {
   "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
     "Sequence": "001",
     "Qtr": "Q1",
     "TaxYr": "2020",
     "TPID": "B123456789000",
     "IsAmendedReturn": true,
     "MonthlyGITAmtWithheld":  {
      "Month1Withheld":2000,
      "Month2Withheld":1000,
      "Month3Withheld":2000
    },
     "Line1TotalWages": 30000,
     "Line2TotalAmtDue": 5000,
     "Line3TotalRemittedCredits": 2000,
     "Line4BalanceDue": 3000,
     "OverPaymentType": null,
     "Line5OverPaymentAmt": 0,
     "DirectDebitIndicator": "Echeck",
     "StatePayment": {
       "AccountType": "Checking",
       "RoutingTransitNumber": "217555555",
       "BankAccountNumber": "0000000001",
       "AccountHolderName": "John Smith",
       "AccountHolderType": "Business"
     }
   },
  "FormNJ927W": {
   "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
    "Sequence": "001",
    "Qtr": "Q2",
    "TaxYr": "2020",
    "TPID": "B123456789000",
    "IsAmendedReturn": true,
    "WeeklyGITAmtWithheld": [
      {
        "Week": 1,
        "AmtWithheld": 2500
      },
      {
        "Week": 2,
        "AmtWithheld": 2500
      }
    ],
    "Line1TotalWages": 30000,
    "Line2TotalAmtDue": 5000,
    "Line3TotalRemittedCredits": 2000,
    "Line4BalanceDue": 3000,
    "OverPaymentType": null,
    "Line5OverPaymentAmt": 0,
    "DirectDebitIndicator": "Echeck",
    "StatePayment": {
      "AccountType": "Checking",
      "RoutingTransitNumber": "217555555",
      "BankAccountNumber": "0000000001",
      "AccountHolderName": "John Smith",
      "AccountHolderType": "Business"
    }
  }
},
    "NC": null
  }
},
"Errors": null
}
*

# GetPDF

Request a PDF download of State WH to be made available through Webhooks

GET StateWH/GetPDF

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	List of record Ids to be downloaded.

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
StateWHRecords	object[]	StateWHRecords Object
Sequence	string	A unique number given by an inbound application to identify records.
FormType	string	Type of State WH Forms filed.
RecordId	Guid	Unique identifier of a record
Message	string	Returns 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

StateWH/GetPdf?SubmissionId=7dd5c92c-1832-45f8-acbf-748d28f9e4ea&RecordIds=3909399a-7566-4810-9b88-f4442a59a923,4f710c2a-c534-405f-b230-ee45c6225055,929c889a-ad5e-4328-b9b3-3d1772dfdedc

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "7dd5c92c-1832-45f8-acbf-748d28f9e4ea",
   "StateWHRecords": [
     {
       "Sequence": "01",
       "FormType": "FormIL941",
       "RecordId": "3909399a-7566-4810-9b88-f4442a59a923",
       "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
     },
     {
   "Sequence": "222",
   "FormType": "FORMWH1605",
   "RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
   "Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
 },
 {
   "Sequence": "001",
   "FormType": "FORMG7",
   "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
   "Message": "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
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# List

Lists State withholding Forms created for a date range.

GET StateWH/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 State WH records to be listed in each page
RecordStatus	string	List the State WH records based on the status
FromDate	string	List State WH records created from
ToDate	string	List State WH records created up to Date.

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.
StateWHRecords	object[]	Returns detailed information of the State WH records.
SubmissionId	guid	Unique identifier of a submission
BusinessId	guid	Unique Identifier of the business
BusinessNm	string	Name of the business
EIN	string	Employer Identification Number
FormType	string	Type of State WH Forms
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	guid	Unique identifier of a record
Qtr	string	Quarter for which State WH needs to be filed
TaxYr	string	Tax year for which State WH needs to be filed
WithholdingNmbr	number	withholding Number
ReturnType	string	Type of the return to be filed. Enter value as FORMIL-941
RecordStatus	string	List the State WH records based on the status.
TotalRecords	number	Total number of records.
TotalPages	number	Total number of pages.
Page	number	Pulls the page number of the page selected
PageSize	number	Number of StateWH 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

"StateWH/List?BusinessId=47914440-f016-482b-a065-43f6e7963904&EIN=00-7895456&Page=0&PageSize=0&RecordStatus=CREATED&FromDate=04/31/2020&ToDate=04/31/2020"

Response JSON

       {
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "StateWHRecords": [
      {
          "SubmissionId": "2906a6ab-cc63-459e-b96d-bd46c4165cfb",
          "BusinessId": "47914440-f016-482b-a065-43f6e7963904",
          "BusinessNm": "Robert Inc",
          "EINorSSN": "00-7895456",
          "FormType": "FormWH1605",
          "Sequence": "",
          "Qtr": "Q1",
          "TaxYr": "2020",
          "WithholdingNmbr": "124153241",
          "RecordId": "db57935e-a216-4320-b4fa-0c7f55576ccf",
          "RecordStatus": "CREATED"
      },
      {
  "SubmissionId": "2906a6ab-cc63-459e-b96d-bd46c4165cfb",
  "BusinessId": "47914440-f016-482b-a065-43f6e7963904",
  "BusinessNm": "Robert Inc",
  "EINorSSN": "00-7895456",
  "FormType": "FormIL941",
  "Sequence": "111",
  "Qtr": "Q1",
  "TaxYr": "2020",
  "WithholdingNmbr": null,
  "RecordId": "bf1d9f7c-2035-465e-9696-c1f37a4a3a37",
  "RecordStatus": "CREATED"
},
{
  "SubmissionId": "2906a6ab-cc63-459e-b96d-bd46c4165cfb",
  "BusinessId": "47914440-f016-482b-a065-43f6e7963904",
  "BusinessNm": "Robert Inc",
  "EINorSSN": "00-7895456",
  "FormType": "FormG7",
  "Sequence": "111",
  "Qtr": "Q1",
  "TaxYr": "2020",
  "WithholdingNmbr": null,
  "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
  "RecordStatus": "CREATED"
},
{
  "SubmissionId": "2906a6ab-cc63-459e-b96d-bd46c4165cfb",
  "BusinessId": "47914440-f016-482b-a065-43f6e7963904",
  "BusinessNm": "Robert Inc",
  "EINorSSN": "00-7895456",
  "FormType": "FormNJ927",
  "Sequence": "112",
  "Qtr": "Q1",
  "TaxYr": "2020",
  "WithholdingNmbr": null,
  "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
  "RecordStatus": "CREATED"
},
{
  "SubmissionId": "2906a6ab-cc63-459e-b96d-bd46c4165cfb",
  "BusinessId": "47914440-f016-482b-a065-43f6e7963904",
  "BusinessNm": "Robert Inc",
  "EINorSSN": "00-7895456",
  "FormType": "FormNJ927W",
  "Sequence": "113",
  "Qtr": "Q2",
  "TaxYr": "2020",
  "WithholdingNmbr": null,
  "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
  "RecordStatus": "CREATED"
}
  ],
  "TotalRecords": 5,
  "TotalPages": 1,
  "Page": 1,
  "PageSize": 100,
  "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
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

# Status

Gets the status of the State WH by Submission Id and Record Ids.

GET StateWH/Status

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	Gets the status for a list of Record IDs
EIN	string	Employer Identification Number Size Range: 9

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.
StateWHRecords	object	Pulls the state withholding form records with Success and Error statuses.
IL	object	Pulls the Illinois state withholding form records with Success and Error statuses.
GA	object	Pulls the Georgia state withholding form records with Success and Error statuses.
SC	object	Pulls the South Carolina state withholding form records with Success and Error statuses.
NJ	object	Pulls the New Jersey state withholding form records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of StateWH Records.
Sequence	string	A unique number given by an inbound application to identify failed records.
FormType	string	Type of State WH form filed.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of return created.
ErrorRecords	object[]	It will show the detailed information about the error status of StateWH Records
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error Id.
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.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error Id.
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

StateWH/Status?SubmissionId=d4dc77a6-81b4-4a70-8cf5-e01a7eff50b0&RecordIds=402fb208-50b2-48cb-a767-db017be95d9d,929c889a-ad5e-4328-b9b3-3d1772dfdedc,4f710c2a-c534-405f-b230-ee45c6225055,344e11d2-375d-48a2-a93a-0222e453a7b7,f5f9f082-b99e-4456-98f7-a64482dee418&EIN=546546546

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "d4dc77a6-81b4-4a70-8cf5-e01a7eff50b0",
"StateWHRecords": {
 "IL": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "FormIL941",
       "RecordId": "402fb208-50b2-48cb-a767-db017be95d9d",
       "RecordStatus": "CREATED",
       "StatusTs": "2020-03-11 08:39:58 -04:00"
     }
   ],
   "ErrorRecords": null
 },
 "SC": {
   "SuccessRecords": [
     {
       "Sequence": "222",
       "FormType": "FormWH1605",
       "RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
       "RecordStatus": "Created",
       "StatusTs": "2020-04-15 13:51:52 +05:30"
     }
   ],
   "ErrorRecords": null
 },
 "GA": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "FormG7",
       "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
       "RecordStatus": "Created",
       "StatusTs": "2020-04-15 13:51:52 +05:30"
     }
   ],
   "ErrorRecords": null
 },
 "NJ": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "WHFORMNJ927",
       "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:14 -04:00"
     },
     {
       "Sequence": "001",
       "FormType": "WHFORMNJ927W",
       "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:32 -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
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

# Transmit

Transmits the StateWH to the IRS after validation.

POST StateWH/Transmit

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	List of record Ids to be transmitted.

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.
StateWHRecords	object	Pulls the StateWh records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of StateWH 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.
ErrorRecords	object[]	It will show the detailed information about the error status of StateWH 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.
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": "a1df04cc-4c08-4828-9ce9-87e4eb151777",
"RecordIds": [
"2c3b7697-fa03-4bfd-ba9b-2857de572416",
"4f710c2a-c534-405f-b230-ee45c6225055",
"929c889a-ad5e-4328-b9b3-3d1772dfdedc",
"344e11d2-375d-48a2-a93a-0222e453a7b7",
"f5f9f082-b99e-4456-98f7-a64482dee418"
]
}

1
2
3
4
5
6
7
8
9
10

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "a1df04cc-4c08-4828-9ce9-87e4eb151777",
"StateWHRecords": {
"IL": {
"SuccessRecords": [
{
"Sequence": "",
"FormType": "FormIL941",
"RecordId": "2c3b7697-fa03-4bfd-ba9b-2857de572416",
"RecordStatus": "Transmitted",
"StatusTs": "2020-04-02 14:14:31 +05:30"
}
],
"ErrorRecords": null
},
"SC": {
"SuccessRecords": [
{
"Sequence": "222",
"FormType": "FormWH1605",
"RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
"RecordStatus": "Transmitted",
"StatusTs": "2020-04-02 14:14:31 +05:30"
}
],
"ErrorRecords": null
},
"GA": {
"SuccessRecords": [
{
"Sequence": "001",
"FormType": "FormG7",
"RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
"RecordStatus": "Transmitted",
"StatusTs": "2020-04-02 14:14:31 +05:30"
}
],
"ErrorRecords": null
},
"NJ": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "WHFormNJ927",
       "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
       "RecordStatus": "Transmitted",
       "StatusTs": "2020-05-23 10:43:48 -04:00"
     },
     {
       "Sequence": "002",
       "FormType": "WHFormNJ927W",
       "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
       "RecordStatus": "Transmitted",
       "StatusTs": "2020-05-23 10:43:48 -04:00"
     }
   ],
   "ErrorRecords": null
 }
},
"Errors": null,
"ErrorRecords": 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
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

# Update

Updates State WH returns with a unique Submission Id which is further used for all other methods referencing these State WH forms.

PUT StateWH/Update

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission.
StateWHRecords	object	Object to create State Withholding Forms.
ReturnHeader	object	Identifies the supporting details of State Withholding Forms.
Forms	object[]	Type of Statewithholding forms and state to be filed.
State	string	State for which Statewithholding forms to be filed. Allowed values: "SC", "IL", "GA", "NJ"
Form	string	Type of Statewithholding forms to be filed. Allowed values: "FormIL941", "FormWH1605", "FormG7", "FormNJ927", "FormNJ927W"
Business	object	Business Details
BusinessId	guid	Business Identifier (Autogenerated).
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 with area code 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	Kind Of Payer based on the Employer's Federal Tax Return. Allowed values: "REGULARW9", "REGULAR944", "AGRICULTURALW9", "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	Employer/Payer's state Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
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's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object	Identifies the State Withholding Forms data.
NJ	object	Forms to be filed for New Jersey State.
FormNJ927	string	Form NJ 927, New Jersey withholding quarterly tax return.
RecordId	guid	Unique identifier of a record.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form NJ 927 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form NJ 927 needs to be filed. Allowed values: "2020"
TPID	string	TaxPayer ID Size Range: 13
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
MonthlyGITAmtWithheld	object	Enter the Monthly withheld details.
Month1Withheld	number	The amount of withholding for Month 1. Size Range: 0-999999999999.99
Month2Withheld	number	The amount of withholding for Month 2. Size Range: 0-999999999999.99
Month3Withheld	number	The amount of withholding for Month 3. Size Range: 0-999999999999.99
Line1TotalWages	number	GIT Wages Subject to Gross Income Tax Withholding to the employees. Size Range: 0-999999999999.99
Line2TotalAmtDue	number	GIT total amount due for Quarter/Year (If filing NJ927H) to the employess. Size Range: 0-9999999999.99
Line3TotalRemittedCredits	number	Total contributions paid prior to this filing. Size Range: 0-999999999999.99
Line4BalanceDue	number	GIT amount for balance due for the employees. Size Range: 0-999999999999.99
OverPaymentType	string	Enter the Over Payment Type. Allowed values: "REFUND", "APPLYTORETURN"
Line5OverPaymentAmt	number	GIT amount for overpayment for the employees. Size Range: 0-999999999999.99
DirectDebitIndicator	string	Enter the Direct Debit Indicator Type. Allowed values: "ECHECK", "EFT"
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
FormNJ927W	string	Form NJ 927W, New Jersey withholding quarterly tax return.
RecordId	guid	Unique identifier of a record.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form NJ 927W needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form NJ 927 needs to be filed. Allowed values: "2020"
TPID	string	TaxPayer ID Size Range: 13
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
WeeklyGITAmtWithheld	object[]	Enter the Weekly withheld details.
Week	number	Enter the Week for which withheld to be Filed. Allowed values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14"
AmtWithheld	number	The amount of withholding for Week. Size Range: 0-999999999999.99
Line1TotalWages	number	GIT Wages Subject to Gross Income Tax Withholding to the employees. Size Range: 0-999999999999.99
Line2TotalAmtDue	number	GIT total amount due for Quarter/Year (If filing NJ927H) to the employess. Size Range: 0-9999999999.99
Line3TotalRemittedCredits	number	Total contributions paid prior to this filing. Size Range: 0-999999999999.99
Line4BalanceDue	number	GIT amount for balance due for the employees. Size Range: 0-999999999999.99
OverPaymentType	string	Enter the Over Payment Type. Allowed values: "REFUND", "APPLYTORETURN"
Line5OverPaymentAmt	number	GIT amount for overpayment for the employees. Size Range: 0-999999999999.99
DirectDebitIndicator	string	Enter the Direct Debit Indicator Type. Allowed values: "ECHECK", "EFT"
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
GA	object	Forms to be filed for Georgia State.
FormG7	object	Form G7, Georgia withholding quarterly tax return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form G7 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form G7 needs to be filed. Allowed values: "2020"
ReturnType	string	The type of return being filed. Allowed values: "Annual", "Monthly", "Quarterly", "Semiweekly"
IsAmendedReturn	Boolean	When true, identifies that the return is amended.
GAWHId	string	Withholding Account ID. Size Range: ..7
TotalTaxWithheld	number	Total Tax Withheld from employees. Size Range: 0-9999999999.99
TotalAdjustmentsTax	number	Total Credits available. Size Range: -9999999999.99 to 9999999999.99
TotalTaxPaid	number	Total Tax Paid. Size Range: 0-9999999999.99
TotalTaxDue	number	Total Tax due. Size Range: -9999999999.99 to 9999999999.99
BalanceDue	number	Balance Due. Size Range: 0-9999999999.99
AddAdjustmentsTaxCredits	object[]	Type of credit Details.
AdjustmentCreditRecordId	Guid	Not Required for AddAdjustmentsTaxCredits.
AdjustmentCreditType	string	Type of credit. Allowed values: "JOBTAXCRD(Job Tax Credit),HDQTRSCRD(Headquarter Job Tax Credit),FLMTAXCRD(Film Tax Credit),CLNNRGCRD(Clean Energy Property Tax Credit),QLJOBSCRD(Quality Jobs Tax Credit),ADDTAXCRD(Additional Tax),OVRPYMCRD(Over Payment),RSCHTXCRD(Research Tax Credit.)"
AdjustmentCreditMonth	string	Enter the month of the quarter for the Adjustment Credit. Allowed values: "1", "2", "3"
AdjustmentCreditAmount	number	Adjustment Credit Amount. Size Range: -9999999999.99 to 9999999999.99
UpdateAdjustmentsTaxCredits	object[]	Update Type of credit Details.
AdjustmentCreditRecordId	Guid	Unique identifier of a AdjustmentCredit record.
AdjustmentCreditType	string	Type of credit. Allowed values: "JOBTAXCRD(Job Tax Credit),HDQTRSCRD(Headquarter Job Tax Credit),FLMTAXCRD(Film Tax Credit),CLNNRGCRD(Clean Energy Property Tax Credit),QLJOBSCRD(Quality Jobs Tax Credit),ADDTAXCRD(Additional Tax),OVRPYMCRD(Over Payment),RSCHTXCRD(Research Tax Credit.)"
AdjustmentCreditMonth	string	FAddAdjustmentsTaxCredits. Allowed values: "1", "2", "3"
AdjustmentCreditAmount	number	Adjustment Credit Amount. Size Range: -9999999999.99 to 9999999999.99
DeleteAdjustmentsTaxCredits	object[]	Deletes AdjustmentCredit Details
AdjustmentCreditRecordId	Guid	Unique identifier of a AdjustmentCredit record.
MonthlyTaxLiability	object	If your return type is monthly, enter the monthly liability and deposit details here.
TaxwithheldMonth1	number	Tax Withheld for Month 1. Size Range: 0-9999999999.99
TaxDepositedMonth1	number	Tax Deposited for Month 1. Size Range: 0-9999999999.99
TaxDueMonth1	number	Tax Due for Month 1. Size Range: -9999999999.99 to 9999999999.99
TaxwithheldMonth2	number	Tax Withheld for Month 2. Size Range: 0-9999999999.99
TaxDepositedMonth2	number	Tax Deposited for Month 2. Size Range: 0-9999999999.99
TaxDueMonth2	number	Tax Due for Month 2. Size Range: -9999999999.99 to 9999999999.99
TaxwithheldMonth3	number	Tax Withheld for Month 3. Size Range: 0-9999999999.99
TaxDepositedMonth3	number	Tax Deposited for Month 3. Size Range: 0-9999999999.99
TaxDueMonth3	number	Tax Due for Month 3. Size Range: -9999999999.99 to 9999999999.99
SemiWeeklyTaxLiability	object	If your return type is semiweekly, enter the liability and deposit details for the days of the quarter.
ScheduleBMonth1Liability	object[]	Tax liability for Day (1 - 31) For Month 1.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth1	number	Tax Withheld for Month 1. Size Range: 0-9999999999.99
TaxDepositedMonth1	number	Tax Deposited for Month 1. Size Range: 0-9999999999.99
TaxDueMonth1	number	Tax Due for Month 1. Size Range: -9999999999.99 to 9999999999.99
ScheduleBMonth2Liability	object[]	Tax liability for Day (1 - 31) For Month 2.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth2	number	Tax Withheld for Month 2. Size Range: 0-9999999999.99
TaxDepositedMonth2	number	Tax Deposited for Month 2. Size Range: 0-9999999999.99
TaxDueMonth2	number	Tax Due for Month 2. Size Range: -9999999999.99 to 9999999999.99
ScheduleBMonth3Liability	object[]	Tax liability for Day (1 - 31) For Month 3.
Day	string	Tax Lability Day of the month. Allowed values: "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"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
TaxwithheldMonth3	number	Tax Withheld for Month 3. Size Range: 0-9999999999.99
TaxDepositedMonth3	number	Tax Deposited for Month 3. Size Range: 0-9999999999.99
TaxDueMonth3	number	Tax Due for Month 3. Size Range: -9999999999.99 to 9999999999.99
StatePayment	object	Payment Details .
AccountHolderName	string	Name of the account holder.
AccountType	string	Account Type (Checking or Saving) of EFW payment.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
SC	object	Forms to be filed for South Carolina State.
FormWH1605	object	Form WH-1605, SC withholding quarterly tax return.
RecordId	guid	Unique identifier of a record.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form WH1605 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form WH1605 needs to be filed. Allowed values: "2020"
WithholdingNmbr	string	SC withholding file number of the business. Size Range: 9
IsAmendedReturn	Boolean	When True, identifies the return is amended.
Line1IncomeTaxWithheld	number	The quarterly SC income tax withheld . Size Range: 0-999999999.99
Line2IncomeTaxDeposits	number	The quarterly SC income tax deposits made. Size Range: 0-999999999.99
Line3Refund	number	Refund amount if Deposit amount is greater than tax withheld. Size Range: 0-999999999.99
Line4TaxDue	number	Balance amount if Deposit amount is lesser than tax withheld. Size Range: 0-999999999.99
Line5Penalty	number	Penalty amount for tax not paid. Size Range: 0-999999999.99
Line5Interest	number	Interest amount for tax not paid Size Range: 0-999999999.99
Line5Total	number	Total Amount of Line 5 Size Range: 0-999999999.99
Line6BalanceDue	number	The total balance amount to be paid to the state. Size Range: 0-999999999.99
IL	object	Forms to be filed for Illinois State.
FormIL941	object	Form IL-941, Illinois withholding income tax return.
RecordId	guid	Unique identifier of a record
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form IL941 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form IL941 needs to be filed. Allowed values: "2020"
IlSeqNumber	number	"The 3 digit sequence number assigned to the taxpayer by the state of Illinois. Your sequence number should be “000” unless you have been assigned a different sequence number when you registered.".
IsFirstReturn	Boolean	When True, identifies the business as a new business.
IsAddressChanged	Boolean	When True, identifies the that the business address has changed.
LineA1W2sIssuedNum	number	The total number of W-2s issues for the entire year. Required only when you filing for the 4th quarter.
LineA2Number1099sIssuedNum	number	The total number of 1099s issued for the entire year. Required only when you filing for the 4th quarter.
LineBIsBusinessClosed	Boolean	When True, identifies the business has closed.
LineBDateFinalWagesPaid	string	The date that the employer has last paid wages. Required only if your business is closed.
Line1WHTaxableWages	number	The total of all amounts subject to Illinois withholding income tax. Size Range: 0-9999999999.99
Line2TotalQtrLiability	number	The total tax liability for the quarter. Should be equal to the sum of Line2aTotalMonth1Liability, Line2cTotalMonth1Liability, & Line2dTotalMonth1Liability,. Size Range: 0-9999999999.99
Line3CreditAmt	number	The amount of credit from Schedule WC, Line 7. Size Range: 0-9999999999.99
Line4WHPaymentsOrDeposits	number	"The total amount of withholding payments you have made during this period. This includes all IL-501 payments(electronic and paper coupons).". Size Range: 0-9999999999.99
Line5WHTotalPayments	number	The total amount by adding Form IL-941 line 3 and 4. Size Range: 0-9999999999.99
Line6WHAmountDue	number	The difference amount to be paid to the Illinois Department of Revenue if line 2 is greater than line 5. If the Line 2 is lessser than line 5, enter 0. Size Range: 0-9999999999.99
PaymentSchedule	object	Tax Liability Information of the Quarter.
Month1Liabilities	object[]	Tax Liability Information for Month 1.
Month2Liabilities	object[]	Tax Liability Information for Month 2.
Month3Liabilities	object[]	Tax Liability Information for Month 3.
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-9999999999.99
Line2aTotalMonth1Liability	number	Tax Liability for Month 1. Size Range: 0-9999999999.99
Line2cTotalMonth1Liability	number	Tax Liability for Month 2. Size Range: 0-9999999999.99
Line2dTotalMonth1Liability	number	Tax Liability for Month 3. Size Range: 0-9999999999.99
ScheduleWC	number	Schedule WC Details.
YearsLeftToCarry	number	The total number of years left to carry forward the credit from Schedule WC-I. Size Range: 0-5
CreditCode	number	The credit code for the withholding income tax credit. Size Range: 4 Allowed values: "0900", "5900", "5910"
QtrEndingCreditEarned	string	"The Four-digit year and two-digit month of the quarter ending during which the credit was first earned".
IdentifyingNum	number	The certificate number listed on the tax credit certificate. For the ILSBJC credit, enter the certificate number listed on the Tax Credit Certificate received from the Illinois Department of Commerce and Economic Opportunity (DCEO). For all other credits, leave the column blank.
CreditsEarned	number	The value of the credits earned. Enter the amount from Schedule WC-I. Size Range: 0-9999999999.99
CreditsCarried	number	The value of the credits carried from a previous quarter. Size Range: 0-9999999999.99
TotalCredits	number	The value of the total credits. The total of CreditsEarned & CreditsCarried. Size Range: 0-9999999999.99
Line5	number	The sum of credits by adding column G, lines 1 through 4. Size Range: 0-9999999999.99
Line6	number	The total tax amount from Form IL-941, Step 4, line 2. Size Range: 0-9999999999.99
Line7	number	The available credit amount. Enter the sane value on Form IL-941, Line 3. Size Range: 0-9999999999.99
AddSchedulePDetails	object[]	Add Schedule P Details .
SchPSeqId	string	A unique number given by an inbound application to identify schedule P failed records.
SchPRecordId	Guid	Not Required for AddschedulePDetails.
FirstNm	number	First name of the employee.
LastNm	number	Last name of the employee.
SSN	string	The employee's SSN. Size Range: 9
TaxableWages	number	The employee's income for the quarter. Size Range: 0-9999999999.99
TaxWithheld	number	The amount withheld from the employee for the quarter. Size Range: 0-9999999999.99
UpdateSchedulePDetails	object[]	Update Schedule P Details .
SchPRecordId	Guid	Unique identifier of a Schedule P record.
DeleteSchedulePDetails	object[]	Deletes Schedule P Details .
SchedulePRecordId	Guid	Unique identifier of a Schedule P record.
ThirdPartyAuthorization	object[]	Third Party Designee Details of Form IL-941.
IsAuthorizeThirdParty	Boolean	When true, your third-party designee is allowed to discuss the return with the IRS.
DesigneeName	string	Third Party Designee's name.
DesigneePhone	string	Third Party Designee's phone number.
StatePayment	object[]	Payment Details .
AccountType	string	Account Type (Checking or Saving) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
AccountHolderName	string	Name of the account holder.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.

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.
StateWHRecords	object	Pulls the State withholding Form records with Success and Error statuses.
IL	object	Pulls the Illinois State withholding Form records with Success and Error statuses.
GA	object	Pulls the Georgia State withholding Form records with Success and Error statuses.
SC	object	Pulls the South Carolina State withholding Form records with Success and Error statuses.
NJ	object	Pulls the New Jersey State withholding Form records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of State WH Records.
Sequence	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
FormType	string	Type of State withholding Form Filed.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of return.
SchPSuccessRecords	object[]	It will show the detailed information about the success status of Schedule P Records.
SchPSeqId	string	A unique number given by an inbound application to identify schedule P records.
SchPRecordId	Guid	Unique identifier of a Schedule P record.
StatusTs	string	Date and time of SChedule P Records
AdjustmentsCreditsSuccessRecords	object[]	It will show the detailed information about the success status of AdjustmentsCredits Records.
RecordStatus	string	Statue of the AdjustmentsCredits Records.
AdjustmentsCreditsRecordId	Guid	Unique identifier of a AdjustmentsCredits record.
StatusTs	string	Date and time of AdjustmentsCredits Records
ErrorRecords	object[]	It will show the detailed information about the error status of State WH Records.
RecordId	Guid	Unique identifier of a record.
Sequence	string	A unique number given by an inbound application to identify 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.
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": "011ab0f8-7192-4343-8b66-596007bd28f4",
"StateWHRecords": {
  "ReturnHeader": {
    "Forms": [
      {
        "State": "IL",
        "Form": "FormIL941"
      },
      {
        "State": "SC",
        "Form": "FormWH1605"
      },
      {
        "State": "GA",
        "Form": "FormG7"
      },
       {
         "State": "NJ",
         "Form": "FormNJ927"
       },
       {
         "State": "NJ",
         "Form": "FormNJ927W"
       }
    ],
    "Business": {
      "BusinessId": null,
      "BusinessNm": "JS Corp",
      "TradeNm": null,
      "IsEIN": true,
      "EINorSSN": "980365121",
      "Email": "john@jscorpllc.com",
      "ContactNm": "John",
      "Phone": "8765468768",
      "PhoneExtn": null,
      "Fax": "8765435787",
      "BusinessType": "CORP",
      "SigningAuthority": {
        "Name": "John Smith",
        "Phone": "9876545687",
        "BusinessMemberType": "CHIEFACCOUNTINGOFFICER"
      },
      "KindOfEmployer": "NONGOVT501C",
      "KindOfPayer": "AGRICULTURAL943",
      "IsBusinessTerminated": false,
      "IsForeign": false,
      "USAddress": {
        "Address1": "123 Main St",
        "Address2": "Suite 123",
        "City": "Rockhill",
        "State": "SC",
        "ZipCd": "29730"
      },
      "ForeignAddress": {
        "Address1": null,
        "Address2": null,
        "City": null,
        "ProvinceOrStateNm": null,
        "Country": null,
        "PostalCd": null
      }
    }
  },
  "ReturnData": {
    "IL": {
      "FormIL941": {
        "RecordId": "493cb106-6857-407c-88cd-7f4f53139ba0",
        "Sequence": null,
        "Qtr": "Q1",
        "TaxYr": "2020",
        "ILSeqNumber": "123",
        "IsFirstReturn": false,
        "IsAddressChanged": false,
        "LineA1W2sIssuedNum": 0,
        "LineA2Number1099sIssuedNum": 0,
        "LineBIsBusinessClosed": false,
        "LineBDateFinalWagesPaid": null,
        "Line1WHTaxableWages": 20000,
        "Line2TotalQtrLiability": 16000,
        "Line3CreditAmt": 10000,
        "Line4WHPaymentsOrDeposits": 5000,
        "Line5WHTotalPayments": 15000,
        "Line6WHAmountDue": 1000,
        "PaymentSchedule": {
          "Month1Liabilities": [
            {
              "Day": 1,
              "Amt": 2000
            },
            {
              "Day": 2,
              "Amt": 2000
            }
          ],
          "Line2aTotalMonth1Liability": 4000,
          "Month2Liabilities": [
            {
              "Day": 1,
              "Amt": 4000
            },
            {
              "Day": 2,
              "Amt": 4000
            }
          ],
          "Line2cTotalMonth2Liability": 8000,
          "Month3Liabilities": [
            {
              "Day": 1,
              "Amt": 2000
            },
            {
              "Day": 2,
              "Amt": 2000
            }
          ],
          "Line2dTotalMonth3Liability": 4000
        },
        "ScheduleWC": {
          "Line1": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 2000,
            "CreditsCarried": 2000,
            "TotalCredits": 4000
          },
          "Line2": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 2000,
            "CreditsCarried": 2000,
            "TotalCredits": 4000
          },
          "Line3": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 2000,
            "CreditsCarried": 2000,
            "TotalCredits": 4000
          },
          "Line4": {
            "YearsLeftToCarry": 2,
            "CreditCode": "5900",
            "QtrEndingCreditEarned": "2003",
            "IdentifyingNum": "abcd",
            "CreditsEarned": 2000,
            "CreditsCarried": 2000,
            "TotalCredits": 4000
          },
          "Line5": 16000,
          "Line6": 16000,
          "Line7": 16000
        },
        "AddSchedulePDetails": [
          {
            "SchPSeqId": null,
            "SchPRecordId": null,
            "FirstNm": "Adam",
            "LastNm": "Smith",
            "SSN": "009876545",
            "TaxableWages": 10000,
            "TaxWithheld": 8000
          }
        ],
        "UpdateSchedulePDetails": [
          {
            "SchPSeqId": null,
            "SchPRecordId": "2888585e-2bf7-4786-b295-a2c1229b7cc9",
            "FirstNm": "Sruthi",
            "LastNm": "Krishna",
            "SSN": "789456123",
            "TaxableWages": 10000,
            "TaxWithheld": 8000
          }
        ],
        "DeleteSchedulePDetails": [
          {
            "SchedulePRecordId": "d7f2f746-1c1f-492a-8bb9-99b6680c25af"
          }
        ],
        "ThirdPartyAuthorization": {
          "IsAuthorizeThirdParty": false,
          "DesigneeName": null,
          "DesigneePhone": null
        },
        "StatePayment": {
          "AccountType": "Checking",
          "RoutingTransitNumber": "217555555",
          "BankAccountNumber": "0000000001",
          "AccountHolderName": "John Smith",
          "AccountHolderType": "Business"
        }
      }
    },
    "SC": {
      "FormWH1605": {
        "RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
        "Sequence": "222",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "WithholdingNmbr": "124563101",
        "IsAmendedReturn": true,
        "Line1IncomeTaxWithheld": 5000,
        "Line2IncomeTaxDeposits": 6000,
        "Line3Refund": 1000,
        "Line4TaxDue": 0,
        "Line5Penalty": 0,
        "Line5Interest": 0,
        "Line5Total": 0,
        "Line6BalanceDue": 0
      },
      "FormWH1606": null
    },
    "GA": {
      "FormG7": {
        "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
        "Sequence": "001",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "ReturnType": "SEMIWEEKLY",
        "IsAmendedReturn": false,
        "GAWHId": 25,
        "TotalTaxWithheld": 100,
        "TotalAdjustmentsTax": 100,
        "TotalTaxDue": 100,
        "TotalTaxPaid": 100,
        "BalanceDue": 100,
        "AddAdjustmentsTaxCredits": [
          {
            "AdjustmentCreditRecordId": null,
            "AdjustmentCreditType": "Overpayment",
            "AdjustmentCreditMonth": 1,
            "AdjustmentCreditAmount": 100.22
          }
        ],
        "UpdateAdjustmentsTaxCredits": [
          {
            "AdjustmentCreditRecordId": "a5327ed3-e2c1-4b4f-9825-e5aa44743bf6",
            "AdjustmentCreditType": "Overpayment",
            "AdjustmentCreditMonth": 2,
            "AdjustmentCreditAmount": 200.22
          }
        ],
        "DeleteAdjustmentsTaxCredits": [
          {
            "AdjustmentCreditRecordId": "f67bbb47-25df-4a93-80f1-844faf4b8b7c"
          }
        ],
        "MonthlyTaxLiability": {
          "TaxwithheldMonth1": 0,
          "TaxDepositedMonth1": 0,
          "TaxDueMonth1": 0,
          "TaxwithheldMonth2": 0,
          "TaxDepositedMonth2": 0,
          "TaxDueMonth2": 0,
          "TaxwithheldMonth3": 0,
          "TaxDepositedMonth3": 0
          "TaxDueMonth3": 0
        },
        "SemiWeeklyTaxLiability": {
          "ScheduleBMonth1Liability": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            },
            {
              "Day": 10,
              "Amt": 1000
            }
          ],
          "TaxWithheldMonth1": 4000,
          "TaxDepositedMonth1": 9000,
          "TaxDueMonth1": 8500,
          "ScheduleBMonth2Liability": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            },
            {
              "Day": 10,
              "Amt": 1000
            }
          ],
          "TaxWithheldMonth2": 5000,
          "TaxDepositedMonth2": 8000,
          "TaxDueMonth1": 9000,
          "ScheduleBMonth3Liability": [
            {
              "Day": 1,
              "Amt": 1000
            },
            {
              "Day": 2,
              "Amt": 1000
            },
            {
              "Day": 10,
              "Amt": 1000
            }
          ],
          "TaxWithheldMonth3": 3000,
          "TaxDepositedMonth3": 5000,
          "TaxDueMonth1": 5500
        },
        "StatePayment": {
          "AccountType": "Checking",
          "RoutingTransitNumber": "217555555",
          "BankAccountNumber": "0000000001",
          "AccountHolderName": "John Smith",
          "AccountHolderType": "Business"
        }
      }
    },
    "NJ": {
   "FormNJ927": {
   "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
     "Sequence": "001",
     "Qtr": "Q1",
     "TaxYr": "2020",
     "TPID": "B123456789000",
     "IsAmendedReturn": true,
     "MonthlyGITAmtWithheld":  {
      "Month1Withheld":2000,
      "Month2Withheld":1000,
      "Month3Withheld":2000
    },
     "Line1TotalWages": 30000,
     "Line2TotalAmtDue": 5000,
     "Line3TotalRemittedCredits": 2000,
     "Line4BalanceDue": 3000,
     "OverPaymentType": null,
     "Line5OverPaymentAmt": 0,
     "DirectDebitIndicator": "Echeck",
     "StatePayment": {
       "AccountType": "Checking",
       "RoutingTransitNumber": "217555555",
       "BankAccountNumber": "0000000001",
       "AccountHolderName": "John Smith",
       "AccountHolderType": "Business"
     }
   },
  "FormNJ927W": {
   "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
    "Sequence": "001",
    "Qtr": "Q2",
    "TaxYr": "2020",
    "TPID": "B123456789000",
    "IsAmendedReturn": true,
    "WeeklyGITAmtWithheld": [
      {
        "Week": 1,
        "AmtWithheld": 2500
      },
      {
        "Week": 2,
        "AmtWithheld": 2500
      }
    ],
    "Line1TotalWages": 30000,
    "Line2TotalAmtDue": 5000,
    "Line3TotalRemittedCredits": 2000,
    "Line4BalanceDue": 3000,
    "OverPaymentType": null,
    "Line5OverPaymentAmt": 0,
    "DirectDebitIndicator": "Echeck",
    "StatePayment": {
      "AccountType": "Checking",
      "RoutingTransitNumber": "217555555",
      "BankAccountNumber": "0000000001",
      "AccountHolderName": "John Smith",
      "AccountHolderType": "Business"
    }
  }
},
    "NC": null
  }
}
}

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "011ab0f8-7192-4343-8b66-596007bd28f4",
"StateWHRecords": {
  "IL": {
    "SuccessRecords": [
      {
        "Sequence": null,
        "FormType": "FORMIL941",
        "RecordId": "493cb106-6857-407c-88cd-7f4f53139ba0",
        "RecordStatus": "Created",
        "StatusTs": "2020-03-31 18:02:11 +05:30",
        "SchPSuccessRecords": [
          {
            "SchPSeqId": null,
            "RecordStatus": "Added",
            "SchPRecordId": "a276c397-a17d-4ddf-9156-4b408370a72b",
            "StatusTs": "2020-04-16T15:47:38.671181+05:30"
          },
          {
            "SchPSeqId": null,
            "RecordStatus": "Updated",
            "SchPRecordId": "2888585e-2bf7-4786-b295-a2c1229b7cc9",
            "StatusTs": "2020-04-16T15:47:39.3023743+05:30"
          },
          {
            "SchPSeqId": null,
            "RecordStatus": "Deleted",
            "SchPRecordId": "d7f2f746-1c1f-492a-8bb9-99b6680c25af",
            "StatusTs": "2020-04-16T08:02:54.3531786-04:00"
          }
        ]
      }
    ],
    "ErrorRecords": null
  },
  "SC": {
    "SuccessRecords": [
      {
        "Sequence": "222",
        "FormType": "FORMWH1605",
        "RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
        "RecordStatus": "Created",
        "StatusTs": "2020-04-15 13:41:27 +05:30"
      }
    ],
    "ErrorRecords": null
  },
  "GA": {
    "SuccessRecords": [
      {
        "Sequence": "001",
        "FormType": "FormG7",
        "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
        "RecordStatus": "Created",
        "StatusTs": "2020-04-29 21:28:09 +05:30",
        "AdjustmentsCreditsSuccessRecords": [
          {
            "RecordStatus": "Added",
            "AdjustmentCreditRecordId": "b4e8bdb8-ac67-460d-ba22-9d0cd670fbc9",
            "StatusTs": "2020-04-29 21:28:23 +05:30"
          },
          {
            "RecordStatus": "Updated",
            "AdjustmentCreditRecordId": "a5327ed3-e2c1-4b4f-9825-e5aa44743bf6",
            "StatusTs": "2020-04-29 21:28:41 +05:30"
          },
          {
            "RecordStatus": "Deleted",
            "AdjustmentCreditRecordId": "f67bbb47-25df-4a93-80f1-844faf4b8b7c",
            "StatusTs": "2020-04-29 21:29:03 +05:30"
          }
        ]
      }
    ],
    "ErrorRecords": null
  },
  "NJ": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "WHFORMNJ927",
       "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:14 -04:00"
     },
     {
       "Sequence": "002",
       "FormType": "WHFORMNJ927W",
       "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:32 -04:00"
     }
   ],
   "ErrorRecords": null
 },
  "NC": null
},
"Errors": null
}
*

# Validate

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

GET StateWH/Validate

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	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.
StateWHRecords	object	Pulls the State WH records with Success and Error statuses.
IL	object	Pulls the Illinois State WH records with Success and Error statuses.
GA	object	Pulls the Georgia State WH records with Success and Error statuses.
SC	object	Pulls the South Carolina State WH records with Success and Error statuses.
NJ	object	Pulls the New Jersey State WH records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of State WH Records.
Sequence	string	A unique number given by an inbound application to identify failed records.
FormType	string	Type of State WH form filed.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of return created.
ErrorRecords	object[]	It will show the detailed information about the error status of State WH 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.
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

StateWH/Validate?SubmissionId=f2fee2f8-74bf-4e1d-9239-399e76929475&RecordIds=ed6bc24b-189d-419b-9224-2dd2bf3b7467,4f710c2a-c534-405f-b230-ee45c6225055,929c889a-ad5e-4328-b9b3-3d1772dfdedc,344e11d2-375d-48a2-a93a-0222e453a7b7,f5f9f082-b99e-4456-98f7-a64482dee418

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f2fee2f8-74bf-4e1d-9239-399e76929475",
"StateWHRecords": {
 "IL": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "FormIL941",
       "RecordId": "ed6bc24b-189d-419b-9224-2dd2bf3b7467",
       "RecordStatus": "CREATED",
       "StatusTs": "2020-03-11 08:39:58 -04:00"
     }
   ],
   "ErrorRecords": null
 },
 "SC": {
   "SuccessRecords": [
     {
       "Sequence": "222",
       "FormType": "FORMWH1605",
       "RecordId": "4f710c2a-c534-405f-b230-ee45c6225055",
       "RecordStatus": "Created",
       "StatusTs": "2020-04-15 13:51:52 +05:30"
     }
   ],
   "ErrorRecords": null
 },
 "GA": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "FORMG7",
       "RecordId": "929c889a-ad5e-4328-b9b3-3d1772dfdedc",
       "RecordStatus": "Created",
       "StatusTs": "2020-04-15 13:51:52 +05:30"
     }
   ],
   "ErrorRecords": null
 },
 "NJ": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "WHFORMNJ927",
       "RecordId": "344e11d2-375d-48a2-a93a-0222e453a7b7",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:14 -04:00"
     },
     {
       "Sequence": "002",
       "FormType": "WHFORMNJ927W",
       "RecordId": "f5f9f082-b99e-4456-98f7-a64482dee418",
       "RecordStatus": "Created",
       "StatusTs": "2020-05-23 10:27:32 -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
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

# ValidateForm

Runs business and data validation checks for State WH forms.

POST StateWH/ValidateForm

Request Body

Field	Type	Description
StateWHRecords	object	Object to create State Withholding Forms
ReturnHeader	object	Identifies the supporting details of State Withholding Forms.
Forms	object[]	Type of Statewithholding forms and state to be filed.
State	string	State for which Statewithholding forms to be filed. Allowed values: "SC,IL"
Form	string	Type of Statewithholding forms to be filed. Allowed values: "FormIL941", "FormWH1605"
Business	object	Business Details
BusinessId	guid	Business Identifier (Autogenerated).
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 with area code 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	Kind Of Payer based on the Employer's Federal Tax Return. Allowed values: "REGULARW9", "REGULAR944", "AGRICULTURALW9", "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	Employer/Payer's state Size Range: 2 Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
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's country Size Range: 2 Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code
ReturnData	object	Identifies the State Withholding Forms data.
IL	object	Forms to be filed for Illinois State.
FormIL941	object	Form IL-941, Illinois Withholding Income Tax Return.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which Form IL941 needs to be filed.
TaxYr	string	The Tax year for which Form IL941 needs to be filed.
IlSeqNumber	number	"The 3 digit sequence number assigned to the taxpayer by the state of Illinois. Your sequence number should be “000” unless you have been assigned a different sequence number when you registered.".
IsFirstReturn	Boolean	When True, identifies the business as a new business.
IsAddressChanged	Boolean	When True, identifies the that the business address has changed.
LineA1W2sIssuedNum	number	The total number of W-2s issues for the entire year. Required only when you filing for the 4th quarter.
LineA2Number1099sIssuedNum	number	The total number of 1099s issued for the entire year. Required only when you filing for the 4th quarter.
LineBIsBusinessClosed	Boolean	When True, identifies the business has closed.
LineBDateFinalWagesPaid	string	The date that the employer has last paid wages. Required only if your business is closed.
Line1WHTaxableWages	number	The total of all amounts subject to Illinois withholding income tax. Size Range: 0-99999999999999.99
Line2TotalQtrLiability	number	The total tax liability for the quarter. Should be equal to the sum of Line2aTotalMonth1Liability, Line2cTotalMonth1Liability, & Line2dTotalMonth1Liability,. Size Range: 0-99999999999999.99
Line3CreditAmt	number	The amount of credit from Schedule WC, Line 7. Size Range: 0-99999999999999.99
Line4WHPaymentsOrDeposits	number	"The total amount of withholding payments you have made during this period. This includes all IL-501 payments(electronic and paper coupons).". Size Range: 0-99999999999999.99
Line5WHTotalPayments	number	The total amount by adding Form IL-941 line 3 and 4. Size Range: 0-99999999999999.99
Line6WHAmountDue	number	The difference amount to be paid to the Illinois Department of Revenue if line 2 is greater than line 5. If the Line 2 is lessser than line 5, enter 0. Size Range: 0-99999999999999.99
PaymentSchedule	object	Tax Liability Information of the Quarter.
Month1Liabilities	object[]	Tax Liability Information for Month 1.
Month2Liabilities	object[]	Tax Liability Information for Month 2.
Month3Liabilities	object[]	Tax Liability Information for Month 3.
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-99999999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-99999999999999.99
Day	string	Tax Lability Day of the month. Allowed values: "Day1", "Day2", "Day3", "Day4", "Day5", "Day6", "Day7", "Day8", "Day9", "Day10", "Day11", "Day12", "Day13", "Day14", "Day15", "Day16", "Day17", "Day18", "Day19", "Day20", "Day21", "Day22", "Day23", "Day24", "Day25", "Day26", "Day27", "Day28", "Day29", "Day30", "Day31"
Amt	number	Tax Liability Amount. Size Range: 0-99999999999999.99
Line2aTotalMonth1Liability	number	Tax Liability for Month 1. Size Range: 0-99999999999999.99
Line2cTotalMonth1Liability	number	Tax Liability for Month 2. Size Range: 0-99999999999999.99
Line2dTotalMonth1Liability	number	Tax Liability for Month 3. Size Range: 0-99999999999999.99
ScheduleWC	number	Schedule WC Details.
YearsLeftToCarry	number	The total number of years left to carry forward the credit from Schedule WC-I. Size Range: 0-5
CreditCode	number	The credit code for the withholding income tax credit. Size Range: 4 Allowed values: "0900", "5900", "5910"
QtrEndingCreditEarned	string	"The Four-digit year and two-digit month of the quarter ending during which the credit was first earned".
IdentifyingNum	number	The certificate number listed on the tax credit certificate. For the ILSBJC credit, enter the certificate number listed on the Tax Credit Certificate received from the Illinois Department of Commerce and Economic Opportunity (DCEO). For all other credits, leave the column blank.
CreditsEarned	number	The value of the credits earned. Enter the amount from Schedule WC-I. Size Range: 0-99999999999999.99
CreditsCarried	number	The value of the credits carried from a previous quarter. Size Range: 0-99999999999999.99
TotalCredits	number	The value of the total credits. The total of CreditsEarned & CreditsCarried. Size Range: 0-99999999999999.99
Line5	number	The sum of credits by adding column G, lines 1 through 4. Size Range: 0-99999999999999.99
Line6	number	The total tax amount from Form IL-941, Step 4, line 2. Size Range: 0-99999999999999.99
Line7	number	The available credit amount. Enter the sane value on Form IL-941, Line 3. Size Range: 0-99999999999999.99
ScheduleP	object[]	Schedule P Details .
FirstNm	number	First name of the employee.
LastNm	number	Last name of the employee.
SSN	string	The employee's SSN. Size Range: 9
TaxableWages	number	The employee's income for the quarter. Size Range: 0-99999999999999.99
TaxWithheld	number	The amount withheld from the employee for the quarter. Size Range: 0-99999999999999.99
ThirdPartyAuthorization	object[]	Third Party Designee Details of Form IL-941.
IsAuthorizeThirdParty	Boolean	When true, your third-party designee is allowed to discuss the return with the IRS.
DesigneeName	string	Third Party Designee's name.
DesigneePhone	string	Third Party Designee's phone number.
StatePayment	object[]	Payment Details .
AccountType	string	Account Type (Checking or Saving) of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFW payment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFW payment. Size Range: 17
AccountHolderName	string	Name of the account holder.
AccountHolderType	string	Account Type (Business or Personal) of EFW payment.
SC	object	Forms to be filed for South Carolina State.
NC	object	Forms to be filed for North Carolina State.

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

{
 "StateWHRecords": {
     "ReturnHeader": {
         "Forms": [
             {
                 "State": "IL",
                 "Form": "FormIL941"
             }
         ],
         "Business": {
             "BusinessId": null,
             "BusinessNm": "JS Corp",
             "TradeNm": null,
             "IsEIN": true,
             "EINorSSN": "980365236",
             "Email": "john@jscorpllc.com",
             "ContactNm": "John",
             "Phone": "8765468768",
             "PhoneExtn": null,
             "Fax": "8765435787",
             "BusinessType": "CORP",
             "SigningAuthority": {
                 "Name": "John Smith",
                 "Phone": "9876545687",
                 "BusinessMemberType": "CHIEFACCOUNTINGOFFICER"
             },
             "KindOfEmployer": "NONGOVT501C",
             "KindOfPayer": "AGRICULTURAL943",
             "IsBusinessTerminated": false,
             "IsForeign": false,
             "USAddress": {
                 "Address1": "123 Main St",
                 "Address2": "Suite 123",
                 "City": "Rockhill",
                 "State": "SC",
                 "ZipCd": "29730"
             },
             "ForeignAddress": {
                 "Address1": null,
                 "Address2": null,
                 "City": null,
                 "ProvinceOrStateNm": null,
                 "Country": null,
                 "PostalCd": null
             }
         }
     },
     "ReturnData": {
         "IL": {
             "FormIL941": {
                 "Sequence": null,
                 "Qtr": "Q1",
                 "TaxYr": "2020",
                 "ILSeqNumber": "123",
                 "IsFirstReturn": false,
                 "IsAddressChanged": false,
                 "LineA1W2sIssuedNum": 0,
                 "LineA2Number1099sIssuedNum": 0,
                 "LineBIsBusinessClosed": false,
                 "LineBDateFinalWagesPaid": null,
                 "Line1WHTaxableWages": 10000,
                 "Line2TotalQtrLiability": 8000,
                 "Line3CreditAmt": 5000,
                 "Line4WHPaymentsOrDeposits": 2000,
                 "Line5WHTotalPayments": 7000,
                 "Line6WHAmountDue": 1000,
                 "PaymentSchedule": {
                     "Month1Liabilities": [
                         {
                             "Day": 1,
                             "Amt": 1000
                         },
                         {
                             "Day": 2,
                             "Amt": 1000
                         }
                     ],
                     "Line2aTotalMonth1Liability": 2000,
                     "Month2Liabilities": [
                         {
                             "Day": 1,
                             "Amt": 2000
                         },
                         {
                             "Day": 2,
                             "Amt": 2000
                         }
                     ],
                     "Line2cTotalMonth2Liability": 4000,
                     "Month3Liabilities": [
                         {
                             "Day": 1,
                             "Amt": 1000
                         },
                         {
                             "Day": 2,
                             "Amt": 1000
                         }
                     ],
                     "Line2dTotalMonth3Liability": 2000
                 },
                 "ScheduleWC": {
                     "Line1": {
                         "YearsLeftToCarry": 2,
                         "CreditCode": "5900",
                         "QtrEndingCreditEarned": "2003",
                         "IdentifyingNum": "abcd",
                         "CreditsEarned": 1000,
                         "CreditsCarried": 1000,
                         "TotalCredits": 2000
                     },
                     "Line2": {
                         "YearsLeftToCarry": 2,
                         "CreditCode": "5900",
                         "QtrEndingCreditEarned": "2003",
                         "IdentifyingNum": "abcd",
                         "CreditsEarned": 1000,
                         "CreditsCarried": 1000,
                         "TotalCredits": 2000
                     },
                     "Line3": {
                         "YearsLeftToCarry": 2,
                         "CreditCode": "5900",
                         "QtrEndingCreditEarned": "2003",
                         "IdentifyingNum": "abcd",
                         "CreditsEarned": 1000,
                         "CreditsCarried": 1000,
                         "TotalCredits": 2000
                     },
                     "Line4": {
                         "YearsLeftToCarry": 2,
                         "CreditCode": "5900",
                         "QtrEndingCreditEarned": "2003",
                         "IdentifyingNum": "abcd",
                         "CreditsEarned": 1000,
                         "CreditsCarried": 1000,
                         "TotalCredits": 2000
                     },
                     "Line5": 8000,
                     "Line6": 8000,
                     "Line7": 8000
                 },
                 "ScheduleP": [
                     {
                         "FirstNm": "Adam",
                         "LastNm": "Smith",
                         "SSN": "009876545",
                         "TaxableWages": 10000,
                         "TaxWithheld": 8000
                     }
                 ],
                 "ThirdPartyAuthorization": {
                     "IsAuthorizeThirdParty": false,
                     "DesigneeName": null,
                     "DesigneePhone": null
                 },
                 "StatePayment": {
                    "AccountType": "Checking",
                    "RoutingTransitNumber": "217555555",
                    "BankAccountNumber": "0000000001",
                    "AccountHolderName": "John Smith",
                    "AccountHolderType": "Business"
                 }
             }
         },
         "SC": null,
         "NC": null
     }
 }
}

Response JSON

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

1
2
3
4
5
6

← StateUI TINMatchingRecipients →