Status

GET Form5498/Status 

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordId	Guid	An unique identifier generated by TaxBandits when a 5498 return is created.

Request Params

"Form5498/status?SubmissionId=eeee66d3-5291-4675-828a-f153616e99ca&RecordId=c0bfc6ce-9c6e-4031-8ab5-3d1099e1c0e7"

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.
PayerRef	string	Unique identifier of the payer.
Form5498Type	string	Denotes the type of 5498 form.
Form5498Records	object	Pulls Form 5498 records with Success and Error statuses
SuccessRecords	object[]	It will show detailed information about the success status of Form 5498 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 5498 return is created.
RecipientId	Guid	An unique identifier generated by TaxBandits for a Recipient when a 5498 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.
Errors	object[]	Shows error information in state returns of Form 5498
Postal	object	Returns the status and StatusTs of postal mailing service for Form 5498 .
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 status of online access for Form 5498 return.
Email	string	Email address for whom the online access to be given.
Info	string	Information about the online access service.
ScheduleFiling	object	Returns the date of the schedule filing.
ErrorRecords	object[]	It will show the detailed information about the error status of Form 5498 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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "eeee66d3-5291-4675-828a-f153616e99ca",
    "BusinessId": "e03eff49-ceb4-4d5a-a991-a50e6be69fb3",
    "PayerRef": "AB12E",
    "Form5498Type": "5498",
    "Form5498Records": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "c0bfc6ce-9c6e-4031-8ab5-3d1099e1c0e7",
                "RecipientId": "1af70d8b-9b55-4139-84bd-aedcb7fdfa07",
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2023-10-31 09:10:04 -04:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2023-10-31 09:10:04 -04:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "sample@bodeem.com",
                    "Info": null
                },
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}