Skip to main content
POST
La Pyme SDK

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,
lineDiscountAmount,
lineDiscountRate,
globalDiscountAmount,
globalDiscountRate,
discountedSalesCount,
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,
invoiceStatus,
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