List

Lists Form 940SCHRs created for a date range.

GET Form940SchR/List 

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

Request Params

"Form940SCHR/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.
Form940SchRRecordList	object[]	Returns detailed information of the Form 940SCHR records.
SubmissionId	Guid	Submission Identifier
BusinessId	Guid	Business Identifier
BusinessNm	string	Business Name
PayerRef	string	Unique identifier of the payer.
EIN	string	Employer Identification Number
BusinessType	string	Business Type
RecordId	Guid	Record Identifier
TaxYr	string	Tax Year
IRSPaymentType	string	IRS Payment Type
ReturnType	string	Return Type
EFileStatus	string	Efile Status (Created, Transmitted, Accepted, Rejected)
ClientCnt	number	Number of Clients reported.
ClientRecordId	Guid[]	Unique identifier of each client record.
TotalRecords	number	Total number of Businesses
TotalPages	number	Total number of pages
Page	number	Pulls the page number of the page selected
PageSize	number	Number of 940SCHR 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.

Response JSON

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "Form940SchRRecordList": [
        {
            "ClientCnt": 3,
            "ClientRecordId": [
                "dec7996c-a866-4fc4-ac48-b21ad6628b1c",
                "84157318-0a1f-4485-b2d5-8fdc0b8cd341",
                "468ce8d5-e5ba-410f-b4b7-b13701c2df0f"
            ],
            "EFileStatus": "CREATED",
            "SubmissionId": "11d190d3-73c7-4a67-8fec-755e5496b8ec",
            "BusinessId": "aa6475d4-2eb9-4204-8d14-3a226d9ff463",
            "PayerRef": "Snow123",
            "BusinessNm": "Snowdaze LLC",
            "EIN": "00-4934527",
            "BusinessType": "ESTE",
            "RecordId": "6c3baec2-7345-4b43-af38-336e3deede32",
            "TaxYr": "2024",
            "IRSPaymentType": null,
            "ReturnType": "Form940SCHR"
        }
    ],
    "TotalRecords": 1,
    "TotalPages": 1,
    "Page": 1,
    "PageSize": 500,
    "Errors": null
}