*API REST › Objetos › Alquileres*

# Proyecto

> El proyecto, tal como lo devuelve la API.

Un proyecto que agrupa pedidos y trabajo para un contacto, con sus fechas, tipo, ubicación y los identificadores de sus pedidos. Los proyectos usan el aislamiento heredado de la cuenta principal, así que una cuenta de facturación también ve los proyectos de su cuenta principal. [`externalReference`](https://docs.filmo.io/es/rest-api/objects/project#response-externalReference) es escribible, así que puede contener tu propia clave. Archiva o restaura un proyecto con [`PUT /api/v1/projects/{projectId}/archive`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/archive-or-restore-a-project) y vincula pedidos a él con [`POST /api/v1/projects/{projectId}/orders/{orderId}`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/link-an-order-to-a-project).

Esquemas: `ProjectDto`, `ProjectDetailDto`

## Atributos

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `id` | string | Identificador único del proyecto. |
| `projectNumber` | string | Número de proyecto legible; null si no está numerado. |
| `name` | string | Nombre del proyecto. |
| `color` | string | Color asociado al proyecto (para la interfaz); null si no tiene. |
| `externalReference` | string | Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta. |
| `projectTypeId` | string | Identificador del tipo de proyecto; null si el proyecto no tiene tipo. |
| `projectType` | object | Referencia compacta al tipo de proyecto; null si no hay. |
| `projectType.id` | string | Identificador único del tipo de proyecto. |
| `projectType.name` | string | Nombre del tipo de proyecto. |
| `projectType.color` | string | Color asociado al tipo de proyecto (para la interfaz); null si no tiene. |
| `contact` | object | Referencia compacta al contacto del proyecto; null si no hay. |
| `contact.id` | string | Identificador único del contacto. |
| `contact.name` | string | Nombre del contacto. |
| `location` | object | Ubicación del proyecto; sus campos internos son null cuando no se han registrado. |
| `location.name` | string | Nombre del lugar o ubicación; null si no está registrado. |
| `location.address` | string | Dirección de la ubicación; null si no consta. |
| `location.city` | string | Ciudad de la ubicación; null si no consta. |
| `location.postalCode` | string | Código postal de la ubicación; null si no se ha registrado. |
| `location.province` | string | Provincia o región de la ubicación; null si no se ha registrado. |
| `location.country` | string | País de la ubicación; null si no consta. |
| `location.lat` | number | Latitud de la ubicación; null si no está registrada. |
| `location.lng` | number | Longitud de la ubicación; null si no está registrada. |
| `startDate` | string<date-time> | Fecha de inicio del proyecto en ISO 8601 con desplazamiento. |
| `endDate` | string<date-time> | Fecha de fin del proyecto en ISO 8601 con desplazamiento. |
| `status` | string | Estado del proyecto: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled o archived. `archived` es un estado HEREDADO que aparece en datos antiguos; el estado archivado actual se expresa mediante el booleano `archived` de este mismo DTO. `draft`, `budgeted`, `confirmed`, `in_progress`, `invoiced`, `completed`, `cancelled`, `archived` |
| `archived` | boolean | Si el proyecto está archivado. |
| `orderIds` | string[] | Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en [`GET /api/v1/orders`](https://docs.filmo.io/es/rest-api/endpoint-reference/orders/list-orders)?projectId=. |
| `totalOrders` | integer | Número total de pedidos del proyecto (igual a orderIds.length). |
| `tags` | object[] | Etiquetas adjuntas al proyecto, con su identificador y nombre. |
| `tags.id` | string | Identificador único de la etiqueta. |
| `tags.name` | string | Nombre de la etiqueta. |
| `customFields` | object<string, any> | Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en `/api/v1/custom-fields`. |
| `source` | string | Origen desde el que se creó el proyecto; null si no consta. |
| `createdAt` | string<date-time> | Fecha de creación en ISO 8601 con desplazamiento. |
| `updatedAt` | string<date-time> | Fecha de la última actualización en ISO 8601 con desplazamiento. |

## Valores

| Campo | Valores |
| --- | --- |
| `status` | `draft`, `budgeted`, `confirmed`, `in_progress`, `invoiced`, `completed`, `cancelled`, `archived` |

## Ejemplo

*Project · Generado a partir del esquema*

```json
{
  "id": "id_8f2a1c",
  "projectNumber": "string",
  "name": "Example",
  "color": "string",
  "externalReference": "string",
  "projectTypeId": "string",
  "projectType": {
    "id": "id_8f2a1c",
    "name": "Example",
    "color": "string"
  },
  "contact": {
    "id": "id_8f2a1c",
    "name": "Example"
  },
  "location": {
    "name": "Example",
    "address": "string",
    "city": "string",
    "postalCode": "string",
    "province": "string",
    "country": "ES",
    "lat": 1,
    "lng": 1
  },
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "status": "draft",
  "archived": true,
  "orderIds": [
    "string"
  ],
  "totalOrders": 1,
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "customFields": {
    "key": "string"
  },
  "source": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Lo devuelven

- [`GET /api/v1/projects`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/list-projects) — Listar proyectos
- [`GET /api/v1/projects/{projectId}`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/get-a-project) — Obtener un proyecto

## Lo modifican

- [`POST /api/v1/projects`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/create-a-project) — Crear un proyecto
- [`PATCH /api/v1/projects/{projectId}`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/update-a-project) — Actualizar un proyecto
- [`POST /api/v1/projects/{projectId}/orders/{orderId}`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/link-an-order-to-a-project) — Vincular un pedido a un proyecto
- [`DELETE /api/v1/projects/{projectId}/orders/{orderId}`](https://docs.filmo.io/es/rest-api/endpoint-reference/projects/unlink-an-order-from-a-project) — Desvincular un pedido de un proyecto

---

URL canónica: https://docs.filmo.io/es/rest-api/objects/project  
Última actualización: 2026-10-25