Version: 1.7.3

Get

Use this endpoint to retrieve the information of a previously created NC-5Q/NC-3 forms for the corresponding business. Your request JSON must include the corresponding SubmissionId and the RecordId (optional) for the forms.

GET StateFilings/NCWH/Get

Run in Postman

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
RecordId	Guid	An unique identifier generated by TaxBandits when a NC-5Q return is created. Mention the return's Record ID that you want to get.

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
StateWHRecords	Object[]	Object to create Form NC-5Q
SequenceId	String	A unique number given by an inbound application to identify failed records. Size Range: ..50
ReturnHeader	Object	Identifies the supporting details of Form NC-5Q.
Qtr	String	The quarter for which Form NC-5Q needs to be filed.
TaxYr	String	The tax year for which Form NC-5Q needs to be filed. Allowed values 2025
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
Email	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[]	Identifies the Form NC-5Q data.
FormNC5Q	Object	North Carolina withholding quarterly tax return.
WHIdNum	String	North Carolina withholding account number. Size Range: 9
L1TotWHTaxLiability	Number	Total tax required to be withheld Size Range: 0-99999999.99
L2TotTaxDeposit	Number	Total payments to North Carolina for quarter Size Range: ..11 Size Range: 0-99999999.99
L3BalanceDue	Number	Balance due amount for the quarter.Note: Balance due amount is required only if L1TotWHTaxLiability is greater than L2TotTaxDeposit Size Range: ..11 Size Range: 0-99999999.99
L4OverPayment	Number	Over payment amount for the quarter.Note: Over payment amount is required only if L2TotTaxDeposit is greater than L1TotWHTaxLiability Size Range: ..11 Size Range: 0-99999999.99
DepositSchedule	String	Deposit schedule of the tax deposits Allowed values "SemiWeekly"
SemiWeeklyDepositor	Object	Object to identify the semi weekly deposit schedule details
Month1TaxLiability	Object[] Object to identify the tax liability details for the first month of the quarter
Day	String	Tax Liability pay day of first month of the quarter. Allowed values "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31"
Amt	Number	Tax liability amount of the pay day. Size Range: 0-99999999.99
Month1TotTaxLiability	Number	Total tax required to be withheld for first month of quarter Size Range: 0-99999999.99
Month2TaxLiability	Object[]	Object to identify the tax liability details for the second month of the quarter
Day	String	Tax Liability pay day of second month of the quarter. Allowed values "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31"
Amt	Number	Tax liability amount of the pay day. Size Range: 0-99999999.99
Month2TotTaxLiability	Number	Total tax required to be withheld for second month of quarter Size Range: 0-99999999.99
Month3TaxLiability	Object[]	Object to identify the tax liability details for the third month of the quarter
Day	String	Tax Liability pay day of third month of the quarter. Allowed values "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31"
Amt	Number	Tax liability amount of the pay day Size Range: 0-99999999.99
Month3TotTaxLiability	Number	Total tax required to be withheld for third month of quarter Size Range: 0-99999999.99
TotQtrTaxLiabilityAmt	Number	Total tax required to be withheld for all the months of the quarter Size Range: 0-99999999.99
Errors	object[]	Shows 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 Params

"statefilings/NCWH/Get?SubmissionId=0199e6d1-cea0-706d-8926-d7dad88478d3&RecordId=0199e6d1-cf7f-747f-afcb-0e489e5ba294"

Response JSON

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

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "019c6b1d-8da2-73ab-b353-48b782750cbb",
  "StateWHRecords": [
      {
          "Sequence": "001",
          "RecordId": "019c6b1d-8ec7-760d-98b7-1fc62e62e4b2",
          "ReturnHeader": {
              "Qtr": "Q4",
              "TaxYr": "2025",
              "Business": {
                  "BusinessId": "19fc7b2f-09f0-4121-a713-613cf21bce36",
                  "BusinessNm": "SnowDaze LLC",
                  "PayerRef": null,
                  "FirstNm": null,
                  "MiddleNm": null,
                  "LastNm": null,
                  "Suffix": null,
                  "TradeNm": null,
                  "IsEIN": true,
                  "EINorSSN": "34-7662200",
                  "Email": "john@gmail.com",
                  "ContactNm": null,
                  "Phone": null,
                  "PhoneExtn": null,
                  "Fax": null,
                  "BusinessType": "ESTE",
                  "SigningAuthority": {
                      "Name": "James Smith",
                      "Phone": "(993) 456-7890",
                      "BusinessMemberType": "ADMINISTRATOR"
                  },
                  "KindOfEmployer": null,
                  "KindOfPayer": null,
                  "IsBusinessTerminated": false,
                  "IsForeign": false,
                  "USAddress": {
                      "Address1": "12 main st",
                      "Address2": null,
                      "City": "Rock Hill",
                      "State": "SC",
                      "ZipCd": "29730"
                  },
                  "ForeignAddress": null,
                  "ACADetails": null
              }
          },
          "ReturnData": {
              "FormNC5Q": {
                  "WHIdNum": "663838756",
                  "L3BalanceDue": 0,
                  "L4OverPayment": 1000,
                  "DepositSchedule": "SemiWeekly",
                  "SemiWeeklyDepositor": {
                      "Month1TaxLiability": [
                          {
                              "Day": "1",
                              "Amt": 1000
                          }
                      ],
                      "Month1TotTaxLiability": 1000,
                       "Month2TaxLiability": [
                          {
                              "Day": "1",
                              "Amt": 1000
                          }
                      ],
                       "Month2TotTaxLiability": 1000,
                      "Month3TaxLiability": [
                          {
                              "Day": "1",
                              "Amt": 1000
                          }
                      ],
                         "Month3TotTaxLiability": 1000

                  },
                  "TotQtrTaxLiabilityAmt": 3000,
                  "L1TotWHTaxLiability": 3000,
                  "L2TotTaxDeposit": 4000
              }
          }
      }
  ],
  "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,
  "StateWHRecords": null,
  "Errors": [
      {
          "Id": "S00-000098",
          "Name": "SubmissionId",
          "Message": "SubmissionId is invalid."
      }
  ]
}

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"
      }
  ]
}

W-9/W-8 Automation

1099 Automation

TIN Matching

W-2 Automation

941/940 Automation

1098-T Automation

ACA Automation

Extension Automation

1042-S Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Healthcare Market Research Platforms

Get

Get

Request Params

Response Body

Request Params​

Response JSON​

Request Params

Response JSON