> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vinmake.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Costing Dashboard

> Aggregated dashboard statistics for cost sheets within a single organization.

The organisation is derived from the `X-Org-Id` header or the authenticated user's org.

- **total_cost_sheets:** Number of unique cost sheets
- **by_status:** Draft/submitted/approved/rejected breakdown
- **avg_total_cost:** Average total cost across versions
- **recent_sheets:** Last 10 versions ordered by created date
- **cost_trend:** Monthly totals for the past six months



## OpenAPI

````yaml /api/openapi-cutmake.json get /api/v1/costings/dashboard
openapi: 3.1.0
info:
  title: VM App API
  version: 0.1.0
servers:
  - url: https://vinmake-erp.onrender.com
security: []
paths:
  /api/v1/costings/dashboard:
    get:
      tags:
        - Costing Management
      summary: Get Costing Dashboard
      description: >-
        Aggregated dashboard statistics for cost sheets within a single
        organization.


        The organisation is derived from the `X-Org-Id` header or the
        authenticated user's org.


        - **total_cost_sheets:** Number of unique cost sheets

        - **by_status:** Draft/submitted/approved/rejected breakdown

        - **avg_total_cost:** Average total cost across versions

        - **recent_sheets:** Last 10 versions ordered by created date

        - **cost_trend:** Monthly totals for the past six months
      operationId: get_costing_dashboard_api_v1_costings_dashboard_get
      parameters:
        - name: X-Org-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Org-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostingDashboardStats'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    CostingDashboardStats:
      properties:
        total_cost_sheets:
          type: integer
          title: Total Cost Sheets
        by_status:
          additionalProperties:
            type: integer
          type: object
          title: By Status
        avg_total_cost:
          type: number
          title: Avg Total Cost
        recent_sheets:
          items:
            $ref: '#/components/schemas/CostingDashboardRecentSheet'
          type: array
          title: Recent Sheets
        cost_trend:
          items:
            $ref: '#/components/schemas/CostingDashboardTrendPoint'
          type: array
          title: Cost Trend
      type: object
      required:
        - total_cost_sheets
        - by_status
        - avg_total_cost
        - recent_sheets
        - cost_trend
      title: CostingDashboardStats
      description: Response payload for `/costings/dashboard`.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CostingDashboardRecentSheet:
      properties:
        document_id:
          type: string
          title: Document Id
        version:
          type: integer
          title: Version
        status:
          type: string
          title: Status
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        total_cost:
          type: number
          title: Total Cost
      type: object
      required:
        - document_id
        - version
        - status
        - total_cost
      title: CostingDashboardRecentSheet
      description: Summary for a recently updated cost sheet.
    CostingDashboardTrendPoint:
      properties:
        month:
          type: string
          title: Month
        total_cost:
          type: number
          title: Total Cost
      type: object
      required:
        - month
        - total_cost
      title: CostingDashboardTrendPoint
      description: Monthly total cost point for trend charts.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/login

````