> ## 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.

# Create project

> Creates a project. The customer and branch must belong to the business.

**Required permission:** `projects.write`



## OpenAPI

````yaml /api-reference/openapi.en.json post /projects
openapi: 3.0.3
info:
  title: FileXpress External API
  version: 1.0.0
  description: >-
    API for integrating third-party systems with FileXpress: billing, HR,
    accounting, inventory, projects, accounts receivable and payable, treasury,
    pricing and promotions, and cash. Current base URL: /api/external/v1. The
    legacy unversioned path (/api/external) will be removed on January 1, 2027;
    migrate to /api/external/v1 (same endpoints, only the base URL changes). The
    v2 API (/api/external/v2) exposes currencies and exchange rates, sales and
    purchases in foreign currency, taxes by id, payrolls with branch, and errors
    with a stable `code`; its operations carry the /v2 prefix in the path. We
    suggest migrating to the available v2 routes before March 30, 2027.
servers:
  - url: https://api.filexpress.app/api/external/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: General
  - name: Billing · Sales
  - name: Billing · Purchases
  - name: Billing · Customers
  - name: Billing · Suppliers
  - name: Billing · Products
  - name: Catalogs
  - name: HR · Employees
  - name: HR · Attendance
  - name: HR · Labor rules
  - name: HR · Schedules
  - name: HR · Holidays
  - name: HR · Attendance results
  - name: HR · Leave requests
  - name: HR · Payrolls
  - name: Accounting
  - name: Inventory
  - name: Projects
  - name: Accounts receivable
  - name: Accounts payable
  - name: Treasury
  - name: Pricing and promotions
  - name: Cash
  - name: Points of sale
  - name: API v2 · General
  - name: API v2 · Currencies and rates
  - name: API v2 · Countries
  - name: API v2 · Sales
  - name: API v2 · Purchases
  - name: API v2 · Payrolls
paths:
  /projects:
    post:
      tags:
        - Projects
      summary: Create project
      description: |-
        Creates a project. The customer and branch must belong to the business.

        **Required permission:** `projects.write`
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectRequest'
            example:
              name: Remodelación oficinas Grupo ABC
              customer_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
              branch_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
              start_date: '2026-09-01'
              end_date: '2026-12-15'
              budget: 25000
              status: in_progress
              description: Obra civil y mobiliario
      responses:
        '201':
          description: Project created
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/Project'
              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'
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '409':
          description: Idempotency conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                idem_body:
                  summary: Idempotency-Key reutilizada con otro cuerpo
                  value:
                    status: false
                    message: >-
                      This Idempotency-Key was already used with a different
                      request.
                idem_busy:
                  summary: Petición con la misma llave en proceso
                  value:
                    status: false
                    message: >-
                      A request with this Idempotency-Key is already being
                      processed.
        '422':
          description: Validation error or customer/branch from another business
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Customer not found
        '429':
          $ref: '#/components/responses/E429'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Optional. Unique key per operation (max. 100 characters, valid for 24 h
        per integration). A retry with the same key and the same body returns
        the original response (header `Idempotent-Replayed: true`) without
        repeating the operation; with a different body, or while the first is
        still in progress, it returns 409.
      schema:
        type: string
        maxLength: 100
      example: pago-2026-10-06-000123
  schemas:
    ProjectRequest:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        customer_id:
          type: string
          format: uuid
          description: Customer of the business.
        branch_id:
          type: string
          format: uuid
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
        budget:
          type: number
          minimum: 0
        status:
          type: string
          description: Status.
          enum:
            - planned
            - in_progress
            - completed
            - on_hold
            - cancelled
        description:
          type: string
          maxLength: 2000
      required:
        - name
        - customer_id
        - start_date
        - status
    Project:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          description: Status.
          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
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Errors per field (validation only).
      required:
        - status
        - message
  headers:
    IdempotentReplayed:
      description: >-
        `true` when the response is the replay of a previous request with the
        same Idempotency-Key.
      schema:
        type: string
        enum:
          - 'true'
  responses:
    E401:
      description: Missing or invalid API Key
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integration without the required permission or deactivated
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E429:
      description: Rate limit exceeded
      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: Integration API Key (Integrations → New Integration).

````

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