Analítica

Ventas y productos

GET/analitica/ventas

Lista ventas con permiso sobre contacto y ejecutivo de la venta. Mantiene sus fechas propias y pagina los productos de forma independiente.

Parámetros

Nombre	Tipo	Validación	Descripción
`params`	varchar
`pagina`	varchar	Requerido	Entero entre 1 y 2147483647. Página de resultados; no admite descarga ilimitada.
`cantidadRegistros`	varchar	Requerido	Entero de 1 a 200. Cantidad máxima de filas de la página.
`tkContactos`	varchar		Hasta 100 tokens separados por coma, máximo 128 caracteres cada uno y 8192 en total. Los duplicados no multiplican resultados.
`tkUsuario`	varchar		Identificador del responsable; no amplía permisos.
`fechaInicio`	varchar		Inicio incluido, ISO 8601 con offset; requiere fechaFin. Se requiere un intervalo de hasta 366 días o tkContactos.
`fechaFin`	varchar		Fin excluido, ISO 8601 con offset, posterior al inicio y hasta 366 días después. Requiere fechaInicio.
`fechaBase`	varchar	Requerido	creacion (default) o cierre; no usa la fecha del contacto.
`orden`	varchar	Requerido	ascendente o descendente por creación, con desempate estable por identidad.
`incluir`	varchar		productos o vacío. La colección se pagina por separado y no multiplica las filas del padre.
`tkOportunidad`	varchar		Token de oportunidad concreta autorizada; inexistente o sin permiso devuelve 404.
`paginaRelacion`	varchar	Requerido	Página de productos desde 1, default 1. Una página posterior exige tkVenta o tkOportunidad de un único padre y el include productos.
`cantidadRegistrosRelacion`	varchar	Requerido	Entre 1 y 100, default 20. Requiere incluir=productos.
`tkVenta`	varchar		Token de venta concreta autorizada; inexistente o sin permiso devuelve 404.

Respuesta

Nombre	Tipo	Descripción
`tkVenta`	String	Venta relacionada y autorizada; puede ser null.
`tkOportunidad`	String	Oportunidad relacionada y perteneciente al contacto, o null.
`tkProspecto`	String	Contacto asociado cuando sólo existe uno en el conjunto consultado; null si hay varios.
`fuente`	String	venta.
`idRegistroFuente`	String	Identidad opaca del registro fuente.
`tkEmpresa`	String	Token de la empresa comercial; null si falta o no existe permiso sobre ella.
`tkUsuario`	String	Token del responsable principal almacenado; puede ser null.
`concepto`	String	Concepto comercial guardado.
`importe`	Number	Monto propio del padre, una sola vez por fila. No se suma por producto o enlace financiero.
`subtotal`	Number	Subtotal propio guardado, sin reconstrucción.
`descuento`	Number	Descuento guardado en la entidad.
`impuestos`	Number	Impuestos trasladados guardados.
`impuestosRetenidos`	Number	Impuestos retenidos guardados; null si no existen.
`moneda`	String	Código de moneda de la entidad; null si no se puede resolver dentro de la cuenta.
`tkMoneda`	String	Token público de la moneda de la cuenta.
`tipoCambio`	Number	Tipo de cambio persistido; no equivale a una conversión histórica reconstruida.
`importeCobradoFuente`	Number	Monto cobrado guardado en la venta; no se recalcula sumando los enlaces.
`saldoFuente`	Number	Saldo guardado en la venta.
`fechaCreacion`	String	Instante de creación con zona explícita; puede ser null.
`fechaCierre`	String	Fecha comercial guardada de la venta, con zona.
`fechaActualizacionVenta`	String	Última modificación propia de la venta, con zona.
`fechaActualizacionContacto`	String	Última modificación del contacto relacionado, separada de la venta.
`fechaOriginal`	String	Fecha original del evento, incluso cuando no se puede convertir; puede ser null.
`baseTemporal`	String	Hecho de la fecha original: creacion, cierre o desconocido.
`idEventoConversion`	String	null: no se acredita un evento causal de conversión desde la venta.
`productos`	Object	null salvo incluir=productos. Contiene datos, pagina, cantidadRegistros, totalRegistros y hayMas. datos incluye idRelacion, tkRelacion, tkProducto, descripcion, cantidad, precioUnitario, subtotal, descuento, importe, moneda y tipoCambio; son valores de las líneas guardadas. La continuación requiere un único padre. Un catálogo eliminado conserva la línea y puede dejar tkProducto=null.
`cobertura`	Object	Estado, fuentes consultadas, capacidadesFaltantes e integridadHistorica.
`advertencias`	Array<Object>	Lista de objetos con codigo, mensaje y fuente que explican límites de cobertura.
`consistencia`	String	Siempre sinInstantanea; los cambios concurrentes pueden alterar la navegación.
`fechaGeneracion`	String	Instante de generación de la respuesta, con zona explícita.
`Row-Count`	Integer	Total del conjunto autorizado y filtrado, antes de paginar.

Solicitud

curl --request GET --url 'https://api.upnify.com/v4/analitica/ventas?tkContactos=P-EJEMPLO&cantidadRegistros=3&incluir=productos&cantidadRegistrosRelacion=2' --header 'token: 00000000-0000-4000-8000-000000000001'const respuesta = await fetch("https://api.upnify.com/v4/analitica/ventas?tkContactos=P-EJEMPLO&cantidadRegistros=3&incluir=productos&cantidadRegistrosRelacion=2", { headers: { token: "00000000-0000-4000-8000-000000000001" } });
console.log(await respuesta.json());const respuesta = await fetch("https://api.upnify.com/v4/analitica/ventas?tkContactos=P-EJEMPLO&cantidadRegistros=3&incluir=productos&cantidadRegistrosRelacion=2", { headers: { token: "00000000-0000-4000-8000-000000000001" } });
console.log(await respuesta.json());import requests

respuesta = requests.get("https://api.upnify.com/v4/analitica/ventas?tkContactos=P-EJEMPLO&cantidadRegistros=3&incluir=productos&cantidadRegistrosRelacion=2", headers={"token": "00000000-0000-4000-8000-000000000001"})
respuesta.raise_for_status()
print(respuesta.json())package main

import (
 "net/http"
 "io"
 "os"
)

func main() {
 solicitud, err := http.NewRequest(http.MethodGet, "https://api.upnify.com/v4/analitica/ventas?tkContactos=P-EJEMPLO&cantidadRegistros=3&incluir=productos&cantidadRegistrosRelacion=2", nil)
 if err != nil { panic(err) }
 solicitud.Header.Set("token", "00000000-0000-4000-8000-000000000001")
 respuesta, err := http.DefaultClient.Do(solicitud)
 if err != nil { panic(err) }
 defer respuesta.Body.Close()
 io.Copy(os.Stdout, respuesta.Body)
}using System;
using System.Net.Http;

using var cliente = new HttpClient();
using var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://api.upnify.com/v4/analitica/ventas?tkContactos=P-EJEMPLO&cantidadRegistros=3&incluir=productos&cantidadRegistrosRelacion=2");
solicitud.Headers.Add("token", "00000000-0000-4000-8000-000000000001");
using var respuesta = await cliente.SendAsync(solicitud);
respuesta.EnsureSuccessStatusCode();
Console.WriteLine(await respuesta.Content.ReadAsStringAsync());

Respuesta

[
  [
    {
      "tkVenta": "TK-EJEMPLO-12",
      "tkOportunidad": "TK-EJEMPLO-8",
      "tkProspecto": "TK-EJEMPLO-2",
      "fuente": "venta",
      "idRegistroFuente": "registro:13",
      "tkEmpresa": "TK-EJEMPLO-4",
      "tkUsuario": "TK-EJEMPLO-5",
      "concepto": "Ganada sintetica",
      "importe": 300,
      "subtotal": 300,
      "descuento": 0,
      "impuestos": 0,
      "impuestosRetenidos": 0,
      "moneda": "MXN",
      "tkMoneda": "TK-EJEMPLO-7",
      "tipoCambio": null,
      "importeCobradoFuente": 150,
      "saldoFuente": 150,
      "fechaCreacion": "2026-09-13T18:00:00Z",
      "fechaCierre": "2026-09-12T17:00:00Z",
      "fechaActualizacionVenta": "2026-09-21T18:00:00Z",
      "fechaActualizacionContacto": "2026-09-21T18:00:00Z",
      "fechaOriginal": "2026-09-13T12:00:00",
      "baseTemporal": "creacion",
      "idEventoConversion": null,
      "productos": {
        "datos": [
          {
            "idRelacion": "registro:14",
            "tkRelacion": "TK-EJEMPLO-15",
            "tkProducto": "TK-EJEMPLO-16",
            "descripcion": "Producto sintetico 1",
            "cantidad": 1,
            "precioUnitario": 100,
            "subtotal": 100,
            "descuento": 0,
            "importe": 100,
            "moneda": "MXN",
            "tipoCambio": 1
          },
          {
            "idRelacion": "registro:17",
            "tkRelacion": "TK-EJEMPLO-18",
            "tkProducto": "TK-EJEMPLO-19",
            "descripcion": "Producto sintetico 2",
            "cantidad": 1,
            "precioUnitario": 100,
            "subtotal": 100,
            "descuento": 0,
            "importe": 100,
            "moneda": "MXN",
            "tipoCambio": 1
          }
        ],
        "pagina": 1,
        "cantidadRegistros": 2,
        "totalRegistros": 3,
        "hayMas": true
      }
    }
  ],
  [
    {
      "cobertura": {
        "estado": "parcial",
        "fuentes": [
          "venta"
        ],
        "capacidadesFaltantes": [
          "ventaCausalConversionManual",
          "conversionMonedaHistorica",
          "historialEliminaciones"
        ],
        "integridadHistorica": "desconocida"
      },
      "advertencias": [
        {
          "codigo": "IMPORTES_POR_VENTA",
          "mensaje": "Cada venta conserva su importe; productos se paginan por separado. No se convierte moneda ni se suman oportunidades y ventas como ingresos independientes.",
          "fuente": "venta"
        }
      ],
      "consistencia": "sinInstantanea",
      "fechaGeneracion": "2026-09-21T18:00:00Z"
    }
  ]
]

Ventas y productos

Parámetros

Respuesta

Solicitud

Ventas y productos de un contacto

Respuesta

HTTP 200; Row-Count: 1