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

Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.

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

*Mandatory parameter

ReportingEntitiesResponse

OVERVIEWEXAMPLE

Overview

Represents the response containing a list of reporting entities.

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

The following is an example response you can expect for this operation

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

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

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: