Skip to main content
POST
/
api
/
v1
/
reports
/
query
La Pyme SDK
import { Lapyme } from "lapyme";

const lapyme = new Lapyme({
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
});

const report = await lapyme.reports.query({
  source: "sales",
  period: {
    startDate: "2026-01-01",
    endDate: "2026-03-31",
  },
  dimensions: ["product"],
  measures: ["total", "units", "count"],
  includeTotals: true,
});
{
  "request_id": "req_report_1",
  "data": {
    "rows": [
      {
        "id": "9c692e8b",
        "ids": [
          "9c692e8b-0f9a-4f7c-8b99-061a2eb188ae"
        ],
        "labels": [
          "Almohada Microfibra 80x50"
        ],
        "measures": {
          "total": 998300,
          "units": 12,
          "count": 8
        }
      },
      {
        "id": "3b4a1c2d",
        "ids": [
          "3b4a1c2d-1234-5678-abcd-ef1234567890"
        ],
        "labels": [
          "King size sheet"
        ],
        "measures": {
          "total": 450000,
          "units": 5,
          "count": 4
        }
      }
    ],
    "totals": {
      "total": 1448300,
      "units": 17,
      "count": 12
    },
    "metadata": {
      "source": "sales",
      "dimensions": [
        "product"
      ],
      "measures": [
        "total",
        "units",
        "count"
      ],
      "period": {
        "start_date": "2026-01-01",
        "end_date": "2026-03-31"
      },
      "date_basis": "commercial"
    }
  }
}

Authorizations

Authorization
string
header
required

Incluí tu API key en el header Authorization con el prefijo Bearer.

Body

application/json
source
enum<string>
required
Available options:
sales
period
object
required
measures
enum<string>[]
required

Medidas a calcular. Al menos una.

Minimum array length: 1
Available options:
total,
subtotal,
taxAmount,
count,
units,
cost,
margin,
avgTicket,
marginPercent,
discountAmount,
balance,
uniqueCustomers,
uniqueProducts
dimensions
enum<string> · string · string[]

Dimensiones de agrupación. Máximo 12. Acepta product_metafield: para campos personalizados select de producto y contact_metafield: para campos personalizados select de contacto.

Maximum array length: 12
Available options:
date,
week,
weekOfYear,
month,
monthOfYear,
dayOfWeek,
year,
quarter,
hourOfDay,
customer,
customerName,
customerEmail,
customerTaxCategory,
province,
city,
product,
productName,
variant,
variantSku,
category,
subcategory,
defaultSupplierName,
productType,
salesperson,
pointOfSale,
warehouse,
register,
integrationSource,
voucherType,
currency,
paymentStatus,
caeStatus,
formattedInvoiceNumber,
taxRate,
saleLineType
dimension_filters
object

Filtros por dimensión. Cada clave debe ser una dimensión filtrable para la fuente. También acepta product_metafield: para campos personalizados select de producto y contact_metafield: para campos personalizados select de contacto cuando la fuente lo soporta. El valor es un array de IDs o valores a incluir.

include_totals
boolean

Si es true, la respuesta incluye totales agregados en el campo totals.

date_basis
enum<string>
default:commercial

commercial usa la fecha de venta. fiscal usa la fecha contable del comprobante.

Available options:
commercial,
fiscal

Response

Reporte ejecutado exitosamente

request_id
string
required
data
object
required