openapi: 3.0.1
info:
  title: Athena API V4
  version: v4
servers:
- url: https://api-uat.onesourcetax.com/trusts/v1/imports
- url: https://api-emea.onesourcetax.com/trusts/v1/imports
- url: https://api-apac.onesourcetax.com/trusts/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/{name}/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: name
        in: path
        required: true
        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
      - 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.CorporateTaxImportResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.CorporateTaxImportResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.CorporateTaxImportResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Imports.CorporateTax.CorporateTaxImportResponse'
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.CorporateTaxImportResponse:
      type: object
      properties:
        importId:
          type: string
          description: dataset id
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        importStatus:
          type: string