Saltar al contenido principal
GET
Obtener resumen de facturas

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de ruta

identifier
string
requerido

RUT del cliente, sin puntos, con guion y con la K del dígito verificador en mayúscula.

Ejemplo:

"76111111-6"

Parámetros de consulta

RUT de la empresa relacionada por la que quieres filtrar. Si lo omites o lo envías vacío, se consideran todas.

sortBy
enum<string>
predeterminado:salesAmount

Campo por el que se ordenan las empresas relacionadas de cada período.

Opciones disponibles:
salesAmount,
salesAmountNet,
salesDocuments,
salesDocumentsConfirmed,
buyAmount,
buyAmountNet,
salesCancelAmount,
salesCancelDocuments,
buyCancelAmount,
buyCancelDocuments,
salesCreditNoteAmount,
salesCreditNoteDocuments,
buyCreditNoteAmount,
realSalesAmount
sortOrder
enum<string>
predeterminado:desc

Sentido del orden.

Opciones disponibles:
asc,
desc

Respuesta

Resumen de facturas del cliente.

Hasta 50 empresas relacionadas por período, ordenadas según sortBy y sortOrder. Las claves son períodos: Last24Months, Last12Months, Last6Months, Last3Months, Last6MonthsPreviousYear (los 6 meses completos que terminaron hace 12 meses) y un mes calendario por cada uno de los últimos 24 meses y el mes en curso, con el formato Mes-Año en inglés (por ejemplo October-2026). Los períodos acumulados no incluyen el mes en curso. Los meses sin documentos vienen con un arreglo vacío. Los períodos Last* listan todas las empresas relacionadas de la ventana, con valores en 0 si no tuvieron actividad en ese período. El ejemplo omite la mayoría de los períodos.

totals
object
requerido

Totales por período, calculados sobre todas las empresas relacionadas (no solo las 50 listadas). Solo vienen los períodos que tienen al menos una empresa relacionada.

lastScrapedDate
string<date-time> | null
requerido

Fecha y hora de la última vez que Pruff actualizó la información tributaria del cliente, en ISO 8601. null si nunca se ha actualizado o el RUT no existe.