Alquileres

Proyecto

El proyecto, tal como lo devuelve la API.

Esquemas: ProjectDto, ProjectDetailDto

{
  "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"
}

Generado a partir del esquema

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 es escribible, así que puede contener tu propia clave. Archiva o restaura un proyecto con PUT /api/v1/projects/{projectId}/archive y vincula pedidos a él con POST /api/v1/projects/{projectId}/orders/{orderId}.

Atributos

idstring

Identificador único del proyecto.

projectNumberstring | null

Número de proyecto legible; null si no está numerado.

namestring

Nombre del proyecto.

colorstring | null

Color asociado al proyecto (para la interfaz); null si no tiene.

externalReferencestring | null

Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta.

projectTypeIdstring | null

Identificador del tipo de proyecto; null si el proyecto no tiene tipo.

projectTypeobject | null

Referencia compacta al tipo de proyecto; null si no hay.

Mostrar atributos hijos

projectType.idstring

Identificador único del tipo de proyecto.

projectType.namestring

Nombre del tipo de proyecto.

projectType.colorstring | null

Color asociado al tipo de proyecto (para la interfaz); null si no tiene.

contactobject | null

Referencia compacta al contacto del proyecto; null si no hay.

Mostrar atributos hijos

contact.idstring

Identificador único del contacto.

contact.namestring

Nombre del contacto.

locationobject

Ubicación del proyecto; sus campos internos son null cuando no se han registrado.

Mostrar atributos hijos

location.namestring | null

Nombre del lugar o ubicación; null si no está registrado.

location.addressstring | null

Dirección de la ubicación; null si no consta.

location.citystring | null

Ciudad de la ubicación; null si no consta.

location.postalCodestring | null

Código postal de la ubicación; null si no se ha registrado.

location.provincestring | null

Provincia o región de la ubicación; null si no se ha registrado.

location.countrystring | null

País de la ubicación; null si no consta.

location.latnumber | null

Latitud de la ubicación; null si no está registrada.

location.lngnumber | null

Longitud de la ubicación; null si no está registrada.

startDatestring<date-time>

Fecha de inicio del proyecto en ISO 8601 con desplazamiento.

endDatestring<date-time>

Fecha de fin del proyecto en ISO 8601 con desplazamiento.

statusstring

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.

Opciones disponibles: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

archivedboolean

Si el proyecto está archivado.

orderIdsstring[]

Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en GET /api/v1/orders?projectId=.

totalOrdersinteger

Número total de pedidos del proyecto (igual a orderIds.length).

tagsobject[]

Etiquetas adjuntas al proyecto, con su identificador y nombre.

Mostrar atributos hijos

tags.idstring

Identificador único de la etiqueta.

tags.namestring

Nombre de la etiqueta.

customFieldsobject<string, any>

Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api/v1/custom-fields.

sourcestring | null

Origen desde el que se creó el proyecto; null si no consta.

createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

Valores

status: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

Lo devuelven

GET /api/v1/projects — Listar proyectos
GET /api/v1/projects/{projectId} — Obtener un proyecto

Lo modifican

POST /api/v1/projects — Crear un proyecto
PATCH /api/v1/projects/{projectId} — Actualizar un proyecto
POST /api/v1/projects/{projectId}/orders/{orderId} — Vincular un pedido a un proyecto
DELETE /api/v1/projects/{projectId}/orders/{orderId} — Desvincular un pedido de un proyecto

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican