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.

GET Utility/GetRecordIds 

Request Params

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.

Request Params

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

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.

Response JSON

Success Response - This is a sample response for successful API requests.

{
   "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
}