Tipos y configuración de campos - Insurance Boosters API

Esta página describe el esquema que envías al crear o actualizar un campo. Para escribir datos, consulta Valores por tipo de campo.

Referencia rápida

`type`	Configuración requerida	Configuración opcional
`string`	—	—
`number`	—	`numberFormat`
`boolean`	—	—
`date`	—	`dateConfig`
`enum`, `enum_multi`	`options`	—
`relation_single`, `relation_multi`	`toDatabaseId`	`displayFieldId`, `bidirectional`, `inverseField`
`contact_single`, `contact_multi`	—	`displayFieldId`
`lookup`	`relationFieldId`, `targetFieldId`, `multipleValuesBehavior`	—
`files`	—	`maxFiles`, `accept`

string y boolean no tienen configuración específica.

Número

numberFormat cambia la presentación, no el valor almacenado.

Propiedad	Requerido	Valores
`type`	Sí	`none`, `currency` o `percent`
`currencyCode`	Solo para `currency`	`USD`, `EUR`, `MXN`, `BRL`, `ARS`, `COP`, `CLP`, `PEN`, `UYU` o `GTQ`
`decimalPlaces`	No	Entero de `0` a `6`; default: `2`
`thousandsSeparator`	No	`boolean`; default: `true`

Número
Moneda
Porcentaje

{
  "name": "Cantidad",
  "key": "cantidad",
  "type": "number",
  "numberFormat": {
    "type": "none",
    "decimalPlaces": 0,
    "thousandsSeparator": true
  }
}

{
  "name": "Prima",
  "key": "prima",
  "type": "number",
  "numberFormat": {
    "type": "currency",
    "currencyCode": "MXN",
    "decimalPlaces": 2,
    "thousandsSeparator": true
  }
}

{
  "name": "Comisión",
  "key": "comision",
  "type": "number",
  "numberFormat": {
    "type": "percent",
    "decimalPlaces": 2,
    "thousandsSeparator": false
  }
}

Fecha y fecha con hora

Usa type: "date" en ambos casos. No existe un type: "datetime".

Presentación	Configuración
Solo fecha	`"dateConfig": { "includeTime": false }`
Fecha y hora	`"dateConfig": { "includeTime": true }`

Solo fecha
Fecha y hora

{
  "name": "Fecha de emisión",
  "key": "fechaEmision",
  "type": "date",
  "dateConfig": {
    "includeTime": false
  }
}

{
  "name": "Inicio de vigencia",
  "key": "inicioVigencia",
  "type": "date",
  "dateConfig": {
    "includeTime": true
  }
}

dateConfig controla cómo el tablero captura y muestra el dato; no cambia la validación de la API. Si lo omites, el tablero usa solo fecha. Consulta los formatos de fecha aceptados.

Selección única y múltiple

Los tipos enum y enum_multi requieren options con al menos una opción.

Propiedad de `options[]`	Requerido	Descripción
`label`	Sí	Texto visible.
`id`	No	Identificador estable; se genera si lo omites.
`color`	No	Nombre o código de color.
`order`	No	Posición desde `0`; se genera si la omites.

Al actualizar options, envía la lista completa que debe conservar el campo.

Selección única
Selección múltiple

{
  "name": "Estado",
  "key": "estado",
  "type": "enum",
  "options": [
    { "label": "Vigente", "color": "green" },
    { "label": "Cancelada", "color": "red" }
  ]
}

{
  "name": "Coberturas",
  "key": "coberturas",
  "type": "enum_multi",
  "options": [
    { "label": "Responsabilidad civil" },
    { "label": "Daños materiales" }
  ]
}

Relaciones

Aplica a relation_single y relation_multi.

Propiedad	Requerido	Descripción
`toDatabaseId`	Sí	ID del tablero relacionado.
`displayFieldId`	No	Campo del tablero destino que se muestra como etiqueta.
`bidirectional`	No	Crea o vincula una relación inversa cuando es `true`.
`inverseField`	Con `bidirectional: true`	Usa `id` para vincular un campo existente, o `name` y `type` para crear uno.

Relación única
Relación múltiple
Bidireccional

{
  "name": "Cliente",
  "key": "cliente",
  "type": "relation_single",
  "toDatabaseId": "<database-id-clientes>",
  "displayFieldId": "<field-id-nombre>"
}

{
  "name": "Beneficiarios",
  "key": "beneficiarios",
  "type": "relation_multi",
  "toDatabaseId": "<database-id-personas>",
  "displayFieldId": "<field-id-nombre>"
}

{
  "name": "Cliente",
  "key": "cliente",
  "type": "relation_single",
  "toDatabaseId": "<database-id-clientes>",
  "bidirectional": true,
  "inverseField": {
    "name": "Pólizas",
    "type": "relation_multi"
  }
}

Para vincular campos existentes después de crearlos, usa Vincular relación.

Contactos

Aplica a contact_single y contact_multi. Usa displayFieldId para seleccionar el campo del contacto que se muestra como etiqueta. Si lo omites, el tablero elige una etiqueta automáticamente.

Contacto único
Contactos múltiples

{
  "name": "Asegurado",
  "key": "asegurado",
  "type": "contact_single",
  "displayFieldId": "<contact-field-id>"
}

{
  "name": "Asegurados",
  "key": "asegurados",
  "type": "contact_multi",
  "displayFieldId": "<contact-field-id>"
}

Campo reflejado

Un lookup obtiene un dato mediante un campo de relación o contacto del mismo tablero.

Propiedad	Requerido	Descripción
`relationFieldId`	Sí	ID del campo de relación o contacto de origen.
`targetFieldId`	Sí	ID del campo cuyo valor se muestra.
`multipleValuesBehavior`	Sí	Cómo resolver varios valores.

multipleValuesBehavior acepta:

allValues: devuelve todos los valores.
uniqueValues: elimina duplicados.
firstValue: devuelve el primero.
lastValue: devuelve el último.

No puedes usar otro lookup, enum_multi ni files como campo destino. Los campos lookup son de solo lectura.

Un valor
Valores únicos

{
  "name": "Correo del cliente",
  "key": "correoCliente",
  "type": "lookup",
  "relationFieldId": "<relation-field-id>",
  "targetFieldId": "<target-field-id>",
  "multipleValuesBehavior": "firstValue"
}

{
  "name": "Correos de beneficiarios",
  "key": "correosBeneficiarios",
  "type": "lookup",
  "relationFieldId": "<relation-field-id>",
  "targetFieldId": "<target-field-id>",
  "multipleValuesBehavior": "uniqueValues"
}

Archivos

Propiedad	Requerido	Descripción
`maxFiles`	No	Entero mayor o igual a `1`.
`accept`	No	Tipos MIME permitidos, por ejemplo `image/*` o `application/pdf`.

Configuración predeterminada
PDF e imágenes

{
  "name": "Adjuntos",
  "key": "adjuntos",
  "type": "files"
}

{
  "name": "Documentos",
  "key": "documentos",
  "type": "files",
  "maxFiles": 5,
  "accept": ["application/pdf", "image/*"]
}

La configuración limita la carga. Para adjuntar contenido usa Subir archivo.

​Referencia rápida

​Número

​Fecha y fecha con hora

​Selección única y múltiple

​Relaciones

​Contactos

​Campo reflejado

​Archivos