Version: 1.7.3

Get

Use this endpoint to retrieve the information of a previously created UC101 form for the corresponding business. Your request JSON must include the corresponding SubmissionId and the RecordId (optional) for the forms.

GET StateFilings/SCUI/Get

Run in Postman

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordId	Guid	A unique identifier generated by TaxBandits when a Form UC101 return is created.

Response Body

Field	Type	Description
StateUIRecords	Object []	Object to identify the records.
SequenceId	String	A unique identifier for this record. Size Range: ..10
ReturnHeader	Object	Contains information about the Business details.
TaxYr	string	The tax year for which the Form UC101 is to be filed. Allowed values "2023", "2024", "2025"
Qtr	string	The quarter for which the Form UC101 is to be filed. Allowed values "Q1", "Q2", "Q3", "Q4"
Business	Object	Object to identify the Business Details.
BusinessId	Guid	Optional: Use the unique Business ID provided in the response from the Business CREATE endpoint.
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-11
Email	string	Optional: Email address of the business. Size Range: ..100
ContactNm	string	Optional: Name of the person who can be contacted by the IRS. Size Range: ..27
Phone	string	Optional: Phone number of the business. Size Range: 10
PhoneExtn	string	Optional: Extension of the business phone number. Size Range: ..5
Fax	string	Optional: Fax number of the business. Size Range: 10
BusinessType	string	Optional: Type of business. Mandatory for 94X series and optional for W-2/1099. Size Range: 4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO"
KindOfEmployer	string	Optional: Identifies the kind of employer. Mandatory for W-2 and optional for 1099-NEC and 94X series.<br/> Allowed values "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional: Identifies the kind of payer. This field is mandatory for W-2 and optional in 1099-NEC and 94X series. Allowed values "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
IsBusinessTerminated	Boolean	When true, indicates that the business is terminated.
IsForeign	Object	When true, indicates that the business has a foreign address.
USAddress	object	If IsForeign is false, pass the US address of the business.
Address1	string	Employer/Payer's US address (street or post office box of that locality). Size Range: ..46
Address2	string	Optional: Employer/Payer's suite or apartment. Size Range: ..46
City	string	Employer/Payer's city. Size Range: ..50
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Employer/Payer's zip code. Size Range: 5..10
ForeignAddress	Object	If IsForeign is true, pass the foreign address of the business.
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality). Size Range: ..50
Address2	string	Optional: Employer/Payer's suite or apartment. Size Range: ..50
City	string	Employer/Payer's city. Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..50
Country	string	Employer/Payer's country. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Employer/Payer's postal code. Size Range: ..16
ReturnData	Object	Contains the return information.
FormUCE101	Object	Identifies the Form UC101 data.
UIIdNum	Object	Employer ID number. Sample format: XXXXXXX
IsNoWageReported	Boolean	When true, indicates that no wage has been reported.
TotWagesAmt	Number	Total wages reported for the quarter. Size Range: ..99999999999.99
ExcessWageAmt	Number	Excess wages calculated for the quarter. Size Range: ..99999999999.99
TaxableWagesAmt	Number	Taxable wages calculated for the quarter. Size Range: ..99999999999.99
TaxRate	Number	Tax rate for the quarter. Size Range: 1-100
UITaxAmt	Number	UI tax calculated for the quarter. Size Range: 0-99999999999999999.99
Penalty	Number	Optional: Penalty for the quarter. Size Range: 0-999999999.99
Interest	Number	Optional: Interest for the quarter. Size Range: 0-999999999.99
BalanceDue	Number	Amount due. Size Range: 0-999999999.99
Overpayment	Number	Reimbursable charges. Size Range: 0-999999999.99
NumOfEmployees	Object	Identifies the total number of employees for the quarter.
Month1TotEmployees	string	Total number of employees in month 1 of the quarter. Size Range: 0-9999999
Month2TotEmployees	string	Total number of employees in month 2 of the quarter. Size Range: 0-9999999
Month3TotEmployees	string	Total number of employees in month 3 of the quarter. Size Range: 0-9999999
EmployeeDetails	Object	Object to identify the employee details.
EmpSequenceId	string	A unique number to identify this record. Size Range: ..10
EmployeeId	Guid	Optional: A unique ID generated by TaxBandits after the return is created and returned in the response.
EmpRef	string	A unique identifier of the employee.
SSN	string	Employee's Social Security Number (SSN). Size Range: 9-11
FirstNm	string	Employee's first name. Size Range: 15
MiddleNm	string	Optional: Employee's middle name. Size Range: 15
LastNm	string	Employee's last name. Size Range: 20
Suffix	string	Optional: Employee's suffix. Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
SocCode	string	SOC code of the employee. Sample format: 11-0000
DateJoined	string	Enter the date the employee was first employed. Format: MM/DD/YYYY or MM-DD-YYYY
DateTerminated	string	Enter the date of separation. Format: MM/DD/YYYY or MM-DD-YYYY
IsOfficer	Boolean	When true, indicates that the employee is an officer.
IsMonth1	Boolean	When true, indicates the employee was employed in month 1 of the quarter.
IsMonth2	Boolean	When true, indicates the employee was employed in month 2 of the quarter.
IsMonth3	Boolean	When true, indicates the employee was employed in month 3 of the quarter.
NumOfHoursWorked	Number	Number of hours worked by the employee. Size Range: ..999
GrossWagesAmt	Number	Gross wages of the employee. Size Range: ..99999999999.99
TaxableAmt	Number	Taxable wages of the employee. Size Range: ..99999999999.99
ExcessAmt	Number	Excess wages of the employee. Size Range: ..99999999999.99
OutOfStateWagesAmt	Number	Other-State wages of the employee. Size Range: ..99999999999.99

Request Params

"statefilings/scui/Get?RecordId=01999580-9061-77d5-86be-bc5686a6a5a5&SubmissionId=0199c8cc-6d8a-77a7-b401-aed04901d431"

Response JSON

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

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "0199c8cc-6d8a-77a7-b401-aed04901d431",
  "StateUIRecords": [
      {
          "SequenceId": "001",
          "ReturnHeader": {
              "Qtr": "Q1",
              "TaxYr": "2025",
              "Business": {
                  "BusinessId": "f319049f-2964-4132-a47d-3e89ed2db430",
                  "BusinessNm": "Snowdaze LLC",
                  "PayerRef": null,
                  "FirstNm": null,
                  "MiddleNm": null,
                  "LastNm": null,
                  "Suffix": null,
                  "TradeNm": "Mayfill Tech",
                  "IsEIN": true,
                  "EINorSSN": "32-7364849",
                  "Email": "james@sample.com",
                  "ContactNm": "John",
                  "Phone": "(789) 456-1231",
                  "PhoneExtn": null,
                  "Fax": null,
                  "BusinessType": null,
                  "SigningAuthority": null,
                  "KindOfEmployer": null,
                  "KindOfPayer": null,
                  "IsBusinessTerminated": false,
                  "IsForeign": false,
                  "USAddress": {
                      "Address1": "12 Main st",
                      "Address2": "CC avenue",
                      "City": "Rock Hill",
                      "State": "SC",
                      "ZipCd": "29730"
                  },
                  "ForeignAddress": null,
                  "ACADetails": null
              }
          },
          "ReturnData": {
              "FormUCE101": {
                  "UIIdNum": 893432567,
                  "IsNoWageReported": false,
                  "TotWagesAmt": 2000,
                  "ExcessWageAmt": 2000,
                  "TaxableWagesAmt": 800,
                  "TaxRate": 0,
                  "UITaxAmt": 0,
                  "Penalty": 100,
                  "Interest": 100,
                  "BalanceDue": 200,
                  "Overpayment": 0,
                  "NumOfEmployees": {
                      "Month1TotEmployees": null,
                      "Month2TotEmployees": null,
                      "Month3TotEmployees": null
                  },
                  "EmployeeDetails": [
                      {
                          "EmpSequenceId": "01",
                          "EmployeeId": "b75ef5ba-3397-4550-b602-9bc2d22509eb",
                          "EmpRef": "8291",
                          "SSN": "783-64-0382",
                          "FirstNm": "James",
                          "MiddleNm": "A",
                          "LastNm": "Smith",
                          "Suffix": "Sr",
                          "SocCode": "11-0000",
                          "DateJoined": "07/18/2024",
                          "DateTerminated": null,
                          "IsOfficer": false,
                          "IsMonth1": true,
                          "IsMonth2": false,
                          "IsMonth3": false,
                          "NumOfHoursWorked": 240,
                          "GrossWagesAmt": 1000,
                          "TaxableAmt": 400,
                          "ExcessAmt": 1000,
                          "OutOfStateWagesAmt": 700
                      },
                      {
                          "EmpSequenceId": "02",
                          "EmployeeId": "7879ed13-2741-45d8-809f-0325fa9731f7",
                          "EmpRef": "8293",
                          "SSN": "738-79-2346",
                          "FirstNm": "Steve",
                          "MiddleNm": "A",
                          "LastNm": "Smith",
                          "Suffix": "Sr",
                          "SocCode": "11-0000",
                          "DateJoined": "07/18/2024",
                          "DateTerminated": null,
                          "IsOfficer": false,
                          "IsMonth1": true,
                          "IsMonth2": false,
                          "IsMonth3": false,
                          "NumOfHoursWorked": 240,
                          "GrossWagesAmt": 1000,
                          "TaxableAmt": 400,
                          "ExcessAmt": 1000,
                          "OutOfStateWagesAmt": 700
                      }
                  ]
              }
          }
      }
  ],
  "Errors": null
}

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
  "StatusCode": "400",
  "StatusName": "BadRequest",
  "StatusMessage": "Validation error has occurred",
  "SubmissionId": null,
  "StateWHRecords": null,
  "Errors": [
      {
          "Id": "S00-000098",
          "Name": "SubmissionId",
          "Message": "SubmissionId is invalid."
      }
  ]
}

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
  "StatusCode": 401,
  "StatusName": "Unauthorized",
  "StatusMessage": "Invalid authorization credentials",
  "Errors": [
      {
          "Id": "AUTH-100018",
          "Name": "Authorization",
          "Message": "JWT EXPIRED"
      }
  ]
}

W-9/W-8 Automation

1099 Automation

TIN Matching

W-2 Automation

941/940 Automation

1098-T Automation

ACA Automation

Extension Automation

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Get

Get

Request Params

Response Body

Request Params​

Response JSON​

Request Params

Response JSON