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

Negocio (Operación, Venta, Cobranza, Acción clave)

Nombre de la entidad: Deal
Descripción: Representa la acción base de medición. Una venta, una operación nueva, una acción que es medible, y que tiene clientes, empresas, cuentas asociadas, así cómo colaboradores que la ejecutaron, y que puede ser evaluados por dicha acción.
Endpoint: POST /v2/integration/deals

Propiedades Requeridas:#

externalId (string): Identificador único en el sistema externo
title (string): Título del deal
ownerExternalId (string): ID externo del propietario (debe existir como Sales Profile)
agentExternalId (string): ID externo del agente (debe existir como Sales Profile)
isWon (boolean): Si el deal está ganado
amount (object): Información del monto
value (string): Valor como string
currency (string): Código de moneda
exchangeRate (string, opcional): Tasa de cambio aplicada

Propiedades Opcionales:#

currentStage (object): Etapa actual
pipelineName (string): Nombre del pipeline
value (string): Valor de la etapa
occurredAt (string): Fecha en formato ISO-8601
stages (array): Historial completo de etapas
closeDate (string): Fecha de cierre en formato ISO-8601
customFields (array): Campos personalizados

Ejemplo de Request:#

{
  "batchId": "batch-003",
  "source": "external-crm",
  "items": [
    {
      "externalId": "DEAL-001",
      "title": "ACME Contract 2025",
      "ownerExternalId": "USER-001",
      "agentExternalId": "USER-002",
      "isWon": false,
      "amount": {
        "value": "15000.00",
        "currency": "USD",
        "exchangeRate": "1.00"
      },
      "currentStage": {
        "pipelineName": "Sales Pipeline",
        "value": "negotiation",
        "occurredAt": "2025-08-20T15:00:00Z"
      },
      "closeDate": "2025-08-25",
      "customFields": [
        {
          "key": "probability",
          "type": string,
          "value": "75",
          "name": "custom_field_3"
        }
      ]
    }
  ]
}
Modificado en 2025-10-10 13:44:03
Anterior
Empresas (Clientes/Cuentas/Compañías)
Siguiente
Actividad (Acción, Productividad, Indicador)
Built with