Thomson Reuters Data Fields API

openapi: 3.2.0
info:
  title: Thomson Reuters Data Fields API
  version: '1.0'
  description: 'Operations tagged Data Fields across 2 of this provider''s published API definitions: thomson-reuters-general-ledger-manager-openapi.json, thomson-reuters-general-ledger-manager-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.onesourcetax.com/general-ledger-manager/v1
security:
- bearerAuth: []
tags:
- name: Data Fields
  description: 'Data Fields can be used to create Master Trial Balance that reconcile Trial Balance.

    ONESOURCE General Ledger Manager Data Fields APIs provides access to the pre-defined Data Fields for Standard Trial Balance and Tax Provision with the data type that are used during the processing, validation and classification for Trial Balances in General Ledger Manager.'
paths:
  /blueprints:
    get:
      tags:
      - Data Fields
      summary: Get a paginated list of available Data Fields
      description: Returns a list of Data Fields with their metadata
      operationId: getBlueprints
      parameters:
      - name: filter
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: X-ONESOURCE-Client-Id
        in: header
        description: Client Id
        required: false
        schema:
          type: integer
      - name: X-ONESOURCE-Client-Number
        in: header
        description: Client Number
        required: false
        schema:
          type: string
      responses:
        '200':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiCollectionBlueprintMeta'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /blueprints/{id}:
    get:
      tags:
      - Data Fields
      summary: Get Data Fields by ID
      description: 'Returns Data Fields metadata for the specified Data Fields ID


        Potential values for ontology:


        idname


        1Financial Hierarchy Code


        3Entity Code


        4Account Code


        5Ending Balance


        13Entity Rollup


        14Account Rollup


        17Chart Of Account Rollup'
      operationId: getBlueprint
      parameters:
      - name: id
        in: path
        description: Unique identifier of the Data Fields
        required: true
        schema:
          type: string
      - name: X-ONESOURCE-Client-Id
        in: header
        description: Client Id
        required: false
        schema:
          type: integer
      - name: X-ONESOURCE-Client-Number
        in: header
        description: Client Number
        required: false
        schema:
          type: string
      responses:
        '200':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MetadataDTO'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /blueprints/{id}/custom-views:
    get:
      tags:
      - Data Fields
      summary: Get a paginated list of available Consolidation
      description: Returns a list of Consolidation
      operationId: getBlueprintCustomViews
      parameters:
      - name: filter
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: Unique identifier of the Data Fields
        required: true
        schema:
          type: integer
          format: int32
      - name: X-ONESOURCE-Client-Id
        in: header
        description: Client Id
        required: false
        schema:
          type: integer
      - name: X-ONESOURCE-Client-Number
        in: header
        description: Client Number
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiCollectionBlueprintMeta'
      security:
      - bearerAuth: []
    post:
      tags:
      - Data Fields
      summary: Create a new Consolidation
      description: Add a Consolidation with required minimum criteria of name, account roll up and can have additional information around consolidation.
      operationId: createCustomView
      parameters:
      - name: id
        in: path
        description: Unique identifier of the Data Fields
        required: true
        schema:
          type: integer
          format: int32
      - name: X-ONESOURCE-Client-Id
        in: header
        description: Client Id
        required: false
        schema:
          type: integer
      - name: X-ONESOURCE-Client-Number
        in: header
        description: Client Number
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomViewDTO'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomViewId'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /blueprints/{id}/custom-views/{CustomViewId}:
    get:
      tags:
      - Data Fields
      summary: Get a Consolidation by Id
      description: Returns a Master Trial Balance Consolidation
      operationId: getBlueprintCustomViewsById
      parameters:
      - name: id
        in: path
        description: Unique identifier of the Data Fields
        required: true
        schema:
          type: integer
          format: int32
      - name: CustomViewId
        in: path
        description: Unique identifier of the Consolidation
        required: true
        schema:
          type: integer
          format: int32
      - name: X-ONESOURCE-Client-Id
        in: header
        description: Client Id
        required: false
        schema:
          type: integer
      - name: X-ONESOURCE-Client-Number
        in: header
        description: Client Number
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomViewResponseDTO'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
components:
  schemas:
    AggregationDTO:
      required:
      - name
      - operator
      - source_column
      type: object
      properties:
        source_column:
          type: string
          description: identifier of the column Id
          example: 149114
        name:
          type: string
          description: Output Name
          example: Output Name
        operator:
          type: string
          description: operator
          example: MAX
        config:
          $ref: '#/components/schemas/ConfigDTOAggregation'
    CustomViewGroupBy:
      type: object
      properties:
        blueprint_column_id:
          type: integer
          format: int32
      description: list of consolidation group by
    BlueprintApiMeta:
      type: object
      properties:
        count:
          type: integer
          format: int64
        limit:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        sort:
          type: string
        filter:
          type: string
        extra:
          type: object
          additionalProperties:
            type: object
          writeOnly: true
    GroupByDTO:
      required:
      - source_column
      type: object
      properties:
        source_column:
          type: string
          description: identifier of the column name
          example: onesource_account_code
        type:
          type: string
        config:
          $ref: '#/components/schemas/ConfigDTO'
    CustomViewAggregation:
      type: object
      properties:
        operator:
          type: string
        name:
          type: string
        blueprint_column_id:
          type: integer
          format: int32
      description: list of consolidation
    ConfigDTOAggregation:
      type: object
      properties:
        weighted_on:
          type: string
    ApiCollectionBlueprintMeta:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BlueprintMeta'
        _meta:
          $ref: '#/components/schemas/BlueprintApiMeta'
    CustomViewResponseDTO:
      type: object
      properties:
        id:
          type: integer
          description: custom view id
          format: int32
          example: 12
        name:
          type: string
          description: name of the custom view
          example: name
        blueprint_id:
          type: integer
          description: id of the consolidation
          format: int32
          example: 1
        aggregation:
          type: array
          description: list of custom view aggregation
          items:
            $ref: '#/components/schemas/CustomViewAggregation'
        group_by:
          type: array
          description: list of custom view group by
          items:
            $ref: '#/components/schemas/CustomViewGroupBy'
    CustomViewDTO:
      required:
      - aggregation
      - group_by
      - name
      type: object
      properties:
        name:
          type: string
          description: Label of the Custom View
          example: My Custom View Name
        aggregation:
          type: array
          items:
            $ref: '#/components/schemas/AggregationDTO'
        group_by:
          type: array
          items:
            $ref: '#/components/schemas/GroupByDTO'
    MetadataDTO:
      required:
      - columns
      - name
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the Data Fields
          format: int32
          example: 46
        version:
          type: integer
          description: Version of the Data Fields
          format: int32
          example: 5
        name:
          type: string
          description: Label of the Data Fields
          example: My Data Fields Name
        columns:
          type: array
          items:
            $ref: '#/components/schemas/ColumnDTO'
        type_id:
          type: integer
          description: Unique identifier of the Data Fields type
          format: int32
          example: 2
        from:
          type: string
          description: Scope of the Data Fields
          example: Client
        is_hidden:
          type: boolean
          description: Visibility of the Data Fields
          example: false
    BlueprintMeta:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the Data Fields
          format: int32
          example: 46
        version:
          type: integer
          description: Version of the Data Fields
          format: int32
          example: 5
        name:
          type: string
          description: Label of the Data Fields
          example: My Data Fields Name
        type_id:
          type: integer
          description: Unique identifier of the Data Fields type
          format: int32
          example: 2
        from:
          type: string
          description: Scope of the Data Fields
          example: Client
        is_hidden:
          type: boolean
          description: Visibility of the Data Fields
          example: false
    ConfigDTO:
      type: object
      properties:
        rollup_id:
          type: integer
          format: int32
        root_entity_column:
          type: string
        allocation_column:
          type: string
    ColumnDTO:
      type: object
      properties:
        name:
          type: string
          description: Label of the column
          example: My Column Name
        type:
          type: string
          description: Expected data type of the column values
          example: number
          enum:
          - currency
          - date
          - number
          - string
        required:
          type: boolean
          description: Requires templates to map this column
          example: true
        index:
          type: boolean
        ontology_id:
          type: integer
          description: Unique identifier of the ontology this column represents
          format: int32
          example: 1
        display_name:
          type: string
    CustomViewId:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the CustomView
          format: int32
          example: 6
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- thomson-reuters-general-ledger-manager-openapi.json
- thomson-reuters-general-ledger-manager-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/9ffcbf40-fb98-54e5-bee2-d680f1d3e7bc
  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)