Foccuz Integration API
  1. API externa
Foccuz Integration API
  • API externa
    • Comenzando con Foccuz Integration API
    • Autenticación vía API Key
    • Límite de uso (Rate Limiting) y Restricciones de tamaño (Body Size Limiting)
    • Colaboradores con Compensaciones Variables (Usuario/Colaborador)
    • Empresas (Clientes/Cuentas/Compañías)
    • Negocio (Operación, Venta, Cobranza, Acción clave)
    • Actividad (Acción, Productividad, Indicador)
    • Campos personalizados
    • Orden de ejecucción
    • Consideraciones
    • Flujos de ejemplo
    • Manejo de errores
    • v2
      • integration
        • deals
          • /v2/integration/deals
          • /v2/integration/deals
        • activities
          • /v2/integration/activities
          • /v2/integration/activities
        • account
          • /v2/integration/account
          • /v2/integration/account
        • sales-profile
          • /v2/integration/sales-profile
          • /v2/integration/sales-profile
  • Integraciones
    • Buk
      • Conectarse con Buk
  1. API externa

Consideraciones

🖌️Campos Personalizados#

Todos los endpoints soportan campos personalizados (customFields)
Cada campo personalizado debe tener key y value
Los campos personalizados son opcionales

#️⃣Identificadores Externos#

Todos los externalId deben ser únicos dentro de tu sistema externo
Los externalId se usan para referencias entre entidades
Mantén consistencia en los IDs entre diferentes entidades

♻️Operaciones de Actualización#

Todos los endpoints también soportan operaciones PATCH para actualizar entidades existentes
Usa el mismo formato de request pero con PATCH en lugar de POST

⚠️Notas Adicionales#

Actividades son opcionales: Si tu negocio no requiere seguimiento de actividades, puedes omitir completamente este endpoint
Accounts pueden ser independientes: No es necesario crear Accounts antes de Deals
Sales Profiles son obligatorios: Siempre necesitas al menos un Sales Profile para cualquier Deal
Monedas: El sistema maneja conversión automática de monedas si proporcionas exchangeRate
Fechas: Usa formato ISO-8601 para todas las fechas
Batch ID: Usa identificadores únicos para cada lote de sincronización
Modificado en 2025-10-10 13:44:14
Anterior
Orden de ejecucción
Siguiente
Flujos de ejemplo
Built with