*API REST › Objetos › Plataforma*

# Definición de campo personalizado

> DEFINICIÓN de un campo personalizado de la cuenta: su identificador, el tipo que admite y los valores que acepta.

La definición de un campo personalizado de la cuenta: su identificador, el tipo de dato que admite, los valores que acepta si es un desplegable y el tipo de entidad a la que se aplica. No es el valor guardado en ningún registro; los valores viajan dentro de cada recurso. Lee las definiciones antes de escribir un campo personalizado. Los campos personalizados usan el aislamiento heredado de la cuenta principal.

Esquemas: `CustomFieldDefinitionDto`

## Atributos

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `id` | string | Identificador único de la definición. Es el que se usa al escribir un valor. |
| `name` | string | Nombre visible del campo. |
| `dataType` | string | Tipo de dato que acepta el campo. `text`, `multitext`, `dropdown`, `checkbox`, `radio`, `date`, `contact`, `item`, `space`, `staff_member`, `vehicle` |
| `description` | string | Descripción del campo; null si no tiene. |
| `options` | string[] | Valores permitidos cuando el campo es un desplegable. Vacío para los demás tipos. |
| `applyAt` | string[] | Entidades en las que se puede usar el campo. `order`, `item`, `space`, `contact`, `project`, `kit`, `orderTemplate`, `repairTicket`, `serializedItem`, `vehicle`, `staff`, `service`, `purchaseOrder`, `incident`, `opportunity`, `document`, `all` |
| `showOn` | string[] | Documentos en los que se imprime el campo. `quote`, `proforma`, `invoice`, `contract`, `packing_slip`, `purchase_order`, `repair_ticket`, `all` |
| `isActive` | boolean | true si la definición está activa y se puede usar. |
| `createdAt` | string<date-time> | Fecha de creación en ISO 8601 UTC; null si no consta. |
| `updatedAt` | string<date-time> | Fecha de la última modificación en ISO 8601 UTC; null si no está registrada. |

## Valores

| Campo | Valores |
| --- | --- |
| `dataType` | `text`, `multitext`, `dropdown`, `checkbox`, `radio`, `date`, `contact`, `item`, `space`, `staff_member`, `vehicle` |
| `applyAt` | `order`, `item`, `space`, `contact`, `project`, `kit`, `orderTemplate`, `repairTicket`, `serializedItem`, `vehicle`, `staff`, `service`, `purchaseOrder`, `incident`, `opportunity`, `document`, `all` |
| `showOn` | `quote`, `proforma`, `invoice`, `contract`, `packing_slip`, `purchase_order`, `repair_ticket`, `all` |

## Ejemplo

*Custom field definition · Generado a partir del esquema*

```json
{
  "id": "id_8f2a1c",
  "name": "Example",
  "dataType": "text",
  "description": "string",
  "options": [
    "string"
  ],
  "applyAt": [
    "order"
  ],
  "showOn": [
    "quote"
  ],
  "isActive": true,
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Lo devuelven

- [`GET /api/v1/custom-fields`](https://docs.filmo.io/es/rest-api/endpoint-reference/custom-fields/list-custom-field-definitions) — Listar definiciones de campos personalizados

## Lo modifican

Ninguna operación.

---

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