Status

Status endpoint is used to get the current status of the Tax Return on-demand. It requires Submission ID as a parameter and Record IDs as an optional parameter.

GET FormW2C/Status 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordIds	Guid[]	Number of record Ids to get status.

Request Params

"FormW2C/Status?SubmissionId=d1f9cb0a-912f-4105-8bcf-059af43d2b31&RecordIds=63842ea1-93ac-4e5f-a3b2-df59c2d147c5"

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a Business.
FormW2CRecords	object	Pulls the Form W-2C records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2C Records
SequenceId	string	An 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	An unique identifier generated by TaxBandits when a W2C return is created.
EmployeeId	Guid	An unique identifier generated by TaxBandits for a employee when a W2C return is created. You can use this id for your future reference to Update.
FederalReturn	object	Returns the record status and StatusTs of federal return.
Status	string	Returns the record status.
StatusTs	string	Returns date and time of return created.
Info	string	Returns information about the Federal Filing service.
StateReturns	object[]	Returns collection of state returns information
StateCd	string	Returns the state code of the state for which the return is filed.
Status	string	Returns the record status of the state return.
StatusTs	string	Date and time of the return created.
Info	string	Returns the information about the state for which we are not supporting state filing.
Errors	object[]	Shows error information of state returns of Form W2C
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Postal	object	Returns the status and StatusTs of postal mailing service for Form W2C.
Status	string	Returns the status of postal order.
StatusTs	string	Returns the date and time of the postal order created.
Info	string	Returns the information about Postal mailing service.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns the Status of the Online Access.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ErrorRecords	object[]	It will show the detailed information about the error status of Form W2C Records.
SequenceId	string	An 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 of a record
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
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

Response JSON

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

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "d1f9cb0a-912f-4105-8bcf-059af43d2b31",
  "BusinessId": "62ac9c76-4fa8-4459-8a7d-e9763862d5fa",
  "FormW2CRecords": {
      "SuccessRecords": [
          {
              "SequenceId": "001",
              "RecordId": "63842ea1-93ac-4e5f-a3b2-df59c2d147c5",
              "EmployeeId": "ad035610-bfc0-494b-a3f0-5eeaf51408ec",
              "FederalReturn": {
                  "Status": "CREATED",
                  "StatusTs": "2021-01-11 15:02:51 +05:30",
                  "Info": null
              },
              "StateReturns": [
                  {
                      "StateCd": "DE",
                      "Status": "CREATED",
                      "StatusTs": "2021-01-11 15:02:51 +05:30",
                      "Info": null,
                      "Errors": null
                  },
                  {
                      "StateCd": "SC",
                      "Status": "CREATED",
                      "StatusTs": "2021-01-11 15:02:51 +05:30",
                      "Info": null,
                      "Errors": null
                  }
              ],
              "Postal": {
                  "Status": "NOTCREATED",
                  "StatusTs": null,
                  "Info": "Postal Alert cannot be opted for the return, when the employee (or) business has foreign address"
              },
              "OnlineAccess": {
                  "Status": "NA",
                  "Email": null,
                  "Info": "This Service will be available soon"
              }
          }
      ],
      "ErrorRecords": null
  },
  "Errors": null
}