Skip to main content
Version: 1.7.0

List

Lists Form 941SCHRs created for a date range.

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

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 Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
Form941SchRRecordsobject[]Returns detailed information of the Form 941SCHR records.
    SubmissionIdGuidUnique identifier of a submission
    BusinessIdGuidUnique identifier of a business
    BusinessNmstringName of the business
    EINGuidEmployer Identification Number
    BusinessTypestringType of business.
    RecordIdGuidUnique identifier of a record.
    TaxYrstringTax year of 941SchR to be filed.
    QtrstringQuarter for which Form 941SCHR needs to be filed.
    ClientCntnumberNumber of Clients reported.
    IRSPaymentTypestringPayment type to make payments pay the IRS. Choose from EFW, EFTPS, Check or Money Order
    EFileStatusstringList the 941SchR records based on the status.
TotalRecordsnumberTotal number of records.
TotalPagesnumberTotal number of pages.
PagenumberPulls the page number of the page selected
PageSizenumberNumber of 941SCHR records to be listed in each page.
Errorsobject[]Shows detailed error information.
    IdstringReturns the validation error id.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.

Response JSON

{
"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
}