Skip to main content
Version: 2.0.0

Get

Get

Use this endpoint to retrieve the information of a previously created VA FC 20-21 form for the corresponding employer (payer). Your request JSON must include the corresponding SubmissionId and the RecordId (optional) for the forms.

GET statefilings/vaui/get 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdGuidOptional An unique identifier generated by TaxBandits when a FC2021 return is created. Mention the return's Record ID that you want to get.

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 FC 20-21 is to be filed.
QtrStringThe quarter for which the Form FC 20-21 is to be filed.
BusinessobjectObject to identify the Business Details.
BusinessIdGuidThe unique Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint.
PayerRefstringThe unique identifier for the payer.
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.
IndividualNmobjectThe individual name fields instead of BusinessNm.
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.
FormFC2021ObjectIdentifies the Form FC 20-21 data.
UIIdNumberStringEmployer's Virginia Unemployment Account Number.
Size Range: 10 digits
Allowed values

00######## or 000#######

IsNoWageReportedBooleanWhen true, indicates that no wage is reported in this quarter.
TotalGrossWagesNumberTotal gross wages reported for all employees for the quarter.
TotalTaxableWagesNumberTotal taxable wages reported for all employees for the quarter.
TotalExcessWagesNumberTotal excess wages reported for all employees for the quarter.
UITaxRateNumberTax rate for the quarter.
UITaxDueNumberUnemployment insurance tax due for the reported taxable wages.
InterestNumberInterest for the quarter.
PenaltyNumberPenalty for the quarter.
TotalUITaxDueNumberTotal unemployment insurance tax due for the quarter.
NumberOfEmployeesObjectIdentifies the total number of employees for the quarter.
TotalMonth1EmployeesstringTotal number of employees in month 1 of the quarter.
TotalMonth2EmployeesstringTotal number of employees in month 2 of the quarter.
TotalMonth3EmployeesstringTotal number of employees in month 3 of the quarter.
EmployeeDetailsObjectObject to identify the employee details.
EmployeeSequenceIdstringA unique number to identify this record.
EmployeeIdGuidA unique ID generated by TaxBandits after the return is created and returned in the response.
EmployeeRefstringUser-provided employee reference identifier
SSNstringEmployee's Social Security Number (SSN).
FirstNmstringEmployee's first name.
MiddleNmstringEmployee's middle name.
LastNmstringEmployee's last name.
SuffixstringEmployee's suffix.
Addressobject[]Address information of the Employee.
Address1stringStreet address or PO Box.
Size Range: 46
Address2stringOptional Suite or apartment number.
Size Range: 46
CitystringEmployee's city.
Size Range: 50
ProvinceOrStatestringEmployee's province or state name.
When the country code is US:
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"

When the country code is CA:
Allowed values

"AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT"

Note: The size range is set to 50 for all countries except the United States and Canada.
ZipcdstringEmployee's ZIP code.
Size Range: 5-16
CountrystringEmployee's 2-character country code.
Allowed values

"US","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"

GrossWagesNumberTotal gross wages paid to the employee during the reporting quarter.
ErrorsObject[]Shows detailed error information.
IdstringTotal due amount.
NamestringName of the validation error.
MessagestringDescription of the validation error.

Request JSON​

"statefilings/VAUI/Get?RecordId=f5c0b155-7261-4f9d-b0bc-cad7a0f69d2e&SubmissionId=01993c45-e77e-7383-823a-d13273fd717c"

Response JSON​

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

{
"SubmissionId": "01a167c6-ab4e-7347-ad84-ccb5e6e4b7c7",
"StateUIRecords": [
{
"SequenceId": "001",
"RecordId": "01a167c6-bd00-77d8-ac28-6c38091ceaf4",
"ReturnHeader": {
"Qtr": "Q3",
"TaxYear": "2026",
"Business": {
"BusinessId": "42ba5f00-c86c-4dd5-af96-88007a5e455b",
"PayerRef": null,
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "26-6108431"
},
"BusinessNm": "Snowdaze LLC",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": "F523893E-DAFD-489A-909E-F4CE15C24646",
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 100",
"City": "Richmond",
"ProvinceOrState": "VA",
"ZipCd": "23219",
"Country": "US"
}
},
"Address": {
"Address1": "456 Market St",
"Address2": "Suite 200",
"City": "Virginia Beach",
"ProvinceOrState": "VA",
"ZipCd": "23451",
"Country": "US"
},
"ContactDetails": {
"FirstNm": "James",
"MiddleNm": "A",
"LastNm": "Anderson",
"Suffix": "Jr",
"Phone": "(564) 650-1651",
"PhoneExtn": "101",
"Email": "contact@snowdaze.com",
"Fax": "(803) 555-5678"
},
"BusinessType": "PART",
"SigningAuthority": {
"FirstNm": "Ambrane",
"MiddleNm": "A",
"LastNm": "Cavil",
"Suffix": "",
"Phone": "(803) 555-1000",
"PhoneExtn": "111",
"BusinessMemberType": "OWNER"
}
}
},
"ReturnData": {
"FormFC2021": {
"UIIdNumber": "0089304997",
"IsNoWageReported": false,
"TotalGrossWages": 30000,
"TotalExcessWages": 9000,
"TotalTaxableWages": 21000,
"UITaxRate": "2.5",
"UITaxDue": 525,
"Penalty": 20.22,
"Interest": 20.32,
"TotalUITaxDue": 565.54,
"NumberOfEmployees": {
"TotalMonth1Employees": 3,
"TotalMonth2Employees": 3,
"TotalMonth3Employees": 3
},
"EmployeeDetails": [
{
"EmployeeSequenceId": "01",
"EmployeeId": "e450c223-d62b-42a1-b883-a7bf9e9ab547",
"EmployeeRef": null,
"SSN": "001-45-6924",
"FirstNm": "John",
"MiddleNm": "A",
"LastNm": "Smith",
"Suffix": "Sr",
"Address": {
"Address1": "789 Broad St",
"Address2": "Suite 300",
"City": "Roanoke",
"ProvinceOrState": "VA",
"ZipCd": "24011",
"Country": "US"
},
"GrossWages": 10000
},
{
"EmployeeSequenceId": "02",
"EmployeeId": "0f8c11be-c2d5-4d3b-9499-16a10dffbf1b",
"EmployeeRef": null,
"SSN": "001-45-6900",
"FirstNm": "roger",
"MiddleNm": "J",
"LastNm": "peter",
"Suffix": "Jr",
"Address": {
"Address1": "321 King St",
"Address2": "Suite 400",
"City": "Alexandria",
"ProvinceOrState": "VA",
"ZipCd": "22314",
"Country": "US"
},
"GrossWages": 10000
},
{
"EmployeeSequenceId": "03",
"EmployeeId": "fa2e473a-f7bd-4583-8c76-65b590f03515",
"EmployeeRef": null,
"SSN": "001-45-6220",
"FirstNm": "Elise",
"MiddleNm": "J",
"LastNm": "Sullivan",
"Suffix": null,
"Address": {
"Address1": "654 Main St",
"Address2": "Suite 500",
"City": "Charlottesville",
"ProvinceOrState": "VA",
"ZipCd": "22902",
"Country": "US"
},
"GrossWages": 10000
}
]
}
}
}
],
"Errors": null
}