Thomson Reuters Data Queue API

openapi: 3.2.0
info:
  title: Thomson Reuters Data Queue API
  version: '1.0'
  description: 'Operations tagged Data Queue 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 Queue
  description: 'Manage ingests, upload files, extensions, extract data from integrations.

    ONESOURCE General Ledger Manager Data Queue APIs enables the users to upload the trial balance data from multiple disparate sources and process it.'
paths:
  /ingest/ingestions:
    get:
      tags:
      - Data Queue
      summary: Get a paginated list of available ingestions
      description: Returns a list of all the ingestions for a particular client based on filter conditions with their metadata
      operationId: getIngestions
      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/ApiCollectionIngestionResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/ingestions/{id}:
    get:
      tags:
      - Data Queue
      summary: Get an ingestion by ID
      description: Retrieves details of an ingestion identified by a unique id from ingest Metadata
      operationId: getIngestionById
      parameters:
      - name: id
        in: path
        description: Unique identifier of the ingested data
        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/IngestionResponse'
      security:
      - bearerAuth: []
    delete:
      tags:
      - Data Queue
      summary: Delete Ingest
      description: Remove Ingest details by ingest id
      operationId: removeIngestDetails
      parameters:
      - name: id
        in: path
        description: Unique identifier of the ingest data
        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:
        '204':
          description: ingest details does not exist
      security:
      - bearerAuth: []
    patch:
      tags:
      - Data Queue
      summary: Updates an existing ingest Metadata
      description: Updates Metadata to change Year, Period & Name
      operationId: updateMetadata_1
      parameters:
      - name: id
        in: path
        description: Unique identifier of the ingested data
        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/PatchIngestionRequest'
      responses:
        '204':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/IdResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/ingestions/{id}/records:
    get:
      tags:
      - Data Queue
      summary: Get a preview of the ingested data
      description: Returns records parsed from file from EFS, given ingest id
      operationId: getIngestRecords
      parameters:
      - name: id
        in: path
        description: Unique identifier of the ingested data
        required: true
        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/ApiCollectionString'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/files:
    get:
      tags:
      - Data Queue
      summary: Get a paginated list of available Files
      description: Returns a list of Files with their metadata
      operationId: getAllFiles
      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/ApiCollectionFileResponse'
      security:
      - bearerAuth: []
    post:
      tags:
      - Data Queue
      summary: Add Files to ingest Metadata
      description: 'Adds File with metadata: name (mandatory), delimiter, year, period'
      operationId: createFile
      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:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileRequest'
      responses:
        '201':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FileIdResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/files/{id}:
    get:
      tags:
      - Data Queue
      summary: Get a File by ID
      description: Returns File metadata for the specified File ID
      operationId: getFile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the File
        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: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FileResponse'
      security:
      - bearerAuth: []
    patch:
      tags:
      - Data Queue
      summary: Updates an existing ingest file
      description: Updates ingest files metadata, ingestion parts, and ingestion metadata to change delimiter, year and period
      operationId: updateMetadata
      parameters:
      - name: id
        in: path
        description: Unique identifier of the ingested data
        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/PatchIngestFileRequest'
      responses:
        '204':
          description: default response
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/files/{id}/upload:
    post:
      tags:
      - Data Queue
      summary: Initiate an upload of data into a file by ID
      description: Adds source file ID to initiate the streaming upload
      operationId: uploadFile
      parameters:
      - name: id
        in: path
        description: Unique identifier of the file
        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:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '200':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FileStatusResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/extensions/readers/xlsx-ingestions/{ingestion_id}/previews:
    post:
      tags:
      - Data Queue
      summary: Create xlsx file preview by ingestion id
      description: Returns the preview id for specified Ingestion Id
      operationId: createPreviewData_1
      parameters:
      - name: ingestion_id
        in: path
        description: Unique identifier of the ingested data
        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/PreviewRequest'
      responses:
        '200':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/IdResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/extensions/readers/xlsx-ingestions/previews/{preview_id}:
    get:
      tags:
      - Data Queue
      summary: Get xlsx file preview by preview id
      description: Returns the file preview for the specified preview id
      operationId: getPreviewRecord_1
      parameters:
      - name: preview_id
        in: path
        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: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PreviewByIdResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/extensions/readers/xlsx-ingestions/previews/{preview_id}/records:
    get:
      tags:
      - Data Queue
      summary: Get a preview of the file data
      description: Returns records parsed from file in S3, given preview id
      operationId: getPreviewOfRecords
      parameters:
      - name: preview_id
        in: path
        description: Unique identifier of the file data preveiw
        required: true
        schema:
          type: integer
          format: int32
      - 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/ApiCollectionString'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/extensions/readers/delimited-ingestions/{ingestion_id}/records:
    get:
      tags:
      - Data Queue
      summary: Get a preview of the ingested data
      description: Returns records parsed from file from EFS, given ingest id
      operationId: getIngestRecordsPreview
      parameters:
      - name: ingestion_id
        in: path
        description: Unique identifier of the ingested data
        required: true
        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/ApiCollectionString'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/extensions/readers/xlsx-ingestions/{ingestion_id}/named-ranges:
    get:
      tags:
      - Data Queue
      summary: Get xlsx file named ranges by ingestion id
      description: Returns the file named ranges for the specified Ingestion Id
      operationId: getNamedRanges
      parameters:
      - name: ingestion_id
        in: path
        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/NamedRangesResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
  /ingest/extensions/readers/xlsx-ingestions/{ingestion_id}/worksheets:
    get:
      tags:
      - Data Queue
      summary: Get xlsx file tab details by ingestion id
      description: Returns the file worksheets for the specified Ingestion Id
      operationId: getTabDetails
      parameters:
      - name: ingestion_id
        in: path
        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/TabDetailsResponse'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.onesourcetax.com/general-ledger-manager/v1
components:
  schemas:
    PatchIngestionRequest:
      type: object
      properties:
        year:
          type: integer
          description: Relevant year of importance for the file data
          format: int32
          example: 2019
        period:
          type: integer
          description: Numeric period of no specific precision
          format: int32
          example: 12
        name:
          type: string
          description: Label of the File
          example: My File Name.csv
    IdResponse:
      type: object
      properties:
        id:
          type: string
    Tab:
      type: object
      properties:
        index:
          type: integer
          format: int32
        name:
          type: string
    FileResponse:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the File
          format: int32
          example: 102
        name:
          type: string
          description: Label of the File
          example: My File Name.csv
        status:
          type: string
          description: Status of file upload
          enum:
          - NEW
          - UPLOADING
          - UPLOADED
          - UPLOAD_FAILED
        delimiter:
          type: string
          description: String upon which the row will be split
          example: ','
        year:
          type: integer
          description: Relevant year of importance for the file data
          format: int32
          example: 2019
        period:
          type: integer
          description: Numeric period of no specific precision
          format: int32
          example: 12
        ingest_id:
          type: string
          description: Unique identifier of the Ingestion
          example: 5ec57f677456242950884996
        created_at:
          type: string
          description: File created at time
          format: date-time
          example: '2020-06-19T21:06:22.453Z'
        created_by:
          type: string
          example: UserA
        completed_at:
          type: string
          description: Process completed at time
          format: date-time
          example: '2020-06-19T21:06:22.453Z'
        upload_started_at:
          type: string
          description: File upload started at time
          format: date-time
          example: '2020-06-19T21:06:22.453Z'
        upload_ended_at:
          type: string
          description: File upload ended at time
          format: date-time
          example: '2020-06-19T21:06:22.453Z'
        uploaded_bytes:
          type: integer
          description: Total file size uploaded
          format: int64
          example: 2384298367492834
        mime_type:
          type: string
          description: file Mediatype
          example: text/csv
        content_type:
          type: string
          description: file ContentType
          example: csv
    FileStatusResponse:
      type: object
      properties:
        status:
          type: string
          example: File Uploaded Successfully
    TabDetailsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Tab'
    NamedRange:
      type: object
      properties:
        name:
          type: string
        range:
          type: string
    FileRequest:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Label of the File
          example: My File Name.csv
        delimiter:
          maxLength: 3
          minLength: 0
          type: string
          description: String upon which the row will be split
          example: ','
        year:
          type: integer
          description: Relevant year of importance for the file data
          format: int32
          example: 2019
        period:
          type: integer
          description: Numeric period of no specific precision
          format: int32
          example: 12
    FileIdResponse:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the File
          format: int32
          example: 102
    PreviewRequest:
      type: object
      properties:
        worksheet_index:
          type: integer
          format: int32
        worksheet_name:
          type: string
        named_range:
          type: string
        cell_range:
          type: string
    PreviewByIdResponse:
      type: object
      properties:
        id:
          type: integer
          format: int32
        ingest_id:
          type: string
        preview_parameter:
          type: object
          additionalProperties:
            type: object
        file_type:
          type: string
        path:
          type: string
        created_date:
          type: string
          description: Time at which this part was created
          format: date-time
          example: '2020-12-19T21:06:22.453Z'
        status:
          type: string
        error:
          type: string
    ApiCollectionIngestionResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/IngestionResponse'
        _meta:
          $ref: '#/components/schemas/IngestApiMeta'
    NamedRangesMeta:
      type: object
      properties:
        count:
          type: integer
          format: int32
    ApiCollectionString:
      type: object
      properties:
        items:
          type: array
          items:
            type: array
            items:
              type: string
        _meta:
          $ref: '#/components/schemas/IngestApiMeta'
    ApiCollectionFileResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FileResponse'
        _meta:
          $ref: '#/components/schemas/IngestApiMeta'
    PatchIngestFileRequest:
      type: object
      properties:
        delimiter:
          type: string
          description: String upon which the row will be split
          example: ','
        year:
          type: integer
          description: Relevant year of importance for the file data
          format: int32
          example: 2019
        period:
          type: integer
          description: Numeric period of no specific precision
          format: int32
          example: 12
        name:
          type: string
          description: Label of the File
          example: My File Name.csv
    IngestApiMeta:
      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
    NamedRangesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/NamedRange'
        _meta:
          $ref: '#/components/schemas/NamedRangesMeta'
    IngestionResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the Ingestion
          example: '46'
        name:
          type: string
          description: Label of the ingestion
          example: My File Name.csv
        year:
          type: integer
          description: Relevant year of importance for the ingestion
          format: int32
          example: 2019
        period:
          type: integer
          description: Numeric period of no specific precision
          format: int32
          example: 12
        provider:
          type: string
          description: Source of ingestion
          example: INTEGRATION, FILE, ALTERYX
        status:
          type: string
          enum:
          - COMPLETE
          - AWAITING
        created_at:
          type: string
          description: Time at which this ingestion was created
          format: date-time
          example: '2020-12-19T21:06:22.453Z'
        created_by:
          type: string
          example: UserA
        mime_type:
          type: string
        content_type:
          type: string
  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)