Generar un reporte | Documentación API de Recurrente

Pide un reporte y recógelo cuando esté listo: la respuesta nace en pending, y cuando status llega a succeeded aparece result.download_url. Si falla, status queda en failed y error explica por qué, para que dejes de esperarlo.

El archivo es el mismo estado de cuenta que se descarga desde el Dashboard, así que cuadra con lo que ya concilia tu contador. Con una llave de organización y sin X-ACCOUNT-ID, un solo reporte cubre todas las cuentas y gana una columna Cuenta; nombrando una cuenta, cubre solo esa.

Pide un reporte y recógelo cuando esté listo: la respuesta nace en `pending`, y cuando `status` llega a `succeeded` aparece `result.download_url`. Si falla, `status` queda en `failed` y `error` explica por qué, para que dejes de esperarlo. El archivo es el mismo estado de cuenta que se descarga desde el Dashboard, así que cuadra con lo que ya concilia tu contador. Con una llave de organización y sin `X-ACCOUNT-ID`, un solo reporte cubre todas las cuentas y gana una columna `Cuenta`; nombrando una cuenta, cubre solo esa.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Request

This endpoint expects an object.

report_typeenumRequired

Tipo de reporte. Va versionado para que las columnas puedan cambiar sin romper integraciones.

Allowed values:

parametersobjectRequired

Response

Reporte encolado

idstring

report_typestring

statusenum

parametersobject

created_atdatetime

resultobject or nullOptional

Vacío hasta que el archivo existe

errorstring or nullOptional

Por qué falló el reporte, cuando falló

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.recurrente.com/api/report_runs \
>	-H "X-SECRET-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"report_type": "ledger.itemized.1",
>	"parameters": {
>	"interval_start": "2026-07-01",
>	"interval_end": "2026-07-31"
>	}
>	}'

1	{
2	"id": "rr_ab12cd34",
3	"report_type": "ledger.itemized.1",
4	"status": "pending",
5	"parameters": {
6	"interval_start": "2023-01-15",
7	"interval_end": "2023-01-15",
8	"currency": "string",
9	"format": "csv"
10	},
11	"created_at": "2024-01-15T09:30:00Z",
12	"result": {
13	"filename": "string",
14	"size_in_bytes": 1,
15	"download_url": "string"
16	},
17	"error": "string"
18	}