Thomson Reuters Trial Balance Compute API

openapi: 3.2.0
info:
  version: v1
  title: GoSystem TBB Trial Balance Compute 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: Trial Balance Compute
paths:
  /v1/trialBalance/{binderId}/compute-status:
    get:
      tags:
      - Trial Balance Compute
      summary: Get combined compute information for a binder
      description: 'Retrieves combined compute information for a binder. This includes Compute Status, Compute Options, and Compute Process Options.


        **Compute Status Codes:**

        - -21: An Exchange Rate Chart is assigned, but the Translation Gain/Loss account isn''t assigned.

        - -20: An Exchange Rate Chart isn''t assigned.

        - -15: ONESOURCE State Apportionment connection error.

        - -14: Unable to consolidate binder.

        - -12: Internal error: Invalid Batch ID.

        - -7: Compute Never Finished. Retry.

        - -4: Warning: Database errors have occurred. Check Action Items for possible sources of this error. If this warning persists, contact customer support.

        - 0: Compute Initializing...

        - 1: Compute Error. Check Action Items for possible sources of this error.

        - 2: Compute Shutting Down...

        - 3: Compute server not found.

        - 4: Compute Ready

        - 5: TAS Compute finished. Determining Organizer Transfer settings

        - 6: Compute Queued...

        - 7: Compute Started...

        - 9: TAS Computing...

        - 10: Organizer Computing...

        - 15: History Refreshing...

        - 16: Updating Entity Information...

        - 17: Transferring Federal Data to Organizer...

        - 18: Transferring State Data to Organizer...

        - 19: Transferring Provision Data to Organizer...

        - 21: Transferring International Data to Organizer...

        - 22: Opening Organizer Database...

        - 23: Transferring Federal Data from Organizer...

        - 24: Transferring State Data from Organizer...

        - 25: Closing Organizer Database...

        - 27: Domestic Compute Complete...

        - 28: Translation gain/loss account not assigned.

        - 30: Transferring BNA data to organizer...

        - 31: BNA Import Complete

        - 32: Retrieving ONESOURCE State Apportionment Data...'
      operationId: GetCombinedComputeInfo
      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
      responses:
        '200':
          description: Success. Combined compute information is retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BinderComputeCombinedResponse'
              examples:
                Binder-Compute-Combined-Response-Examples:
                  value:
                    ComputeStatus:
                      ComputeStatus: 4
                      StatusMessage: Compute Ready
                      PercentComplete: 100
                      lastComputeTime: null
                      ActionMessage: TAS Data has changed. A compute is needed.
                    ComputeOption:
                      BinderId: 00FT3777241145TX
                      ClosingAccountId: 4673603
                      ClosingAccountNumber: 22-123.001
                      ClosingAccountDescription: TBB Capital
                      RoundingAccountId: 0
                      RoundingAccountNumber: null
                      RoundingAccountDescription: null
                      GainLossAccountId: 0
                      GainLossAccountNumber: null
                      GainLossAccountDescription: null
                      RoundUpAmount: 0
                      EnableTcc001Transfer: false
                      Disable912ComputeAutoAdjustments: false
                      Disable997ComputeAutoAdjustments: false
                      SuppressZeroBalances: false
                      CalculateCasewareM1: false
                    ComputeProcessOptions:
                      BinderId: null
                      UpdateFederalTAS:
                        IsEnabled: true
                        IsVisible: true
                        IsSelected: false
                      UpdateStateAA:
                        IsEnabled: false
                        IsVisible: true
                        IsSelected: false
                      UpdateStateTITAS:
                        IsEnabled: false
                        IsVisible: true
                        IsSelected: false
                      UpdateONESOURCEStateApportionment:
                        IsEnabled: false
                        IsVisible: false
                        IsSelected: false
                      Transfer8865K1:
                        IsEnabled: false
                        IsVisible: true
                        IsSelected: false
                      TransferInternational:
                        IsEnabled: true
                        IsVisible: false
                        IsSelected: false
                      RefreshEntity:
                        IsEnabled: true
                        IsVisible: true
                        IsSelected: false
                      RefreshHistoricalBalances:
                        IsEnabled: false
                        IsVisible: true
                        IsSelected: false
        '400':
          description: Bad Request
        '500':
          description: Error calling external compute API or parsing response.
  /v1/trialBalance/{binderId}/compute-transfer-config:
    put:
      tags:
      - Trial Balance Compute
      summary: Update compute transfer options for a binder
      description: Updates the compute transfer options for a binder. The shouldUpdateFederalTAS parameter should be set to true to update the organizer.
      operationId: PutComputeTransferOptions
      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
      requestBody:
        description: Compute transfer options request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeTransferOptionsRequest'
            examples:
              update-transfer-option-example:
                value:
                  shouldUpdateFederalTAS: true
      responses:
        '200':
          description: Success. Compute transfer options are updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeTransferOptionsResponse'
              examples:
                update-transfer-option-example:
                  value:
                    BinderId: 00FT3777241145TX
                    ShouldUpdateFederalTAS: true
                    ShouldUpdateStateAA: false
                    ShouldUpdateONESOURCEStateApportionment: false
                    ShouldUpdateStateTITAS: false
                    ShouldTransfer8865K1: false
                    ShouldTransferInternational: false
        '400':
          description: Bad Request
        '500':
          description: Error calling external compute transfer options API.
  /v1/trialBalance/{binderId}/computations:
    post:
      tags:
      - Trial Balance Compute
      summary: Trigger trial balance computation for a binder
      description: Submits a batch job to the compute queue for the specified binder. Once the batch job is completed successfully, the data from the Trial Balance bridge is updated in the organizer.
      operationId: PostTrialBalanceComputation
      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
      requestBody:
        description: Trial balance computation request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrialBalanceComputationRequest'
            examples:
              compute-example:
                value:
                  Refresh: false
      responses:
        '200':
          description: Success. Computation is submitted.
          content:
            application/json:
              schema:
                type: string
              examples:
                example-1:
                  value: Compute submitted for BinderId 00FT3777241145TX.
        '400':
          description: Bad Request
        '500':
          description: Error calling external trial balance computation API.
components:
  schemas:
    ComputeTransferOptionsRequest:
      type: object
      properties:
        shouldUpdateFederalTAS:
          type: boolean
          description: Set to true to update the organizer with computed data.
    BinderComputeProcessOptions:
      type: object
      properties:
        BinderId:
          type:
          - string
          - 'null'
        UpdateFederalTAS:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
        UpdateStateAA:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
        UpdateStateTITAS:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
        UpdateONESOURCEStateApportionment:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
        Transfer8865K1:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
        TransferInternational:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
        RefreshEntity:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
        RefreshHistoricalBalances:
          $ref: '#/components/schemas/ComputeProcessOptionFlag'
    ComputeProcessOptionFlag:
      type: object
      properties:
        IsEnabled:
          type: boolean
        IsVisible:
          type: boolean
        IsSelected:
          type: boolean
    BinderComputeCombinedResponse:
      type: object
      properties:
        ComputeStatus:
          $ref: '#/components/schemas/BinderComputeStatus'
        ComputeOption:
          $ref: '#/components/schemas/BinderComputeOption'
        ComputeProcessOptions:
          $ref: '#/components/schemas/BinderComputeProcessOptions'
    BinderComputeStatus:
      type: object
      properties:
        ComputeStatus:
          type: integer
        StatusMessage:
          type: string
        PercentComplete:
          type: integer
        lastComputeTime:
          type:
          - string
          - 'null'
        ActionMessage:
          type: string
    BinderComputeOption:
      type: object
      properties:
        BinderId:
          type: string
        ClosingAccountId:
          type: integer
        ClosingAccountNumber:
          type:
          - string
          - 'null'
        ClosingAccountDescription:
          type:
          - string
          - 'null'
        RoundingAccountId:
          type: integer
        RoundingAccountNumber:
          type:
          - string
          - 'null'
        RoundingAccountDescription:
          type:
          - string
          - 'null'
        GainLossAccountId:
          type: integer
        GainLossAccountNumber:
          type:
          - string
          - 'null'
        GainLossAccountDescription:
          type:
          - string
          - 'null'
        RoundUpAmount:
          type: number
          format: double
        EnableTcc001Transfer:
          type: boolean
        Disable912ComputeAutoAdjustments:
          type: boolean
        Disable997ComputeAutoAdjustments:
          type: boolean
        SuppressZeroBalances:
          type: boolean
        CalculateCasewareM1:
          type: boolean
    TrialBalanceComputationRequest:
      type: object
      properties:
        Refresh:
          type: boolean
          description: Set to true to refresh data during computation.
    ComputeTransferOptionsResponse:
      type: object
      properties:
        BinderId:
          type: string
        ShouldUpdateFederalTAS:
          type: boolean
        ShouldUpdateStateAA:
          type: boolean
        ShouldUpdateONESOURCEStateApportionment:
          type: boolean
        ShouldUpdateStateTITAS:
          type: boolean
        ShouldTransfer8865K1:
          type: boolean
        ShouldTransferInternational:
          type: boolean
  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)