Skip to navigation

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.

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.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

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.

Headers

X-ACCOUNT-IDstringOptional

ID de una cuenta hija conectada. Ejecuta el request dentro de esa cuenta, como Stripe-Account en Stripe Connect. La plataforma puede acceder a todos los recursos API que pertenecen a la hija, sin filtrar por creador. Solo aplica a hijas directas: si la cuenta no está conectada a la tuya, el request responde 404 con code: connected_account_not_found.

Con una llave de organización este header nombra la cuenta miembro sobre la que quieres operar; si no pertenece a la organización, el request responde 404 con code: organization_account_not_found. En una lectura puedes omitirlo para abarcar todas las cuentas de la organización.

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
Allowed values:
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