Delete
Deletes 941SCHR returns by Submission Ids and Record Ids.
DELETE Form941SCHR/Delete
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Submission Id |
RecordIds | string |
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. |
Form941SchRRecords | object | Pulls the Form 941SCHR records with Success and Error statuses |
  SuccessRecords | object[] | It will show the detailed information about the success status of Form 941 Schedule R 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. |
    ClientSuccessRecords | object[] | Client Success Status |
      CSeqId | string | This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence. Required |
      CRecordId | Guid | Client Record Identifier |
      RecordStatus | string | Return status details like Processing, Created, Accepted, Rejected. |
      CreatedTs | string | Return created date and time |
      UpdatedTs | string | Return updated date and time |
  ErrorRecords | object[] | It will show the detailed information about the error status of Form 941 Schedule R Records |
    Sequence | string | A unique number given by an inbound application to identify failed records. |
    RecordId | Guid | Unique identifier of a record |
    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. |
    ClientErrorRecords | object[] | Client Error Status |
      CSeqId | string | This identifies the sequence on the record sent in the pay load. When errors occur we will send the errors attached to particular sequence. Required |
      CRecordId | Guid | Client Record Identifier |
      Errors | object[] | It will show the detailed information about the error. |
        Code | string | It will return the validation error code. |
        Name | string | It will return the name of the validation error. |
        Message | string | It will return the detailed message of the validation error. |
        Type | string | It will show the type of an 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
Form941SCHR/Delete?SubmissionId=8476b2ba-4bca-4e7e-845f-2c06ecaea9be&RecordIds=fc4e001f-6282-4b61-aea2-30e3cdef4fae
Response JSON
{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "Form941SchRecords": { "SuccessRecords": [ { "Sequence": "", "RecordId": "fc4e001f-6282-4b61-aea2-30e3cdef4fae", "RecordStatus": "DELETED", "CreatedTs": "2019-08-06 10:03:00 -04:00", "UpdatedTs": "2019-08-06 10:03:55 -04:00", "ClientSuccessRecords": null } ], "ErrorRecords": null }, "Errors": null}