Skip to main content
Version: 1.7.3

List

Lists Form 940s created for a date range.

GET Form940/List 
Run in Postman

Request Params

FieldTypeDescription
BusinessIdGuidUnique identifier of a business.
EINstringEmployer Identification Number.
PagenumberPulls the page number of the page selected
PageSizenumberNumber of 940 records to be listed in each page
EfileStatusstringList the 940 records based on the status
FromDatestringEnter a date from which the form Form 940 records need to be listed in MM/DD/YYYY format
ToDatestringEnter 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

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
Form940RecordListobject[]Returns detailed information of the Form 940 records.
    SubmissionIdGuidUnique identifier of a submission
    BusinessIdGuidUnique Identifier of the business
    BusinessNmstringName of the business
    EINstringEmployer Identification Number
    BusinessTypestringType of business.
    RecordIdGuidUnique identifier of a record
    TaxYrstringTax year for which Form 940 needs to be filed
    IRSPaymentTypestringPayment type to make payments pay the IRS. Choose from EFW, EFTPS, Check or Money Order
    ReturnTypestringType of the return to be filed. Enter values like FORM940, FORM940PR
    EFileStatusstringList the 940 records based on the status.
TotalRecordsnumberTotal number of records.
TotalPagesnumberTotal number of pages.
PagenumberPulls the page number of the page selected
PageSizenumberNumber of 940 records to be listed in each page.
Errorsobject[]Shows detailed error information.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType 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": "7f9cb1ab-f90b-4358-ae5f-acfe19617d96",
"BusinessId": "c5beb833-2ce4-4293-9772-6c94d37173f2",
"BusinessNm": "Snowdaze LLC",
"EIN": "00-5498751",
"BusinessType": "Estate",
"RecordId": "22af7b4b-42f2-4e68-a9ac-743d2fd76636",
"TaxYr": "2018",
"IRSPaymentType": "EFTPS",
"ReturnType": "Form940",
"EFileStatus": "CREATED"
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 10,
"Errors": null
}