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.

Esquemas: CustomFieldDefinitionDto

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

Generado a partir del esquema

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.

Atributos

idstring

Identificador único de la definición. Es el que se usa al escribir un valor.

namestring

Nombre visible del campo.

dataTypestring

Tipo de dato que acepta el campo.

Opciones disponibles: text, multitext, dropdown, checkbox, radio, date, contact, item, space, staff_member, vehicle

descriptionstring | null

Descripción del campo; null si no tiene.

optionsstring[]

Valores permitidos cuando el campo es un desplegable. Vacío para los demás tipos.

applyAtstring[]

Entidades en las que se puede usar el campo.

Opciones disponibles: order, item, space, contact, project, kit, orderTemplate, repairTicket, serializedItem, vehicle, staff, service, purchaseOrder, incident, opportunity, document, all

showOnstring[]

Documentos en los que se imprime el campo.

Opciones disponibles: quote, proforma, invoice, contract, packing_slip, purchase_order, repair_ticket, all

isActiveboolean

true si la definición está activa y se puede usar.

createdAtstring<date-time> | null

Fecha de creación en ISO 8601 UTC; null si no consta.

updatedAtstring<date-time> | null

Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.

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

Lo devuelven

GET /api/v1/custom-fields — Listar definiciones de campos personalizados

Lo modifican

Ninguna operación.

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican