CRM

Contacto

El contacto, tal como lo devuelve la API.

Esquemas: ContactDto, ContactDetailDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "contactType": "person",
  "role": "client",
  "status": "active",
  "nif": "00000000T",
  "commercialName": "Example",
  "position": "string",
  "contactNumber": "string",
  "emails": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "email": "ana@example.com",
      "isPrimary": true
    }
  ],
  "billingEmail": "ana@example.com",
  "phoneNumbers": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "number": "string",
      "countryCode": "ES",
      "isPrimary": true
    }
  ],
  "websites": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "url": "https://example.com"
    }
  ],
  "addresses": [
    {
      "id": "id_8f2a1c",
      "label": "Example",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "province": "string",
      "postcode": "string",
      "country": "ES",
      "isMain": true
    }
  ],
  "folder": "string",
  "discountPercentage": 1,
  "preferredLanguage": "es-ES",
  "currency": "EUR",
  "paymentMethod": {
    "type": "bank_transfer",
    "customValue": "string"
  },
  "paymentDays": [
    1
  ],
  "expirationDays": 1,
  "subscribedToMarketing": true,
  "isAppUser": true,
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "relatedContacts": [
    {
      "id": "id_8f2a1c",
      "name": "Example",
      "commercialName": "Example",
      "contactType": "person",
      "role": "client",
      "status": "active",
      "relationRole": "string"
    }
  ]
}

Generado a partir del esquema

Un cliente o un proveedor de la cuenta, con sus datos fiscales, correos electrónicos, teléfonos, direcciones y condiciones comerciales. Los pedidos, presupuestos, facturas y proyectos apuntan a un contacto. Los contactos usan el aislamiento heredado de la cuenta principal, así que una cuenta de facturación también ve los contactos de su cuenta principal. contactNumber es escribible (hasta 50 caracteres) pero no es único y Filmo no lo genera. La lectura de detalle, GET /api/v1/contacts/{contactId}, añade los contactos relacionados, que la lista no incluye.

Atributos

idstring

Identificador único del contacto.

namestring

Nombre del contacto (persona o empresa).

contactTypestring

Tipo de contacto: person (particular) o company (negocio).

Opciones disponibles: person, company

rolestring

Rol del contacto: client, provider, lead, debtor, creditor, student, teacher o unspecified.

Opciones disponibles: client, provider, lead, debtor, creditor, student, teacher, unspecified

statusstring

Estado del contacto: active (operativo), inactive (desactivado) o archived (cerrado, conservado como histórico).

Opciones disponibles: active, inactive, archived

nifstring | null

NIF/CIF o número de identificación fiscal; null si no se ha registrado.

commercialNamestring | null

Nombre comercial; null si coincide con el nombre o no consta.

positionstring | null

Cargo o puesto de la persona de contacto; null si no está registrado.

contactNumberstring | null

Número de contacto asignado por la cuenta (referencia interna); null si no consta.

emailsobject[]

Lista de direcciones de correo electrónico del contacto.

Mostrar atributos hijos

emails.idstring

Identificador interno del correo electrónico dentro del contacto.

emails.labelstring | null

Etiqueta descriptiva del email; null si no tiene.

emails.emailstring

Dirección de email.

emails.isPrimaryboolean

Si este es el email principal del contacto.

billingEmailstring | null

Email de facturación dedicado; null significa que se usa el email principal.

phoneNumbersobject[]

Lista de teléfonos del contacto.

Mostrar atributos hijos

phoneNumbers.idstring

Identificador interno del teléfono dentro del contacto.

phoneNumbers.labelstring | null

Etiqueta descriptiva del teléfono; null si no tiene.

phoneNumbers.numberstring

Número de teléfono.

phoneNumbers.countryCodestring | null

Prefijo telefónico internacional del país (p. ej. "+34"); null si no consta.

phoneNumbers.isPrimaryboolean

Si este es el teléfono principal del contacto.

websitesobject[]

Lista de sitios web del contacto.

Mostrar atributos hijos

websites.idstring

Identificador interno del sitio web dentro del contacto.

websites.labelstring | null

Etiqueta descriptiva del sitio web; null si no tiene.

websites.urlstring

URL del sitio web.

addressesobject[]

Lista de direcciones del contacto.

Mostrar atributos hijos

addresses.idstring

Identificador interno de la dirección dentro del contacto.

addresses.labelstring | null

Etiqueta descriptiva de la dirección; null si no tiene.

addresses.addressLine1string | null

Primera línea de la dirección; null si no consta.

addresses.addressLine2string | null

Segunda línea de la dirección; null si no consta.

addresses.citystring | null

Ciudad; null si no consta.

addresses.provincestring | null

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

addresses.postcodestring | null

Código postal; null si no se ha registrado.

addresses.countrystring | null

País; null si no consta.

addresses.isMainboolean

Si esta es la dirección principal del contacto.

folderstring | null

Carpeta o agrupación organizativa; null si el contacto no está clasificado.

discountPercentagenumber | null

Porcentaje de descuento general del contacto (0-100); null si no hay descuento configurado.

preferredLanguagestring | null

Idioma preferido del contacto; null si no se ha registrado.

currencystring | null

Moneda por defecto del contacto como código ISO 4217; null si no consta.

paymentMethodobject | null

Método de pago preferido del contacto; null si no está configurado.

Mostrar atributos hijos

paymentMethod.typestring

Tipo de método de pago: bank_transfer, card, cash, sepa_direct_debit u other.

Opciones disponibles: bank_transfer, card, cash, other, sepa_direct_debit

paymentMethod.customValuestring | null

Detalle en texto libre cuando el tipo es "other" (por ejemplo, un método registrado antes de configurarse); null en caso contrario.

paymentDaysinteger[] | null

Días del mes en que el contacto hace pagos; null si no está configurado.

expirationDaysinteger | null

Días de vencimiento por defecto de las facturas del contacto; null si no está configurado.

subscribedToMarketingboolean

Si el contacto está suscrito a comunicaciones de marketing.

isAppUserboolean

Si el contacto tiene acceso a la app.

customFieldsobject<string, any>

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

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.

relatedContactsobject[]solo en el detalle

Contactos relacionados con este contacto (p. ej. las personas de una empresa).

Mostrar atributos hijos

relatedContacts.idstring

Identificador único del contacto relacionado.

relatedContacts.namestring

Nombre del contacto relacionado.

relatedContacts.commercialNamestring | null

Nombre comercial del contacto relacionado; null si no consta.

relatedContacts.contactTypestring

Tipo del contacto relacionado: person o company.

Opciones disponibles: person, company

relatedContacts.rolestring

Rol del contacto relacionado.

Opciones disponibles: client, provider, lead, debtor, creditor, student, teacher, unspecified

relatedContacts.statusstring

Estado del contacto relacionado: active, inactive o archived.

Opciones disponibles: active, inactive, archived

relatedContacts.relationRolestring | null

Rol de la relación entre los dos contactos (p. ej. "empleado de"); null si no consta.

Valores

contactType: person, company
role: client, provider, lead, debtor, creditor, student, teacher, unspecified
status: active, inactive, archived

Lo devuelven

GET /api/v1/contacts — Listar contactos
GET /api/v1/contacts/{contactId} — Obtener un contacto

Lo modifican

POST /api/v1/contacts — Crear un contacto
PATCH /api/v1/contacts/{contactId} — Actualizar un contacto
PATCH /api/v1/contacts/{contactId}/preferences — Actualizar las condiciones comerciales de un contacto
POST /api/v1/contacts/{contactId}/addresses — Añadir una dirección a un contacto
PATCH /api/v1/contacts/{contactId}/addresses/{addressId} — Actualizar una dirección de un contacto
DELETE /api/v1/contacts/{contactId}/addresses/{addressId} — Quitar una dirección de un contacto
POST /api/v1/contacts/{contactId}/related-contacts — Relacionar dos contactos
PATCH /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Cambiar el rol de una relación
DELETE /api/v1/contacts/{contactId}/related-contacts/{relatedContactId} — Quitar la relación entre dos contactos

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican