List
GET Form3921/List
Request Params
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission. |
BusinessId | Guid | Unique identifier of a business. |
TINType | string | List the 3921 records based on the given TINType and TIN. |
TIN | string | List the 3921 records based on the given TIN. |
TaxYear | string | List the 3921 records based on the given taxyear. Allowed values: "2024" |
Page | number | Pulls the records listed in the page selected. |
PageSize | number | Number of 3921 records to be listed in each page. |
EfileStatus | string | List the 3921 records based on the status ("CREATED, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED") |
FromDate | string | Enter a date from which the Form 3921 records need to be listed in MM/DD/YYYY format. |
ToDate | string | Enter a date till which the 3921 records created are to be listed in MM/DD/YYYY format. |
Request Params
"Form3921/List?SubmissionId=1875b2f6-5b09-45f5-a906-d2bfde5d8625&TINType=SSN&TIN=092167881&Page=1&FromDate=01/02/2024&ToDate=01/10/2024&EfileStatus=CREATED&BusinessId=f6d35e63-0ebe-450b-9485-cdcd72487aff&TaxYear=2024"
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 |
FormType | string | Denoted the Form Type. |
Form3921Records | object[] | Returns detailed information of the Form 3921 records. |
SubmissionId | Guid | Unique identifier of a submission. |
BusinessId | Guid | Unique identifier of a business. |
PayerRef | string | Unique identifier of the payer. |
BusinessNm | string | Name of the business. |
FirstNm | string | First Name of the Individual |
MiddleNm | string | Middle Name of the Individual |
LastNm | string | Last Name of the Individual |
Suffix | string | Suffix of the Individual |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) |
ContactNm | string | Contact Name of the Business. |
TaxYear | string | Tax year of 3921 to be filed. |
Recipient | object | Details of the Recipient. |
SequenceId | string | A 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 3921 return is created. |
RecipientId | Guid | A unique identifier generated by TaxBandits for a Recipient when a 3921 return is created. You can use this id for your future reference to Update. |
RecipientNm | Boolean | Name of Recipient. |
FirstNm | string | First Name of the Individual |
MiddleNm | string | Middle Name of the Individual |
LastNm | string | Last Name of the Individual |
Suffix | string | Suffix of the Individual |
TINType | string | TIN type of the Recipient. |
TIN | string | TIN of the Recipient. |
PayeeRef | string | A unique identifier for each payee completing their information. |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-NEC is filed. Size Range: 4..20 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number. |
FederalReturn | object | Returns the record status and StatusTs of federal return service for Form 3921. |
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 detailed error information. |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 3921. |
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 3921 return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
TotalRecords | number | Total number of records. |
TotalPages | number | Total number of pages. |
Page | number | Pulls the records listed in the page selected |
PageSize | number | Number of 3921records to be listed in each page. |
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",
"Form3921Records": [
{
"SubmissionId": "c03feb88-d8a1-4080-8bc6-4e6adec1bba5",
"BusinessId": "8d177248-992e-4ca5-ba9e-1a5a8a93db56",
"PayerRef": "Snow123",
"FormType": "3921",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsEIN": true,
"EINorSSN": "71-3787159",
"ContactNm": "John",
"TaxYear": "2024",
"Recipient": {
"SequenceId": "1",
"RecordId": "488b1c7e-d244-4d6a-8491-65ae2209a99f",
"RecipientId": "472079fb-2dcf-4228-8548-73656ddafc30",
"RecipientNm": "Mark Davis",
"TINType": "SSN",
"TIN": "363-81-4579",
"PayeeRef": "Payee001",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-04-18 05:31:03 -04:00",
"Info": null,
"Errors": null
},
"Postal": null,
"OnlineAccess": {
"Status": "CREATED",
"Email": "mark@sample.com",
"Info": null
}
}
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}