List
GET Form944/List
Request Params
Field | Type | Description |
---|---|---|
BusinessId | Guid | Optional Unique identifier of a business. |
EIN | string | Optional Employer Identification Number. |
Page | number | Optional Pulls the page number of the page selected |
PageSize | number | Optional Number of 944 records to be listed in each page |
EfileStatus | string | Optional List the 944 records based on the status |
FromDate | string | Optional Enter a date from which the form Form 944 records need to be listed in MM/DD/YYYY format |
ToDate | string | Optional Enter a date till which the 944 records created are to be listed in MM/DD/YYYY format. |
Request Params
Form944/List?BusinessId=b6d9e695-cc72-46f7-b131-58317a54668b&FromDate=01/01/2023&ToDate=12/31/2023&EfileStatus=CREATED&Page=1&PageSize=10&EIN=144718269
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. |
Form944Records | object[] | Returns detailed information of the Form 944 records. |
SubmissionId | Guid | Unique identifier of a submission. |
BusinessId | Guid | Unique Identifier of the business. |
BusinessNm | string | Name of the business. |
EIN | Guid | Employer identification Number. |
BusinessType | string | Type of the return to be filed. Like as FORM941, FORM941PR, FORM941SS. |
RecordId | Guid | Unique identifier of a record. |
TaxYr | string | Tax year of Form 944 to be filed. |
Qtr | string | Quarter of Form 944 to be filed. |
IRSPaymentType | string | Payment type to make payments to the IRS. |
EFileStatus | string | List the Form 944 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 944 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. |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "496570cd-e218-4f91-83e6-1549ea8ce525",
"Form944Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "7d9a60e8-e6d6-4c1c-9daf-0575f5b3fb69",
"RecordStatus": "DELETED",
"CreatedTs": "2023-10-03 03:00:02 -04:00",
"UpdatedTs": "2023-10-03 03:37:03 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}