Skip to main content
GET
Listar resumen de libro de compras/ventas SII

¿Para qué se usa?

Permite obtener el resumen agregado del libro de compras y ventas (getResumen del SII) de una entidad para un período determinado. Cada ítem representa un total por tipo de documento (factura, nota de crédito, etc.) y operación (COMPRA o VENTA), no el detalle línea a línea de cada documento.

Qué hace

  • Devuelve los totales del libro (total_docs, net_amount, exempt_amount, vat_amount, total_amount) agrupados por dte_type_code y operation para el period (YYYYMM) indicado.
  • La entidad se indica con el query param master_entity_id, igual que en /documents. Acepta el id opaco (eid_..., campo opaque_id de /master-entities?rut=) o el id entero.
  • Puedes filtrar por operación (COMPRA o VENTA); si se omite, devuelve ambas.
  • El campo is_enabled indica si la entidad tiene habilitado el scrape de este resumen. Si es false, results viene vacío aunque el período sea válido — la entidad necesita ser habilitada primero (ver Introducción).

Ejemplos de uso

  • Conciliar el IVA débito/crédito declarado por el SII contra tu propia contabilidad.
  • Mostrar en un dashboard los totales mensuales de compras y ventas de una entidad sin tener que descargar el detalle documento por documento.

Authorizations

Authorization
string
header
required

API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)

Query Parameters

master_entity_id
string
required

ID de la entidad maestra. Acepta el id opaco (eid_..., campo opaque_id de /master-entities?rut=) o el id entero.

Example:

"eid_NDgyMTM6c2lnbmF0dXJl"

period
string
required

Período a consultar, formato YYYYMM.

Example:

"202603"

operation
enum<string>

Filtra por operación: COMPRA o VENTA. Si se omite, devuelve ambas.

Available options:
COMPRA,
VENTA

Response

Resumen de libro para la entidad y período consultado

count
integer

Total de filas en results

is_enabled
boolean

true si la entidad tiene habilitado el scrape de resumen de libros (BOOK_SUMMARY). Si es false, results estará vacío aunque el período sea válido.

results
object[]