Thomson Reuters

Tax Return Import/Export API

This endpoint assigns groups, preparers, reviewers, managers, partners, and time tracking information to tax returns. When using the /locator/v2/assignment endpoint to assign an existing locator to a group without updating time tracking dates, the timeTracking object must still be included in the request as an empty object ("timeTracking": {}); omitting it or passing null values will result in a 400 Bad Request. The flag field accepts the following values: Users: - N: does nothing - U: removes the assigned user - C: assigns the user Groups: - N: does nothing - U: removes the assigned groups -

Documentation GitHub OpenAPI

Business capability

Tax Reporting & Compliance BC-220.40

Operations 4

POST /v1/binderId/{binderId}/tax-returns-events/{eventName} Create an Import Export in either json or CSV (octet-stream) #

POST /v2/binders/{binderId}/tax-returns-events/{eventName} Create an Import Export in either json or CSV (octet-stream) #

GET /v1/years/{year}/tax-return-statuses Use to retrieve the Import or Export Status of Tax Return events triggered #

GET /v1/binders/{binderId}/processes/{processId}/tax-return Use to retrieve the Tax Return as JSON or CSV file for a given binder and… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/thomson-reuters:tax-return-import-export-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Thomson Reuters Tax Return Import Export API
  version: v1
  description: 'Operations tagged Tax Return Import Export across 2 of this provider''s published API definitions: thomson-reuters-onesource-income-tax-tax-return-import-export-apis-openapi.json, thomson-reuters-onesource-income-tax-tax-return-import-export-apis-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.onesourcetax.com/income-tax/binders
security:
- Authorization: []
tags:
- name: Tax Return Import Export
paths:
  /v1/binderId/{binderId}/tax-returns-events/{eventName}:
    post:
      tags:
      - Tax Return Import Export
      summary: Create an Import Export in either json or CSV (octet-stream)
      operationId: taxReturnEventsV1
      description: 'Best Practice: Start with Export to retrieve the template for Import.


        Export: Requires no body. It will be {}.


        Import: Requires no body with content type as octet-stream. Select and upload the file.


        Import: Requires a body with content type as json with requirements below.'
      parameters:
      - name: binderId
        in: path
        description: 16 digit unique system defined tax return identifier
        required: true
        schema:
          type: string
      - name: eventName
        in: path
        description: Use Values "Import" or "Export" (case sensitive)
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Indicate the media type response that can be accepted - application/json is currently the only option.
        required: true
        schema:
          type: string
          default: application/json
          enum:
          - application/json
      - name: Content-Type
        in: header
        description: Indicate the response content media type to return
        required: true
        schema:
          type: string
          default: application/json
      requestBody:
        description: Tax Return Info
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
          application/json+DK1:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
          application/octet-stream:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
          application/octet-stream+DK1:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
          application/octet-stream+DK2:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
        required: false
      responses:
        '200':
          description: Success
          content: {}
        '401':
          description: Indicates a lack of authorization to perform this action on this resource. Check credentials and rights
          content: {}
        '404':
          description: Not Found
          content: {}
        '500':
          description: Unexpected Error Occurred. Contact ONESOURCE Technical Support.
          content: {}
      deprecated: true
    servers:
    - url: https://api.onesourcetax.com/income-tax/binders
  /v2/binders/{binderId}/tax-returns-events/{eventName}:
    post:
      tags:
      - Tax Return Import Export
      summary: Create an Import Export in either json or CSV (octet-stream)
      operationId: taxReturnEventsV2
      description: 'Best Practice: Start with Export to retrieve the template for Import.


        Export: Requires no body. It will be {}.


        Import: Requires no body with content type as octet-stream. Select and upload the file.


        Import: Requires a body with content type as json with requirements below.'
      parameters:
      - name: binderId
        in: path
        description: 16 digit unique system defined tax return identifier
        required: true
        schema:
          type: string
      - name: eventName
        in: path
        description: Use Values "Import" or "Export" (case sensitive)
        required: true
        schema:
          type: string
      requestBody:
        description: '<u><b>Summary of Import/Export Types: </b></u>Users can perform different types of import and export operations. These operations are handled using various request bodies, and the Content-Type header is automatically set based on the type of request body.</br></u></br><ul><li><b><u>application/json</b></u> - Indicates a data connection import with json data.</li><li><b><u>applicationa/json+DK1</b></u> - Indicates a DK1 import with json data.</li><li><b><u>application/json+taxreturn</b></u> - Indicates a tax return import with json data.</li><li><b><u>application/octet-stream</b></u> - Indicates a data connection import with csv data.</li><li><b><u>application/octet-stream+DK1</b></u> - Indicates a DK1 import with csv data.</li><li><b><u>application/octet-stream+taxreturn</b></u> - Indicates a tax return import with csv data.</li></ul><b>Export: </b> For all types of export, you need to select a type with empty body {}.</br></br><b>Note: </b>The data connection type is valid only for 2023 and prior years. For <b> 2024 </b> and later, you should use the tax return type instead of data connection.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
          application/json+DK1:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
          application/json+taxreturn:
            schema:
              $ref: '#/components/schemas/TaxReturnInfoRepresentation'
          application/octet-stream:
            schema:
              type: string
              format: binary
          application/octet-stream+DK1:
            schema:
              type: string
              format: binary
          application/octet-stream+taxreturn:
            schema:
              type: string
              format: binary
        required: false
      responses:
        '200':
          description: Success
          content: {}
        '401':
          description: Indicates a lack of authorization to perform this action on this resource. Check credentials and rights
          content: {}
        '404':
          description: Not Found
          content: {}
        '500':
          description: Unexpected Error Occurred. Contact ONESOURCE Technical Support.
          content: {}
      deprecated: false
    servers:
    - url: https://api.onesourcetax.com/income-tax/binders
  /v1/years/{year}/tax-return-statuses:
    get:
      tags:
      - Tax Return Import Export
      summary: Use to retrieve the Import or Export Status of Tax Return events triggered
      parameters:
      - name: year
        in: path
        required: true
        description: Identify the tax year for status retrieval (2018 and forward)
        schema:
          type: integer
      - name: processId
        in: query
        description: This is the guid that is returned when import or export is triggered.
        schema:
          type: string
        required: false
      - name: Accept
        in: header
        description: Indicate the response content media type to return - application/json is currently the only option.
        required: true
        schema:
          type: string
          default: application/json
          enum:
          - application/json
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ImportExportStatusLogRepresentations'
              examples:
                tax-return-import-export-statuses:
                  $ref: '#/components/examples/tax-return-import-export-statuses'
        '204':
          description: No data found for given inputs
          content: {}
        '400':
          description: Request failed. This is usually due to validation errors
        '401':
          description: Indicates a lack of authorization to perform this action on this resource. Check credentials and rights
          content: {}
        '404':
          description: Not Found
          content: {}
        '500':
          description: Unexpected Error Occurred. Contact ONESOURCE Technical Support.
          content: {}
      operationId: getV1YearsByYearTaxReturnStatuses
      x-operation-id-source: derived
    servers:
    - url: https://api.onesourcetax.com/income-tax/binders
  /v1/binders/{binderId}/processes/{processId}/tax-return:
    get:
      tags:
      - Tax Return Import Export
      summary: Use to retrieve the Tax Return as JSON or CSV file for a given binder and…
      description: 'Note: Please select the Accept header Media type below prior to retrieval. Either application/json+taxreturn or text/csv+taxreturn must be used for 2024 and later.

        The "Import" process will not generate a file to retrieve.'
      parameters:
      - name: binderId
        in: path
        required: true
        description: 16 digit unique system defined tax return identifier
        schema:
          type: string
      - name: processId
        in: path
        description: This is the guid that is returned when import or export is triggered.
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaxReturnInfoRepresentation'
              examples:
                tax-return-process-data:
                  $ref: '#/components/examples/tax-return-process-data'
            application/json+taxreturn:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaxReturnInfoRepresentation'
              examples:
                tax-return-process-data:
                  $ref: '#/components/examples/tax-return-process-data'
            text/csv:
              schema:
                type: string
                format: binary
            text/csv+taxreturn:
              schema:
                type: string
                format: binary
        '204':
          description: No data found for given inputs
          content: {}
        '400':
          description: Request failed. This is usually due to validation errors
        '401':
          description: Indicates a lack of authorization to perform this action on this resource. Check credentials and rights
          content: {}
        '404':
          description: Not Found
          content: {}
        '500':
          description: Unexpected Error Occurred. Contact ONESOURCE Technical Support.
          content: {}
      operationId: getV1BindersByBinderIdProcessesByProcessIdTaxReturn
      x-operation-id-source: derived
    servers:
    - url: https://api.onesourcetax.com/income-tax/binders
components:
  examples:
    tax-return-process-data:
      value:
        nameLine1: 0022NL
        nameLine2: Parent
        clientCode: TA_EXPORT
        importFlag: M
        taxReturnData:
        - formName: SCHEDULE K-1
          fieldName: CORPORATION ADDRESS
          fieldType: O
          group1: 0
          group2: 0
          group3: 0
          group4: 0
          group5: 0
          data: 4567 Main Street
    tax-return-import-export-statuses:
      value:
        resourceList:
        - processId: ABCDEF-ABCDEF-ABCDEF-ABCDEF-ABCDEF
          actionType: DCExport
          entityNumber: EN11
          entityName: Entity 11
          binderName: Binder1
          locatorName: Locator1
          taxReturnType: 1120C
          statusMessage: Submitted
          binderId: ACCT000001234
          statusCode: '0'
          submitTime: 1/7/2021 09:32:32.613
          userId: user1234
          userName: username1234
          dataFileName: OIT_Export
          source: ''
          _links: []
          _embedded: null
  schemas:
    TaxReturnRepresentation:
      type: object
      properties:
        FormName:
          type: string
          example: GENERAL INFORMATION
        FieldName:
          type: string
          example: DOMESTIC ADDRESS LN 1
        FieldType:
          type: string
          example: O, T, W
        Group1:
          type: integer
        Group2:
          type: integer
        Group3:
          type: integer
        Group4:
          type: integer
        Group5:
          type: integer
        Data:
          type: string
          example: 123 Hope Ln
    ImportExportStatusLogRepresentation:
      type: object
      properties:
        ProcessId:
          type: string
          description: Guid
        ActionType:
          type: string
        EntityNumber:
          type: string
        EntityName:
          type: string
        BinderName:
          type: string
        LocatorName:
          type: string
        TaxReturnType:
          type: string
        StatusMessage:
          type: string
        BinderId:
          type: string
        StatusCode:
          type: string
        SubmitTime:
          type: string
        UserId:
          type: string
        UserName:
          type: string
        DataFileName:
          type: string
        Source:
          type: string
    ImportExportStatusLogRepresentations:
      type: array
      items:
        $ref: '#/components/schemas/ImportExportStatusLogRepresentation'
    TaxReturnInfoRepresentation:
      type: object
      properties:
        NameLine1:
          type: string
          example: 6-digit unique system defined tax return identifier (locator number)
        NameLine2:
          type: string
          example: Entity Name, Not Required
        ClientCode:
          type: string
          example: NA, leave blank
        ImportFlag:
          type: string
          example: U, S, H, M
        TaxReturnData:
          type: array
          items:
            $ref: '#/components/schemas/TaxReturnRepresentation'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
x-refined-from:
- thomson-reuters-onesource-income-tax-tax-return-import-export-apis-openapi.json
- thomson-reuters-onesource-income-tax-tax-return-import-export-apis-openapi.yml
x-generator: NSwag v13.18.2.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))
x-provenance:
  method: harvested
  publisher: Thomson Reuters
  source: https://api.thomsonreuters.com/developer-experience/content/v1/documents/api-reference/168ef595-afa0-4239-bea1-d310047c92e9
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)