erp Centro de Ayuda

API Endpoint: Ventas

Listar Ventas

• URL: /ventas.list.json
• Método: GET
• Descripción: Obtiene una lista de todas las ventas de la empresa, con varios filtros opcionales para refinar la búsqueda.
• Parámetros (opcional):
  • id_dcto_desde: Filtra por ID de venta desde un valor específico.
  • tipo_dcto: Filtra por tipo de documento.
  • folio_dcto: Filtra por número de folio del documento. Admite operadores de comparación.
  • external_id: Filtra por ID externo.
  • mes: Filtra por mes de emisión del documento.
  • ano: Filtra por año de emisión del documento.
  • fecha: Filtra por fecha específica de emisión del documento (formato: dd-mm-yyyy).
  • fecha_desde: Filtra por fecha de emisión desde (formato: dd-mm-yyyy).
  • fecha_hasta: Filtra por fecha de emisión hasta (formato: dd-mm-yyyy).
  • fecha_vcto_desde: Filtra por fecha de vencimiento desde (formato: dd-mm-yyyy).
  • fecha_vcto_hasta: Filtra por fecha de vencimiento hasta (formato: dd-mm-yyyy).
  • total: Filtra por el total del documento. Admite operadores de comparación.
  • total_pagado: Filtra por el total pagado. Admite operadores de comparación.
  • total_por_pagar: Filtra por el total pendiente de pago. Admite operadores de comparación.
  • cliente: Filtra por ID del cliente.
  • cliente_rut: Filtra por RUT del cliente.
  • sucursal: Filtra por ID de la sucursal.
  • bodega: Filtra por ID de la bodega.
  • usuario: Filtra por ID del usuario que realizó la venta.
  • vendedor: Filtra por ID del vendedor.

Obtener Último Folio de Documento

• URL: /ventas.listLast.json
• Método: GET
• Descripción: Devuelve el último folio emitido para un tipo específico de documento.
• Parámetros:
  • tipo_dcto: Tipo de documento cuyo último folio se desea obtener.

Listar Ítems de Ventas

• URL: /ventas.listItems.json
• Método: GET
• Descripción: Obtiene una lista de todos los ítems de las ventas, con varios filtros opcionales para refinar la búsqueda.
• Parámetros (opcional):
  • id_dcto: Filtra por ID específico.
  • id_dcto_desde: Filtra por ID de venta desde un valor específico.
  • tipo_dcto: Filtra por tipo de documento.
  • folio_dcto: Filtra por número de folio del documento.
  • mes: Filtra por mes de emisión del documento.
  • ano: Filtra por año de emisión del documento.
  • fecha: Filtra por fecha específica de emisión del documento (formato: dd-mm-yyyy).
  • fecha_desde: Filtra por fecha de emisión desde (formato: dd-mm-yyyy).
  • fecha_hasta: Filtra por fecha de emisión hasta (formato: dd-mm-yyyy).
  • fecha_vcto_desde: Filtra por fecha de vencimiento desde (formato: dd-mm-yyyy).
  • fecha_vcto_hasta: Filtra por fecha de vencimiento hasta (formato: dd-mm-yyyy).
  • total: Filtra por el total del documento.
  • cliente: Filtra por ID del cliente.
  • sucursal: Filtra por ID de la sucursal.
  • bodega: Filtra por ID de la bodega.
  • usuario: Filtra por ID del usuario que realizó la venta.
  • vendedor: Filtra por ID del vendedor.
  • producto: Filtra por ID del producto.
  • producto_sku: Filtra por SKU del producto.

Obtener Detalle de una Venta por ID

• URL: /ventas.findById.json/{RecursoId}
• Método: GET
• Descripción: Devuelve el detalle de una venta específica basada en el ID proporcionado.
• Parámetros:
  • RecursoId: ID de la venta (incluido en la URL).

Listar Referencias de Ventas

• URL: /ventas.listReferencias.json
• Método: GET
• Descripción: Obtiene una lista de todas las referencias de las ventas.
• Parámetros (opcional):
  • tipo_dcto: Filtra por tipo de documento.
  • folio_dcto: Filtra por número de folio del documento.
  • mes: Filtra por mes de emisión del documento.
  • ano: Filtra por año de emisión del documento.
  • total: Filtra por el total del documento.
  • cliente: Filtra por ID del cliente.
  • sucursal: Filtra por ID de la sucursal.
  • bodega: Filtra por ID de la bodega.
  • usuario: Filtra por ID del usuario que realizó la venta.
  • vendedor: Filtra por ID del vendedor.
  • tipo_dcto_ref: Filtra por tipo de documento de referencia.
  • folio_dcto_ref: Filtra por número de folio del documento de referencia.
  • fecha_dcto_ref: Filtra por fecha del documento de referencia.

Listar Ventas por ID Cliente

• URL: /ventas.listByCustomer.json
• Método: POST
• Descripción: Obtiene una lista de todas las ventas realizadas a un cliente específico.
• Parámetros (JSON Body):
  • idCliente: ID del cliente cuyas ventas se desea consultar.
  • tipoBusqueda: Tipo de búsqueda (all, periodo, folio).
  • mes: Mes del período a consultar (necesario si tipoBusqueda es periodo).
  • ano: Año del período a consultar (necesario si tipoBusqueda es periodo).
  • folio: Folio del documento a consultar (necesario si tipoBusqueda es folio).

Listar Ventas por Rut Cliente

• URL: /ventas.listByCustomerRut.json
• Método: POST
• Descripción: Obtiene una lista de todas las ventas realizadas a un cliente específico basado en su RUT.
• Parámetros (JSON Body):
  • rutCliente: RUT del cliente cuyas ventas se desea consultar.
  • tipoBusqueda: Tipo de búsqueda (all, periodo, folio).
  • mes: Mes del período a consultar (necesario si tipoBusqueda es periodo).
  • ano: Año del período a consultar (necesario si tipoBusqueda es periodo).
  • folio: Folio del documento a consultar (necesario si tipoBusqueda es folio).

Obtener Documento de Venta por ID

• URL: /ventas.listOne.json/{RecursoId}
• Método: GET
• Descripción: Devuelve los datos de un documento de venta específico basado en el ID proporcionado.
• Parámetros:
  • RecursoId: ID de la venta (incluido en la URL).

Endpoints para tarabajar con Notas de Venta :

Anular Nota de Venta

• URL: /ventas.deleteNotaVenta.json
• Método: GET
• Descripción: Anula una nota de venta específica basada en el ID proporcionado y realiza la reversión del inventario asociado.
• Parámetros:
  • id_venta: ID de la venta a anular.