Get

Get

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

GET StateFilings/PAWH/Get 

Run in Postman

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
RecordId	Guid	A unique identifier generated by TaxBandits when a W-3 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 W-3
SequenceId	String	A unique number given by an inbound application to identify failed records. Size Range: 1-10
ReturnHeader	Object	Identifies the supporting details of Form W-3.
Qtr	String	The Quarter for which Form W-3 needs to be filed. Allowed values "Q1", "Q2", "Q3", "Q4"
TaxYr	String	The tax year for which Form W-3 needs to be filed. Allowed values "2025", "2026"
BusinessId	String	Optional: Use the unique BusinessId (Generated by TaxBandits) you received in the response of the Business CREATE Endpoint. If you do not have a BusinessId, ignore the field. By giving the BusinessId, you do not have to provide all the business information again.
Business	Object	The details of the business you're filing for.
BusinessNm	String	Name of the business. Size Range: 1-75
PayerRef	string	Optional: A unique identifier for each payer completing their information. This identifier can be used in future references to the payer in the API. Size Range: 1-50
TradeNm	String	Optional Name under which the business operates. Size Range: 1-75
IsEIN	Boolean	When true, it identifies the business with an EIN.
EINorSSN	String	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN). Size Range: 9-11
Email	String	Email address of the business. Size Range: 1-100
IsForeign	Boolean	When true, identifies the business as having a foreign address.
USAddress	Object	If IsForeign is false, pass the US address of the business.
Address1	String	Employer/Payer's US address (street address or post office box). Size Range: 1-46
Address2	String	Optional Employer/Payer's suite or apartment. Size Range: 1-46
City	String	Employer/Payer's city. Size Range: 1-50
State	String	Employer/Payer's state. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN"
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). Size Range: 1-50
Address2	String	Optional Employer/Payer's suite or apartment. Size Range: 1-50
City	String	Employer/Payer's city. Size Range: 1-50
ProvinceOrStateNm	String	Employer/Payer's province or state name. Size Range: 1-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"
PostalCd	String	Employer/Payer's postal code. Size Range: 1-16
ReturnData	Object	Identifies the Form W-3
FormW3	Object	Pennsylvania withholding tax returns.
WHIdNum	String	Pennsylvania withholding file number. Size Range: 8 or 11
DepositSchedule	string	The filing frequency of Form W-3 Allowed values "QUARTERLY", "MONTHLY", "SEMI_MONTHLY", "SEMI_WEEKLY"
TotPayrollAmt	Number	Total pennsylvania taxable wages paid for the quarter. Size Range: 0-999999999.99
TaxWH	Number	Pennsylvania income tax withheld from all sources for the filing period Size Range: 0-99999999.99
TaxPaid	Number	Pennsylvania income tax paid from all sources for the filing period Size Range: 0-99999999.99
Overpayment	Number	Overpayment amount. Size Range: 0-999999999.99
BalanceDue	Number	Balance due amount. Size Range: 0-999999999.99
MonthlyWHDeposit	Object	Identifies details of monthly tax withheld deposits.
Month1WHAmt	Number	Total Pennsylvania income tax withheld for the month 1. Size Range: 0-999999999.99
Month2WHAmt	Number	Total Pennsylvania income tax withheld for the month 2. Size Range: 0-999999999.99
Month3WHAmt	Number	Total Pennsylvania income tax withheld for the month 3. Size Range: 0-999999999.99
SemiMonthlyWHDeposit	Object	Identifies details of semi-monthly tax withheld deposits.
Month1FHWHAmt	Number	Total Pennsylvania income tax withheld for the first half of Month 1. Size Range: 0-999999999.99
Month1SHWHAmt	Number	Total Pennsylvania income tax withheld for the second half of Month 1. Size Range: 0-999999999.99
Month2FHWHAmt	Number	Total Pennsylvania income tax withheld for the first half of Month 2. Size Range: 0-999999999.99
Month2SHWHAmt	Number	Total Pennsylvania income tax withheld for the second half of Month 2. Size Range: 0-999999999.99
Month3FHWHAmt	Number	Total Pennsylvania income tax withheld for the first half of Month 3. Size Range: 0-999999999.99
Month3SHWHAmt	Number	Total Pennsylvania income tax withheld for the second half of Month 3. Size Range: 0-999999999.99
SemiWeeklyWHDeposit	Object	Identifies details of semi-weekly tax withheld deposits.
Period1	Number	Total Pennsylvania income tax withheld for Period 1 of the semi-weekly deposit. Size Range: 0-999999999.99
Period2	Number	Total Pennsylvania income tax withheld for Period 2 of the semi-weekly deposit. Size Range: 0-999999999.99
Period3	Number	Total Pennsylvania income tax withheld for Period 3 of the semi-weekly deposit. Size Range: 0-999999999.99
Period4	Number	Total Pennsylvania income tax withheld for Period 4 of the semi-weekly deposit. Size Range: 0-999999999.99
Period5	Number	Total Pennsylvania income tax withheld for Period 5 of the semi-weekly deposit. Size Range: 0-999999999.99
Period6	Number	Total Pennsylvania income tax withheld for Period 6 of the semi-weekly deposit. Size Range: 0-999999999.99
Period7	Number	Total Pennsylvania income tax withheld for Period 7 of the semi-weekly deposit. Size Range: 0-999999999.99
Period8	Number	Total Pennsylvania income tax withheld for Period 8 of the semi-weekly deposit. Size Range: 0-999999999.99
Period9	Number	Total Pennsylvania income tax withheld for Period 9 of the semi-weekly deposit. Size Range: 0-999999999.99
Period10	Number	Total Pennsylvania income tax withheld for Period 10 of the semi-weekly deposit. Size Range: 0-999999999.99
Period11	Number	Total Pennsylvania income tax withheld for Period 11 of the semi-weekly deposit. Size Range: 0-999999999.99
Period12	Number	Total Pennsylvania income tax withheld for Period 12 of the semi-weekly deposit. Size Range: 0-999999999.99
Period13	Number	Total Pennsylvania income tax withheld for Period 13 of the semi-weekly deposit. Size Range: 0-999999999.99
Period14	Number	Total Pennsylvania income tax withheld for Period 14 of the semi-weekly deposit. Size Range: 0-999999999.99
Period15	Number	Total Pennsylvania income tax withheld for Period 15 of the semi-weekly deposit. Size Range: 0-999999999.99
Period16	Number	Total Pennsylvania income tax withheld for Period 16 of the semi-weekly deposit. Size Range: 0-999999999.99
Period17	Number	Total Pennsylvania income tax withheld for Period 17 of the semi-weekly deposit. Size Range: 0-999999999.99
Period18	Number	Total Pennsylvania income tax withheld for Period 18 of the semi-weekly deposit. Size Range: 0-999999999.99
Period19	Number	Total Pennsylvania income tax withheld for Period 19 of the semi-weekly deposit. Size Range: 0-999999999.99
Period20	Number	Total Pennsylvania income tax withheld for Period 20 of the semi-weekly deposit. Size Range: 0-999999999.99
Period21	Number	Total Pennsylvania income tax withheld for Period 21 of the semi-weekly deposit. Size Range: 0-999999999.99
Period22	Number	Total Pennsylvania income tax withheld for Period 22 of the semi-weekly deposit. Size Range: 0-999999999.99
Period23	Number	Total Pennsylvania income tax withheld for Period 23 of the semi-weekly deposit. Size Range: 0-999999999.99
Period24	Number	Total Pennsylvania income tax withheld for Period 24 of the semi-weekly deposit. Size Range: 0-999999999.99
Period25	Number	Total Pennsylvania income tax withheld for Period 25 of the semi-weekly deposit. Size Range: 0-999999999.99
Period26	Number	Total Pennsylvania income tax withheld for Period 26 of the semi-weekly deposit. Size Range: 0-999999999.99
Period27	Number	Total Pennsylvania income tax withheld for Period 27 of the semi-weekly deposit. Size Range: 0-999999999.99
TotQtrTaxLiabAmt	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/PAWH/get?SubmissionId=019db3c1-8275-71c4-8899-4f3ec8dff392"

Response JSON

200

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

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "019dcd76-97b6-7659-b3e3-c475ba901ef9",
  "StateWHRecords": [
      {
          "SequenceId": "001",
          "RecordId": "019dcd76-98d6-778b-bc88-3a30c5b3a2bc",
          "ReturnHeader": {
              "Qtr": "Q2",
              "TaxYr": "2025",
              "Business": {
                  "BusinessId": "dcb6d480-b798-4be4-8ff9-ed22b3623a00",
                  "BusinessNm": "Keystone Manufacturing LLC",
                  "PayerRef": "Keystone123",
                  "FirstNm": null,
                  "MiddleNm": null,
                  "LastNm": null,
                  "Suffix": null,
                  "TradeNm": "Keystone Mfg",
                  "IsEIN": true,
                  "EINorSSN": "23-6789128",
                  "Email": "info@keystonemfg.com",
                  "ContactNm": "Michael Turner",
                  "Phone": "(717) 555-4821",
                  "PhoneExtn": "101",
                  "Fax": "(717) 555-4899",
                  "BusinessType": "ESTE",
                  "SigningAuthority": {
                      "Name": "Michael Turner",
                      "Phone": "(717) 555-4821",
                      "BusinessMemberType": "ADMINISTRATOR"
                  },
                  "KindOfEmployer": "NONGOVT501C",
                  "KindOfPayer": "REGULAR941",
                  "IsBusinessTerminated": false,
                  "IsForeign": false,
                  "USAddress": {
                      "Address1": "1500 Market Street",
                      "Address2": "Suite 1200",
                      "City": "Philadelphia",
                      "State": "PA",
                      "ZipCd": "19102"
                  },
                  "ForeignAddress": null,
                  "ACADetails": null
              }
          },
          "ReturnData": {
              "FormW3": {
                  "WHIdNum": "00007000",
                  "DepositSchedule": "MONTHLY",
                  "TotPayrollAmt": "4000",
                  "TaxWH": "3500",
                  "TaxPaid": "2000",
                  "Overpayment": "0",
                  "BalanceDue": "1500",
                  "MonthlyWHDeposit": {
                      "Month1WHAmt": 1000,
                      "Month2WHAmt": 1500,
                      "Month3WHAmt": 1000
                  },
                  "SemiMonthlyWHDeposit": null,
                  "SemiWeeklyWHDeposit": null,
                  "TotQtrTaxLiabAmt": 3500
              }
          }
      }
  ],
  "Errors": null
}

400

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,
  "StateUIRecords": null,
  "Errors": [
      {
          "Id": "S00-000099",
          "Name": "RecordId",
          "Message": "RecordId is invalid."
      }
  ]
}