Skip to main content
Version: 2.0.0

Get

Get

Use this endpoint to retrieve the information of a previously created TX UI C3 form for the corresponding employer (payer). Your request JSON must include the corresponding SubmissionId and the RecordId (optional) for the forms.

GET StateFilings/TXUI/Get 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return
RecordIdGuidA unique identifier generated by TaxBandits when a Form C3 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.
Size Range: ..50
ReturnHeaderObjectContains business information.
TaxYearStringThe tax year for which the Form C3 is to be filed.
QtrStringThe quarter for which the Form C3 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.
BusinessTypeStringLegal structure of the business.
SigningAuthorityObjectDetails of the person authorized to sign the return. Mandatory for 94x forms.
FirstNmStringFirst name of the signatory.
MiddleNmStringMiddle name of the signatory.
LastNmStringLast name of the signatory.
SuffixStringThe suffix of the signatory.
PhoneStringPhone number of the signatory
PhoneExtnStringPhone extension number of the signatory.
BusinessMemberTypeStringTitle or role of the signatory.
ReturnDataObjectContains the return information.
FormC3ObjectIdentifies the Form C3 data.
UIIdNumstringEmployer ID number.
CountyCdstringEmployer's county code
UITaxRateNumberTax rate for the quarter.
NAICSCdNumberNorth American Industry Classification System code that best classifies the employer.
IsNoWageRptdBooleanWhen true, indicates that no wages were reported for the quarter.
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.
MaxEmpCountystringCounty code of the county in which there were greatest number of employees.
NumOfOutOfCountyNumberNumber of employees in more than one county in texas
IsOutOfStateWagesBooleanWhen true, it identifies that wages exist from another state.
TotGrossWagesNumberTotal gross wages reported for the quarter.
TotTaxableWagesNumberTaxable wages for the quarter.
L2TotExcessWagesNumberExcess wages for the quarter.
UITaxDueNumberTax due for the quarter.
InterestNumberInterest for the quarter.
PenaltyNumberPenalty for the quarter.
PrevQtrAdjNumberBalance due from prior periods
TotUIDueNumberTotal tax due for 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.
GrossWagesNumberGross wages of the employee.
TaxableWagesNumberTaxable wages of the employee.
ExcessWagesNumberExcess wages of the employee.
OutOfStateTaxableWagesNumberOut of state taxable wages of the employee.
IdstringReturns the validation error Id
NamestringName of the validation error
MessagestringDescription of the validation error

Request JSON​

"statefilings/txui/get?SubmissionId=01a0e7e9-75b0-72ac-bd71-fa19b230fb11&RecordId=01a0e7e9-7c7f-7420-9030-d0071e85df2b"

Response JSON​

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

{
"SubmissionId": "01a0e7e9-75b0-72ac-bd71-fa19b230fb11",
"StateUIRecords": [
{
"SequenceId": "001",
"RecordId": "01a0e7e9-7c7f-7420-9030-d0071e85df2b",
"ReturnHeader": {
"Qtr": "Q3",
"TaxYear": "2026",
"Business": {
"BusinessId": "339a0fee-9318-4058-9c7a-f24887e10a2f",
"PayerRef": null,
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "45-8982092"
},
"BusinessNm": "Snowdaze LLC",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": "FD33D409-DCAD-4ACA-BB52-092EB78A2620",
"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": {
"FormC3": {
"UIIdNum": "12-345678-0",
"CountyCd": "227",
"UITaxRate": 10,
"NAICSCd": "123431",
"IsNoWageRptd": false,
"NumOfEmp": {
"TotMonth1Emp": 1,
"TotMonth2Emp": 1,
"TotMonth3Emp": 1
},
"MaxEmpCounty": "113",
"NumOfOutOfCounty": 3,
"IsOutOfStateWages": true,
"TotGrossWages": 1000.12,
"TotTaxableWages": 1000.01,
"UITaxDue": 100,
"Interest": 1000.66,
"Penalty": 300.98,
"PrevQtrAdj": 300.67,
"TotUIDue": 1702.31,
"EmpDetails": [
{
"EmployeeSequenceId": "11",
"EmployeeId": "396b6972-31b8-4cdf-b782-89852a96b2f6",
"EmployeeRef": "Payee01",
"SSN": "761-45-6924",
"FirstNm": "Michael",
"MiddleNm": "Alan",
"LastNm": "Johnson",
"Suffix": null,
"Address": {
"Address1": "500 W 2nd St",
"Address2": "Apt 301",
"City": "Austin",
"ProvinceOrState": "TX",
"ZipCd": "78701",
"Country": "US"
},
"GrossWages": 1000.12,
"OutOfStateTaxableWages": 100
}
]
}
}
}
],
"Errors": null
}