Thomson Reuters Get Template API

openapi: 3.2.0
info:
  version: v1
  title: GoSystem TBB Get Template API
  description: 'A RESTful API to provide access to the GoSystem TBB functionality.


    Get Locator API (/v1/trialbalance/locators/{account}/{year}) - Retrieves the list of locators along with the binder ID.


    GET Template API (/v1/trialBalance/{binderid}/importTemplates/{importtype}) - Retrieves the list of templates available for the particular import type. The import types are 3000 - Preliminary Balances, 3001 - Adjustments, 3 - TCC, 3007 - Schedule M-3. You can pass the binder IDs you get from the Get Locator API.


    TBB Import (/v1/trialBalance/{binderid}/import/{importtype}/template/{templateid}) - Imports the data from Excel in Preliminary Balance, Adjustment, Schedule M-3, and TCC screens. Import type IDs for different imports are 3000 - Preliminary Balances, 3001 - Adjustments, 3 - TCC, 3007 - Schedule M-3. You''ll get the template ID from the GET Template API.


    Valid tax return types are 1120C, 1120S, and 1065 for TBB Import.


    Trial Balance Computation API (/v1/trialBalance/{binderId}/computations) - Submits a batch job to the compute queue. Once the batch job is completed successfully, the data from the Trial Balance bridge is updated in the organizer.


    Note: Make sure the locator is closed while performing this operation.


    Compute Transfer Options API (/v1/trialBalance/{binderId}/compute-transfer-config) - This endpoint allows you to update the computed date within the organizer. To ensure that the organizer is updated, the parameter UpdateFederalTAS must be set to true. If UpdateFederalTAS is set to false, the data is updated only within the TBB and isn''t transferred to the organizer.


    Compute Status API (/v1/trialBalance/{binderId}/compute-status) - Retrieves combined compute information for a binder. This includes Compute Status, Compute Options, and Compute Process Options.'
servers:
- url: https://api.thomsonreuters.com/gosystem/tax-returns
security:
- Authorization: []
tags:
- name: Get Template
paths:
  /v1/trialBalance/{binderid}/importTemplates/{importtype}:
    get:
      tags:
      - Get Template
      summary: Retrieve the list of templates for import type
      operationId: ListOfTemplateIDs
      parameters:
      - name: binderid
        in: path
        required: true
        description: A Binder ID is a unique alphanumeric identifier for a trial balance binder in GoSystem Tax RS. To retrieve Binder IDs for a specific account and tax year, you can use the endpoint GET /v1/trialbalance/locators/{account}/{year}.
        schema:
          type: string
      - name: importtype
        in: path
        required: true
        description: Identifies the category of data being imported into a Trial Balance Binder. Available types are 3000 – Preliminary Balances, 3001 – Adjustments, 3 – TCC, and 3007 – Schedule M-3.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success. The template list is retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateListWrapper'
              examples:
                template-list-example:
                  $ref: '#/components/examples/template-example'
        '404':
          description: Not Found
        '500':
          description: An error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateListError'
              examples:
                template-list-Wrong-importtypeid-example:
                  $ref: '#/components/examples/template-example1'
                template-list-Wrong-binderid-example:
                  $ref: '#/components/examples/template-example1'
      x-operation-id-source: normalized
      x-operation-id-original: List of Template IDs
components:
  examples:
    template-example1:
      value:
        Message: An error has occurred.
    template-example:
      value:
        TemplateList:
        - id: 91
          name: PrelimB_Template
        - id: 291
          name: Demo Template
        - id: 292
          name: Import Template by User
  schemas:
    TemplateList:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
    TemplateListError:
      type: object
      properties:
        Message:
          type: string
    TemplateListWrapper:
      type: object
      properties:
        TemplateList:
          type: array
          items:
            $ref: '#/components/schemas/TemplateList'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Thomson Reuters
  source: https://api.thomsonreuters.com/developer-experience/content/v1/documents/api-reference/d147dad2-5b4a-5ea9-898d-11e1712137f1
  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)