List
List
Lists Form 945s created for a date range.
GET Form945/List Request Params
| Field | Type | Description |
|---|---|---|
| BusinessId | Guid | Optional Unique identifier of a business |
| EIN | string | Optional Employer Identification Number |
| Page | number | OptionalPulls the page number of the page selected |
| PageSize | number | Optional Number of 945 records to be listed in each page Note: PageSize can be maximum of 100. |
| EfileStatus | string | Optional List the 945 records based on the status Allowed values"Accepted", "Rejected", "Transmitted", "Created" |
| FromDate | string | OptionalEnter a date from which the form 945 records need to be listed in MM/DD/YYYY format |
| ToDate | string | Optional Enter a date till which the 945 records created are to be listed in MM/DD/YYYY format. |
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. |
| Form945RecordList | object[] | Returns detailed information of the Form 945 records. |
| SubmissionId | Guid | Unique identifier of a submission |
| BusinessId | Guid | Unique Identifier of the business |
| BusinessNm | string | Name of the business |
| PayerRef | string | Unique identifier of the payer. |
| EIN | string | Employer Identification Number |
| BusinessType | string | Type of business. |
| RecordId | Guid | Unique identifier of a record |
| TaxYr | string | Tax year for which Form 945 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 value as FORM945 |
| EFileStatus | string | List the 945 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 945 records to be listed in each page. |
| Errors | object[] | Shows detailed error information. |
| Id | string | Returns the validation error code. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request Params
"Form945/List?BusinessId=b6d9e695-cc72-46f7-b131-58317a54668b&FromDate=01/01/2023&ToDate=12/31/2023&EfileStatus=CREATED&Page=1&PageSize=10&EIN=144718269"
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form945RecordList": [
{
"SubmissionId": "5bfa4bb2-2b1d-4690-84de-05a4536beda4",
"BusinessId": "b6d9e695-cc72-46f7-b131-58317a54668b",
"BusinessNm": "Snowdaze LLC",
"EIN": "14-4718269",
"BusinessType": "Partnership or LLC as Partnership",
"PayerRef": "Snow123",
"RecordId": "ec70c5d7-7289-4ca1-9a21-6c0aa9f59bd5",
"TaxYr": "2024",
"IRSPaymentType": "EFTPS",
"ReturnType": "Form945",
"EFileStatus": "CREATED"
}
],
"TotalRecords": 1,
"TotalPages": 1,
"Page": 1,
"PageSize": 10,
"Errors": null
}