SureTax Returns API

GET External Reporting Entities

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

The External Reporting Entities API facilitates the retrieval of an up-to-date roster of active reporting entities linked to a designated Parent Account. Each reporting entity is uniquely identified by a distinct ID, ensuring seamless management and tracking.

OperationId: GET External Reporting Entities

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/ExternalReportingEntities

Request Headers

Display String	Field Name	Field Type
Authorization Token*	Authorization Token	string

*Mandatory parameter

ReportingEntitiesResponse

OVERVIEWEXAMPLE

Overview

ReportingEntitiesResponse

Display Name	Field Name	Field Type
Data	data	array[ReportingEntity]

ReportingEntity

Display Name	Field Name	Field Type
Id	id	string
Name	Name	array[Name]

Name

Display Name	Field Name	Field Type
Text	text	string
Language	language	string

Example Response

{
  "data": [
    {
      "id": "0000022222",
      "name": [
        {
          "text": "ABC",
          "language": "EN"
        }
      ]
    }
  ]
}

Response Codes

code	description
200	The API response contains a list of reporting entities in the specified format. Success Response - 200 OK. The API will respond with a list of active reporting entities and their information.
204	204 No Content If no reporting entities are found for the provided Parent Account, the API will respond with a No Content status. Error Responses
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/ExternalReportingEntities

Add Request Headers: