openapi: 3.0.1
info:
  title: Athena API V4
  version: v4
servers:
- url: https://api-uat.onesourcetax.com/trusts/v1/master-data
- url: https://api-emea.onesourcetax.com/trusts/v1/master-data
- url: https://api-apac.onesourcetax.com/trusts/v1/master-data
paths:
  /entities:
    get:
      tags:
      - Entities
      summary: This endpoint is used to list all the Entities in the system.
      operationId: Entities_GetEntities
      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.Entities.EntityListApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse'
    post:
      tags:
      - Entities
      summary: This endpoint is used for creating entities in the system.
      operationId: Entities_CreateEntities
      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.Entities.EntityCreationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityCreationRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityCreationRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityCreationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityCreationRequest'
        required: true
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse'
      x-codegen-request-body-name: entitiesCreateRequest
  /entities/{id}:
    get:
      tags:
      - Entities
      summary: This endpoint is used to fetch the detailed information of the entity
        that matches the input parameters.
      operationId: Entities_GetEntities_id
      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.Entities.EntityApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityApiResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityApiResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityApiResponse'
  /entity-hierarchy:
    get:
      tags:
      - Entities
      summary: This endpoint is used to fetch the information on Groups and Entities
        and the relation between them.
      operationId: Entities_getEntityHierarchy
      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.Entities.EntityHierarchyModelForApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityHierarchyModelForApiResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityHierarchyModelForApiResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityHierarchyModelForApiResponse'
  /jurisdictions:
    get:
      tags:
      - Jurisdictions
      summary: This endpoint fetches the details of all Jurisdictions supported in
        the system.
      operationId: Jurisdictions_GetJurisdictions
      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.Jurisdictions.JurisdictionListModelApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Jurisdictions.JurisdictionListModelApiResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Jurisdictions.JurisdictionListModelApiResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Jurisdictions.JurisdictionListModelApiResponse'
  /template-families:
    get:
      tags:
      - TemplateFamilies
      summary: This endpoint fetches the list of all Template Families supported in
        the system.
      operationId: TemplateFamilies_GetLicensedTemplates
      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.Templates.TemplateFamilyListResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.TemplateFamilyListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.TemplateFamilyListResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.TemplateFamilyListResponse'
  /template-families/{id}/templates:
    get:
      tags:
      - TemplateFamilies
      summary: This endpoint is used to retrieve the list of all templates in a specific
        Template Family.
      operationId: TemplateFamilies_getTemplatesFromTemplateId
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - 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.Templates.TemplateListResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.TemplateListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.TemplateListResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.TemplateListResponse'
components:
  schemas:
    TRTA.Athena.Models.Api.V4.Entities.EntityListApiResponse:
      type: object
      properties:
        items:
          type: array
          description: Entities
          readOnly: true
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityModel'
      description: Entity List API Response
    TRTA.Athena.Models.Api.V4.Entities.EntityModel:
      type: object
      properties:
        id:
          type: string
          description: Id
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
          description: Name
        shortName:
          type: string
          description: Short Name
        businessSegment:
          type: string
          description: Business Segment
        geography:
          type: string
          description: Geography
        active:
          type: boolean
          description: Active
        access:
          type: string
          description: Access
        legalEntityType:
          type: string
          description: Legal Entity Type
        managerLogin:
          type: string
          description: Manager
        partnerLogin:
          type: string
          description: Partner
        directorLogin:
          type: string
          description: Director
        type:
          type: string
          description: Type
        identifier:
          type: string
          description: Identifier
        taxId:
          type: string
          description: Tax Id
        team:
          type: string
          description: Team
        city:
          type: string
          description: City
        service:
          type: string
          description: Service
        jurisdiction:
          $ref: '#/components/schemas/TRTA.Athena.Models.Api.Jurisdiction'
        createdBy:
          type: string
          description: Created By
        createDate:
          type: string
          description: Created Date
        lastUpdatedBy:
          type: string
          description: Last Updated By
        lastUpdatedDate:
          type: string
          description: Last Update Date
      description: Entity
    TRTA.Athena.Models.Api.Jurisdiction:
      type: object
      properties:
        id:
          type: string
          description: Id of jurisdiction
        name:
          type: string
          description: Name of jurisdiction
    TRTA.Athena.Models.Api.V4.Entities.EntityCreationRequest:
      type: object
      properties:
        entities:
          type: array
          description: Entities
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityCreationModel'
    TRTA.Athena.Models.Api.V4.Entities.EntityCreationModel:
      type: object
      properties:
        name:
          type: string
          description: Name
        shortName:
          type: string
          description: Short Name
        businessSegment:
          type: string
          description: Business Segment
        geography:
          type: string
          description: Geography
        legalEntityType:
          type: string
          description: Legal Entity Type
        managerLogin:
          type: string
          description: Manager
        partnerLogin:
          type: string
          description: Partner
        directorLogin:
          type: string
          description: Director
        type:
          type: string
          description: Type
        identifier:
          type: string
          description: Identifier
        taxId:
          type: string
          description: Tax Id
        team:
          type: string
          description: Team
        city:
          type: string
          description: City
        service:
          type: string
          description: Service
        jurisdictionId:
          type: string
          description: Jurisdiction Name
      description: Entity
    TRTA.Athena.Models.Api.V4.Entities.EntityApiResponse:
      type: object
      properties:
        id:
          type: string
          description: Id
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
          description: Name
        shortName:
          type: string
          description: Short Name
        businessSegment:
          type: string
          description: Business Segment
        geography:
          type: string
          description: Geography
        active:
          type: boolean
          description: Active
        access:
          type: string
          description: Access
        legalEntityType:
          type: string
          description: Legal Entity Type
        managerLogin:
          type: string
          description: Manager
        partnerLogin:
          type: string
          description: Partner
        directorLogin:
          type: string
          description: Director
        type:
          type: string
          description: Type
        identifier:
          type: string
          description: Identifier
        taxId:
          type: string
          description: Tax Id
        team:
          type: string
          description: Team
        city:
          type: string
          description: City
        service:
          type: string
          description: Service
        jurisdiction:
          $ref: '#/components/schemas/TRTA.Athena.Models.Api.Jurisdiction'
        createdBy:
          type: string
          description: Created By
        createDate:
          type: string
          description: Created Date
        lastUpdatedBy:
          type: string
          description: Last Updated By
        lastUpdatedDate:
          type: string
          description: Last Update Date
      description: Entity API Response
    TRTA.Athena.Models.Api.V4.Entities.EntityHierarchyModelForApiResponse:
      type: object
      properties:
        items:
          type: array
          description: Hierarchy
          readOnly: true
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityHierarchyModelForApi'
      description: Entity hierarchy
    TRTA.Athena.Models.Api.V4.Entities.EntityHierarchyModelForApi:
      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
        exitDate:
          type: string
          description: Entity exit date
        entryDate:
          type: string
          description: Entity entry date
        isGroup:
          type: boolean
          description: If entity is group
          readOnly: true
        displayOrder:
          type: integer
          description: Entity display order
          format: int32
        entities:
          type: array
          description: Child entities
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Entities.EntityHierarchyModelForApi'
    TRTA.Athena.Models.Api.V4.Jurisdictions.JurisdictionListModelApiResponse:
      type: object
      properties:
        items:
          type: array
          description: Jurisdictions
          readOnly: true
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Jurisdictions.Jurisdiction'
    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.Templates.TemplateFamilyListResponse:
      type: object
      properties:
        items:
          type: array
          description: Template families
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.TemplateFamily'
    TRTA.Athena.Models.Api.V4.Templates.TemplateFamily:
      type: object
      properties:
        id:
          type: integer
          description: Id of template family
          format: int32
        name:
          type: string
          description: Name of template family
        taxRegime:
          type: string
          description: Tax Regime of template
        taxType:
          type: string
          description: Tax type of template
    TRTA.Athena.Models.Api.V4.Templates.TemplateListResponse:
      type: object
      properties:
        items:
          type: array
          description: Templates
          readOnly: true
          items:
            $ref: '#/components/schemas/TRTA.Athena.Models.Api.V4.Templates.Template'
    TRTA.Athena.Models.Api.V4.Templates.Template:
      type: object
      properties:
        id:
          type: string
          description: Id of template
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        name:
          type: string
          description: Name of template
        majorVersion:
          type: integer
          description: Major version of template
          format: int32
        minorVersion:
          type: integer
          description: Minor version of template
          format: int32
        year:
          type: integer
          description: Year of template
          format: int32
        taxRegimeId:
          type: string
          description: Tax Regime Id of template
        taxType:
          type: string
          description: Tax type of template
        isClientTemplate:
          type: boolean
          description: If it is client template
        sourceReturnIdClid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        sourceReturnCsid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000