Skip to main content
Version: 1.7.0

List

Lists Form 940SCHRs created for a date range.

GET Form940SchR/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 940SCHR records to be listed in each page
EfileStatusstringList the 940SCHR records based on the status
FromDatestringEnter a date from which the form Form 940SCHR records need to be listed in MM/DD/YYYY format
ToDatestringEnter a date till which the 940SCHR records created are to be listed in MM/DD/YYYY format.

Request Params

"Form940SCHR/List?BusinessId=e0e21430-ca3a-4573-bb70-f792ff160ca1&EIN=007820414&Page=1&PageSize=10&EfileStatus=null&FromDate=07/01/2021&ToDate=03/31/2021"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
Form940SchRRecordListobject[]Returns detailed information of the Form 940SCHR records.
    SubmissionIdGuidSubmission Identifier
    BusinessIdGuidBusiness Identifier
    BusinessNmstringBusiness Name
    EINstringEmployer Identification Number
    BusinessTypestringBusiness Type
    RecordIdGuidRecord Identifier
    TaxYrstringTax Year
    IRSPaymentTypestringIRS Payment Type
    ReturnTypestringReturn Type
    EFileStatusstringEfile Status (Created, Transmitted, Accepted, Rejected)
    ClientCntnumberNumber of Clients reported.
    ClientRecordIdGuid[]Unique identifier of each client record.
TotalRecordsnumberTotal number of Businesses
TotalPagesnumberTotal number of pages
PagenumberPulls the page number of the page selected
PageSizenumberNumber of 940SCHR 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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form940SchRRecordList": [
{
"ClientCnt": 2,
"ClientRecordId": [
"3982d093-1838-404b-8b0c-9bc1491c9701",
"11aa7f66-9bfd-449e-af4c-cdaefd8fc20b"
],
"EFileStatus": "CREATED",
"SubmissionId": "9723f666-c46e-43e6-8c56-8cba391acbf7",
"BusinessId": "e0e21430-ca3a-4573-bb70-f792ff160ca1",
"BusinessNm": "ABC LLC",
"EIN": "00-7820414",
"BusinessType": "Estate",
"RecordId": "e6e465db-f293-44e6-b659-3e528ea0cec7",
"TaxYr": "2020",
"IRSPaymentType": null,
"ReturnType": "Form940SCHR"
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 10,
"Errors": null
}