Create
Create
POST StateFilings/TNUI/Create Request Body
| Field | Type | Description |
|---|---|---|
| StateUIRecords | Object[] | Object to identify the records. |
| SequenceId | String | A unique identifier for this record. Size Range: ..50 |
| ReturnHeader | Object | Contains information about the Business details. |
| TaxYr | string | The tax year for which the Form LB0456 is to be filed.Allowed values"2025" |
| Qtr | string | The quarter for which the Form LB0456 is to be filed.Allowed values"Q1", "Q2", "Q3", "Q4" |
| Business | Object | Object to identify the business details. |
| BusinessId | Guid | Optional Use the unique identifier 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 the Employer Identification Number (EIN) Note: IsEIN should always be set to true, as EIN is the only allowed TIN type for state payroll forms. Size Range: 9-11 |
| string | Optional Email address of the business. Size Range: ..100 | |
| ContactNm | string | Optional Name of the person who can be contacted by the State Agency. 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 | Type of business. Size Range: 4 Allowed values"ESTE", "PART", "CORP", "EORG", "SPRO" |
| SigningAuthority | object | Details of the person who is authorized to sign the return. |
| Name | string | Name of the signing authority. Size Range: ..35 |
| Phone | string | Phone number of the signing authority. Size Range: 10 |
| BusinessMemberType | string | Business title of the signing authority Size Range: 5..29 Allowed values"CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
| KindOfEmployer | string | Optional Identifies the kind of employer.Allowed values"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
| KindOfPayer | string | Optional Identifies the kind of payer.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 to 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. |
| FormLB0456 | Object | Identifies the Form LB0456 data. |
| UIIdNum | string | Employer ID number. Sample format: XXXX-XXX X Size Range:8 |
| IsNoWageReported | Boolean | When true, indicates that no wages were reported for the quarter. |
| TaxRate | Number | Tax rate for the quarter. Size Range: 1-100 |
| NumOfEmployees | Object | Identifies the total number of employees for the quarter. |
| Month1Employees | string | Total number of employees in month 1 of the quarter. Size Range: 0-9999999 |
| Month2Employees | string | Total number of employees in month 2 of the quarter. Size Range: 0-9999999 |
| Month3Employees | string | Total number of employees in month 3 of the quarter. Size Range: 0-9999999 |
| L1GrossWages | Number | Total wages reported for the quarter. Size Range: ..99999999999.99 |
| L2ExcessWages | Number | Excess wages for the quarter. Size Range: ..99999999999.99 |
| L3TaxableWages | Number | Taxable wages for the quarter. Size Range: ..99999999999.99 |
| L4TaxDue | Number | Tax due for the quarter. Size Range: 0-99999999999.99 |
| L5Interest | Number | Optional Interest for the quarter. Size Range: 0-999999999.99 |
| L8IPenalty | Number | Optional Penalty for the quarter. Size Range: 0-999999999.99 |
| L10BalanceDue | Number | Total tax due for the quarter Size Range: 0-999999999.99 |
| 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" |
| 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", |
| ZipCd | string | Employer/Payer's zip code. Size Range: 5..10 |
| GrossWages | Number | Employee Gross wages of the employee. Size Range: ..99999999999.99 |
| TaxableWages | Number | Employee Taxable wages of the employee. Size Range: ..99999999999.99 |
| ExcessWages | Number | Employee Excess wages of the employee. Size Range: ..99999999999.99 |
| OccupationCode | string | Employee’s SOC (6-digit) or O-NET (8-digit) code. Size Range: 8 digits |
| HireDate | string | Enter the employee’s hire dateAllowed valuesMM/DD/YYYY or MM-DD-YYYY |
| EmploymentStatus | string | Employee’s most recent employment status.Allowed valuesFull_Time, Part_Time, Seasonal |
| IsMonth1Emp | Boolean | When true, indicates the employee was employed during the month 1 of the quarter. |
| IsMonth2Emp | Boolean | When true, indicates the employee was employed during the month 2 of the quarter. |
| IsMonth3Emp | Boolean | When true, indicates the employee was employed during the month 3 of the quarter. |
Response Body
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier for a submission. |
| SuccessRecords | object[] | Provides detailed information about the success status of Form RT-6 records. |
| SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the response for your reference. |
| BusinessId | Guid | Unique identifier for the business (payer) generated by TaxBandits. |
| PayerRef | string | Unique identifier for the business (payer) provided by you.. |
| RecordId | Guid | A unique identifier generated by TaxBandits when a Form RT-6 return is created. |
| FormType | string | Type of form. |
| Status | string | Returns the record status. |
| StatusTs | string | Returns the date and time when the return was created. |
| Info | string | Provides additional information about the return. |
| Errors | object[] | Displays error information related to the state returns of Form RT-6. |
| Id | string | Returns the validation error ID. |
| Name | string | Name of the validation error. |
| ErrorRecords | object[] | Provides detailed information about the error status of Form RT-6 records. |
| SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the response for your reference. |
| RecordId | Guid | Unique identifier for the record. |
| Errors | object[] | Displays detailed error information. |
| Id | string | Returns the validation error ID. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request JSON
- Sample 1
Create NCUI return for each quarter of the tax year
{
"StateUIRecords": [
{
"SequenceId": "001",
"ReturnHeader": {
"TaxYr": "2025",
"Qtr": "Q4",
"Business": {
"BusinessId": null,
"BusinessNm": "Snowdaze LLC",
"TradeNm": "Mayfill Tech",
"IsEIN": true,
"EINorSSN": "74-8756945",
"Email": "james@sample.com",
"ContactNm": "John",
"Phone": "7894561231",
"IsForeign": false,
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "James Smith",
"Phone": "9934567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"USAddress": {
"Address1": "12 Main st",
"Address2": "CC avenue",
"City": "Rock Hill",
"State": "SC",
"ZipCd": "29730"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": {
"FormLB0456": {
"UIIdNum": "6457354575-354",
"IsNoWageReported": false,
"TaxRate": "10",
"NumOfEmployees": {
"Month1Employees": "50",
"Month2Employees": "124",
"Month3Employees": "46"
},
"L1GrossWages": "500.00",
"L2ExcessWages": "400.00",
"L3TaxableWages": "500.00",
"L4TaxDue": "0.00",
"L5Interest": "0.00",
"L8Penalty": "0.00",
"L10BalanceDue": "0.00",
"EmployeeDetails": [
{
"EmpSequenceId": "1",
"EmployeeId": null,
"SSN": "001-45-6924",
"FirstNm": "John",
"MiddleNm": "A",
"LastNm": "Smith",
"Suffix": "Sr",
"USAddress": {
"Address1": "12 Main st",
"Address2": "CC avenue",
"City": "Rock Hill",
"State": "SC",
"ZipCd": "29730"
},
"GrossWages": 1000,
"TaxableWages": 1000,
"ExcessWages": 0,
"OccupationCode": "00-0000.00",
"HireDate": "12/21/2025",
"EmploymentStatus": "Full_Time",
"IsMonth1": true,
"IsMonth2": true,
"IsMonth3": true
},
{
"EmpSequenceId": "1",
"EmployeeId": null,
"SSN": "001-45-6924",
"FirstNm": "John",
"MiddleNm": "A",
"LastNm": "Smith",
"Suffix": "Sr",
"USAddress": {
"Address1": "12 Main st",
"Address2": "CC avenue",
"City": "Rock Hill",
"State": "SC",
"ZipCd": "29730"
},
"GrossWages": 1000,
"TaxableWages": 1000,
"ExcessWages": 0,
"OccupationCode": "00-0000.00",
"HireDate": "12/21/2025",
"EmploymentStatus": "Full_Time",
"IsMonth1": true,
"IsMonth2": true,
"IsMonth3": true
}
]
}
}
}
]
}
Response JSON
- 200
- 400
- 401
Success Response - This is a sample response for successful API requests.
{
"StatusCode": "200",
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "0199c873-73a6-777d-a932-0453fa4b9b13",
"SuccessRecords": [
{
"SequenceId": "001",
"BusinessId": "fd1ab53b-7175-4230-8fa3-80c73e72fecf",
"PayerRef": null,
"RecordId": "0199c873-7683-74c9-9cb6-b72655998a89",
"EmployeeData": [
{
"EmployeeId": "4e288a51-e54b-464d-afc8-23790a8beb5a",
"EmpRef": "8290"
},
{
"EmployeeId": "3cf1a21d-d0ce-438f-bdbb-e3c3bd129eb7",
"EmpRef": "82928"
}
],
"FormType": "LB0456",
"Status": "CREATED",
"StatusTs": "2025-10-09 06:10:34 -04:00",
"Info": null,
"Errors": null
}
],
"ErrorRecords": null,
"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,
"SuccessRecords": null,
"ErrorRecords": [
{
"SequenceId": "001",
"RecordId": null,
"Errors": [
{
"Id": "S00-000190",
"Name": "Quarter",
"Message": "Return already exists for a given quarter and tax year."
}
]
}
],
"Errors": null
}
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"
}
]
}