Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Validate

Runs business and data validation checks for the 940 forms already created in API. You must use the Submission ID of the return to Validate.

GET Form940/Validate

Request Body

FieldTypeDescription
SubmissionIdstringUnique identifier of a submission
RecordIdsstringList of record Ids to be transmitted.

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.
Form940RecordsobjectPulls the Form 940 records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 940 Records.
        SequencestringA unique number given by an inbound application to identify failed records.
        RecordIdGuidUnique identifier of a record.
        RecordStatusstringReturns the status of the records.
        CreatedTsstringDate and time of return created.
        UpdatedTsstringDate and time of return updated.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 940 Records
        RecordIdGuidUnique identifier of a record.
        SequencestringA unique number given by an inbound application to identify failed records.
        Errorsobject[]Shows detailed error information.
            CodestringReturns the validation error code.
            NamestringName of the validation error.
            MessagestringDescription of the validation error.
            TypestringType of validation error.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Request JSON

Form940/Validate?SubmissionId=8129c446-dedd-4b40-befb-0ce0ae4f0678&RecordIds=91b4df85-dc32-4b0c-b4db-b47838882cb3

Response JSON

{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "8129c446-dedd-4b40-befb-0ce0ae4f0678", "Form940Records": {   "SuccessRecords": [     {       "Sequence": "",       "RecordId": "91b4df85-dc32-4b0c-b4db-b47838882cb3",       "RecordStatus": "Created",       "CreatedTs": "2019-08-06 01:09:55 -04:00",       "UpdatedTs": "2019-08-06 01:21:28 -04:00"     }   ],   "ErrorRecords": null }, "Errors": null}