Status
GET Form1099SA/status
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordId | Guid | OptionalAn unique identifier generated by TaxBandits when a 1099 SA return is created. |
Request Params
Form1099SA/Status?RecordIds=11944cac-7aa0-47e8-951c-5454e38cda4e&SubmissionId=556e41eb-0ccb-4aeb-b486-19743d3a1c32
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. |
Form1099SAType | string | Denotes the type of 1099SA form. |
Form1099SARecords | object | Pulls Form 1099SA records with Success and Error statuses |
SuccessRecords | object[] | It will show detailed information about the success status of Form 1099SA 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 | A unique identifier generated by TaxBandits when a 1099SA return is created. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 1099SA 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 1099SA. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 1099SA . |
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 1099SA return. |
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. |
ScheduledOn | string | Date of the schedule filing to know when the return to be filed to the IRS. |
Info | string | Information about Schedule Filing service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099SA 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": "556e41eb-0ccb-4aeb-b486-19743d3a1c32",
"BusinessId": "04485bd3-713a-4dac-b460-4e9b3fd65473",
"PayerRef": "PAY123",
"Form1099Type": "SA",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "11944cac-7aa0-47e8-951c-5454e38cda4e",
"RecipientId": "9dccfc65-e8ec-47e7-a220-3660df1959b7",
"AccountNum": null,
"FederalReturn": {
"Status": "TRANSMITTED",
"StatusTs": "2024-01-11 00:27:28 -05:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "CREATED",
"StatusTs": "2024-01-11 00:27:28 -05:00",
"Info": null
},
"OnlineAccess": {
"Status": "ORDER_RECEIVED",
"Email": "sample1@bodeem.com",
"Info": null
},
"ScheduleFiling": {
"ScheduledOn": null,
"Info": "This service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}