List

List

Lists Form 941SCHRs created for a date range.

GET Form941SCHR/List 

Run in Postman

Request Params

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 941SCHR records to be listed in each page. Note: PageSize can be maximum of 100.
EfileStatus	string	List the 941SCHR records based on the status.
FromDate	string	Enter a date from which the form 941SCHR records need to be listed in MM/DD/YYYY format
ToDate	string	Enter a date till which the 941SCHR records created are to be listed in MM/DD/YYYY format.

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.
Form941SchRRecords	object[]	Returns detailed information of the Form 941SCHR records.
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique identifier of a 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 941SchR to be filed.
Qtr	string	Quarter for which Form 941SCHR needs to be filed.
ClientCnt	number	Number of Clients reported.
IRSPaymentType	string	Payment type to make payments pay the IRS. Choose from EFW, EFTPS, Check or Money Order
EFileStatus	string	List the 941SchR 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 941SCHR 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.

Request Params

"Form941schr/List?BusinessId=ab6d5856-4cb4-49f9-8a71-b6979ea9a541&FromDate=02/03/2022&ToDate=03/22/2022&EfileStatus=CREATED&EIN=015852985&Page=1&PageSize=10"

Response JSON

Success Response - This is a sample response for successful API requests.

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "Form941SchRRecords": [
   {
     "SubmissionId": "8e73ad5f-47c9-46b8-ae35-9f4c7432ffa9",
     "BusinessId": "8e43389a-7f32-466e-9295-3d64df777385",
     "BusinessNm": "Snowdaze LLC",
     "EIN": "002586736",
     "BusinessType": "CORP",
     "RecordId": "d3888fc3-fee0-4020-bd6d-2a3795beff37",
     "TaxYr": "2022",
     "Qtr": "Q1",
     "ClientCnt": 2,
     "IRSPaymentType": "EFTPS",
     "EFileStatus": null
   }
 ],
 "TotalRecords": 3,
 "TotalPages": 1,
 "Page": 1,
 "PageSize": 10,
 "Errors": null
}