openapi: 3.0.3
info:
  title: Apptio Technology Business Management API
  description: >-
    API for the Apptio technology business management platform, providing
    programmatic access to cost allocations, IT financial data, budgets, and
    technology investment analytics for IT finance and planning teams.
  version: 1.0.0
  contact:
    name: Apptio Developer
    url: https://developer.apptio.com
  license:
    name: Proprietary
servers:
  - url: https://api.apptio.com/v1
    description: Apptio TBM API
security:
  - bearerAuth: []
tags:
  - name: Cost Allocations
    description: Technology cost allocation management
  - name: Budgets
    description: IT budget planning and tracking
  - name: Reports
    description: Financial reporting and analytics
paths:
  /cost-allocations:
    get:
      operationId: listCostAllocations
      summary: Apptio - List Cost Allocations
      description: Returns a list of technology cost allocations by period and cost center
      tags:
        - Cost Allocations
      parameters:
        - name: period
          in: query
          description: Filter by reporting period (YYYY-MM format)
          schema:
            type: string
        - name: costCenter
          in: query
          description: Filter by cost center or department
          schema:
            type: string
        - name: category
          in: query
          description: Filter by technology cost category
          schema:
            type: string
      responses:
        '200':
          description: A list of cost allocations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CostAllocation'
                  total:
                    type: number
                    description: Total allocated amount
              examples:
                ListAllocationsExample:
                  x-microcks-default: true
                  summary: Example cost allocations list
                  value:
                    data:
                      - allocationId: ALLOC-2026-Q1-001
                        costCenter: Engineering
                        category: Cloud Infrastructure
                        period: "2026-01"
                        amount: 125000.00
                        currency: USD
                        vendor: AWS
                    total: 125000.00
        '401':
          description: Unauthorized - invalid or missing authentication token
  /cost-allocations/{allocationId}:
    get:
      operationId: getCostAllocation
      summary: Apptio - Get Cost Allocation
      description: Returns details for a specific cost allocation record
      tags:
        - Cost Allocations
      parameters:
        - name: allocationId
          in: path
          required: true
          description: Unique cost allocation identifier
          schema:
            type: string
      responses:
        '200':
          description: Cost allocation details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostAllocation'
              examples:
                GetAllocationExample:
                  x-microcks-default: true
                  summary: Example cost allocation detail
                  value:
                    allocationId: ALLOC-2026-Q1-001
                    costCenter: Engineering
                    category: Cloud Infrastructure
                    period: "2026-01"
                    amount: 125000.00
                    currency: USD
                    vendor: AWS
                    tags:
                      environment: production
                      team: platform
        '404':
          description: Cost allocation not found
        '401':
          description: Unauthorized - invalid or missing authentication token
  /budgets:
    get:
      operationId: listBudgets
      summary: Apptio - List Budgets
      description: Returns a list of IT budget plans and their current spending status
      tags:
        - Budgets
      parameters:
        - name: fiscalYear
          in: query
          description: Filter by fiscal year
          schema:
            type: integer
      responses:
        '200':
          description: A list of budgets
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Budget'
              examples:
                ListBudgetsExample:
                  x-microcks-default: true
                  summary: Example budgets list
                  value:
                    data:
                      - budgetId: BUD-2026-ENG
                        name: Engineering IT Budget 2026
                        fiscalYear: 2026
                        totalBudget: 2000000.00
                        spentAmount: 375000.00
                        currency: USD
        '401':
          description: Unauthorized - invalid or missing authentication token
  /reports:
    get:
      operationId: listReports
      summary: Apptio - List Reports
      description: Returns a list of available financial and technology management reports
      tags:
        - Reports
      responses:
        '200':
          description: A list of reports
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Report'
              examples:
                ListReportsExample:
                  x-microcks-default: true
                  summary: Example reports list
                  value:
                    data:
                      - reportId: RPT-COST-TREND-2026
                        name: IT Cost Trend Analysis Q1 2026
                        type: cost-trend
                        period: Q1 2026
                        status: ready
        '401':
          description: Unauthorized - invalid or missing authentication token
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    CostAllocation:
      title: CostAllocation
      description: A technology cost allocation record
      type: object
      properties:
        allocationId:
          type: string
          description: Unique allocation identifier
        costCenter:
          type: string
          description: Cost center or department
        category:
          type: string
          description: Technology cost category
        period:
          type: string
          description: Reporting period (YYYY-MM)
        amount:
          type: number
          description: Allocated cost amount
        currency:
          type: string
          description: Currency code
        vendor:
          type: string
          description: Technology vendor or provider
        tags:
          type: object
          description: Custom metadata tags
    Budget:
      title: Budget
      description: An IT budget plan with spending tracking
      type: object
      properties:
        budgetId:
          type: string
          description: Unique budget identifier
        name:
          type: string
          description: Budget name
        fiscalYear:
          type: integer
          description: Fiscal year for the budget
        totalBudget:
          type: number
          description: Total budget amount
        spentAmount:
          type: number
          description: Amount spent to date
        currency:
          type: string
          description: Currency code
    Report:
      title: Report
      description: An Apptio financial or technology management report
      type: object
      properties:
        reportId:
          type: string
          description: Unique report identifier
        name:
          type: string
          description: Report name
        type:
          type: string
          description: Report type (cost-trend, allocation, variance, etc.)
        period:
          type: string
          description: Report period
        status:
          type: string
          enum: [generating, ready, failed]
          description: Report generation status