Utility

CancelSubmission

Cancels a submission by Submission Id.

POST Utility/CancelSubmission

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission.

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.
Status	string	Form 940 records success and error status
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

{
  "SubmissionId": "4d7a31d9-6387-4c67-aa54-769465e6e551"
}

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4d7a31d9-6387-4c67-aa54-769465e6e551",
   "Status": "CANCELLED",
   "Errors": null
}

GetAllSubmissionId

Gets information for list of Submission Ids.

GET Utility/GetAllSubmissionId

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.
SubmissionIds	guid[]	Has all the submission Id's related to the user id
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

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionIds": [
    "4debe44f-93bf-40f9-b3d2-504a621c3038",
    "37405655-7851-446a-a88e-a718abccbd74"
  ],
  "Errors": null
}

GetRecordIdBySubmissionId

Gets information of the records by Submission Id.

GET Utility/GetRecordIdBySubmissionId

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission

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.
RecordIds	guid[]	List of record Ids.
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

"Utility/GetRecordIdBySubmissionId?SubmissionId=db283d52-9c19-4923-90f7-02479204b9a6"

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "RecordIds": [
   "56bd98f1-f01c-47d1-9cfb-9c40532f0153"
 ],
 "Errors": null
}

GetRecordIds

This utility allows you to get the RecordIds of the previously submitted returns. Which can be used in other endpoints like status, list, update etc.

In the request use a particular SubmissionId to retrive RecordIds of that submission or give BusinessId with TaxYear to get RecordIds againt that business for that TaxYear. Also, use the Form type filter to filter RecordIds for that particular form type.

POST Utility/GetRecordIds

Request Body

Field	Type	Description
SubmissionId	guid	Unique identifier of a submission.
BusinessId	Guid	Unique identifier of a business.
TaxYear	string	List the RecordIds based on the given tax year.
FormType	string	List the RecordIds based on the Type of Form requested for the business.

Response Body

Field	Type	Description
BusinessId	Guid	Unique identifier of a business.
PayerRef	string	A Unique identifier of the payer.
TaxYear	string	Tax year for which the record IDs are requested.
Records	object[]	It will show the detailed information about the RecordIds.
SubmissionId	Guid	A Unique identifier created by TaxBandits for each submission.
FormType	string	Type of form for which the RecordIds are listed.
RecordIds	object[]	Type of form for which the RecordIds are listed.
RecordId	Guid	A Unique identifier of a record.
RecipientId	Guid	A unique ID generated by TaxBandits for a Recipient.
EmployeeId	Guid	A Unique ID generated by Taxbandits for the employee.
PayeeRef	string	A Unique identifier of the recipient. Set by the client.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Request JSON

"Utility/GetRecordIds?SubmissionId=7862f7cf-0b2e-48cb-a94f-cfbdf94ce757&BusinessId=b48037d1-7459-4fec-bae0-48f7ad07b82c&TaxYear=2021&FormType=Form1099NEC"

Response JSON

{
   "BusinessId": "b48037d1-7459-4fec-bae0-48f7ad07b82c",
   "PayerRef": "B123",
   "TaxYear": "2021",
   "Records": [
       {
           "SubmissionId": "7862f7cf-0b2e-48cb-a94f-cfbdf94ce757",
           "FormType": "Form1099NEC",
           "RecordIds": [
               {
                   "RecordId": "766e3f80-34b6-4b57-987e-5883008dc5a3",
                   "RecipientId": "1f5bc7ba-e6fc-4082-823c-897d87206537",
                   "EmployeeId": null,
                   "PayeeRef": null
               }
           ]
       }
   ],
   "Errors": null
}

GetSubmissionIdByRecordId

Gets information of the submission by Record Id.

GET Utility/GetSubmissionIdByRecordId

Request Body

Field	Type	Description
RecordId	guid	Unique identifier of a record.

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.
SubmissionIds	guid	List of submission Ids related to the User Id.
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

"Utility/GetSubmissionIdByRecordId?RecordId=56bd98f1-f01c-47d1-9cfb-9c40532f0153"

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "db283d52-9c19-4923-90f7-02479204b9a6",
 "Errors": null
}