Saltar al contenido principal
GET
/
sales
Listar ventas
curl --request GET \
  --url https://tu-dominio.com/api/external/v1/sales \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "meta": {
    "empresa": "Mi Empresa S.A.",
    "timestamp": "2023-11-07T05:31:56Z",
    "filters_applied": {}
  },
  "data": [
    {
      "fecha": "2025-01-15",
      "estado": "Completada",
      "total": 150.75,
      "id": 12345,
      "correlativo": "FAC-001",
      "referencia": "ORD-2025-00042",
      "referencia_externa": "ORD-2025-00042",
      "cotizacion": false,
      "forma_pago": "Efectivo",
      "iva": 13.5,
      "sub_total": 137.25,
      "descuento": 0,
      "nombre_cliente": "Juan Pérez",
      "nombre_usuario": "Admin User",
      "nombre_vendedor": "Vendedor 1",
      "saldo": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "detalles": [
        {
          "cantidad": 2,
          "precio": 75,
          "total": 150,
          "descripcion": "Producto A",
          "nombre_producto": "Producto A",
          "codigo": "PROD-001",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 100,
    "total": 1250,
    "total_pages": 13,
    "has_next": true,
    "has_prev": false,
    "from": 1,
    "to": 100
  }
}

Autorizaciones

Authorization
string
header
requerido

API Key de la empresa en formato Bearer token.

Ejemplo: Authorization: Bearer G8RCjH11DabBNjnX7wO5

Parámetros de consulta

fecha_inicio
string<date>

Fecha de inicio (formato Y-m-d)

Ejemplo:

"2025-01-01"

fecha_fin
string<date>

Fecha de fin (formato Y-m-d)

Ejemplo:

"2025-01-31"

estado
enum<string>

Estado de la venta

Opciones disponibles:
Completada,
Pendiente,
Anulada,
Cotizacion
Ejemplo:

"Completada"

page
integer
predeterminado:1

Número de página

Rango requerido: x >= 1
per_page
integer
predeterminado:100

Registros por página

Rango requerido: 1 <= x <= 200
order_by
enum<string>
predeterminado:fecha

Campo de ordenamiento

Opciones disponibles:
fecha,
total,
correlativo,
created_at
order_direction
enum<string>
predeterminado:desc

Dirección del ordenamiento

Opciones disponibles:
asc,
desc

Respuesta

Lista de ventas obtenida exitosamente

success
boolean
requerido

Indica si la operación fue exitosa

meta
object
data
object[]
pagination
object