# StateUI

# Create

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

POST StateUI/Create

Request Body

Field	Type	Description
StateUIRecords	object	Object to create State UI Forms
ReturnHeader	object	Identifies the supporting details of State UI Forms.
Forms	object[]	Type of State Unemployment Insurance forms and state to be filed.
State	string	State for which Unemployment Insurance forms to be filed. Allowed values: "IL,FL,GA,TX"
Form	string	Type of State Unemployment Insurance forms to be filed. Allowed values: "FormUI340, FormRT6, FormDOL4N, FormC3"
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. Include First Name and Last Name in Contact Name. It is mandatory for Form RT-6 (Florida UI). 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 Unemployment Insurance Forms data.
GA	object	Forms to be filed for Georgia State.
FormDOL4N	object	Form DOL4N, Georgia State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form DOL4N needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form DOL4N needs to be filed. Allowed values: "2020"
DOLAccNumber	string	Employer's DOL Account number. Size Range: 8
Line1NumberOfEmployees	object	Total number of full-time and part-time employees.
Month1Employees	number	Total number of full-time and part-time employees for Month 1. Size Range: 5
Month2Employees	number	Total number of full-time and part-time employees for Month 2. Size Range: 5
Month3Employees	number	Total number of full-time and part-time employees for Month 3. Size Range: 5
Line2GrossWages	number	Total reportable gross wages paid this quarter. Size Range: 0-999999999.99
Line3NonTaxableWages	number	Non-Taxable Wages paid this quarter. Size Range: 0-999999999.99
Line4TaxableWages	number	Taxable wages paid this quarter. Size Range: 0-999999999.99
ContributionRate	number	Contribution Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Size Range: 0-1
Line5ContributionDue	number	Contribution Tax Due Amount. Size Range: 0-999999999.99
AdministrativeAsstRate	number	Administrative Assessment Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Allowed values: "0", "0.0006"
Line6AdministrativeAsstDue	number	Administrative Assessment Due Amount. Size Range: 0-999999999.99
Line7Interest	number	Interest Amount. Size Range: 0-999999999.99
Line8Penalty	number	Penalty for filing late. Size Range: 0-999999999.99
Line9BalanceType	string	Credit or debit after calculating tax. Allowed values: Credit, Debit
BalanceAmtDuePeriod	string	Balance Amount Due Period.
Line9BalanceAmt	number	Balance Amount. Size Range: 0-999999999.99
Line10TotalAmtDue	number	Total amount due. Size Range: 0-999999999.99
PayRoll	object[]	Payroll Details.
EmployeeSeqId	string	A unique number given by an inbound application to identify payroll records.
SSN	string	Employee's Social Security Number. Size Range: 9
FirstNm	string	Employee's First Name.
LastNm	string	Employee's Last Name.
TotalGrossWages	number	Employee's Total Individual Reportable Gross Wages paid this quarter. Size Range: 0-999999.99
FL	object	Forms to be filed for Florida State.
FormRT6	object	Form RT6, Florida State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form RT6 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form RT6 needs to be filed. Allowed values: "2020"
RTAccNumber	string	Employer's RT Account number. Size Range: 7
IsFinalReturn	Boolean	When true, identifies that this is the final return.
DateOperationCeased	string	Date after which operations ceased.
Line1NumberOfEmployees	object	Total number of full-time and part-time employees.
Month1Employees	number	Total number of full-time and part-time employees for Month 1. Size Range: 6
Month2Employees	number	Total number of full-time and part-time employees for Month 2. Size Range: 6
Month3Employees	number	Total number of full-time and part-time employees for Month 3. Size Range: 6
Line2UITotalWages	number	Total gross wages paid before deductions. Size Range: 0-999999999.99
Line3ExcessWages	number	Wages exceeding $7,000 paid to each employee. Size Range: 0-999999999.99
Line4UITaxableWages	number	Wages that are taxable. Size Range: 0-999999999.99
TaxRate	number	Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Size Range: 0.0010 - 0.0540
Line5TaxDue	number	Tax Due amount. Size Range: 0-999999999.99
Line6UIPenalty	number	Penalty due amount. Size Range: 0-999999999.99
Line7UIInterest	number	Interest due amount. Size Range: 0-999999999.99
Line9AUITotalDue	number	Total amount due. Size Range: 0-999999999.99
PayRoll	object[]	Payroll Details.
EmployeeSeqId	string	unique number given by an inbound application to identify records.
SSN	string	Employee's Social Security Number. Size Range: 9
FirstNm	string	Employee's First Name.
Initial	string	Employee's Middle Initial.
LastNm	string	Employee's Last Name.
TotalWages	number	Employee’s gross wages paid this quarter. Size Range: 0-999999999.99
TaxableWages	number	Employee’s taxable wages paid this quarter. Size Range: 0-99999.99
OutOfStateWageDetails	object	Out of State Wage Details.
OutOfStateTotalWages	number	Total Gross Wages. Size Range: 0-9999999999.99
OutOfStateTaxableWages	number	Total Taxable Wages . Size Range: 0-99999.99
TaxState	string	Tax State.
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 Holder Type (Business or Personal) of EFW payment.
IL	object	Forms to be filed for Illinois State.
FormUI340	object	Form UI 3/40, Illinois State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form UI340 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form UI340 needs to be filed. Allowed values: "2020"
ILAccNumber	string	Employer's Illinois Acount Number. Size Range: 7
Line1NumberOfEmployees	object	The total number of workers for the given month.
Month1Employees	number	The total number of workers for the 1st month. Size Range: 9
Month2Employees	number	The total number of workers for the 2nd month. Size Range: 9
Month3Employees	number	The total number of workers for the 3rd month. Size Range: 9
Line2UITotalWages	number	The total wages paid to all the workers. Size Range: 0-9999999999.99
Line3ExcessWages	number	The total wages that are over $12,740 per worker per calendar year. Size Range: 0-9999999999.99
Line4UITaxableWages	number	Wages that are taxable. Size Range: 0-9999999999.99
ContributionRate	string	Contribution Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06.
ContributionDue	number	Multiply line 4 by contribution rate in percentage . Size Range: 0-9999999999.99
Line6AUIInterest	number	Calculated Interest Amount for any overdue tax. Size Range: 0-100
Line6BUIPenalty	number	Penalty Amount for late filing. Size Range: 0-9999999999.99
Line6CUIAmountDuePreviousPeriod	number	The amount of the underpayment including interest from previous underpayment. Size Range: 0-9999999999.99
Line6DUICreditPreviousPeriod	number	Any overpayment from previous deposits. Size Range: 0-9999999999.99
Line7UITotalDue	string	The amount to be paid to the Illinois Department of Revenue Enter the sum of line 5A or 5B plus Lines 6A, 6B, and 6C and less any amount on line 6D. Size Range: 0-9999999999.99
PayRoll	object[]	The payroll details of the employees.
EmployeeSeqId	string	A unique number given by an inbound application to identify records.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker.
Initial	string	Initial of the Worker.
LastNm	string	Last Name of the worker.
TotalWages	string	Total wages paid to the workers.
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 Holder Type (Business or Personal) of EFW payment.
TX	object	Forms to be filed for Texas State.
FormC3	object	Form UI C3, Texas State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form C3 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
StateAccNumber	string	State Unemployment Insurance Account Number. Size Range: 9
NAICSCode	string	NAICS Code. Size Range: 6
IsNoWorkersOrNoWage	Boolean	When True, Identifies that there is no employees for this quarter.
TotalNumberOfEmployees	number	Total number of employees. Size Range: 7
Month1Employment	number	Month 1 employment for employer. Size Range: 7
Month2Employment	number	Month 2 employment for employer. Size Range: 7
Month3Employment	number	Month 3 employment for employer. Size Range: 7
TotWages	number	Total State Quarterly UI total wages for employer. Size Range: 0-999999999999.99
TotTaxableWages	number	Total State Quarterly UI taxable wages for employer. Size Range: 0-999999999999.99
UITaxRate	number	Texas UI tax rate for the quarter. Size Range: 0.31000 - 6.31000
HighestEmployeesCountyCode	string	County code where employer has greatest number of employees. Size Range: 3
OutsideCountyEmployees	number	Employees outside the county mentioned above. Size Range: 7
PayRollDetails	object[]	The payroll details of the employees.
EmployeeSequenceId	string	A unique number given by an inbound application to identify records.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker. Size Range: 12
MiddleNm	string	Middle Name of the Worker. Size Range: 1
LastNm	string	Last Name of the worker. Size Range: 20
Wages	number	State Quarterly unemployment insurance total wages. Size Range: 0-999999999999.99
TaxableWages	number	State Quarterly unemployment insurance taxable wages. Size Range: 0-999999999999.99

Response Body

Field	Type	Description
RecordId	Guid	Unique identifier of a record, not required for create method.
EmployeeRecordId	Guid	Unique identifier of a record, not required for create method.
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.
StateUIRecords	object	Pulls the State withholding Form records with Success and Error statuses.
IL	object	Pulls the Illinois State UI Form records with Success and Error statuses.
FL	object	Pulls the Florida State UI Form records with Success and Error statuses.
GA	object	Pulls the Georgia State UI Form records with Success and Error statuses.
TX	object	Pulls the Texas State UI Form records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of State UI Records.
Sequence	string	A unique number given by an inbound application to identify records.
RecordId	Guid	Unique identifier of a record.
FormType	string	Type of State UI Form Filed.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of return.
PayRollSuccessRecords	object[]	It will show the detailed information about the success status of Payroll Details of Workers.
EmployeeSeqId	string	A unique number given by an inbound application to identify Payroll records.
RecordStatus	string	Returns status of Payroll Records.
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
StatusTs	string	Date and time of Payroll Records
ErrorRecords	object[]	It will show the detailed information about the error status of State UI 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

 {
   "StateUIRecords": {
     "ReturnHeader": {
       "Forms": [
         {
           "State": "IL",
           "Form": "FormUI340"
         },
         {
           "State": "FL",
           "Form": "FormRT6"
         },
         {
           "State": "GA",
           "Form": "FormDOL4N"
         },
		 {
          "State": "TX",
          "Form": "FormC3"
         }
       ],
       "Business": {
         "BusinessId": null,
         "BusinessNm": "Mayfill Tech LLC",
         "TradeNm": "Mayfill Tech",
         "IsEIN": true,
         "EINorSSN": "001687743",
         "Email": "mayfill.k@zolotech.com",
         "ContactNm": "John",
         "Phone": "7894561231",
         "PhoneExtn": "12345",
         "Fax": "7123547895",
         "BusinessType": "ESTE",
         "SigningAuthority": {
           "Name": "John",
           "Phone": "7894561231",
           "BusinessMemberType": "ADMINISTRATOR"
         },
         "KindOfEmployer": null,
         "KindOfPayer": null,
         "IsBusinessTerminated": false,
         "IsForeign": false,
         "USAddress": {
           "Address1": "12 Main st",
           "Address2": "CC avenue",
           "City": "Rock Hill",
           "State": "SC",
           "ZipCd": "29730"
         },
         "ForeignAddress": {
           "Address1": null,
           "Address2": null,
           "City": null,
           "ProvinceOrStateNm": null,
           "Country": null,
           "PostalCd": null
         }
       }
     },
     "ReturnData": {
       "FL": {
         "FormRT6": {
           "RecordId": null,
           "Sequence": "001",
           "Qtr": "Q1",
           "TaxYr": "2020",
           "RTAccNumber": "1234567",
           "IsFinalReturn": true,
           "DateOperationCeased": "2020-04-20T00:00:00",
           "Line1NumberOfEmployees": {
             "Month1Employees": 10,
             "Month2Employees": 20,
             "Month3Employees": 30
           },
           "Line2UITotalWages": 2000,
           "Line3ExcessWages": 600,
           "Line4UITaxableWages": 1400,
           "TaxRate": 0.054,
           "Line5TaxDue": 75.6,
           "Line6UIPenalty": 1,
           "Line7UIInterest": 1,
           "Line9AUITotalDue": 77.6,
           "PayRoll": [
             {
               "EmployeeRecordId": null,
               "EmployeeSeqId": "11",
               "SSN": "001456924",
               "FirstNm": "John",
               "Initial": "A",
               "LastNm": "Smith",
               "TotalWages": 1000,
               "TaxableWages": 700,
               "OutOfStateWageDetails": {
                 "OutOfStateTotalWages": 300,
                 "OutOfStateTaxableWages": 200,
                 "TaxState": "GA"
               }
             },
             {
               "EmployeeRecordId": null,
               "EmployeeSeqId": "12",
               "SSN": "001456925",
               "FirstNm": "Kenny",
               "Initial": "A",
               "LastNm": "Sebastian",
               "TotalWages": 1000,
               "TaxableWages": 700,
               "OutOfStateWageDetails": {
                 "OutOfStateTotalWages": 500,
                 "OutOfStateTaxableWages": 400,
                 "TaxState": "CA"
               }
             }
           ],
           "StatePayment": {
             "AccountType": "Checking",
             "RoutingTransitNumber": "217555555",
             "BankAccountNumber": "0000000001",
             "AccountHolderName": "John Smith",
             "AccountHolderType": "Business"
           }
         }
       },
       "IL": {
         "FormUI340": {
           "Sequence": "001",
           "Qtr": "Q2",
           "TaxYr": "2020",
           "ILAccNumber": "9992459",
           "Line1NumberOfEmployees": {
             "Month1Employees": 1,
             "Month2Employees": 3,
             "Month3Employees": 2
           },
           "Line2UITotalWages": 2000,
           "Line3ExcessWages": 1000,
           "Line4UITaxableWages": 1000,
           "ContributionRate": 0.02,
           "ContributionDue": 20,
           "Line6AUIInterest": 1,
           "Line6BUIPenalty": 50,
           "Line6CUIAmountDuePreviousPeriod": 1,
           "Line6DUICreditPreviousPeriod": 0,
           "Line7UITotalDue": 72,
           "PayRoll": [
             {
               "EmployeeSeqId": "11",
               "SSN": "011456924",
               "FirstNm": "John",
               "Initial": "A",
               "LastNm": "Smith",
               "TotalWages": 1000
             },
             {
               "EmployeeSeqId": "12",
               "SSN": "011456925",
               "FirstNm": "Kenny",
               "Initial": "A",
               "LastNm": "Sebastian",
               "TotalWages": 1000
             }
           ],
           "StatePayment": {
             "AccountType": "Checking",
             "RoutingTransitNumber": "217555555",
             "BankAccountNumber": "0000000001",
             "AccountHolderName": "John Smith",
             "AccountHolderType": "Business"
           }
         }
       },
       "GA": {
         "FormDOL4N": {
           "Sequence": "001",
           "Qtr": "Q1",
           "TaxYr": "2020",
           "DOLAccNumber": "99999999",
           "Line1NumberOfEmployees": {
             "Month1Employees": 2,
             "Month2Employees": 2,
             "Month3Employees": 1
           },
           "Line2GrossWages": 45000,
           "Line3NonTaxableWages": 11500,
           "Line4TaxableWages": 33500,
           "ContributionRate": 0.04,
           "Line5ContributionDue": 1340,
           "AdministrativeAsstRate": 0.0006,
           "Line6AdministrativeAsstDue": 20.1,
           "Line7Interest": 20.4,
           "Line8Penalty": 22.5,
           "Line9BalanceType": "Debit",
           "BalanceAmtDuePeriod": "2020-04-20T00:00:00",
           "Line9BalanceAmt": 500,
           "Line10TotalAmtDue": 1903,
           "PayRoll": [
             {
               "EmployeeSeqId": "01",
               "SSN": "011450001",
               "FirstNm": "John",
               "LastNm": "Smith",
               "TotalGrossWages": 1000
             },
             {
               "EmployeeSeqId": "02",
               "SSN": "011450002",
               "FirstNm": "John",
               "LastNm": "Martyn",
               "TotalGrossWages": 10000
             },
             {
               "EmployeeSeqId": "03",
               "SSN": "011450003",
               "FirstNm": "Alex",
               "LastNm": "Karev",
               "TotalGrossWages": 4000
             },
             {
               "EmployeeSeqId": "04",
               "SSN": "011450004",
               "FirstNm": "Joseph",
               "LastNm": "Wilson",
               "TotalGrossWages": 10000
             },
             {
               "EmployeeSeqId": "05",
               "SSN": "011450005",
               "FirstNm": "Jack",
               "LastNm": "Wilson",
               "TotalGrossWages": 20000
             }
           ]
         }
       },
       "TX": {
         "FormC3": {
           "Sequence": null,
           "Qtr": "Q1",
           "TaxYr": "2020",
           "StateAccNumber": "13245",
           "NAICSCode": "125",
           "IsNoWorkersOrNoWage": false,
           "TotalNumberOfEmployees": 1,
           "Month1Employment": 1,
           "Month2Employment": 2,
           "Month3Employment": 3,
           "TotWages": 120,
           "TotTaxableWages": 100,
           "UITaxRate": 0.32,
           "TaxDue": 32,
           "HighestEmployeesCountyCode": 1,
           "OutsideCountyEmployees": 60,
           "PayRollDetails": [
             {
               "SSN": "12-5678451",
               "FirstNm": "King",
               "MiddleNm": "k",
               "LastNm": "Khan",
               "Wages": 120,
               "TaxableWages": 100
             }
           ]
         }
       }
     }
   }
 }

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

Response JSON

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "2dcd13bc-93e9-47ad-ae73-9fafd13d306f",
  "StateUIRecords": {
    "IL": {
      "SuccessRecords": [
        {
          "Sequence": "001",
          "FormType": "FormUI340",
          "RecordId": "60d795bc-bc36-471c-b754-b939ffecd02b",
          "RecordStatus": "Created",
          "StatusTs": "2020-05-13 01:29:52 -04:00",
          "PayrollSuccessRecords": [
            {
              "EmployeeSeqId": "11",
              "RecordStatus": "Added",
              "EmployeeRecordId": "573eb155-cc89-4d31-8931-7217ad911f28",
              "StatusTs": null
            },
            {
              "EmployeeSeqId": "12",
              "RecordStatus": "Added",
              "EmployeeRecordId": "f942e1da-b56a-4844-8d54-9a0aea64c5fb",
              "StatusTs": null
            }
          ]
        }
      ],
      "ErrorRecords": null
    },
    "FL": {
      "SuccessRecords": [
        {
          "Sequence": "001",
          "FormType": "FormRT6",
          "RecordId": "6fcdbcf1-219c-40ee-b655-efe4aaf0d89c",
          "RecordStatus": "Created",
          "StatusTs": "2020-05-13 01:29:53 -04:00",
          "PayrollSuccessRecords": [
            {
              "EmployeeSeqId": "11",
              "RecordStatus": "Added",
              "EmployeeRecordId": "6a39ec0b-edfe-48c6-bc8c-cc0ac8d93b41",
              "StatusTs": null
            },
            {
              "EmployeeSeqId": "12",
              "RecordStatus": "Added",
              "EmployeeRecordId": "630e22d5-7273-4659-a092-0b447fec1a5a",
              "StatusTs": null
            }
          ]
        }
      ],
      "ErrorRecords": null
    },
    "GA": {
      "SuccessRecords": [
        {
          "Sequence": "001",
          "FormType": "FormDOL4N",
          "RecordId": "1c2a4d96-0307-450d-89de-eb62c33d385d",
          "RecordStatus": "Created",
          "StatusTs": "2020-05-13 01:29:54 -04:00",
          "PayrollSuccessRecords": [
            {
              "EmployeeSeqId": "01",
              "RecordStatus": "Added",
              "EmployeeRecordId": "55d0211e-694e-4081-a4ce-d2dd609a9608",
              "StatusTs": null
            },
            {
              "EmployeeSeqId": "02",
              "RecordStatus": "Added",
              "EmployeeRecordId": "411ce808-54ab-4c88-991b-915f9d092016",
              "StatusTs": null
            },
            {
              "EmployeeSeqId": "03",
              "RecordStatus": "Added",
              "EmployeeRecordId": "006fbf7b-70ac-4794-a3f1-110c19859974",
              "StatusTs": null
            },
            {
              "EmployeeSeqId": "04",
              "RecordStatus": "Added",
              "EmployeeRecordId": "e7c39c3a-ae43-4189-a806-f8b086228793",
              "StatusTs": null
            },
            {
              "EmployeeSeqId": "05",
              "RecordStatus": "Added",
              "EmployeeRecordId": "054b2960-f35b-4b86-b2eb-999cd0f22541",
              "StatusTs": null
            }
          ]
        }
      ],
      "ErrorRecords": null
    },
    "TX": {
      "SuccessRecords": [
        {
          "Sequence": null,
          "FormType": "FormC3",
          "RecordId": "9747b4b9-cb4a-4d24-b7e6-cf5cc1572ebf",
          "RecordStatus": "Created",
          "StatusTs": "2020-05-22 03:52:50 -04:00",
          "PayrollSuccessRecords": [
            {
              "EmployeeSeqId": null,
              "EmployeeRecordId": "3e9b232f-0595-4a7d-ba53-f30b265e2053",
              "RecordStatus": "Added",
              "StatusTs": "2020-05-22 03:52:50 -04:00"
            }
          ]
        }
      ],
      "ErrorRecords": null
    }
  },
  "Errors": null
}

# Delete

Deletes IL returns by Submission Ids and Record Ids.

DELETE StateUI/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.
StateUIRecords	object	Pulls the State UI records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of StateUI Records.
Sequence	string	A unique number given by an inbound application to identify records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of return.
PayRollSuccessRecords	object[]	It will show the detailed information about the success status of Payroll Details of Workers.
EmployeeSeqId	string	A unique number given by an inbound application to identify Payroll records.
RecordStatus	string	Returns status of Payroll Records.
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
StatusTs	string	Date and time of Payroll Records
ErrorRecords	object[]	It will show the detailed information about the error status of StateUI 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

StateUI/Delete?SubmissionId=2906a6ab-cc63-459e-b96d-bd46c4165cfb&RecordIds=c12d2be4-6f84-4cc2-b6b1-20b6dc026750,27948c3c-2acd-4ddc-be64-c40ef98f982a

Response JSON

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "2906a6ab-cc63-459e-b96d-bd46c4165cfb",
  "StateUIRecords": {
    "IL": {
      "SuccessRecords": [
        {
          "Sequence": "001",
          "FormType": "FormUI340",
          "RecordId": "c12d2be4-6f84-4cc2-b6b1-20b6dc026750",
          "RecordStatus": "Deleted",
          "StatusTs": "2020-03-11 08:39:58 -04:00",
          "PayrollSuccessRecords": null
        }
      ],
      "ErrorRecords": null
    },
    "FL": {
  "SuccessRecords": [
    {
      "Sequence": "001",
      "FormType": "FormRT6",
      "RecordId": "27948c3c-2acd-4ddc-be64-c40ef98f982a",
      "RecordStatus": "Deleted",
      "StatusTs": "2020-03-11 08:39:58 -04:00",
      "PayrollSuccessRecords": null
    }
  ],
  "ErrorRecords": null
},
 "GA": {
   "SuccessRecords": [
  {
   "Sequence": "001",
   "FormType": "FormDOL4N",
   "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
   "RecordStatus": "DELETED",
   "StatusTs": "2020-05-04 04:23:41 -04:00",
  "PayrollSuccessRecords": null
 }
],
 "ErrorRecords": null
},
 "TX": {
   "SuccessRecords": [
  {
   "Sequence": "001",
   "FormType": "FormC3",
   "RecordId": "1570b923-1ab6-4d7f-80ab-07c3d846073b",
   "RecordStatus": "DELETED",
   "StatusTs": "2020-05-04 04:23:41 -04:00",
  "PayrollSuccessRecords": null
 }
],
 "ErrorRecords": null
}
  },
  "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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

# Get

Gets information of State UI returns by Submission Id.

GET StateUI/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
StateUIRecords	object	Object to create State Withholding Forms
ReturnHeader	object	Identifies the supporting details of State Withholding Forms.
Forms	object[]	Type of State Unemployment Insurance forms and state to be filed.
State	string	State for which Unemployment Insurance forms to be filed. Allowed values: "IL", "GA", "FL", "TX"
Form	string	Type of State Unemployment Insurance forms to be filed. Allowed values: "FormUI340", "FormRT6", "FormDOL4N", "FormC3"
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 Unemployment Insurance Forms data.
GA	object	Forms to be filed for Georgia State.
FormDOL4N	object	Form DOL4N, Georgia State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form DOL4N needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form DOL4N needs to be filed. Allowed values: "2020"
DOLAccNumber	string	Employer's DOL Account number. Size Range: 8
Line1NumberOfEmployees	object	Total number of full-time and part-time employees.
Month1Employees	number	Total number of full-time and part-time employees for Month 1. Size Range: 5
Month2Employees	number	Total number of full-time and part-time employees for Month 2. Size Range: 5
Month3Employees	number	Total number of full-time and part-time employees for Month 3. Size Range: 5
Line2GrossWages	number	Total Reportable gross wages paid this quarter. Size Range: 0-999999999.99
Line3NonTaxableWages	number	Non-Taxable Wages paid this quarter. Size Range: 0-999999999.99
Line4TaxableWages	number	Taxable wages paid this quarter. Size Range: 0-999999999.99
ContributionRate	number	Contribution Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Size Range: 0-1
Line5ContributionDue	number	Contribution Tax Due Amount. Size Range: 0-999999999.99
AdministrativeAsstRate	number	Administrative Assessment Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Allowed values: "0", "0.0006"
Line6AdministrativeAsstDue	number	Administrative Assessment Due Amount. Size Range: 0-999999999.99
Line7Interest	number	Interest Amount. Size Range: 0-999999999.99
Line8Penalty	number	Penalty for filing late. Size Range: 0-999999999.99
Line9BalanceType	string	Credit or debit after calculating tax. Allowed values: Credit, Debit
BalanceAmtDuePeriod	string	Balance Amount Due Period.
Line9BalanceAmt	number	Balance Amount. Size Range: 0-999999999.99
Line10TotalAmtDue	number	Total amount due. Size Range: 0-999999999.99
PayRoll	object[]	Pulls The Payroll Details.
EmployeeSeqId	string	A unique number given by an inbound application to identify PayRoll records.
SSN	string	Employee's Social Security Number. Size Range: 9
FirstNm	string	Employee's First Name.
LastNm	string	Employee's Last Name.
TotalGrossWages	number	Employee's Total Individual Reportable Gross Wages paid this quarter. Size Range: 0-999999.99
FL	object	Forms to be filed for Florida State.
FormRT6	guid	Form RT6, Florida State UI Form.
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 RT6 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form RT needs to be filed. Allowed values: "2020"
RTAccNumber	string	Employer's RT Account number. Size Range: 7
IsFinalReturn	Boolean	When true, identifies that this is the final return.
DateOperationCeased	string	Date after which operations ceased.
Line1NumberOfEmployees	object	Total number of full-time and part-time employees.
Month1Employees	number	Total number of full-time and part-time employees for Month 1. Size Range: 6
Month2Employees	number	Total number of full-time and part-time employees for Month 2. Size Range: 6
Month3Employees	number	Total number of full-time and part-time employees for Month 3. Size Range: 6
Line2UITotalWages	number	Total gross wages paid before deductions. Size Range: 0-999999999.99
Line3ExcessWages	number	Wages exceeding $7,000 paid to each employee. Size Range: 0-999999999.99
Line4UITaxableWages	number	Wages that are taxable. Size Range: 0-999999999.99
TaxRate	number	Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Size Range: 0.0010 - 0.0540
Line5TaxDue	number	Tax Due amount. Size Range: 0-999999999.99
Line6UIPenalty	number	Penalty due amount. Size Range: 0-999999999.99
Line7UIInterest	number	Interest due amount. Size Range: 0-999999999.99
Line9AUITotalDue	number	Total amount due. Size Range: 0-999999999.99
PayRoll	object[]	Payroll Details.
EmployeeSeqId	string	A unique number given by an inbound application to identify records.
EmployeeRecordId	Guid	Unique identifier of employee.
SSN	string	Employee's Social Security Number. Size Range: 9
FirstNm	string	Employee's First Name.
Initial	string	Employee's Middle Initial.
LastNm	string	Employee's Last Name.
TotalWages	number	employee’s gross wages paid this quarter. Size Range: 0-999999999.99
TaxableWages	number	Employee’s taxable wages paid this quarter. Size Range: 0-99999.99
OutOfStateWageDetails	object	Out of State Wage Details.
OutOfStateTotalWages	number	Total Gross Wages. Size Range: 0-9999999999.99
OutOfStateTaxableWages	number	Total Taxable Wages . Size Range: 0-99999.99
TaxState	string	Tax State.
StatePayment	object	Payment Details .
AccountType	string	Account Type (Checking or Saving of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFWpayment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFWpayment. Size Range: 17
AccountHolderName	string	Name of the account holder.
AccountHolderType	string	Account Holder Type (Business or Personal) of EFW payment.
IL	object	Forms to be filed for Illinois State.
FormUI340	object	Form UI 3/40, Illinois State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form UI340 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form UI340 needs to be filed. Allowed values: "2020"
ILAccNumber	string	Employer's Illinois Acount Number. Size Range: 7
Line1NumberOfEmployees	object	The total number of workers for the given month.
Month1Employees	number	The total number of workers for the 1st month. Size Range: 9
Month2Employees	number	The total number of workers for the 2nd month. Size Range: 9
Month3Employees	number	The total number of workers for the 3rd month. Size Range: 9
Line2UITotalWages	number	The total wages paid to all the workers. Size Range: 0-9999999999.99
Line3ExcessWages	number	The total wages that are over $12,740 per worker per calendar year. Size Range: 0-9999999999.99
Line4UITaxableWages	number	Wages that are taxable. Size Range: 0-9999999999.99
ContributionRate	string	Contribution Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06.
ContributionDue	number	Multiply line 4 by contribution rate in percentage . Size Range: 0-9999999999.99
Line6AUIInterest	number	Calculated Interest Amount for any overdue tax. Size Range: 0-100
Line6BUIPenalty	number	Penalty Amount for late filing. Size Range: 0-9999999999.99
Line6CUIAmountDuePreviousPeriod	number	The amount of the underpayment including interest from previous underpayment. Size Range: 0-9999999999.99
Line6DUICreditPreviousPeriod	number	Any overpayment from previous deposits. Size Range: 0-9999999999.99
Line7UITotalDue	string	The amount to be paid to the Illinois Department of Revenue Enter the sum of line 5A or 5B plus Lines 6A, 6B, and 6C and less any amount on line 6D. Size Range: 0-9999999999.99
PayRoll	object[]	The payroll details of the employees.
EmployeeSeqId	string	A unique number given by an inbound application to identify records.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker.
Initial	string	Initial of the Worker.
LastNm	string	Last Name of the worker.
TotalWages	string	Total wages paid to the workers.
StatePayment	object	Payment Details .
AccountType	string	Account Type (Checking or Saving of EFW payment.
RoutingTransitNumber	string	Bank Routing Number of EFWpayment. Size Range: 9
BankAccountNumber	string	Bank Account Number of EFWpayment. Size Range: 17
AccountHolderName	string	Name of the account holder.
AccountHolderType	string	Account Holder Type (Business or Personal) of EFW payment.
TX	object	Forms to be filed for Texas State.
FormC3	object	Form UI C3, Texas State UI Form.
RecordId	Guid	Unique identifier of a record, not required for create method.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form C3 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
StateAccNumber	string	State Unemployment Insurance Account Number. Size Range: 9
NAICSCode	string	NAICS Code. Size Range: 6
IsNoWorkersOrNoWage	Boolean	When True, Identifies that there is no employees for this quarter.
TotalNumberOfEmployees	number	Total number of employees. Size Range: 7
Month1Employment	number	Month 1 employment for employer. Size Range: 7
Month2Employment	number	Month 2 employment for employer. Size Range: 7
Month3Employment	number	Month 3 employment for employer. Size Range: 7
TotWages	number	Total State Quarterly UI total wages for employer. Size Range: 0-999999999999.99
TotTaxableWages	number	Total State Quarterly UI taxable wages for employer. Size Range: 0-999999999999.99
UITaxRate	number	Texas UI tax rate for the quarter. Size Range: 0.31000 - 6.31000
HighestEmployeesCountyCode	string	County code where employer has greatest number of employees. Size Range: 3
OutsideCountyEmployees	number	Employees outside the county mentioned above. Size Range: 7
PayRollDetails	object[]	The payroll details of the employees.
EmployeeRecordId	Guid	Unique identifier of a record, not required for create method.
EmployeeSequenceId	string	A unique number given by an inbound application to identify records.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker. Size Range: 12
MiddleNm	string	Middle Name of the Worker. Size Range: 1
LastNm	string	Last Name of the worker. Size Range: 20
Wages	number	State Quarterly unemployment insurance total wages. Size Range: 0-999999999999.99
TaxableWages	number	State Quarterly unemployment insurance taxable wages. Size Range: 0-999999999999.99
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

"StateUI/Get?SubmissionId=a4ea750f-40c5-46bd-9f48-2928dd24e708&RecordIds=fe17d02e-11ca-4980-a125-330aef375d51,27948c3c-2acd-4ddc-be64-c40ef98f982a"

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "a4ea750f-40c5-46bd-9f48-2928dd24e708",
"StateUIRecords": {
  "ReturnHeader": {
    "Forms": [
      {
        "State": "IL",
        "Form": "FormUI340"
      },
      {
        "State": "FL",
        "Form": "FormRT6"
      },
      {
        "State": "GA",
        "Form": "FormDOL4N"
      }
    ],
    "Business": {
      "BusinessId": "34fe32bc-3b11-4b45-9350-36d17562bc08",
      "BusinessNm": "Mayfill Tech LLC",
      "TradeNm": "Mayfill Tech",
      "IsEIN": true,
      "EINorSSN": "001687743",
      "Email": "mayfill.k@zolotech.com",
      "ContactNm": "John",
      "Phone": "7894561231",
      "PhoneExtn": "12345",
      "Fax": "(712) 354-7895",
      "BusinessType": "ESTE",
      "SigningAuthority": {
        "Name": "John",
        "Phone": "7894561231",
        "BusinessMemberType": "ADMINISTRATOR"
      },
      "KindOfEmployer": null,
      "KindOfPayer": null,
      "IsBusinessTerminated": false,
      "IsForeign": false,
      "USAddress": {
        "Address1": "12 Main st",
        "Address2": "CC avenue",
        "City": "Rock Hill",
        "State": "SC",
        "ZipCd": "29730"
      },
      "ForeignAddress": {
        "Address1": null,
        "Address2": null,
        "City": null,
        "ProvinceOrStateNm": null,
        "Country": null,
        "PostalCd": null
      }
    }
  },
  "ReturnData": {
    "IL": {
      "FormUI340": {
        "RecordId": "fe17d02e-11ca-4980-a125-330aef375d51",
        "Sequence": "001",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "ILAccNumber": "9992459",
        "Line1NumberOfEmployees": {
          "Month1Employees": 1,
          "Month2Employees": 3,
          "Month3Employees": 2
        },
        "Line2UITotalWages": 2000,
        "Line3ExcessWages": 1000,
        "Line4UITaxableWages": 1000,
        "ContributionRate": 4,
        "ContributionDue": 40,
        "Line6AUIInterest": 1,
        "Line6BUIPenalty": 1,
        "Line6CUIAmountDuePreviousPeriod": 1,
        "Line6DUICreditPreviousPeriod": 0,
        "Line7UITotalDue": 43,
        "PayRoll": [
          {
            "EmployeeRecordId": "d89b5480-5edc-4983-a217-d7f9d041c2e3",
            "EmployeeSeqId": "11",
            "SSN": "011456924",
            "FirstNm": "John",
            "Initial": "A",
            "LastNm": "Smith",
            "TotalWages": 1000
          },
          {
            "EmployeeRecordId": "20e8b141-012e-4418-bf08-2c4519a16ce0",
            "EmployeeSeqId": "12",
            "SSN": "011456925",
            "FirstNm": "Kenny",
            "Initial": "A",
            "LastNm": "Sebastian",
            "TotalWages": 1000
          }
        ],
        "StatePayment": {
          "AccountType": "Checking",
          "RoutingTransitNumber": "217555555",
          "BankAccountNumber": "0000000001",
          "AccountHolderName": "John Smith",
          "AccountHolderType": "Business"
        }
      }
    },
    "FL": {
      "FormRT6": {
        "RecordId": "27948c3c-2acd-4ddc-be64-c40ef98f982a",
        "Sequence": "001",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "RTAccNumber": "1234567",
        "IsFinalReturn": true,
        "DateOperationCeased": "04/20/2020",
        "Line1NumberOfEmployees": {
          "Month1Employees": 10,
          "Month2Employees": 20,
          "Month3Employees": 30
        },
        "Line2UITotalWages": 1000,
        "Line3ExcessWages": 2000,
        "Line4UITaxableWages": 3000,
        "TaxRate": 4,
        "Line5TaxDue": 500,
        "Line6UIPenalty": 600,
        "Line7UIInterest": 700,
        "Line9AUITotalDue": 800,
        "PayRoll": [
          {
            "EmployeeSeqId": "11",
            "SSN": "001456924",
            "FirstNm": "John",
            "Initial": "A",
            "LastNm": "Smith",
            "TotalWages": 10000,
            "TaxableWages": 7000,
            "OutOfStateWageDetails": {
              "OutOfStateTotalWages": 100,
              "OutOfStateTaxableWages": 200,
              "TaxState": "GA"
            }
          },
          {
            "EmployeeSeqId": "12",
            "SSN": "001456925",
            "FirstNm": "Kenny",
            "Initial": "A",
            "LastNm": "Sebastian",
            "TotalWages": 10000,
            "TaxableWages": 7000,
            "OutOfStateWageDetails": {
              "OutOfStateTotalWages": 300,
              "OutOfStateTaxableWages": 400,
              "TaxState": "CA"
            }
          }
        ],
        "StatePayment": {
          "AccountType": "Checking",
          "RoutingTransitNumber": "217555555",
          "BankAccountNumber": "0000000001",
          "AccountHolderName": "John Smith",
          "AccountHolderType": "Business"
        }
      }
    },
    "GA": {
      "FormDOL4N": {
        "Sequence": "001",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "DOLAccNumber": "99999999",
        "Line1NumberOfEmployees": {
          "Month1Employees": 2,
          "Month2Employees": 2,
          "Month3Employees": 1
        },
        "Line2GrossWages": 45000,
        "Line3NonTaxableWages": 11500,
        "Line4TaxableWages": 33500,
        "ContributionRate": 0.04,
        "Line5ContributionDue": 1340,
        "AdministrativeAsstRate": 0.0006,
        "Line6AdministrativeAsstDue": 20.1,
        "Line7Interest": 20.40,
        "Line8Penalty": 22.5,
        "Line9BalanceType": "Debit",
        "BalanceAmtDuePeriod": "2020-04-20T00:00:00",
        "Line9BalanceAmt": 500,
        "Line10TotalAmtDue": 1903,
        "PayRoll": [
          {
            "EmployeeSeqId": "01",
            "SSN": "011450001",
            "FirstNm": "John",
            "LastNm": "Smith",
            "TotalGrossWages": 1000
          },
          {
            "EmployeeSeqId": "02",
            "SSN": "011450002",
            "FirstNm": "John",
            "LastNm": "Martyn",
            "TotalGrossWages": 10000
          },
          {
            "EmployeeSeqId": "03",
            "SSN": "011450003",
            "FirstNm": "Alex",
            "LastNm": "Karev",
            "TotalGrossWages": 4000
          },
          {
            "EmployeeSeqId": "04",
            "SSN": "011450004",
            "FirstNm": "Joseph",
            "LastNm": "Wilson",
            "TotalGrossWages": 10000
          },
          {
            "EmployeeSeqId": "05",
            "SSN": "011450005",
            "FirstNm": "Jack",
            "LastNm": "Wilson",
            "TotalGrossWages": 20000
          }
        ]
      }
    },
    "TX": {
       "FormC3": {
         "RecordId": "1570b923-1ab6-4d7f-80ab-07c3d846073b",
         "Sequence": null,
         "Qtr": "Q1",
         "TaxYr": "2020",
         "StateAccNumber": "13245",
         "NAICSCode": "125",
         "IsNoWorkersOrNoWage": false,
         "TotalNumberOfEmployees": 1,
         "Month1Employment": 1,
         "Month2Employment": 2,
         "Month3Employment": 3,
         "TotWages": 120,
         "TotTaxableWages": 100,
         "UITaxRate": 0.32,
         "TaxDue": 32,
         "HighestEmployeesCountyCode": 1,
         "OutsideCountyEmployees": 60,
         "PayRollDetails": [
           {
             "SSN": "12-5678451",
             "FirstNm": "King",
             "MiddleNm": "k",
             "LastNm": "Khan",
             "Wages": 120,
             "TaxableWages": 100
           }
         ]
       }
     }
  }
},
"Errors": null
}

# GetPDF

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

GET StateUI/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
StateUIRecords	object[]	StateUIRecords Object
Sequence	string	A unique number given by an inbound application to identify records.
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

StateUI/GetPdf?SubmissionId=7dd5c92c-1832-45f8-acbf-748d28f9e4ea&RecordIds=3909399a-7566-4810-9b88-f4442a59a923,01003b0c-ba1f-4ad2-8857-c8c065f178bb

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "7dd5c92c-1832-45f8-acbf-748d28f9e4ea",
   "StateUIRecords": [
     {
       "Sequence": "01",
       "RecordId": "3909399a-7566-4810-9b88-f4442a59a923",
       "Message": "We've successfully received your request. You’ll be notified with a link to download the pdf."
     },
     {
   "Sequence": "02",
   "RecordId": "01003b0c-ba1f-4ad2-8857-c8c065f178bb",
   "FormType": "FormRT6",
   "Message": "We've successfully received your request. You’ll be notified with a link to download     the    pdf."
 },
     {
   "Sequence": "03",
   "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
   "FormType": "FormDOL4N",
   "Message": "We've successfully received your request. You’ll be notified with a link 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

# List

Lists State withholding Forms created for a date range.

GET StateUI/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 UI records to be listed in each page
RecordStatus	string	List the State UI records based on the status
FromDate	string	List State UI records created from
ToDate	string	List State UI 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.
StateUIRecords	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
EINorSSN	string	Employer Identification Number
FormType	string	Type of State WH Forms
Sequence	string	A unique number given by an inbound application to identify records.
RecordId	guid	Unique identifier of a record
Qtr	string	Quarter for which State UI needs to be filed
TaxYr	string	Tax year for which State UI needs to be filed
RecordStatus	string	List the State UI 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 StateUI 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

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

Response JSON

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "StateUIRecords": [
      {
        "SubmissionId": "efacde0b-93e4-4327-84f5-f003b14fdc47",
        "BusinessId": "47914440-f016-482b-a065-43f6e7963904",
        "BusinessNm": "Lohan LLC",
        "EINorSSN": "00-7895456",
        "FormType": "FormUI340",
        "Sequence": "001",
        "Qtr": "Q3",
        "TaxYr": "2020",
        "RecordId": "7629fc38-5a6f-4b51-842e-b3058bc5a94c",
        "RecordStatus": "CREATED"
      },
      {
      "SubmissionId": "efacde0b-93e4-4327-84f5-f003b14fdc47",
      "BusinessId": "47914440-f016-482b-a065-43f6e7963904",
      "BusinessNm": "Lohan LLC",
      "EINorSSN": "00-7895456",
      "FormType": "FormRT6",
      "Sequence": "002",
      "Qtr": "Q3",
      "TaxYr": "2020",
      "RecordId": "7629fc38-5a6f-4b51-842e-b3058bc5a94c",
      "RecordStatus": "CREATED"
    },
    {
      "SubmissionId": "2419666e-d0ab-4511-87e1-2d2cdd0f247f",
        "BusinessId": "429766de-2ca0-4cf1-aa04-cf6a6d20cda2",
        "BusinessNm": "Zolo Tech LLC",
        "EINorSSN": "00-4562589",
        "FormType": "FormDOL4N",
        "Sequence": "001",
        "Qtr": "Q1",
        "TaxYr": "2020",
        "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
        "RecordStatus": "CREATED
    },
    {
      "SubmissionId": "2419666e-d0ab-4511-87e1-2d2cdd0f247f",
      "BusinessId": "429766de-2ca0-4cf1-aa04-cf6a6d20cda2",
      "BusinessNm": "Zolo Tech LLC",
      "EINorSSN": "00-4562589",
      "FormType": "FormC3",
      "Sequence": "001",
      "Qtr": "Q1",
      "TaxYr": "2020",
      "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
      "RecordStatus": "CREATED
    }
    ],
    "TotalRecords": 2,
    "TotalPages": 1,
    "Page": 1,
    "PageSize": 10,
    "Errors": null
  }

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

# Status

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

GET StateUI/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.
StateUIRecords	object	Pulls the state withholding form records with Success and Error statuses.
IL	object	Pulls the Illinois state UI form records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of StateUI Records.
Sequence	string	A unique number given by an inbound application to identify 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.
PayRollSuccessRecords	object[]	It will show the detailed information about the success status of Payroll Details of Workers.
EmployeeSeqId	string	A unique number given by an inbound application to identify Payroll records.
RecordStatus	string	Returns status of Payroll Records.
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
StatusTs	string	Date and time of Payroll Records
ErrorRecords	object[]	It will show the detailed information about the error status of StateUI 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

StateUI/Status?SubmissionId=d4dc77a6-81b4-4a70-8cf5-e01a7eff50b0&RecordIds=402fb208-50b2-48cb-a767-db017be95d9d,27948c3c-2acd-4ddc-be64-c40ef98f982a&EIN=546546546

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "d4dc77a6-81b4-4a70-8cf5-e01a7eff50b0",
 "StateUIRecords": {
   "IL": {
     "SuccessRecords": [
       {
         "Sequence": "001",
         "FormType": "FormUI340",
         "RecordId": "402fb208-50b2-48cb-a767-db017be95d9d",
         "RecordStatus": "Created",
         "StatusTs": "2020-03-11 08:39:58 -04:00",
         "PayrollSuccessRecords": null
       }
     ],
     "ErrorRecords": null
   },
    "FL": {
  "SuccessRecords": [
    {
      "Sequence": "001",
      "FormType": "FormRT6",
      "RecordId": "27948c3c-2acd-4ddc-be64-c40ef98f982a",
      "RecordStatus": "Created",
      "StatusTs": "2020-03-11 08:39:58 -04:00",
      "PayrollSuccessRecords": null
    }
  ],
  "ErrorRecords": null
},
"GA": {
  "SuccessRecords": [
    {
      "Sequence": "001",
      "FormType": "FormDOL4N",
      "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
      "RecordStatus": "Created",
      "StatusTs": "2020-03-11 08:39:58 -04:00",
      "PayrollSuccessRecords": null
    }
  ],
  "ErrorRecords": null
},
"TX": {
  "SuccessRecords": [
    {
      "Sequence": "001",
      "FormType": "FormC3",
      "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
      "RecordStatus": "Created",
      "StatusTs": "2020-03-11 08:39:58 -04:00",
      "PayrollSuccessRecords": null
    }
  ],
  "ErrorRecords": null
}
 },
 "Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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

# Transmit

Transmits the StateUI to the IRS after validation.

POST StateUI/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.
StateUIRecords	object	Pulls the StateUI records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of StateUI Records.
Sequence	string	A unique number given by an inbound application to identify records.
RecordId	Guid	Unique identifier of a record.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of Record.
PayRollSuccessRecords	object[]	It will show the detailed information about the success status of Payroll Details of Workers.
EmployeeSeqId	string	A unique number given by an inbound application to identify Payroll records.
RecordStatus	string	Returns status of Payroll Records.
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
StatusTs	string	Date and time of Payroll Records
ErrorRecords	object[]	It will show the detailed information about the error status of StateUI 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": "a1df04cc-4c08-4828-9ce9-87e4eb151777",
"RecordIds": [
"2c3b7697-fa03-4bfd-ba9b-2857de572416",
"27948c3c-2acd-4ddc-be64-c40ef98f982a"
]
}

1
2
3
4
5
6
7

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "a1df04cc-4c08-4828-9ce9-87e4eb151777",
"StateUIRecords": {
  "IL": {
    "SuccessRecords": [
      {
        "Sequence": "001",
        "FormType": "FormUI340",
        "RecordId": "2c3b7697-fa03-4bfd-ba9b-2857de572416",
        "RecordStatus": "Transmitted",
        "StatusTs": "2020-03-11 08:39:58 -04:00",
        "PayrollSuccessRecords": null
      }
    ],
    "ErrorRecords": null
  },
   "FL": {
 "SuccessRecords": [
   {
     "Sequence": "001",
     "FormType": "FormRT6",
     "RecordId": "27948c3c-2acd-4ddc-be64-c40ef98f982a",
     "RecordStatus": "Transmitted",
     "StatusTs": "2020-03-11 08:39:58 -04:00",
     "PayrollSuccessRecords": null
   }
 ],
 "ErrorRecords": null
},
   "GA": {
 "SuccessRecords": [
   {
     "Sequence": "001",
     "FormType": "FORMDOL4N",
     "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
     "RecordStatus": "Transmitted",
     "StatusTs": "2020-03-11 08:39:58 -04:00",
     "PayrollSuccessRecords": null
   }
 ],
 "ErrorRecords": null
},
"TX": {
 "SuccessRecords": [
   {
     "Sequence": "001",
     "FormType": "FormC3",
     "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
     "RecordStatus": "Transmitted",
     "StatusTs": "2020-03-11 08:39:58 -04:00",
     "PayrollSuccessRecords": null
   }
 ],
 "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

# Update

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

PUT StateUI/Update

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission.
StateUIRecords	object	Object to update State UI Forms
ReturnHeader	object	Identifies the supporting details of State UI Forms.
Forms	object[]	Type of State Unemployment Insurance forms and state to be filed.
State	string	State for which Unemployment Insurance forms to be filed. Allowed values: "IL", "FL", "GA", "TX"
Form	string	Type of State Unemployment Insurance forms to be filed. Allowed values: "FormUI340", "FormRT6", "FormDOL4N", "FormC3"
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 Unemployment Insurance Forms data.
GA	object	Forms to be filed for Georgia State.
FormDOL4N	object	Form DOL4N, Georgia State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form DOL4N needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form DOL4N needs to be filed. Allowed values: "2020"
DOLAccNumber	string	Employer's DOL Account number. Size Range: 8
Line1NumberOfEmployees	object	Total number of full-time and part-time employees.
Month1Employees	number	Total number of full-time and part-time employees for Month 1. Size Range: 5
Month2Employees	number	Total number of full-time and part-time employees for Month 2. Size Range: 5
Month3Employees	number	Total number of full-time and part-time employees for Month 3. Size Range: 5
Line2GrossWages	number	Total Reportable gross wages paid this quarter. Size Range: 0-999999999.99
Line3NonTaxableWages	number	Non-Taxable Wages paid this quarter. Size Range: 0-999999999.99
Line4TaxableWages	number	Taxable wages paid this quarter. Size Range: 0-999999999.99
ContributionRate	number	Contribution Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Size Range: 0-1
Line5ContributionDue	number	Contribution Tax Due Amount. Size Range: 0-999999999.99
AdministrativeAsstRate	number	Administrative Assessment Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Allowed values: "0", "0.0006"
Line6AdministrativeAsstDue	number	Administrative Assessment Due Amount. Size Range: 0-999999999.99
Line7Interest	number	Interest Amount. Size Range: 0-999999999.99
Line8Penalty	number	Penalty for filing late. Size Range: 0-999999999.99
Line9BalanceType	string	Credit or debit after calculating tax. Allowed values: Credit, Debit
BalanceAmtDuePeriod	string	Balance Amount Due Period.
Line9BalanceAmt	number	Balance Amount. Size Range: 0-999999999.99
Line10TotalAmtDue	number	Total amount due. Size Range: 0-999999999.99
PayRoll	object[]	Payroll Details.
EmployeeSeqId	string	unique number given by an inbound application to identify records.
SSN	string	Employee's Social Security Number. Size Range: 9
FirstNm	string	Employee's First Name.
LastNm	string	Employee's Last Name.
TotalGrossWages	number	Employee's Total Individual Reportable Gross Wages paid this quarter. Size Range: 0-999999.99
FL	object	Forms to be filed for Florida State.
FormRT6	guid	Form RT6, Florida State UI Form.
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 RT6 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form RT6 needs to be filed. Allowed values: "2020"
RTAccNumber	string	Employer's RT Account number. Size Range: 7
IsFinalReturn	Boolean	When true, identifies that this is the final return.
DateOperationCeased	string	Date after which operations ceased.
Line1NumberOfEmployees	object	Total number of full-time and part-time employees.
Month1Employees	number	Total number of full-time and part-time employees for Month 1. Size Range: 6
Month2Employees	number	Total number of full-time and part-time employees for Month 2. Size Range: 6
Month3Employees	number	Total number of full-time and part-time employees for Month 3. Size Range: 6
Line2UITotalWages	number	Total gross wages paid before deductions. Size Range: 0-999999999.99
Line3ExcessWages	number	Wages exceeding $7,000 paid to each employee. Size Range: 0-999999999.99
Line4UITaxableWages	number	Wages that are taxable. Size Range: 0-999999999.99
TaxRate	number	Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06. Size Range: 0.0010 - 0.0540
Line5TaxDue	number	Tax Due amount. Size Range: 0-999999999.99
Line6UIPenalty	number	Penalty due amount. Size Range: 0-999999999.99
Line7UIInterest	number	Interest due amount. Size Range: 0-999999999.99
Line9AUITotalDue	number	Total amount due. Size Range: 0-999999999.99
AddPayRoll	object[]	Add Payroll Details.
EmployeeSeqId	string	A unique number given by an inbound application to identify records.
EmployeeRecordId	Guid	Not Required For AddPayRoll Details.
SSN	string	Employee's Social Security Number. Size Range: 9
FirstNm	string	Employee's First Name.
Initial	string	Employee's Middle Initial.
LastNm	string	Employee's Last Name.
TotalWages	number	Employee’s gross wages paid this quarter. Size Range: 0-999999999.99
TaxableWages	number	Employee’s taxable wages paid this quarter. Size Range: 0-99999.99
OutOfStateWageDetails	object	Out of State Wage Details.
OutOfStateTotalWages	number	Total Gross Wages. Size Range: 0-9999999999.99
OutOfStateTaxableWages	number	Total Taxable Wages . Size Range: 0-99999.99
TaxState	string	Tax State.
UpdatePayRoll	object[]	Update Payroll Details.
EmployeeSeqId	string	A unique number given by an inbound application to identify records..
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
SSN	string	Employee's Social Security Number. Size Range: 9
FirstNm	string	Employee's First Name.
Initial	string	Employee's Middle Initial.
LastNm	string	Employee's Last Name.
TotalWages	number	Employee’s gross wages paid this quarter. Size Range: 0-999999999.99
TaxableWages	number	Employee’s taxable wages paid this quarter. Size Range: 0-99999.99
OutOfStateWageDetails	object	Out of State Wage Details.
OutOfStateTotalWages	number	Total Gross Wages. Size Range: 0-9999999999.99
OutOfStateTaxableWages	number	Total Taxable Wages . Size Range: 0-99999.99
TaxState	string	Tax State.
DeletePayRoll	object[]	Pulls The Payroll Details.
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
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 Holder Type (Business or Personal) of EFW payment.
IL	object	Forms to be filed for Illinois State.
FormUI340	object	Form UI 3/40, Illinois State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
RecordId	guid	Unique identifier of a record.
Qtr	string	The Quarter for which, Form UI340 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
TaxYr	string	The Tax year for which, Form UI340 needs to be filed. Allowed values: "2020"
ILAccNumber	string	Employer's Illinois Acount Number. Size Range: 7
Line1NumberOfEmployees	object	The total number of workers for the given month.
Month1Employees	number	The total number of workers for the 1st month. Size Range: 9
Month2Employees	number	The total number of workers for the 2nd month. Size Range: 9
Month3Employees	number	The total number of workers for the 3rd month. Size Range: 9
Line2UITotalWages	number	The total wages paid to all the workers. Size Range: 0-9999999999.99
Line3ExcessWages	number	The total wages that are over $12,740 per worker per calendar year. Size Range: 0-9999999999.99
Line4UITaxableWages	number	Wages that are taxable. Size Range: 0-9999999999.99
ContributionRate	string	Contribution Tax Rate assigned by the state. Enter the decimal value and not the percentage. Eg: For 6%, enter 0.06.
ContributionDue	number	Multiply line 4 by contribution rate in percentage . Size Range: 0-9999999999.99
Line6AUIInterest	number	Calculated Interest Amount for any overdue tax. Size Range: 0-100
Line6BUIPenalty	number	Penalty Amount for late filing. Size Range: 0-9999999999.99
Line6CUIAmountDuePreviousPeriod	number	The amount of the underpayment including interest from previous underpayment. Size Range: 0-9999999999.99
Line6DUICreditPreviousPeriod	number	Any overpayment from previous deposits. Size Range: 0-9999999999.99
Line7UITotalDue	string	The amount to be paid to the Illinois Department of Revenue Enter the sum of line 5A or 5B plus Lines 6A, 6B, and 6C and less any amount on line 6D. Size Range: 0-9999999999.99
AddPayRoll	object[]	Add payroll details of the employees.
EmployeeSeqId	string	A unique number given by an inbound application to identify failed records.
EmployeeRecordId	string	Not Required For AddPayRoll details.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker.
Initial	string	Initial of the Worker.
LastNm	string	Last Name of the worker.
TotalWages	string	Total wages paid to the workers.
UpdatePayRoll	object[]	Update payroll details of the employees.
EmployeeSeqId	string	A unique number given by an inbound application to identify records.
EmployeeRecordId	string	Unique identifier of a Payroll record.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker.
Initial	string	Initial of the Worker.
LastNm	string	Last Name of the worker.
TotalWages	string	Total wages paid to the workers.
DeletePayRoll	object[]	Delete payroll details of the employees.
EmployeeRecordId	object	Unique identifier of a Payroll record.
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 Holder Type (Business or Personal) of EFW payment.
TX	object	Forms to be filed for Texas State.
FormC3	object	Form UI C3, Texas State UI Form.
Sequence	string	A unique number given by an inbound application to identify records.
Qtr	string	The Quarter for which, Form C3 needs to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4"
StateAccNumber	string	State Unemployment Insurance Account Number. Size Range: 9
NAICSCode	string	NAICS Code. Size Range: 6
IsNoWorkersOrNoWage	Boolean	When True, Identifies that there is no employees for this quarter.
TotalNumberOfEmployees	number	Total number of employees. Size Range: 7
Month1Employment	number	Month 1 employment for employer. Size Range: 7
Month2Employment	number	Month 2 employment for employer. Size Range: 7
Month3Employment	number	Month 3 employment for employer. Size Range: 7
TotWages	number	Total State Quarterly UI total wages for employer. Size Range: 0-999999999999.99
TotTaxableWages	number	Total State Quarterly UI taxable wages for employer. Size Range: 0-999999999999.99
UITaxRate	number	Texas UI tax rate for the quarter. Size Range: 0.31000 - 6.31000
HighestEmployeesCountyCode	string	County code where employer has greatest number of employees. Size Range: 3
OutsideCountyEmployees	number	Employees outside the county mentioned above. Size Range: 7
AddPayRollDetails	object[]	The payroll details of the employees.
EmployeeSequenceId	string	A unique number given by an inbound application to identify records.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker. Size Range: 12
MiddleNm	string	Middle Name of the Worker. Size Range: 1
LastNm	string	Last Name of the worker. Size Range: 20
Wages	number	State Quarterly unemployment insurance total wages. Size Range: 0-999999999999.99
TaxableWages	number	State Quarterly unemployment insurance taxable wages. Size Range: 0-999999999999.99
UpdatePayRollDetails	object[]	The payroll details of the employees.
EmployeeSequenceId	string	A unique number given by an inbound application to identify records.
SSN	string	Social Security Number of the Worker. Size Range: 9
FirstNm	string	First Name of the worker. Size Range: 12
MiddleNm	string	Middle Name of the Worker. Size Range: 1
LastNm	string	Last Name of the worker. Size Range: 20
Wages	number	State Quarterly unemployment insurance total wages. Size Range: 0-999999999999.99
TaxableWages	number	State Quarterly unemployment insurance taxable wages. Size Range: 0-999999999999.99
DeletePayRollDetails	object[]	The payroll details of the employees.

Response Body

Field	Type	Description
RecordId	Guid	Unique identifier of a record.
EmployeeRecordId	Guid	Unique identifier of a record.
EmployeeRecordId	Guid	Unique identifier of a record.
EmployeeRecordId	Guid	Unique identifier of a record.
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.
StateUIRecords	object	Pulls the State withholding Form records with Success and Error statuses.
IL	object	Pulls the Illinois State UI Form records with Success and Error statuses.
FL	object	Pulls the Florida State UI Form records with Success and Error statuses.
GA	object	Pulls the Georgia State UI Form records with Success and Error statuses.
TX	object	Pulls the Texas State UI Form records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of State UI Records.
Sequence	string	A unique number given by an inbound application to identify records.
RecordId	Guid	Unique identifier of a record.
FormType	string	Type of State UI Form Filed.
RecordStatus	string	Returns the status of the records.
StatusTs	string	Date and time of return.
PayRollSuccessRecords	object[]	It will show the detailed information about the success status of Payroll Details of Workers.
EmployeeSeqId	string	A unique number given by an inbound application to identify Payroll records.
RecordStatus	string	Returns status of Payroll Records.
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
StatusTs	string	Date and time of Payroll Records
ErrorRecords	object[]	It will show the detailed information about the error status of State UI 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	D escription 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 ": "60219129-9345-4c2c-b4e8-c1242e0e7527 ",
  "StateUIRecords ": {
    "ReturnHeader": {
      "Forms": [
        {
          "State": "IL",
          "Form": "FormUI340"
        },
        {
          "State": "FL",
          "Form": "FormRT6"
        },
        {
          "State": "GA",
          "Form": "FormDOL4N"
        },
		{
          "State": "TX",
          "Form": "FormC3"
        }
      ],
      "Business": {
        "BusinessId": null,
        "BusinessNm": "Mayfill Tech LLC",
        "TradeNm": "Mayfill Tech",
        "IsEIN": true,
        "EINorSSN": "001687743",
        "Email": "mayfill.k@zolotech.com",
        "ContactNm": "John",
        "Phone": "7894561231",
        "PhoneExtn": "12345",
        "Fax": "7123547895",
        "BusinessType": "ESTE",
        "SigningAuthority": {
          "Name": "John",
          "Phone": "7894561231",
          "BusinessMemberType": "ADMINISTRATOR"
        },
        "KindOfEmployer": null,
        "KindOfPayer": null,
        "IsBusinessTerminated": false,
        "IsForeign": false,
        "USAddress": {
          "Address1": "12 Main st",
          "Address2": "CC avenue",
          "City": "Rock Hill",
          "State": "SC",
          "ZipCd": "29730"
        },
        "ForeignAddress": {
          "Address1": null,
          "Address2": null,
          "City": null,
          "ProvinceOrStateNm": null,
          "Country": null,
          "PostalCd": null
        }
      }
    },
    "ReturnData": {
      "FL": {
        "FormRT6": {
          "RecordId": "5c1834f0-495c-46bb-bcea-b8c046d7df23",
          "Sequence": "001",
          "Qtr": "Q1",
          "TaxYr": "2020",
          "RTAccNumber": "1234567",
          "IsFinalReturn": true,
          "DateOperationCeased": "2020-04-20T00:00:00",
          "Line1NumberOfEmployees": {
            "Month1Employees": 10,
            "Month2Employees": 20,
            "Month3Employees": 30
          },
          "Line2UITotalWages": 2000,
          "Line3ExcessWages": 600,
          "Line4UITaxableWages": 1400,
          "TaxRate": 0.054,
          "Line5TaxDue": 75.6,
          "Line6UIPenalty": 1,
          "Line7UIInterest": 1,
          "Line9AUITotalDue": 77.6,
          "AddPayRoll": [
            {
              "EmployeeSeqId": "13",
              "EmployeeRecordId": null,
              "SSN": "001456924",
              "FirstNm": "John",
              "Initial": "A",
              "LastNm": "Smith",
              "TotalWages": 500,
              "TaxableWages": 800,
              "OutOfStateWageDetails": {
                "OutOfStateTotalWages": 0,
                "OutOfStateTaxableWages": 0,
                "TaxState": "GA"
              }
            }
          ],
          "UpdatePayRoll": [
            {
              "EmployeeSeqId": "12",
              "EmployeeRecordId": "2888585e-2bf7-4786-b295-a2c1229b7cc9",
              "SSN": "001456929",
              "FirstNm": "Johnny",
              "Initial": "A",
              "LastNm": "Smith",
              "TotalWages": 1500,
              "TaxableWages": 600,
              "OutOfStateWageDetails": {
                "OutOfStateTotalWages": 0,
                "OutOfStateTaxableWages": 0,
                "TaxState": "GA"
              }
            }
          ],
          "DeletePayRoll": [
            {
              "EmployeeRecordId": "01003b0c-ba1f-4ad2-8857-c8c065f178bb"
            }
          ],
          "StatePayment": {
            "AccountType": "Checking",
            "RoutingTransitNumber": "217555555",
            "BankAccountNumber": "0000000001",
            "AccountHolderName": "John Smith",
            "AccountHolderType": "Business"
          }
        }
      },
      "IL": {
        "FormUI340": {
          "RecordId": "27948c3c-2acd-4ddc-be64-c40ef98f982a",
          "Sequence": "001",
          "Qtr": "Q2",
          "TaxYr": "2020",
          "ILAccNumber": "9992459",
          "Line1NumberOfEmployees": {
            "Month1Employees": 1,
            "Month2Employees": 3,
            "Month3Employees": 2
          },
          "Line2UITotalWages": 2000,
          "Line3ExcessWages": 1000,
          "Line4UITaxableWages": 1000,
          "ContributionRate": 0.02,
          "ContributionDue": 20,
          "Line6AUIInterest": 1,
          "Line6BUIPenalty": 50,
          "Line6CUIAmountDuePreviousPeriod": 1,
          "Line6DUICreditPreviousPeriod": 0,
          "Line7UITotalDue": 72,
          "AddPayRoll": [
            {
              "EmployeeSeqId": "13",
              "SSN": "011456926",
              "FirstNm": "Lohan",
              "Initial": "A",
              "LastNm": "Smith",
              "TotalWages": 2000
            }
          ],
          "UpdatePayRoll": null,
          "DeletePayRoll": null,
          "StatePayment": {
            "AccountType": "Checking",
            "RoutingTransitNumber": "217555555",
            "BankAccountNumber": "0000000001",
            "AccountHolderName": "John Smith",
            "AccountHolderType": "Business"
          }
        }
      },
      "GA": {
        "FormDOL4N": {
          "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
          "Sequence": "001",
          "Qtr": "Q1",
          "TaxYr": "2020",
          "DOLAccNumber": "99999999",
          "Line1NumberOfEmployees": {
            "Month1Employees": 2,
            "Month2Employees": 2,
            "Month3Employees": 1
          },
          "Line2GrossWages": 45000,
          "Line3NonTaxableWages": 11500,
          "Line4TaxableWages": 33500,
          "ContributionRate": 0.04,
          "Line5ContributionDue": 1340,
          "AdministrativeAsstRate": 0.0006,
          "Line6AdministrativeAsstDue": 20.1,
          "Line7Interest": 20.4,
          "Line8Penalty": 22.5,
          "Line9BalanceType": "Debit",
          "BalanceAmtDuePeriod": "2020-04-20T00:00:00",
          "Line9BalanceAmt": 500,
          "Line10TotalAmtDue": 1903,
          "AddPayRoll": [
            {
              "EmployeeSeqId": "06",
              "SSN": "011450006",
              "FirstNm": "Ken",
              "LastNm": "Sebastian",
              "TotalGrossWages": 20000
            }
          ],
          "UpdatePayRoll": [
            {
              "EmployeeRecordId": "d6e96d94-15b4-4970-b681-ee020b85f3be",
              "EmployeeSeqId": "01",
              "SSN": "011450001",
              "FirstNm": "John",
              "LastNm": "Mark",
              "TotalGrossWages": 1000
            }
          ],
          "DeletePayRoll": [
            {
              "EmployeeRecordId": "d6e96d94-15b4-4970-b685-ee020b85f3be"
            }
          ]
        }
      },
      "TX": {
        "FormC3": {
          "RecordId": "1570b923-1ab6-4d7f-80ab-07c3d846073b",
          "Sequence": null,
          "Qtr": "Q1",
          "TaxYr": "2020",
          "StateAccNumber": "13245",
          "NAICSCode": "125",
          "IsNoWorkersOrNoWage": false,
          "TotalNumberOfEmployees": 2,
          "Month1Employment": 1,
          "Month2Employment": 2,
          "Month3Employment": 3,
          "TotWages": 1200,
          "TotTaxableWages": 135,
          "UITaxRate": 0.32,
          "TaxDue": 43.2,
          "HighestEmployeesCountyCode": 1,
          "OutsideCountyEmployees": 60,
          "AddPayRollDetails": [
            {
              "EmployeeSequenceId": null,
              "EmployeeRecordId": null,
              "FirstNm": "King",
              "MiddleNm": "k",
              "LastNm": "Khan",
              "SSN": "12-7778451",
              "Wages": 0,
              "TaxableWages": 0
            }
          ],
          "UpdatePayRollDetails": [
            {
              "EmployeeSequenceId": null,
              "EmployeeRecordId": "1631fd5e-049d-4af2-964e-2c46d5657831",
              "FirstNm": "Mathew",
              "MiddleNm": "John",
              "LastNm": "A",
              "SSN": "123454321",
              "Wages": 1200,
              "TaxableWages": 135
            }
          ],
          "DeletePayRollDetails": [
            {
              "EmployeeRecordId": "00000000-0000-0000-0000-000000000000"
            }
          ]
        }
      }
    }
  }
}

Response JSON

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "60219129-9345-4c2c-b4e8-c1242e0e7527",
  "StateUIRecords": {
    "IL": {
      "SuccessRecords": [
        {
          "Sequence": "123",
          "FormType": "FormIL941",
          "RecordId": "27948c3c-2acd-4ddc-be64-c40ef98f982a",
          "RecordStatus": "Created",
          "StatusTs": "2020-04-16 15:47:35 +05:30",
          "PayRollSuccessRecords": [
            {
              "EmployeeSeqId": "11",
              "RecordStatus": "Added",
              "EmployeeRecordId": "a276c397-a17d-4ddf-9156-4b408370a72b",
              "StatusTs": "2020-04-16T15:47:38.671181+05:30"
            }
          ]
        }
      ],
      "ErrorRecords": null
    },
    "FL": {
      "SuccessRecords": [
        {
          "Sequence": "123",
          "FormType": "FormRT6",
          "RecordId": "5c1834f0-495c-46bb-bcea-b8c046d7df23",
          "RecordStatus": "Created",
          "StatusTs": "2020-04-16 15:47:35 +05:30",
          "PayRollSuccessRecords": [
            {
              "EmployeeSeqId": "13",
              "RecordStatus": "Added",
              "EmployeeRecordId": "a276c397-a17d-4ddf-9156-4b408370a72b",
              "StatusTs": "2020-04-16T15:47:38.671181+05:30"
            },
            {
              "EmployeeSeqId": "12",
              "RecordStatus": "Updated",
              "EmployeeRecordId": "2888585e-2bf7-4786-b295-a2c1229b7cc9",
              "StatusTs": "2020-04-16T15:47:39.3023743+05:30"
            },
            {
              "EmployeeSeqId": null,
              "RecordStatus": "Deleted",
              "EmployeeRecordId": "01003b0c-ba1f-4ad2-8857-c8c065f178bb",
              "StatusTs": "2020-04-16T15:47:39.3023743+05:30"
            }
          ]
        }
      ],
      "ErrorRecords": null
    },
    "GA": {
      "SuccessRecords": [
        {
          "Sequence": "001",
          "FormType": "FormDOL4N",
          "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
          "RecordStatus": "Created",
          "StatusTs": "2020-05-04 10:58:46 +05:30",
          "PayrollSuccessRecords": [
            {
              "EmployeeSeqId": "06",
              "RecordStatus": "Added",
              "EmployeeRecordId": "7df8f0e1-d617-4fa3-87dc-bd52692e41e2",
              "StatusTs": "2020-05-04 06:54:34 -04:00"
            },
            {
              "EmployeeSeqId": "01",
              "RecordStatus": "Updated",
              "EmployeeRecordId": "d6e96d94-15b4-4970-b681-ee020b85f3be",
              "StatusTs": "2020-05-04 06:54:34 -04:00"
            },
            {
              "EmployeeSeqId": "05",
              "RecordStatus": "Deleted",
              "EmployeeRecordId": "01003b0c-ba1f-4ad2-8857-c8c065f178bb",
              "StatusTs": "2020-05-04 06:54:34 -04:00"
            }
          ]
        }
      ],
      "ErrorRecords": null
    },
    "TX": {
      "SuccessRecords": [
        {
          "Sequence": null,
          "FormType": "FormC3",
          "RecordId": "1570b923-1ab6-4d7f-80ab-07c3d846073b",
          "RecordStatus": "Created",
          "StatusTs": "2020-05-22 06:50:26 -04:00",
          "PayrollSuccessRecords": [
            {
              "EmployeeSeqId": null,
              "EmployeeRecordId": "af1182f0-d3c1-4199-80fd-27feb50a66ed",
              "RecordStatus": "Added",
              "StatusTs": "2020-05-22 06:50:26 -04:00"
            },
            {
              "EmployeeSeqId": null,
              "EmployeeRecordId": "1631fd5e-049d-4af2-964e-2c46d5657831",
              "RecordStatus": "Updated",
              "StatusTs": "2020-05-22 06:50:26 -04:00"
            },
            {
              "EmployeeSeqId": null,
              "EmployeeRecordId": "00000000-0000-0000-0000-000000000000",
              "RecordStatus": null,
              "StatusTs": null
            }
          ]
        }
      ],
      "ErrorRecords": 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 StateUI/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.
StateUIRecords	object	Pulls the State UI records with Success and Error statuses.
GA	object	Pulls the Georgia State UI records with Success and Error statuses.
FL	object	Pulls the Florida State UI records with Success and Error statuses.
IL	object	Pulls the Illinois State UI records with Success and Error statuses.
TX	object	Pulls the Texas State UI 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 records.
FormType	string	Type of State UI 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.
PayRollSuccessRecords	object[]	It will show the detailed information about the success status of Payroll Details of Workers.
EmployeeSeqId	string	A unique number given by an inbound application to identify Payroll records.
RecordStatus	string	Returns status of Payroll Records.
EmployeeRecordId	Guid	Unique identifier of a Payroll record.
StatusTs	string	Date and time of Payroll 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

StateWH/Validate?SubmissionId=f2fee2f8-74bf-4e1d-9239-399e76929475&RecordIds=ed6bc24b-189d-419b-9224-2dd2bf3b7467,27948c3c-2acd-4ddc-be64-c40ef98f982a

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "f2fee2f8-74bf-4e1d-9239-399e76929475",
 "StateUIRecords": {
   "IL": {
     "SuccessRecords": [
       {
         "Sequence": "001",
         "FormType": "FormUI340",
         "RecordId": "ed6bc24b-189d-419b-9224-2dd2bf3b7467",
         "RecordStatus": "Created",
         "StatusTs": "2020-03-11 08:39:58 -04:00",
         "PayrollSuccessRecords": null
       }
     ],
     "ErrorRecords": null
   },
    "FL": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "FormRT6",
       "RecordId": "27948c3c-2acd-4ddc-be64-c40ef98f982a",
       "RecordStatus": "Created",
       "StatusTs": "2020-03-11 08:39:58 -04:00",
       "PayrollSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 },
     "GA": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "FormDOL4N",
       "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
       "RecordStatus": "Created",
       "StatusTs": "2020-03-11 08:39:58 -04:00",
       "PayrollSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 },
 "TX": {
   "SuccessRecords": [
     {
       "Sequence": "001",
       "FormType": "FormC3",
       "RecordId": "a317d6be-dedf-45be-a20e-fb263ccc5805",
       "RecordStatus": "Created",
       "StatusTs": "2020-03-11 08:39:58 -04:00",
       "PayrollSuccessRecords": null
     }
   ],
   "ErrorRecords": null
 }
},
"Errors": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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

← Reports StateWH →