GetSubmissionIdByBusiness
Gets the Submission IDs available for the given business.
GETUtility/GetSubmissionIdByBusiness
Request Params
Field | Type | Description |
---|---|---|
Taxyear | string | TaxYear for which the form is filed. |
BusinessId | Guid | Use 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
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. |
BusinessId | Guid[] | Unique identifier of a business |
PayerRef | string | Unique identifier of a payer |
TIN | string | Tax Identification Number of the business |
Submissions | object[] | Has detailed information about the submissions of the given business |
SubmissionId | Guid[] | Unique identifier of a submission |
FormType | string | Type of form for which the SubmissionId is listed |
SubmissionStatus | string | Status of the submission |
TotalRecords | number | Total number of records in the submission |
RecordsReceived | number | Total number of records received |
TaxYear | number | TaxYear 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
}