List

Lists Form 941s created for a date range.

GET Form941/List

Request Body

Field	Type	Description
BusinessId	Guid	Unique identifier of a business
EIN	string	Employer Identification Number
Page	number	Pulls the page number of the page selected
PageSize	number	Number of 941 records to be listed in each page
EfileStatus	string	List the 941 records based on the status
FromDate	DateTime	List 941 records created from
ToDate	DateTime	List 941 records created up to

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.
Form941Records	object[]	Returns detailed information of the Form 941 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 the return to be filed. Like as FORM941, FORM941PR, FORM941SS.
RecordId	Guid	Unique identifier of a record.
TaxYr	string	Tax year of Form 941 to be filed.
Qtr	string	Quarter of Form 941 to be filed.
IRSPaymentType	string	Payment type to make payments to the IRS.
EFileStatus	string	List the Form 941 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 records to be listed in each page.
Errors	object[]	Shows detailed error information.
Code	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Type	string	Type of validation error.

Request JSON

"Form941/List?BusinessId=730f3e93-f5d8-490f-9deb-36bbf158e51c&EIN=006587034&Page=0&PageSize=0&EfileStatus=ALL&FromDate=null&ToDate=null"

Response JSON

{   "StatusCode": 200,   "StatusName": "Ok",   "StatusMessage": "Successful API call",   "Form941Records": [       {           "SubmissionId": "909a8bc8-f60b-4d90-8bb3-247be7179ace",           "BusinessId": "730f3e93-f5d8-490f-9deb-36bbf158e51c",           "BusinessNm": "Eastman Kodak Company",           "EIN": "006687034",           "BusinessType": "CORP",           "RecordId": "cba7aa73-6104-476d-99f7-e8ac2dea7f0a",           "TaxYr": "2021",           "Qtr": "Q1",           "IRSPaymentType": "EFTPS",           "ReturnType": "Form941",           "EFileStatus": "CREATED"       },       {           "SubmissionId": "747a8bc8-f60b-4d90-8bb3-247be7179ace",           "BusinessId": "730f3e93-f5d8-490f-9deb-36bbf158e51c",           "BusinessNm": "Eastman Kodak Company",           "EIN": "006687034",           "BusinessType": "CORP",           "RecordId": "abc7aa73-6104-476d-99f7-e8ac2dea7f0a",           "TaxYr": "2021",           "Qtr": "Q1",           "IRSPaymentType": "EFTPS",           "ReturnType": "Form941",           "EFileStatus": "CREATED"       }   ],   "TotalRecords": 2,   "TotalPages": 1,   "Page": 1,   "PageSize": 100,   "Errors": null}