GetAllSubmissionId

This endpoint can be used to retrieve all the SubmissionIds of the BOI Reports created in TaxBandits.

GETBOIR/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	Object[]	Lists the SubmisssionIds of all the BOI Report
SubmissionId	Guid	Return the SubmissionId of the report
CreatedTs	string	Returns the created date and time of the submission
UpdatedTs	string	Returns updated date and time of the submission
Errors	object[]	Object that provides the collection of error information in the request
Id	string	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	string	Name of the errored node.
Message	string	Shows the description of the error message

Response JSON

200

This is a sample response for successful API requests.

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionIds": [
        {
            "SubmissionId": "ec893456-2d31-45c9-a0c3-fd5968d068b2",
            "CreatedTs": "2024-08-05T05:10:17.414Z",
            "UpdatedTs": "2024-08-05T05:10:17.414Z"
        },
        {
            "SubmissionId": "41859fe9-83cd-4988-8425-6f90cda7bc8f",
            "CreatedTs": "2024-08-05T07:31:29.05Z",
            "UpdatedTs": "2024-08-05T07:31:29.05Z"
        }
    ],
    "Errors": null
}

400

You'll get the below response when your API requests contain any validation errors.

{
    "StatusCode": 404,
    "StatusName": "NotFound",
    "StatusMessage": "The resource you have specified cannot be found",
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1625",
            "Name": "SubmissionId",
            "Message": "No Submission found"
        }
    ]
}

401

You'll get the below response when your API requests don't contain valid authentication credentials.

{
    "StatusCode": 401,
    "StatusName": "Unauthorized",
    "StatusMessage": "Invalid authorization credentials",
    "Errors": [
        {
            "Id": "AUTH-100026",
            "Name": "Authorization ",
            "Message": "Authorization Failed"
        }
    ]
}