reportRuns

Generar un reporte

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.

post/report_runs

Headers

X-SECRET-KEYstring required

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 body

report_type'ledger.itemized.1' required

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

Response

Reporte encolado

idstring required
report_typestring required
status'pending' | 'succeeded' | 'failed' required
errorstring nullable

Por qué falló el reporte, cuando falló

created_atstring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.