openapi: 3.0.1
info:
  title: Imports
  version: v1
servers:
- url: https://api-emea.onesourcetax.com/corporate-tax/v1/imports
- url: https://api-apac.onesourcetax.com/corporate-tax/v1/imports
paths:
  /datasets/{id}/import-types:
    get:
      tags:
      - CorporateTaxImports
      summary: This endpoint is used to list all the supported import types for a
        specific dataset.
      operationId: CorporateTaxImports_GetSupportedImports
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeListReponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeListReponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeListReponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeListReponse'
  /datasets/{id}/import-types/{importtypeid}/metadata:
    get:
      tags:
      - CorporateTaxImports
      summary: This endpoint is used to retrieve the input parameters for a specific
        import type.
      operationId: CorporateTaxImports_GetImportMedata
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: importtypeid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: importBasedOn
        in: query
        schema:
          type: string
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeMetaDataListReponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeMetaDataListReponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeMetaDataListReponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeMetaDataListReponse'
  /:
    post:
      tags:
      - CorporateTaxImports
      summary: This endpoint is used to import data into calculations. Input parameters
        required can be fetched from metadata API.
      operationId: CorporateTaxImports_ImportData
      parameters:
      - name: isAppend
        in: query
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
            application/xml:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
        "400":
          description: BadRequest
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            text/xml:
              schema:
                type: string
  /operations/{id}:
    get:
      tags:
      - CorporateTaxImports
      operationId: CorporateTaxImports_GetStatusForImport
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
  /datasets/{datasetId}/journals:
    get:
      tags:
      - CorporateTaxImports
      summary: This endpoint is used to list all the journals  for a specific dataset.
      operationId: CorporateTaxImports_GetAllJournals
      parameters:
      - name: datasetId
        in: path
        description: The unique identifier of the dataset.
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.JournalsListResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.JournalsListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.JournalsListResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.JournalsListResponse'
    delete:
      tags:
      - CorporateTaxImports
      summary: This endpoint is used to delete all the journals  for a specific dataset.
      operationId: CorporateTaxImports_DeleteJournalsbasedondatasetID
      parameters:
      - name: datasetId
        in: path
        description: The unique identifier of the dataset.
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "204":
          description: NoContent
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
        "404":
          description: NotFound
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
  /datasets/{datasetId}/journals/{journalId}:
    delete:
      tags:
      - CorporateTaxImports
      summary: This endpoint is used to delete a journal  for a specific dataset.
      operationId: CorporateTaxImports_DeleteJournalBasedondatasetIdandjournalId
      parameters:
      - name: datasetId
        in: path
        description: The unique identifier of the dataset.
        required: true
        schema:
          type: string
          format: uuid
      - name: journalId
        in: path
        description: The unique identifier of the journal.
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      responses:
        "204":
          description: NoContent
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
        "404":
          description: NotFound
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
components:
  schemas:
    TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeListReponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportType'
      description: Import Type List Response
    TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportType:
      type: object
      properties:
        name:
          type: string
          description: Import Type Name
    TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportTypeMetaDataListReponse:
      type: object
      properties:
        fields:
          type: array
          description: Import fields
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportField'
    TRTA.Athena.Models.Api.V4.Imports.CorporateTax.ImportField:
      type: object
      properties:
        name:
          type: string
          description: Field name
        description:
          type: string
          description: Caption of field
        isRequired:
          type: boolean
          description: If field is required
    TRTA.Athena.Models.Api.V4.Imports.CorporateTax.JournalsListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.JournalData'
      description: Journals List Response
    TRTA.Athena.Models.Api.V4.Imports.CorporateTax.JournalData:
      type: object
      properties:
        id:
          type: string
          description: Journals List
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        description:
          type: string
        returnId:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        datasetName:
          type: string
        period:
          type: string
        year:
          type: integer
          format: int32
        referenceNumber:
          type: string
        entityId:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        entityIdentifier:
          type: string
        entityName:
          type: string
        entityShortName:
          type: string
        lineItemsCount:
          type: integer
          format: int32
        importType:
          type: string
        isAppended:
          type: boolean
        startDate:
          type: string
        endDate:
          type: string
        createdBy:
          type: string
        lastUpdatedBy:
          type: string
        createdDate:
          type: string
          format: date-time
        lastUpdateDate:
          type: string
          format: date-time
x-original-swagger-version: "2.0"