Thomson Reuters Processing Instructions API

openapi: 3.2.0
info:
  title: Thomson Reuters Processing Instructions API
  version: '1.0'
  description: 'Operations tagged Processing Instructions 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: Processing Instructions
  description: 'Documentation for Processing Instructions Service.

    ONESOURCE General Ledger Manager Processing Instructions APIs enables the definition of the expected data format and related information that is used during the data processing in GLM for the trial balances. During creation of processing instructions, users can provide source information and define, validate and enrichment information about the columns.

    Note: Providing the information on what Chart of Accounts is to be used is mandatory at the time of creating the Processing Instructions and is to be mapped to the field classified as ONESOURCE Account Code.'
paths:
  /templates:
    get:
      tags:
      - Processing Instructions
      summary: Get a paginated list of available Processing Instructions
      description: Returns a list of Processing Instructions with their metadata
      operationId: getTemplates
      parameters:
      - name: filter
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: Number of records in a Master Trial Balance to skip before starting the response set
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Maximum number of records to return in the result set
        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/ApiCollectionTemplateMeta'
      security:
      - bearerAuth: []
    post:
      tags:
      - Processing Instructions
      summary: Create a new Processing Instructions
      description: Adds Processing Instructions with required minimum criteria of ID & name and can have additional information around Data Fields (ID, version) & pipeline (validation, enrichment)
      operationId: createTemplate
      parameters:
      - 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:
        description: A Processing Instructions object that includes a pipeline. A pipeline is a list of operators that will be applied sequentially to each record in the ingested set
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplatePipeline'
        required: true
      responses:
        '201':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PostTemplatesResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /templates/{id}:
    get:
      tags:
      - Processing Instructions
      summary: Get Processing Instructions by ID
      description: Returns Processing Instructions metadata for the specified Processing Instructions ID
      operationId: getTemplate
      parameters:
      - name: id
        in: path
        description: Unique identifier of the Processing Instructions
        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/Template'
      security:
      - bearerAuth: []
    patch:
      tags:
      - Processing Instructions
      summary: Update Processing Instructions by ID
      description: Updates Processing Instructions metadata for the specified Processing Instructions ID. This endpoint also allows for a Processing Instructions to be renamed.
      operationId: updateTemplate
      parameters:
      - name: id
        in: path
        description: Unique identifier of the Processing Instructions
        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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTemplateRequest'
      responses:
        '204':
          description: default response
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
components:
  schemas:
    BlueprintId:
      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
        type_id:
          type: integer
          description: Unique identifier of the Data Fields type
          format: int32
          example: 2
    TemplateApiMeta:
      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
    Template:
      required:
      - name
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the Processing Instructions
          example: 5ec57f677456242950884996
        name:
          type: string
          description: Label of the Processing Instructions
          example: My Processing Instructions Name
        blueprint:
          $ref: '#/components/schemas/BlueprintId'
        source:
          $ref: '#/components/schemas/Source'
        pipeline:
          type: array
          description: A pipeline is a list of operators that will be executed in sequential order against each record in the ingested record set
          example:
          - offset: 1
          - identify:
            - name: account
              type: string
              ontology_id: 4
              blueprint_pos: 0
              parameters:
              - chart_of_accounts_id: 7b624759-9e17-4c7b-b17c-4fd9a926c777
              - format: -###,###.##
          - validate:
            - 0
          - enrich:
            - in: 0
              out:
                name: account
                type: string
                ontology_id: 4
                blueprint_pos: 0
          items:
            type: object
        is_hidden:
          type: boolean
          description: Visibility of the Processing Instructions
          example: false
        created_by:
          type: string
          example: UserA
        mapped_column_count:
          type: integer
          description: Total number of mapped columns in the Processing Instructions
          format: int32
          example: 5
        enrich_column_count:
          type: integer
          description: Total number of enrich columns in the Processing Instructions
          format: int32
          example: 5
        created_date:
          type: string
          description: File created at time
          format: date-time
          example: '2020-06-19T21:06:22.453Z'
        revision_id:
          type: integer
          description: Processing Instructions revision id
          format: int64
    TemplatePipeline:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Label of the Processing Instructions
          example: My Processing Instructions Name
        blueprint:
          $ref: '#/components/schemas/BlueprintId'
        pipeline:
          type: array
          description: A pipeline is a list of operators that will be executed in sequential order against each record in the ingested record set
          example:
          - offset: 1
          - identify:
            - name: account
              type: string
              ontology_id: 4
              blueprint_pos: 0
              parameters:
              - chart_of_accounts_id: 7b624759-9e17-4c7b-b17c  -4fd9a926c777
              - format: -###,###.##
          - validate:
            - 0
          - enrich:
            - in: 0
              out:
                name: account
                type: string
                ontology_id: 4
                blueprint_pos: 0
          items:
            type: object
        source:
          $ref: '#/components/schemas/Source'
    PostTemplatesResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the Processing Instructions
          example: 5ec57f677456242950884996
    ApiCollectionTemplateMeta:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TemplateMeta'
        _meta:
          $ref: '#/components/schemas/TemplateApiMeta'
    TemplateMeta:
      required:
      - name
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the Processing Instructions
          example: 5ec57f677456242950884996
        name:
          type: string
          description: Label of the Processing Instructions
          example: My Processing Instructions Name
        blueprint:
          $ref: '#/components/schemas/BlueprintId'
        source:
          $ref: '#/components/schemas/Source'
        is_hidden:
          type: boolean
          description: Visibility of the Processing Instructions
          example: false
        created_by:
          type: string
          example: UserA
        mapped_column_count:
          type: integer
          description: Total number of mapped columns in the Processing Instructions
          format: int32
          example: 5
        enrich_column_count:
          type: integer
          description: Total number of enrich columns in the Processing Instructions
          format: int32
          example: 5
        created_date:
          type: string
          description: Processing Instructions Created Date & time
          format: date-time
          example: '2020-06-19T21:06:22.453Z'
        revision_id:
          type: integer
          description: Processing Instructions revision id
          format: int64
    PatchTemplateRequest:
      type: object
      properties:
        pipeline:
          type: array
          description: A pipeline is a list of operators that will be executed in sequential order against each record in the ingested record set
          example:
          - offset: 1
          - identify:
            - name: account
              type: string
              ontology_id: 4
              blueprint_pos: 0
              parameters:
              - chart_of_accounts_id: 7b624759-9e17-4c7b-b17c-4fd9a926c777
              - format: -###,###.##
          - validate:
            - 0
          - enrich:
            - in: 0
              out:
                name: account
                type: string
                ontology_id: 4
                blueprint_pos: 0
          items:
            type: object
        source:
          $ref: '#/components/schemas/Source'
        is_hidden:
          type: boolean
          description: Visibility of the Processing Instructions
          example: false
        name:
          type: string
          description: A new name for the Processing Instructions
    Source:
      type: object
      properties:
        type:
          type: string
          description: Type of the file
          example: XLSX/DELIMITED
        delimiter:
          type: string
          description: delimiter of the file
          example: ','
        named_range:
          type: string
          description: Range in the Worksheet
          example: Named Range
        worksheet_name:
          type: string
          description: Name of the Worksheet
          example: Sheet1
        worksheet_index:
          type: integer
          description: Work Sheet index in the Excel file
          format: int32
          example: 0
        cell_range:
          type: string
          description: cell Range in the Excel file
          example: A10:C10
  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)