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

# Consultar proyecto

> Detalle del proyecto con su resumen financiero: ventas, compras, planillas, órdenes de trabajo, utilidad, margen y avance del presupuesto.

**Permiso requerido:** `projects`



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{id}
openapi: 3.0.3
info:
  title: FileXpress API Externa
  version: 1.0.0
  description: >-
    API para integrar sistemas de terceros con FileXpress: facturación, RRHH,
    contabilidad, inventario, proyectos, cuentas por cobrar y pagar, tesorería,
    precios y promociones y caja.
servers:
  - url: https://api.filexpress.app/api/external
    description: Producción
security:
  - ApiKey: []
tags:
  - name: General
  - name: Facturación · Ventas
  - name: Facturación · Compras
  - name: Facturación · Clientes
  - name: Facturación · Proveedores
  - name: Facturación · Productos
  - name: Catálogos
  - name: RRHH · Empleados
  - name: RRHH · Asistencia
  - name: RRHH · Permisos
  - name: RRHH · Planillas
  - name: Contabilidad
  - name: Inventario
  - name: Proyectos
  - name: Cuentas por cobrar
  - name: Cuentas por pagar
  - name: Tesorería
  - name: Precios y promociones
  - name: Caja
paths:
  /projects/{id}:
    get:
      tags:
        - Proyectos
      summary: Consultar proyecto
      description: >-
        Detalle del proyecto con su resumen financiero: ventas, compras,
        planillas, órdenes de trabajo, utilidad, margen y avance del
        presupuesto.


        **Permiso requerido:** `projects`
      parameters:
        - name: id
          in: path
          required: true
          description: ID del proyecto
          schema:
            type: string
            format: uuid
          example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
      responses:
        '200':
          description: Éxito
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/ProjectDetail'
              example:
                status: true
                data:
                  id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  name: Remodelación oficinas Grupo ABC
                  status: in_progress
                  customer:
                    id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                    name: Grupo ABC S.A. de C.V.
                  branch_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  start_date: '2026-09-01'
                  end_date: '2026-12-15'
                  budget: 25000
                  description: Obra civil y mobiliario
                  quotation_id: null
                  created_at: '2026-08-28T11:00:00-06:00'
                  summary:
                    total_sales: 12000
                    total_expenses: 6500
                    total_payroll: 2100
                    total_work_orders: 400
                    total_costs: 9000
                    profit: 3000
                    margin_percent: 25
                    budget: 25000
                    budget_used_percent: 36
                    counts:
                      sales: 3
                      expenses: 8
                      payrolls: 2
                      work_orders: 1
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          description: No encontrado o de otro negocio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Project not found
        '429':
          $ref: '#/components/responses/E429'
components:
  schemas:
    ProjectDetail:
      allOf:
        - $ref: '#/components/schemas/Project'
        - type: object
          properties:
            summary:
              $ref: '#/components/schemas/ProjectSummary'
          required:
            - summary
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Errores por campo (solo en validación).
      required:
        - status
        - message
    Project:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          description: Estado.
          enum:
            - planned
            - in_progress
            - completed
            - on_hold
            - cancelled
        customer:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
          nullable: true
        branch_id:
          type: string
          format: uuid
          nullable: true
        start_date:
          type: string
          format: date
          nullable: true
        end_date:
          type: string
          format: date
          nullable: true
        budget:
          type: number
          nullable: true
        description:
          type: string
          nullable: true
        quotation_id:
          type: string
          format: uuid
          nullable: true
        created_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - status
    ProjectSummary:
      type: object
      properties:
        total_sales:
          type: number
        total_expenses:
          type: number
        total_payroll:
          type: number
        total_work_orders:
          type: number
        total_costs:
          type: number
        profit:
          type: number
        margin_percent:
          type: number
          nullable: true
        budget:
          type: number
          nullable: true
        budget_used_percent:
          type: number
          nullable: true
        counts:
          type: object
          properties:
            sales:
              type: integer
            expenses:
              type: integer
            payrolls:
              type: integer
            work_orders:
              type: integer
  responses:
    E401:
      description: API Key ausente o inválida
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integración sin el permiso requerido o desactivada
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E429:
      description: Límite de peticiones excedido
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key de la integración (Integraciones → Nueva Integración).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.