> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.recurrente.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.recurrente.com/_mcp/server.

# Generar un reporte

POST https://app.recurrente.com/api/report_runs
Content-Type: application/json

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.


Reference: https://docs.recurrente.com/referencia-api/api-reference/report-runs/create-report-run

## Authentication

- `X-SECRET-KEY` header (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. 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`.

## Request

### Body (application/json)

This endpoint expects an object.

- `report_type` (enum, required) — Tipo de reporte. Va versionado para que las columnas puedan cambiar sin romper integraciones.
  - Allowed values: `ledger.itemized.1`
- `parameters` (ReportRunsPostRequestBodyContentApplicationJsonSchemaParameters, required)

## Response

### 201

Reporte encolado

- `id` (string, required)
- `report_type` (string, required)
- `status` (enum, required)
  - Allowed values: `pending`, `succeeded`, `failed`
- `parameters` (ReportRunParameters, required)
- `created_at` (datetime, required)
- `result` (ReportRunResult, optional, nullable) — Vacío hasta que el archivo existe
- `error` (string, optional, nullable) — Por qué falló el reporte, cuando falló

## Errors

### 422 Unprocessable Entity Error

Parámetros incompletos o tipo de reporte desconocido

- `message` (string, optional) — Mensaje de error
- `code` (string, optional) — Código estable legible por máquinas, cuando aplica
- `refund_id` (string, optional) — ID del reembolso relacionado cuando aplica
- `endpoint` (string, optional) — Acción de API rechazada, cuando aplica
- `errors` (ErrorErrors, optional) — Detalles de errores por campo

## Types

### ReportRunsPostRequestBodyContentApplicationJsonSchemaParameters

- `interval_start` (date, required)
- `interval_end` (date, required)
- `currency` (string, optional) — Moneda del balance. Por defecto, la de la cuenta.
- `format` (enum, optional, default: csv)
  - Allowed values: `csv`, `xlsx`

### ReportRunParameters

- `interval_start` (date, optional)
- `interval_end` (date, optional)
- `currency` (string, optional)
- `format` (enum, optional)
  - Allowed values: `csv`, `xlsx`

### ReportRunResult

Vacío hasta que el archivo existe

- `filename` (string, optional)
- `size_in_bytes` (integer, optional)
- `download_url` (string, optional)

### ErrorErrors

Detalles de errores por campo

## Examples

**Request**

```json
{
  "report_type": "ledger.itemized.1",
  "parameters": {
    "interval_start": "2026-07-01",
    "interval_end": "2026-07-31"
  }
}
```

**Response**

```json
{
  "id": "rr_ab12cd34",
  "report_type": "ledger.itemized.1",
  "status": "pending",
  "parameters": {
    "interval_start": "2023-01-15",
    "interval_end": "2023-01-15",
    "currency": "string",
    "format": "csv"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "result": {
    "filename": "string",
    "size_in_bytes": 1,
    "download_url": "string"
  },
  "error": "string"
}
```

**SDK Code**

```python
import requests

url = "https://app.recurrente.com/api/report_runs"

payload = {
    "report_type": "ledger.itemized.1",
    "parameters": {
        "interval_start": "2026-07-01",
        "interval_end": "2026-07-31"
    }
}
headers = {
    "X-SECRET-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.recurrente.com/api/report_runs';
const options = {
  method: 'POST',
  headers: {'X-SECRET-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"report_type":"ledger.itemized.1","parameters":{"interval_start":"2026-07-01","interval_end":"2026-07-31"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.recurrente.com/api/report_runs"

	payload := strings.NewReader("{\n  \"report_type\": \"ledger.itemized.1\",\n  \"parameters\": {\n    \"interval_start\": \"2026-07-01\",\n    \"interval_end\": \"2026-07-31\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SECRET-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.recurrente.com/api/report_runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SECRET-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"report_type\": \"ledger.itemized.1\",\n  \"parameters\": {\n    \"interval_start\": \"2026-07-01\",\n    \"interval_end\": \"2026-07-31\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.recurrente.com/api/report_runs")
  .header("X-SECRET-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"report_type\": \"ledger.itemized.1\",\n  \"parameters\": {\n    \"interval_start\": \"2026-07-01\",\n    \"interval_end\": \"2026-07-31\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.recurrente.com/api/report_runs', [
  'body' => '{
  "report_type": "ledger.itemized.1",
  "parameters": {
    "interval_start": "2026-07-01",
    "interval_end": "2026-07-31"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-SECRET-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.recurrente.com/api/report_runs");
var request = new RestRequest(Method.POST);
request.AddHeader("X-SECRET-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"report_type\": \"ledger.itemized.1\",\n  \"parameters\": {\n    \"interval_start\": \"2026-07-01\",\n    \"interval_end\": \"2026-07-31\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-SECRET-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "report_type": "ledger.itemized.1",
  "parameters": [
    "interval_start": "2026-07-01",
    "interval_end": "2026-07-31"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.recurrente.com/api/report_runs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```