Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

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 Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Number of record Ids to get status.

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
FormW2CRecordsobjectPulls the Form W-2C records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2C Records
        SequenceIdstringAn 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.
        RecordIdGuidAn unique identifier generated by TaxBandits when a W2C return is created.
        EmployeeIdGuidAn 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.
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
        StateReturnsobject[]Returns collection of state returns information
            StateCdstringReturns the state code of the state for which the return is filed.
            StatusstringReturns the record status of the state return.
            StatusTsstringDate and time of the return created.
            InfostringReturns the information about the state for which we are not supporting state filing.
            Errorsobject[]Shows error information of state returns of Form W2C
                IdstringReturns the validation error Id.
                NamestringName of the validation error.
                MessagestringDescription of the validation error.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form W2C.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns the Status of the Online Access.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2C Records.
        SequenceIdstringAn 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.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error Id
            NamestringName of the validation error
            MessagestringDescription of the validation error
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Request JSON

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

Response JSON

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