Contactos

Actualizar las condiciones comerciales de un contacto

Define cómo y cuándo paga este contacto: moneda, idioma de sus documentos, correo de facturación, método de pago, días de pago, vencimiento, descuento habitual y los códigos de facturación electrónica para la administración pública.

Herramienta
filmo_contacts_preferences_update
Acceso: Escritura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_contacts_preferences_update",
    "arguments": {
      "contactId": "cont_8f2a1c"
    }
  }
}

generado desde el esquema

La configuración de impuestos por defecto NO forma parte del contrato público. Devuelve el contacto actualizado en detalle.

Argumentos

contactIdstringObligatorio

Identificador del contacto.

Límites: longitud mín. 1

preferredLanguagestring | null

Idioma de los documentos emitidos al contacto, p. ej. "es-ES"; null lo borra.

Opciones disponibles: es-ES, en-US, fr-FR, ca-ES, de-DE, pl-PL

currencystring | null

Moneda por defecto, como código ISO 4217 de 3 letras (p. ej. "EUR"); null la borra.

Límites: longitud mín. 3, longitud máx. 3

billingEmailstring<email> | null

Dirección de email a la que se envían las facturas; null la borra.

paymentMethodobject | null

Método de pago acordado con el contacto; null lo borra.

Mostrar atributos hijos
paymentMethod.typestringObligatorio

Método de pago acordado, con el mismo vocabulario que devuelve el contacto: bank_transfer, card, cash u other. La domiciliación es un método configurado de la cuenta: asígnala mediante paymentMethodIds.

Opciones disponibles: bank_transfer, card, cash, other

paymentMethod.customValuestring

Detalle en texto libre cuando el tipo es "other".

paymentMethodIdsstring[]

Métodos de pago configurados en la cuenta que acepta este contacto.

primaryPaymentMethodIdstring | null

Cuál de ellos es el principal; null lo borra.

paymentDaysinteger[] | null

Días del mes en que el contacto paga. Sustituye toda la lista; null la borra.

Límites: cada uno: mín. 1, cada uno: máx. 31

expirationDaysinteger | null

Días de vencimiento de las facturas del contacto, como número entero de días; null usa el valor por defecto de la cuenta.

Límites: mín. 0

discountSettingsobject

Descuento que se aplica por defecto al contacto.

Mostrar atributos hijos
discountSettings.percentagenumberObligatorio

Descuento habitual, como porcentaje (0-100).

Límites: mín. 0, máx. 100

eInvoiceFieldsobject | null

Códigos de facturación electrónica para la administración pública.

Mostrar atributos hijos
eInvoiceFields.accountingOfficestring

Oficina contable (FACe).

eInvoiceFields.managementBodystring

Órgano gestor (FACe).

eInvoiceFields.processingUnitstring

Unidad tramitadora (FACe).

eInvoiceFields.proposingBodystring

Órgano proponente (FACe).

idempotencyKeystring

Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.

Límites: longitud mín. 1, longitud máx. 255

ifMatchstring

Bloqueo optimista: el meta.etag que obtuviste de la lectura de detalle de este recurso (o "*"). Si el recurso ha cambiado desde entonces, la llamada falla con 412 precondition_failed antes de escribir nada; léelo de nuevo y reintenta. Omítelo para escribir sin condiciones.

Límites: longitud mín. 1

Resultado

En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.

Ver los atributos de data
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[]

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.

Un error es un resultado con isError: true y el problema en content[0].text; no hay structuredContent. Consulta Errores.

La misma operación por REST

Esta herramienta ejecuta PATCH /api/v1/contacts/{contactId}/preferences.

  • Contactos

    Actualizar las condiciones comerciales de un contacto

    Define cómo y cuándo paga este contacto: moneda, idioma de sus documentos, correo de facturación, método de pago, días de pago, vencimiento, descuento habitual y los códigos de facturación electrónica para la administración pública.

  • Guías

    Escrituras seguras

    Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.

  • Guías

    Errores

    Un error de herramienta es un resultado con isError: true y el problema en el primer bloque de texto. Ramifica por su code.