GetTranscript

This endpoint is used to get the transcript of the BOI reports accepted/rejected by the FinCEN. The request must include the SubmissionId or Report Number.

GETBOIR/GetTranscript

Request Params

Field	Type	Description
SubmissionId	guid	Provide the SubmissionId (unique identifier created by TaxBandits for a submission) to identify for which submission needs to Get the Transcript. Either SubmissionId or ReportNumber can be provided to get the transcript of the Report.
ReportNumber	string	Provide the ReportNumber (unique identifier created by TaxBandits for a report) to identify which report needs to Get the Transcript.

Request Params

Sample 1

Request using SubmissionId.

BOIR/GetTranscript?SubmissionId=954cdad5-3b8a-4123-9052-8beba4be5376

Sample 2

Request using ReportNumber.

BOIR/GetTranscript?ReportNumber=109685

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	Returns the SubmissionId of the report
ReportNumber	number	Returns the Report Number for which the request was made.
ReportType	string	The type of the report created in the submission
ReportStatus	string	Returns the status of the report
BOITranscript	string	Returns the Transcript of the accepted/rejected report provided by the FinCen
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",
    "SubmissionId": "0efbd933-0047-4544-89e3-cf049dd8165a",
    "ReportNumber": "112426",
    "ReportType": "INITIAL",
    "ReportStatus": "ACCEPTED",
    "BOITranscript": "UserFiles/66badf6c02714fadeda218c/f3ca092e-b531-4abe-829c-9cf13366e4a5transcript/Transcript_66fbc48de0bef3aae8193c20.pdf",
    "Errors": null
}

400

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

{
    "StatusCode": 400,
    "StatusName": "BadRequest",
    "StatusMessage": "Validation error has occurred",
    "SubmissionId": "0efbd933-0047-4544-89e3-cf049dd8165a",
    "ReportNumber": "112426",
    "ReportType": "INITIAL",
    "ReportStatus": "TRANSMITTED",
    "BOITranscript": null,
    "Errors": [
        {
            "Id": "BOI-ER-1700",
            "Name": "SubmissionId",
            "Message": "Your BOI Report haven't accepted yet"
        }
    ]
}

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

404

You'll get the below response if your API request contains a record that's not found in our database.

{
    "StatusCode": 404,
    "StatusName": "NotFound",
    "StatusMessage": "The resource you have specified cannot be found",
    "SubmissionId": "102ecf74-d96b-4ce9-9054-f5170d847fac",
    "ReportNumber": null,
    "ReportType": null,
    "ReportStatus": null,
    "BOITranscript": null,
    "Errors": [
        {
            "Id": "BOI-ER-1464",
            "Name": "SubmissionId",
            "Message": "SubmissionId is invalid"
        }
    ]
}