Skip to main content
Version: 2.0.0

Get

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 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdGuidA unique identifier generated by TaxBandits when a Form UCE-101 return is created.

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier created by TaxBandits for each submission.
StateUIRecordsObject[]Object to identify the records.
SequenceIdStringA unique identifier for this record.
ReturnHeaderObjectContains business information.
TaxYearStringThe tax year for which the Form UCE101 is to be filed.
QtrStringThe quarter for which the Form UCE101 is to be filed.
BusinessobjectObject to identify the Business Details.
BusinessIdGuidThe unique Business ID (Generated by TaxBandits) that is received in the response of the Business CREATE Endpoint.
PayerRefstringThe unique identifier for the payer. Can replace BusinessId in future requests.
IsDefaultBusinessBooleanWhen set to TRUE, this business will be set as the default across requests that do not specify a business.
TINDetailsobjectTIN information for the business.
FormatstringSpecifies how the TIN is passed.
TINTypestringSpecify the TIN type of the business.
TINstringThe TIN value according to the Format selected.
IndividualNmobjectobject to identify Individual name
FirstNmstringThe first name of the individual.
MiddleNmstringMiddle name of the individual.
LastNmstringThe last name of the individual.
SuffixstringSuffix of the individual's name.
BusinessNmstringLegal name of the business.
NameCtrlstringName control of the business as registered with the IRS.
DBADetailsobject[]DBA (Doing Business As) information.
DBANmstringName of the DBA.
DBARefstringUnique identifier for the DBA.
DBAIdGuidTaxBandits-generated DBA identifier.
Addressobject[]Address information of the DBA.
Address1stringStreet address or PO Box.
Address2stringSuite or apartment number.
CitystringDBA's city.
ProvinceOrStatestringDBA's province or state name.
ZipcdstringDBA's ZIP code.
CountrystringDBA's 2-character country code.
EmailstringEmail address of the Business.
AddressobjectPrimary address of the business.
Address1stringStreet address or PO Box of the business.
Address2stringSuite or apartment number of the business.
CitystringCity of the business.
ProvinceOrStatestringProvince or state name of the business.
ZipCdstringZIP code of the business.
Countrystring2-character country code of the business.
ContactDetailsobject[]Details of the person the IRS can contact regarding the given business.
FirstNmstringFirst name of the contact person.
MiddleNmstringMiddle name of the contact person.
LastNmstringLast name of the contact person.
SuffixstringThe suffix of the contact person.
PhonestringPhone number of the contact person.
PhoneExtnstringPhone extension number.
EmailstringEmail address of the contact person.
FaxstringFax number of the contact person.
ReturnDataObjectContains the return information.
FormUCE101ObjectIdentifies the Form UC101 data.
UIIdNumstringEmployer ID number.
IsNoWageRptdBooleanWhen true, indicates that no wage has been reported.
TotGrossWagesNumberTotal wages reported for the quarter.
TotExcessWagesNumberExcess wages calculated for the quarter.
TotTaxableWagesNumberTaxable wages calculated for the quarter.
UITaxRateNumberTax rate for the quarter.
UITaxDueNumberUI tax calculated for the quarter.
PenaltyNumberPenalty for the quarter.
InterestNumberInterest for the quarter.
TotUIDueNumberAmount due.
OverpaymentNumberReimbursable charges.
NumOfEmpObjectIdentifies the total number of employees for the quarter.
TotMonth1EmpstringTotal number of employees in month 1 of the quarter.
TotMonth2EmpstringTotal number of employees in month 2 of the quarter.
TotMonth3EmpstringTotal number of employees in month 3 of the quarter.
EmpDetailsObjectObject to identify the employee details.
EmployeeSequenceIdstringA unique number to identify this record.
EmpIdGuidA unique ID generated by TaxBandits after the return is created and returned in the response.
EmployeeRefstringA unique identifier of the employee.
SSNstringEmployee's Social Security Number (SSN).
FirstNmstringEmployee's first name.
MiddleNmstringEmployee's middle name.
LastNmstringEmployee's last name.
SuffixstringEmployee's suffix.
SocCodestringSOC code of the employee.
JoinedDtstringThe date the employee was first employed.
TerminatedDtstringThe date of separation.
IsOfficerBooleanWhen true, indicates that the employee is an officer.
IsMonth1BooleanWhen true, indicates the employee was employed in month 1 of the quarter.
IsMonth2BooleanWhen true, indicates the employee was employed in month 2 of the quarter.
IsMonth3BooleanWhen true, indicates the employee was employed in month 3 of the quarter.
NumOfHrsWrkdNumberNumber of hours worked by the employee.
GrossWagesNumberGross wages of the employee.
TaxableWagesNumberTaxable wages of the employee.
ExcessWagesNumberExcess wages of the employee.
OutOfStateWagesNumberOther-State wages of the employee.
Errorsobject[]Shows detailed error information
IdstringReturns the validation error Id
NamestringName of the validation error
MessagestringDescription of the validation error

Request JSON​

"statefilings/scui/get?SubmissionId=01a0e7c2-a3cb-767b-8a6c-07c2cb64e430&RecordId=01a0e7c2-a8cd-75cc-82dd-0c3c9f6c4c50"

Response JSON​

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

{
"SubmissionId": "01a0e7c2-a3cb-767b-8a6c-07c2cb64e430",
"StateUIRecords": [
{
"SequenceId": "001",
"RecordId": "01a0e7c2-a8cd-75cc-82dd-0c3c9f6c4c50",
"ReturnHeader": {
"Qtr": "Q3",
"TaxYear": "2026",
"Business": {
"BusinessId": "eadc30eb-eb56-4783-90f9-cc5a1c2968ce",
"PayerRef": null,
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "45-9099227"
},
"BusinessNm": "Snowdaze LLC",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": "A26A7DA7-6937-4160-B862-3F28B167AE60",
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 1001",
"City": "Rock Hill",
"ProvinceOrState": "SC",
"ZipCd": "29730",
"Country": "US"
}
},
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 1001",
"City": "Rock Hill",
"ProvinceOrState": "SC",
"ZipCd": "29730",
"Country": "US"
},
"ContactDetails": {
"FirstNm": "James",
"MiddleNm": "A",
"LastNm": "Anderson",
"Suffix": "Jr",
"Phone": "(803) 555-1234",
"PhoneExtn": "101",
"Email": "contact@snowdaze.com",
"Fax": "(803) 555-5678"
},
"BusinessType": "ESTE",
"SigningAuthority": {
"FirstNm": "Ambrane",
"MiddleNm": "A",
"LastNm": "Cavil",
"Suffix": "Jr",
"Phone": "(803) 555-1000",
"PhoneExtn": "111",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": null,
"KindOfPayer": null
}
},
"ReturnData": {
"FormUCE101": {
"UIIdNum": "8934997",
"IsNoWageRptd": false,
"TotGrossWages": 1000,
"TotExcessWages": 600,
"TotTaxableWages": 400,
"UITaxRate": "10",
"UITaxDue": 40,
"Penalty": 100,
"Interest": 100,
"TotUIDue": 240,
"Overpayment": "0",
"NumOfEmp": {
"TotMonth1Emp": 1,
"TotMonth2Emp": 1,
"TotMonth3Emp": 1
},
"EmpDetails": [
{
"EmployeeSequenceId": "01",
"EmployeeId": "6069d83e-d2ea-4626-a781-d69d3c6b343a",
"EmployeeRef": null,
"SSN": "231-45-6924",
"FirstNm": "John",
"MiddleNm": "A",
"LastNm": "Smith",
"Suffix": "Sr",
"Address": {
"Address1": "12 Main st",
"Address2": "CC avenue",
"City": "Rock Hill",
"ProvinceOrState": "SC",
"ZipCd": "29730",
"Country": "US"
},
"SocCode": "12-1232",
"JoinedDt": "07/18/2024",
"TerminatedDt": "07/18/2024",
"IsOfficer": false,
"NumOfHrsWrkd": 240,
"GrossWages": 1000,
"OutOfStateWages": 540
}
]
}
}
}
],
"Errors": null
}