Skip to main content
Version: 2.0.0

Get

Get

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

GET StateFilings/PAUI/Get 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdGuidOptional An unique identifier generated by TaxBandits when a UC2/2A 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.
StateWHRecordsObject[]Object to identify the records.
SequenceIdStringA unique identifier for this record.
ReturnHeaderObjectContains business information.
TaxYearStringThe tax year for which the Form UC2/2A is to be filed.
QtrStringThe quarter for which the Form UC2/2A 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.
FormatstringThe TIN is passed.
TINTypestringThe 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.
BusinessTypeStringLegal structure of the business.
SigningAuthorityObjectDetails of the person authorized to sign the return.
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.
FormUC2ObjectIdentifies the Form UC2/2A data.
UIIdNumberStringEmployer's Pennsylvania Unemployment Account Number.
UITaxRateStringTax rate for the quarter.
IsNoWageReportedBooleanIndicates whether no wages are being reported on the wage report.
NumberOfEmployeesObjectTotal number of employees reported for the quarter.
TotalMonth1EmployeesNumberTotal number of employees in month 1 of the quarter.
TotalMonth2EmployeesNumberTotal number of employees in month 2 of the quarter.
TotalMonth3EmployeesNumberTotal number of employees in month 3 of the quarter.
TotalGrossWagesNumberTotal wages reported for the quarter.
EmployeeUITaxDueStringTotal employee unemployment compensation contribution due for the reporting quarter, calculated at 0.07% of total gross wages.
TotalTaxableWagesNumberTaxable wages for the quarter.
EmployerUITaxDueStringTotal employer unemployment compensation contribution due for the reporting quarter, calculated by multiplying taxable wages by the applicable UC contribution rate.
UITaxDueNumberTax due for the quarter.
InterestNumberInterest for the quarter.
PenaltyNumberPenalty for the quarter.
TotalUITaxDueNumberTotal remittance due for the reporting quarter, including unemployment compensation tax, interest, and applicable penalties.
EmployeeDetailsObject[]Object to identify the employee details.
EmployeeIdGuidA unique ID generated by TaxBandits after the return is created and returned in the response.
EmployeeSequenceIdStringA unique number to identify this record.
PayeeRefStringA unique identifier for each payee completing their information. This identifier can be used in future references of the payee in the API.
SSNStringEmployee's Social Security Number (SSN).
FirstNmStringFirst name of the employee.
MiddleNmStringMiddle name of the employee.
LastNmStringLast name of the employee.
SuffixStringThe suffix of the employee.
GrossWagesNumberTotal gross wages reported for the quarter.
TaxableWagesNumberTotal taxable wages for the quarter.
ExcessWagesNumberTotal excess wages for the quarter.
NumberOfCreditWeeksNumberNumber of calendar weeks in the quarter in which the employee earned $116 or more.
ErrorsObject[]Shows detailed error information.
IdstringReturns the validation error ID.
NamestringName of the validation error.
MessagestringDescription of the validation error.

Request JSON​

"statefilings/PAUI/Get?RecordId=019e01ee-757e-7708-9c3b-ad5bb3ce2cc4&SubmissionId=019e01ee-6b5c-71a6-b4e8-70f859471064"

Response JSON​

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

{
"SubmissionId": "019e01ee-6b5c-71a6-b4e8-70f859471064",
"StateWHRecords": [
{
"SequenceId": "001",
"RecordId": "019e01ee-757e-7708-9c3b-ad5bb3ce2cc4",
"ReturnHeader": {
"Qtr": "Q1",
"TaxYear": "2026",
"Business": {
"BusinessId": "2166182e-ea40-4562-bc15-d8650c355a3e",
"PayerRef": null,
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "45-1254785"
},
"BusinessNm": "Snowdaze LLC",
"NameCtrl": "SNOW",
"Address": {
"Address1": "550 W 7th Ave",
"Address2": "Suite 1800",
"City": "Anchorage",
"ProvinceOrState": "AK",
"ZipCd": "99501",
"Country": "US"
},
"ContactDetails": {
"FirstNm": "John",
"MiddleNm": null,
"LastNm": "Anderson",
"Suffix": null,
"Phone": "3231231232",
"PhoneExtn": null,
"Email": null,
"Fax": null
},
"BusinessType": "PART",
"SigningAuthority": {
"FirstNm": "John",
"MiddleNm": null,
"LastNm": "Anderson",
"Suffix": null,
"Phone": "3231231232",
"PhoneExtn": null,
"BusinessMemberType": "OWNER"
}
}
},
"ReturnData": {
"FormUC2": {
"UIIdNumber": "99999999",
"UITaxRate": "2.7",
"IsNoWageReported": false,
"NumberOfEmployees": {
"TotalMonth1Employees": 1,
"TotalMonth2Employees": 2,
"TotalMonth3Employees": 2
},
"TotalGrossWages": 20000.00,
"EmployeeUITaxDue": "0.00",
"TotalTaxableWages": 14000.00,
"EmployerUITaxDue": "0.00",
"UITaxDue": 378.00,
"Interest": null,
"Penalty": null,
"TotalUITaxDue": 378.00,
"EmployeeDetails": [
{
"EmployeeId": "5d52556d-def9-46ae-b9e3-87ab57f96bad",
"EmployeeSequenceId": "12",
"PayeeRef": "Payref002",
"SSN": "001-45-6924",
"FirstNm": "John",
"MiddleNm": "Harry",
"LastNm": "Smith",
"Suffix": "Jr",
"GrossWages": 10000.00,
"TaxableWages": 7000.00,
"ExcessWages": 3000.00,
"NumberOfCreditWeeks": 3
}
]
}
}
}
],
"Errors": null
}