List
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 Note: PageSize can be maximum of 100. |
| EfileStatus | string | List the 940 records based on the status Allowed values"Accepted", "Rejected", "Transmitted", "Created" |
| FromDate | string | Enter a date from which the 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 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 |
| PayerRef | string | Unique identifier of the payer. |
| 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. |
Request Params
"Form940/List?BusinessId=906476cb-89da-48d3-97d9-90106114e4bf"
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form940RecordList": [
{
"SubmissionId": "adfaa49c-58c7-4e66-a2df-1258dad0a3e1",
"BusinessId": "906476cb-89da-48d3-97d9-90106114e4bf",
"PayerRef": "Snow001",
"BusinessNm": "Snowdaze LLC",
"EIN": "00-8171246",
"BusinessType": "PART",
"RecordId": "9657e565-c91c-455e-ac2b-d9ef18d19db6",
"TaxYr": "2024",
"IRSPaymentType": "EFTPS",
"ReturnType": "Form940",
"EFileStatus": "CREATED"
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 100,
"Errors": null
}