List

Lists Form 940s created for a date range.

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

Request Params

"Form940/List?BusinessId=646ce2d4-a643-4034-b7a9-00ae216234f1&EIN=057348870&Page=1&PageSize=10&EfileStatus=All&FromDate=01/01/2021&ToDate=03/29/2021"

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.
Form940RecordList	object[]	Returns detailed information of the Form 940 records.
SubmissionId	Guid	Unique identifier of a submission
BusinessId	Guid	Unique Identifier of the business
BusinessNm	string	Name of the business
EIN	string	Employer Identification Number
BusinessType	string	Type of business.
RecordId	Guid	Unique identifier of a record
TaxYr	string	Tax year for which Form 940 needs to be filed
IRSPaymentType	string	Payment type to make payments pay the IRS. Choose from EFW, EFTPS, Check or Money Order
ReturnType	string	Type of the return to be filed. Enter values like FORM940, FORM940PR
EFileStatus	string	List the 940 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 940 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",
    "Form940RecordList": [
        {
            "SubmissionId": "45abb430-9e66-4e35-becc-8b44aff1b047",
            "BusinessId": "ac6a3517-5045-41c9-9cdf-9070057fe2af",
            "BusinessNm": "Snowdaze LLC",
            "EIN": "00-8171246",
            "BusinessType": "PART",
            "RecordId": "dd089480-46ff-414a-a4f0-d1e16afae65d",
            "TaxYr": "2024",
            "IRSPaymentType": "EFTPS",
            "ReturnType": "Form940",
            "EFileStatus": "CREATED"
        },
        {
            "SubmissionId": "e7c94253-ec51-4d56-b47d-c5112b95fdab",
            "BusinessId": "ac6a3517-5045-41c9-9cdf-9070057fe2af",
            "BusinessNm": "Snowdaze LLC",
            "EIN": "00-8171246",
            "BusinessType": "PART",
            "RecordId": "ba9d5803-d8d1-4e85-9fb5-619e98cca6b0",
            "TaxYr": "2024",
            "IRSPaymentType": "EFTPS",
            "ReturnType": "Form940",
            "EFileStatus": "CREATED"
        }
    ],
    "TotalRecords": 2,
    "TotalPages": 1,
    "Page": 1,
    "PageSize": 100,
    "Errors": null
}