RErecurrente
reportRuns

Generar un reporte

Changed on

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

Request

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

  • 33bad9197d59Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API