Status
Gets the status of the 941 returns by Submission Id and Record Ids.
GET Form941/Status
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | List of record Ids to get status. |
ReturnType | string | Type of the return to be filed. Enter values like FORM941, FORM941PR, FORM941SS. Allowed values: "FORM941", "FORM941PR", "FORM941SS" |
EIN | string | Employer Identification Number |
Qtr | string | Quarter of Form 941 to be filed. Allowed values: "Q1", "Q2", "Q3", "Q4" |
TaxYr | string | Tax year of Form 941 to be filed. Allowed values: "2019", "2020", "2021" |
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. |
SubmissionId | Guid | Unique identifier of a submission. |
Form941Records | object | Pulls the Form 941 records with Success and Error statuses. |
  SuccessRecords | object[] | It will show the detailed information about the success status of Form 941 Records. |
    Sequence | string | A unique number given by an inbound application to identify failed records. |
    RecordId | Guid | Unique identifier of a record. |
    RecordStatus | string | Returns the status of the records. |
    CreatedTs | string | Date and time of return created. |
    UpdatedTs | string | Date and time of return updated. |
  ErrorRecords | object[] | It will show the detailed information about the error status of Form 941 Records. |
    RecordId | Guid | Unique identifier of a record. |
    Sequence | string | A unique number given by an inbound application to identify failed records. |
    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. |
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 JSON
Form941/Status?SubmissionId=f2fee2f8-74bf-4e1d-9239-399e76929475&RecordIds=ed6bc24b-189d-419b-9224-2dd2bf3b7467&ReturnType=FORM941&EIN=005534958&Qtr=Q4&TaxYear=2020
Response JSON
{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "f2fee2f8-74bf-4e1d-9239-399e76929475", "Form941Records": { "SuccessRecords": [ { "Sequence": "", "RecordId": "ed6bc24b-189d-419b-9224-2dd2bf3b7467", "RecordStatus": "Created", "CreatedTs": "2019-08-06 03:06:07 -04:00", "UpdatedTs": "2019-08-06 03:46:54 -04:00" } ], "ErrorRecords": null }, "Errors": null}