List
Use this method to retrieve the list of 941-X forms created and transmitted for a particular business or submission. For example, if you provide a BusinessId, all the returns created under that BusinessId will be listed.
GET Form941X/List
Request Params
Field | Type | Description |
---|---|---|
BusinessId | Guid | Optional Unique identifier of a business |
EIN | string | Optional Employer Identification Number |
Page | number | OptionalPulls the page number of the page selected |
PageSize | number | Optional Number of 941-X records to be listed in each page Note: PageSize can be maximum of 100. |
EfileStatus | string | Optional List the 941-X records based on the status |
FromDate | string | OptionalEnter a date from which the form Form 941X records need to be listed in MM/DD/YYYY format |
ToDate | string | Optional Enter a date till which the 941-X records created are to be listed in MM/DD/YYYY format. |
Request Params
"Form941X/List?BusinessId=b6d9e695-cc72-46f7-b131-58317a54668b&FromDate=01/01/2023&ToDate=12/31/2023&EfileStatus=CREATED&Page=1&PageSize=10&EIN=144718269"
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. |
Form941XRecords | object[] | Returns detailed information of the Form 941-X records. |
SubmissionId | Guid | Unique identifier of a submission. |
BusinessId | Guid | Unique Identifier of the business. |
BusinessNm | string | Name of the business. |
EIN | Guid | Employer identification Number. |
BusinessType | string | Type of business. |
RecordId | Guid | Unique identifier of a record. |
TaxYr | string | Tax year of Form 941 to be corrected. |
Qtr | string | Quarter of Form 941 to be corrected. |
IRSPaymentType | string | Payment type to make payments to the IRS. |
EFileStatus | string | List the Form 941-X records based on the status. |
TotalRecords | number | Total number of records. |
TotalPages | number | Total number of pages. |
Page | number | Pulls the page number of the page selected. |
PageSize | number | Number of 941-X records 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",
"Form941XRecords": [
{
"SubmissionId": "7c1f1df2-61f1-4881-88d5-2a5db230e987",
"BusinessId": "47e6f5ea-f9b9-49ae-bf4a-ef945da053be",
"BusinessNm": "SnowDaze LLC",
"EIN": "00-2356895",
"BusinessType": "CORP",
"RecordId": "9ae8badc-d68e-4913-a050-fae80d0a9acd",
"TaxYr": "2024",
"Qtr": "Q2",
"IRSPaymentType": "EFTPS",
"ReturnType": "Form941x",
"EFileStatus": "CREATED"
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}