Ir al contenido

API Transacciones

De LAZARVS

API Transacciones de Lazarvs

Esta documentación describe los endpoints disponibles en la API de Lazarvs para operaciones relacionadas con transacciones, como oportunidades y notas de venta.

Índice

Información General

  • Título: API_Transacciones
  • Descripción: API para operaciones de transacciones.
  • URL Base del Servidor: {{URL de Lazarvs}}/transacciones

Autenticación

Para acceder a los endpoints, se requiere un token JWT que debe incluirse en el encabezado Authorization con el prefijo "Bearer".

Ejemplo de Encabezado: 

 Authorization: Bearer <tu_token_jwt>

Endpoints de la API

1. /OportunidadExiste

Descripción
Verifica la existencia de una oportunidad en el sistema.
Método
GET
Parámetros de Consulta
  • Oportunidad (string, opcional): Identificador de la oportunidad.
Respuesta

La respuesta exitosa tendrá el código 200 y devuelve un JSON con la estructura de API_Transacciones_Respuesta.

2. /OportunidadInsertar

Descripción
Inserta una nueva oportunidad en el sistema.
Método
POST
Cuerpo de la Solicitud (JSON)
  • SDTOportunidad (object): Datos de la oportunidad a insertar.
Cuerpo de Solicitud Vacío
{
  "SDTOportunidad": {
    "Nombre": "<string>",
    "Tipo": "<string>",
    "NumeroExterno": "<string>",
    "Territorio": "<string>",
    "AsignadoA": "<string>",
    "Cuenta": "<string>",
    "CuentaIdTributaria": "<string>",
    "Prospecto": "<long>",
    "Origen": "<string>",
    "FechaApertura": "<date>",
    "FechaInicio": "<date>",
    "FechaEntregaOferta": "<date>",
    "FechaCierreEsperado": "<date>",
    "FechaCierreEfectivo": "<date>",
    "Etapa": "<string>",
    "Probabilidad": "<double>",
    "Solucion": "<string>",
    "ProximoPaso": "<string>",
    "DeclaradoAlProveedor": "<boolean>",
    "OportunidadProveedor": "<string>",
    "Importante": "<boolean>",
    "Competencia": "<string>",
    "Descripcion": "<string>",
    "ActividadPlanificada": "<string>",
    "Moneda": "<string>",
    "IngresoEsperadoMoneda": "<double>"
  }
}
Ejemplo de Cuerpo de Solicitud
{
  "SDTOportunidad": {
    "Nombre": "Prod XX",
    "Tipo": "",
    "NumeroExterno": "2024-0101",
    "Territorio": "",
    "AsignadoA": "",
    "Cuenta": "",
    "CuentaIdTributaria": "NRORUT/CUIT",
    "Prospecto": "0",
    "Origen": "",
    "FechaApertura": "2024-01-01",
    "FechaInicio": "2024-03-01",
    "FechaEntregaOferta": "2024-06-30",
    "FechaCierreEsperado": "2024-09-30",
    "FechaCierreEfectivo": "2024-10-15",
    "Etapa": "50",
    "Probabilidad": "0",
    "Solucion": "Lazarvs",
    "ProximoPaso": "No hay",
    "DeclaradoAlProveedor": "false",
    "OportunidadProveedor": "N/A",
    "Importante": "true",
    "Competencia": "Otro ERP",
    "Descripcion": "Oportunidad de prueba",
    "ActividadPlanificada": "Sin plan",
    "Moneda": "USD",
    "IngresoEsperadoMoneda": "20000"
  }
}

3. /NotaVentaOportunidadExiste

Descripción
Verifica la existencia de una nota de venta para una oportunidad específica.
Método
GET
Parámetros de Consulta
  • Oportunidad (string, opcional): Identificador de la oportunidad.

4. /NotaVentaOportunidadInsertar

Descripción
Inserta una nueva nota de venta para una oportunidad existente.
Método
POST
Cuerpo de la Solicitud (JSON)
  • SDTNotaVenta (object): Datos de la nota de venta a insertar.
Cuerpo de Solicitud vacío
{
  "SDTNotaVenta": {
    "Fecha": "<date>",
    "Tipo": "<string>",
    "Descripcion": "<string>",
    "Comentarios": "<string>",
    "Local": "<string>",
    "Almacen": "<string>",
    "Moneda": "<string>",
    "OportunidadExterna": "<string>",
    "OportunidadNumero": "<long>",
    "UsaIdentificacion": "<boolean>",
    "Cliente": "<string>",
    "DireccionEntregaNumero": "<long>",
    "Condicion": "<string>",
    "CongelaPrecios": "<boolean>",
    "FechaPrecios": "<date>",
    "OrdenDeCompraCliente": "<string>",
    "Territorio": "<string>",
    "Jurisdiccion": "<string>",
    "PorcentajeDescuentoGlobal": "<double>",
    "FechaInicialEntrega": "<date>",
    "FechaFinalEntrega": "<date>",
    "Identificacion": {
      "ClienteNombre": "<string>",
      "ClienteTipo": "<string>",
      "ClienteDireccion": "<string>",
      "ClienteCiudad": "<string>",
      "ClientePais": "<string>",
      "ClientePersonaFisicaTipoDocumento": "<string>",
      "ClientePersonaFisicaNumeroDocumento": "<string>",
      "ClientePersonaJuridicaTipoDocumento": "<string>",
      "ClientePersonaJuridicaNumeroDocumento": "<string>"
    },
    "Entrega": {
      "EntregaDireccion": "<string>",
      "EntregaCiudad": "<string>",
      "EntregaCodigoPostal": "<string>",
      "EntregaEstadoProvincia": "<string>",
      "EntregaPais": "<string>",
      "EntregaTelefono": "<string>",
      "EntregaContacto": "<string>"
    },
    "Articulos": [
      {
        "ArticuloCodigo": "<string>",
        "ArticuloLote": "<string>",
        "ArticuloCantidad": "<double>",
        "ArticuloTipoDeVenta": "<string>",
        "ArticuloSerie": "<string>",
        "ArticuloPorcentajeImpuesto": "<double>",
        "ArticuloPrecio": "<double>",
        "ArticuloPrecioImpuestoIncluido": "<boolean>",
        "ArticuloDescuento": "<double>",
        "ArticuloProveedor": "<string>",
        "ArticuloCostoUnitario": "<double>",
        "ArticuloGastosImportacion": "<double>"
      },
      {
        "ArticuloCodigo": "<string>",
        "ArticuloLote": "<string>",
        "ArticuloCantidad": "<double>",
        "ArticuloTipoDeVenta": "<string>",
        "ArticuloSerie": "<string>",
        "ArticuloPorcentajeImpuesto": "<double>",
        "ArticuloPrecio": "<double>",
        "ArticuloPrecioImpuestoIncluido": "<boolean>",
        "ArticuloDescuento": "<double>",
        "ArticuloProveedor": "<string>",
        "ArticuloCostoUnitario": "<double>",
        "ArticuloGastosImportacion": "<double>"
      }
    ],
    "Enlaces": [
      {
        "EnlaceDescripcion": "<string>",
        "EnlaceURL": "<string>"
      },
      {
        "EnlaceDescripcion": "<string>",
        "EnlaceURL": "<string>"
      }
    ]
  }
}
Ejemplo de Cuerpo de Solicitud
{
  "SDTNotaVenta": {
    "Fecha": "2024-10-20",
    "Tipo": "",
    "Descripcion": "Nota venta Test",
    "Comentarios": "Sin comentarios",
    "Local": "",
    "Almacen": "",
    "Moneda": "USD",
    "OportunidadExterna": "2024-01",
    "OportunidadNumero": "0",
    "UsaIdentificacion": "false",
    "Cliente": "",
    "DireccionEntregaNumero": "0",
    "Condicion": "Credito",
    "CongelaPrecios": "false",
    "FechaPrecios": "",
    "OrdenDeCompraCliente": "OC-CLI-001",
    "Territorio": "",
    "Jurisdiccion": "",
    "PorcentajeDescuentoGlobal": "0",
    "FechaInicialEntrega": "",
    "FechaFinalEntrega": "",
    "Identificacion": {
      "ClienteNombre": "",
      "ClienteTipo": "",
      "ClienteDireccion": "",
      "ClienteCiudad": "",
      "ClientePais": "",
      "ClientePersonaFisicaTipoDocumento": "",
      "ClientePersonaFisicaNumeroDocumento": "",
      "ClientePersonaJuridicaTipoDocumento": "",
      "ClientePersonaJuridicaNumeroDocumento": ""
    },
    "Entrega": {
      "EntregaDireccion": "",
      "EntregaCiudad": "",
      "EntregaCodigoPostal": "",
      "EntregaEstadoProvincia": "",
      "EntregaPais": "",
      "EntregaTelefono": "",
      "EntregaContacto": ""
    },
    "Articulos": [
      {
        "ArticuloCodigo": "9780444505156",
        "ArticuloLote": "",
        "ArticuloCantidad": "2",
        "ArticuloTipoDeVenta": "",
        "ArticuloSerie": "",
        "ArticuloPorcentajeImpuesto": "0",
        "ArticuloPrecio": "2500",
        "ArticuloPrecioImpuestoIncluido": "false",
        "ArticuloDescuento": "0",
        "ArticuloProveedor": "",
        "ArticuloCostoUnitario": "1000",
        "ArticuloGastosImportacion": "10"
      },
      {
        "ArticuloCodigo": " 4605664000050",
        "ArticuloLote": "",
        "ArticuloCantidad": "1",
        "ArticuloTipoDeVenta": "",
        "ArticuloSerie": "",
        "ArticuloPorcentajeImpuesto": "0",
        "ArticuloPrecio": "1500",
        "ArticuloPrecioImpuestoIncluido": "false",
        "ArticuloDescuento": "0",
        "ArticuloProveedor": "",
        "ArticuloCostoUnitario": "500",
        "ArticuloGastosImportacion": "20"
      }
    ],
    "Enlaces": [
      {
        "EnlaceDescripcion": "Test1",
        "EnlaceURL": "https://www.abcdefyy.com"
      },
      {
        "EnlaceDescripcion": "Test2",
        "EnlaceURL": "https://www.jklmnozz.com"
      }
    ]
  }
}

Esquemas de Respuesta

Esquema API_Transacciones_Respuesta

  • Existe (boolean): Indica si el elemento existe.
  • Datos (string): Información adicional sobre el resultado.
  • Mensajes (array): Mensajes relacionados con la operación.
 * Id (string): ID del mensaje.
 * Type (integer): Tipo de mensaje (informativo, advertencia, error, etc.).
 * Description (string): Descripción del mensaje.

Esquema OportunidadInsertarInput

  • SDTOportunidad (object): Información detallada de la oportunidad.
 * Nombre (string): Nombre.
 * Tipo (string): Tipo de Oportunidad.
 * NumeroExterno (string): Número Externo.
 * Territorio (string): Territorio.
 * AsignadoA (string): Asignado a.
 * Cuenta (string): Cuenta.
 * CuentaIdTributaria (string): Número de Documento.
 * Prospecto (integer, format: int64): Prospecto.
 * Origen (string): Origen.
 * FechaApertura (string, format: date): Fecha Apertura.
 * FechaInicio (string, format: date): Fecha Inicio de Validez.
 * FechaEntregaOferta (string, format: date): Fecha Entrega Oferta.
 * FechaCierreEsperado (string, format: date): Fecha Cierre Esperado.
 * FechaCierreEfectivo (string, format: date): Fecha Cierre Efectivo.
 * Etapa (string): Etapa.
 * Probabilidad (number, format: double): Probabilidad.
 * Solucion (string): Solución Ofrecida.
 * ProximoPaso (string): Próximo paso.
 * DeclaradoAlProveedor (boolean): Declarado al Proveedor.
 * OportunidadProveedor (string): Oportunidad en Proveedor.
 * Importante (boolean): Importante.
 * Competencia (string): Competencia.
 * Descripcion (string): Descripción.
 * ActividadPlanificada (string): Pasos Planificados.
 * Moneda (string): Moneda.
 * IngresoEsperadoMoneda (number, format: double): Ingreso Esperado.

Esquema NotaVentaOportunidadInsertarInput

  • SDTNotaVenta (object): Información detallada de la nota de venta.
 * Fecha (string, format: date): Fecha.
 * Tipo (string): Código.
 * Descripcion (string): Descripción.
 * Comentarios (string): Comentarios.
 * Local (string): Local.
 * Almacen (string): Almacén.
 * Moneda (string): Moneda.
 * OportunidadExterna (string): Número Externo.
 * OportunidadNumero (integer, format: int64): Oportunidad.
 * UsaIdentificacion (boolean): Ingresa Identificación.
 * Cliente (string): Cliente.
 * ClienteIdTributaria (string): Id Tributaria de Cliente (cuando no se envía cliente).
 * DireccionEntregaNumero (integer, format: int64): Dirección Entrega.
 * Condicion (string): Condición.
 * CongelaPrecios (boolean): Congela Precios.
 * FechaPrecios (string, format: date): Fecha para Precios.
 * OrdenDeCompraCliente (string): Orden de Compra de Cliente.
 * Territorio (string): Territorio.
 * Jurisdiccion (string): Jurisdicción.
 * PorcentajeDescuentoGlobal (number, format: double): Porcentaje de Descuento.
 * FechaInicialEntrega (string, format: date): Fecha Inicial de Entrega.
 * FechaFinalEntrega (string, format: date): Fecha Final de Entrega.
 * Identificacion: Información de Identificación (ver sección SDTNotaVenta.Identificacion).
 * Entrega: Información de Entrega (ver sección SDTNotaVenta.Entrega).
 * Articulos: Lista de artículos (ver sección SDTNotaVenta.Articulos_Articulo).
 * Enlaces: Lista de enlaces (ver sección SDTNotaVenta.Enlaces_Enlace).
  • SDTNotaVenta.Identificacion (object): Información de Identificación del cliente.
 * ClienteNombre (string): Nombre de Cliente.
 * ClienteTipo (string): Tipo.
 * ClienteDireccion (string): Dirección de Cliente.
 * ClienteCiudad (string): Ciudad.
 * ClientePais (string): País.
 * ClientePersonaFisicaTipoDocumento (string): Documento.
 * ClientePersonaFisicaNumeroDocumento (string): Número.
 * ClientePersonaJuridicaTipoDocumento (string): Localización.
 * ClientePersonaJuridicaNumeroDocumento (string): Id Tributaria.
  • SDTNotaVenta.Entrega (object): Información de Entrega.
 * EntregaDireccion (string): Dirección de Entrega.
 * EntregaCiudad (string): Ciudad.
 * EntregaCodigoPostal (string): Código Postal.
 * EntregaEstadoProvincia (string): Estado / Provincia.
 * EntregaPais (string): País.
 * EntregaTelefono (string): Teléfono.
 * EntregaContacto (string): Contacto.
  • SDTNotaVenta.Articulos_Articulo (object): Detalles de Artículos.
 * ArticuloCodigo (string): Artículo.
 * ArticuloLote (string): Lote.
 * ArticuloCantidad (number, format: double): Cantidad.
 * ArticuloTipoDeVenta (string): Tipo de Venta.
 * ArticuloSerie (string): Serie.
 * ArticuloPorcentajeImpuesto (number, format: double): Porcentaje de Impuesto.
 * ArticuloPrecio (number, format: double): Precio.
 * ArticuloPrecioImpuestoIncluido (boolean): Impuesto de Venta incluido en el precio.
 * ArticuloDescuento (number, format: double): Descuento.
 * ArticuloProveedor (string): Proveedor.
 * ArticuloCostoUnitario (number, format: double): Costo Unitario.
 * ArticuloGastosImportacion (number, format: double): Gastos de Importación.
  • SDTNotaVenta.Enlaces_Enlace (object): Detalles de Enlaces.
 * EnlaceDescripcion (string): Descripción.
 * EnlaceURL (string): URL.
Obtenido de «https://wiki.lazarvs.com/index.php?title=API_Transacciones&oldid=4»