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,
tax_amount,
count,
sale_count,
credit_note_count,
units,
sold_units,
units_per_sale,
cost,
margin,
avg_ticket,
margin_percent,
channel_fee,
seller_shipping,
additional_costs,
contribution_margin,
contribution_margin_percent,
discount_amount,
line_discount_amount,
line_discount_rate,
global_discount_amount,
global_discount_rate,
discounted_sales_count,
balance,
unique_customers,
unique_products
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,
week_of_year,
month,
month_of_year,
day_of_week,
year,
quarter,
hour_of_day,
customer,
customer_name,
assigned_salesperson,
customer_email,
customer_tax_category,
customer_type,
customer_recency,
province,
city,
product,
product_name,
variant,
variant_sku,
category,
subcategory,
default_supplier_name,
product_type,
sold_product,
sold_sku,
sold_product_type,
salesperson,
cashier,
point_of_sale,
price_list,
warehouse,
register,
integration_source,
channel_listing,
channel_listing_type,
channel_logistics,
voucher_type,
currency,
payment_status,
cae_status,
invoice_status,
formatted_invoice_number,
tax_rate,
sale_line_type
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.

reporting_currency
enum<string>
default:ARS

Currency used for all monetary measures in the report.

Available options:
ARS,
USD
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