Skip to main content
Version: 1.7.3

GetSubmissionIdByBusiness

Gets the Submission IDs available for the given business.

GET Utility/GetSubmissionIdByBusiness 
Run in Postman

Request Params

FieldTypeDescription
TaxyearstringTaxYear for which the form is filed.
BusinessIdGuidUse the Business Id for which you are trying to get the SubmissionId’s.

Request Params

"Utility/GetSubmissionIdByBusiness?Taxyear=2021&BusinessId=0071f016-7577-4e61-bf95-eaac37e9388f"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message.
BusinessIdGuid[]Unique identifier of a business
PayerRefstringUnique identifier of a payer
TINstringTax Identification Number of the business
Submissionsobject[]Has detailed information about the submissions of the given business
SubmissionIdGuid[]Unique identifier of a submission
FormTypestringType of form for which the SubmissionId is listed 
SubmissionStatusstringStatus of the submission
TotalRecordsnumberTotal number of records in the submission
RecordsReceivednumberTotal number of records received
TaxYearnumberTaxYear for which the forms have been filed

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"BusinessId": "0071f016-7577-4e61-bf95-eaac37e9388f",
"PayerRef": "5#er",
"TIN": "52-9600362",
"Submissions": [
{
"SubmissionId": "c56aff35-f09b-424d-bc3c-57bf5d5da7bf",
"FormType": "Form1099MISC",
"SubmissionStatus": "CREATED",
"TotalRecords": 2000,
"RecordsReceived": 2000,
"TaxYear": "2021"
}
],
"Errors": null
}