openapi: 3.0.1
info:
  title: Athena API V4
  version: v4
servers:
- url: https://api-uat.onesourcetax.com/trusts/v1/datasets
- url: https://api-emea.onesourcetax.com/trusts/v1/datasets
- url: https://api-apac.onesourcetax.com/trusts/v1/datasets
paths:
  /:
    get:
      tags:
      - DataSets
      summary: This endpoint is used to fetch the list of all datasets present including
        detailed information like Period, Entities, Templates, Created by etc.
      operationId: DataSets_GetDatasetsForApi
      parameters:
      - 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.Datasets.DatasetDetailsForApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetDetailsForApiResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetDetailsForApiResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetDetailsForApiResponse'
    post:
      tags:
      - DataSets
      summary: This endpoint is used to create a new dataset with the given payload
        parameters.
      operationId: DataSets_PerformDatasetOperationForApi
      parameters:
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Dataset'
          text/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Dataset'
          application/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Dataset'
          text/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Dataset'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Dataset'
        required: true
      responses:
        201:
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
        400:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus'
      x-codegen-request-body-name: datasetRequest
  /{id}:
    get:
      tags:
      - DataSets
      operationId: DataSets_GetDatasetDetailsById
      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.Datasets.DatasetDetail'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetDetail'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetDetail'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetDetail'
  /operations/{id}:
    get:
      tags:
      - DataSets
      summary: This endpoint is used to fetch the status (Pass/Fail/InProgress) of
        created Dataset.
      operationId: DataSets_GetStatusForDataset
      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.Common.OpertaionsResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Common.OpertaionsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Common.OpertaionsResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Common.OpertaionsResponse'
  /returns/e-file-return-search:
    post:
      tags:
      - DataSets
      summary: 'This endpoint is used to access EFiled data in a specific period.
        The input parameters required are: Start and End dates (Mandatory), Purpose(Optional).'
      operationId: DataSets_getCalculationandefiledData
      parameters:
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledJsonModel'
          text/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledJsonModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledJsonModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledJsonModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledJsonModel'
        required: true
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledCalculationResult'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledCalculationResult'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledCalculationResult'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.EfiledCalculationResult'
      x-codegen-request-body-name: searchrequest
  /{datasetid}/entities/{entityid}/sheet-data:
    post:
      tags:
      - DataSets
      summary: This endpoint is used for exporting return into json format.
      operationId: DataSets_GetCalculationSheetData
      parameters:
      - name: datasetid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: entityid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: The authorization token
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationDataRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationDataRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationDataRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationDataRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationDataRequest'
        required: true
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationSheetdataResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationSheetdataResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationSheetdataResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.CalculationSheetdataResponse'
      x-codegen-request-body-name: calculationDataRequest
  /{datasetid}/entities/{entityid}/export-return:
    get:
      tags:
      - DataSets
      summary: This endpoint is used for exporting return into excel format.
      operationId: DataSets_GetExport
      parameters:
      - name: datasetid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: entityid
        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:
                type: object
            text/json:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
components:
  schemas:
    TRTA.Athena.Models.Api.V4.Datasets.DatasetDetailsForApiResponse:
      type: object
      properties:
        items:
          type: array
          description: Datasets
          readOnly: true
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.DatasetDetail'
    TRTA.Athena.Models.Api.V4.Datasets.DatasetDetail:
      type: object
      properties:
        id:
          type: string
          description: Id of dataset
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
          description: Name of dataset
        startDate:
          type: string
          description: Start date of dataset
        endDate:
          type: string
          description: End  date of dataset
        year:
          type: integer
          description: Year of dataset
          format: int32
        purpose:
          type: string
          description: Purpose of dataset
        periodType:
          type: string
          description: Period type of dataset
          readOnly: true
        returnType:
          type: string
          description: Return type of dataset
        returns:
          type: array
          description: Returns or calculations
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Return'
    TRTA.Athena.Models.Api.V4.Datasets.Return:
      type: object
      properties:
        id:
          type: string
          description: Id of return
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
          description: Name of return
        status:
          type: string
          description: Status of return
        efilingStatus:
          type: string
          description: Efiling status of return
        year:
          type: string
          description: Year of return
        jurisdiction:
          $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Jurisdictions.Jurisdiction'
        startDate:
          type: string
          description: Start date  of return
        endDate:
          type: string
          description: End date of return
        entity:
          $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Entity'
        template:
          $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Template'
        createdBy:
          type: string
          description: Created by
        lastUpdatedBy:
          type: string
          description: Last updated by
        createdDate:
          type: string
          description: Created date
        lastUpdateDate:
          type: string
          description: Last update date
    TRTA.Athena.Models.Api.V4.Jurisdictions.Jurisdiction:
      type: object
      properties:
        id:
          type: string
          description: Id of jurisdiction
        name:
          type: string
          description: Name of jurisdiction
    TRTA.Athena.Models.Api.V4.Datasets.Entity:
      type: object
      properties:
        id:
          type: string
          description: Entity id
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
          description: Entity name
        shortName:
          type: string
          description: Entity short name
    TRTA.Athena.Models.Api.V4.Datasets.Template:
      type: object
      properties:
        id:
          type: string
          description: Template id
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        version:
          type: string
          description: Template version
        family:
          type: string
          description: Template family name
    TRTA.Athena.Models.Api.V4.Datasets.Dataset:
      type: object
      properties:
        name:
          type: string
          description: Name of dataset
        year:
          type: integer
          description: Year of dataset
          format: int32
        period:
          $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.Period'
        purpose:
          type: string
          description: Purpose of dataset
        type:
          type: string
          description: Type of dataset
        returnDetails:
          type: array
          description: Details of returns to be created.
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Datasets.ReturnDetails'
    TRTA.Athena.Models.Api.V4.Datasets.Period:
      type: object
      properties:
        startDate:
          type: string
          description: Start date of period
        endDate:
          type: string
          description: End date of period
        type:
          type: string
          description: Type of  period
      description: Period
    TRTA.Athena.Models.Api.V4.Datasets.ReturnDetails:
      type: object
      properties:
        entityId:
          type: string
          description: Entity id
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        templateId:
          type: string
          description: Template id
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        templateFamilyName:
          type: string
          description: Template family name
        clientTemplateName:
          type: string
          description: Name of dataset
        returnName:
          type: string
          description: Name of return
    TRTA.Athena.Models.Api.V4.Datasets.DatasetStatus:
      type: object
      properties:
        id:
          type: string
          description: Id of dataset
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        status:
          type: string
          description: Current status of dataset
        errors:
          type: array
          description: Errors if any
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Common.Errors'
      description: 'TODO: This is actually DataSetStatus Model'
    TRTA.Athena.Models.Api.V4.Common.Errors:
      type: object
      properties:
        id:
          type: integer
          description: Error id
          format: int32
        description:
          type: string
          description: Error message
    TRTA.Athena.Models.Api.V4.Common.OpertaionsResponse:
      type: object
      properties:
        status:
          type: string
        resourceLocation:
          type: string
    TRTA.Athena.Models.Api.V4.Calculations.EfiledJsonModel:
      type: object
      properties:
        startDate:
          type: string
          description: start date of period
        endDate:
          type: string
          description: End date of period
        purpose:
          type: string
          description: purpose
    TRTA.Athena.Models.Api.V4.Calculations.EfiledCalculationResult:
      type: object
      properties:
        returnName:
          type: string
          description: Name of the return
        isAmendedReturn:
          type: string
          description: Yes/No if return is amended
        clientTemplateName:
          type: string
          description: Name of client template from which return is created (if Any)
        datasetName:
          type: string
          description: Name of Dataset
        datasetPurpose:
          type: string
          description: Purpose of Dataset
        datasetType:
          type: string
          description: Type of Dataset
        datasetYear:
          type: integer
          description: Year of Dataset
          format: int32
        datasetStartDate:
          type: string
          description: Start Date of Dataset
        datasetEndDate:
          type: string
          description: End date of Dataset
        createdBy:
          type: string
          description: Name of user who created Dataset
        createDate:
          type: string
          description: Date of dataset creation
        entityName:
          type: string
          description: Name of the entity
        entityShortName:
          type: string
          description: Short name of Entity
        legalEntityType:
          type: string
          description: Type of Entity
        entityTaxType:
          type: string
          description: Tax type of Entity
        efileQueuedBy:
          type: string
          description: Name of user who queued return
        efileQueuedDate:
          type: string
          description: Date when Return is queued
        efileSubmittedBy:
          type: string
          description: Name of user who submitted the return
        efileSubmittedDate:
          type: string
          description: Date when Return is submitted
        efileValidated:
          type: string
          description: Calculcation is validated or not. (Yes/No)
        efilingStatus:
          type: string
          description: Current efiling status
        efileTan:
          type: string
          description: Efile TAN of return
    TRTA.Athena.Models.Api.V4.Calculations.CalculationDataRequest:
      type: object
      properties:
        sheetNames:
          type: array
          items:
            type: string
    TRTA.Athena.Models.Api.V4.Calculations.CalculationSheetdataResponse:
      type: object
      properties:
        sheetData:
          type: array
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.SheetData'
        datsetId:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        calculationName:
          type: string
        calculationId:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        entity:
          type: string
        error:
          type: string
    TRTA.Athena.Models.Api.V4.Calculations.SheetData:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        rowData:
          type: array
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.RowData'
    TRTA.Athena.Models.Api.V4.Calculations.RowData:
      type: object
      properties:
        index:
          type: integer
          format: int32
        rowId:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        columnData:
          type: array
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Calculations.ColumnData'
    TRTA.Athena.Models.Api.V4.Calculations.ColumnData:
      type: object
      properties:
        index:
          type: integer
          format: int32
        columnId:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        value:
          type: string