Create a Report

Use this endpoint to generate reports asynchronously using pre-registered templates. You can apply custom filters to define specific criteria by domain, like account IDs in onboarding.

The request returns a unique reportId to track status and download the report when ready.

POST /v1/reports

Create a Report

cURL

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-id: <x-organization-id>' \
  --data '
{
  "templateId": "01953d09-e6cb-7c1c-a01a-272855a9ffb7",
  "filters": {
    "midaz_onboarding": {
      "account": {
        "created_at": {
          "between": [
            "2025-08-02",
            "2025-08-03"
          ]
        }
      }
    }
  }
}
'

201

Example

{
  "id": "0196c5c0-5044-724f-95f3-4b32076e7ad7",
  "templateId": "01953d09-e6cb-7c1c-a01a-272855a9ffb7",
  "filters": {
    "midaz_onboarding": {
      "account": {
        "created_at": {
          "between": [
            "2025-08-02",
            "2025-08-03"
          ]
        }
      }
    }
  },
  "completedAt": null,
  "createdAt": "2025-05-12T18:27:17.188156815Z",
  "updatedAt": "2025-05-12T18:27:17.188156815Z",
  "deletedAt": null
}

Headers

Authorization · string

The authorization token in the 'Bearer ' format.

Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

X-Organization-id · string · required

The unique identifier of the Organization associated with the request.

X-Idempotency · string

Optional idempotency key for safe retries. If omitted, the server may generate one automatically.

See Retries and idempotency for details.

Body

application/json

Details of the request to generate the report.

templateId · string · required

Unique identifier of the template used to generate the report.

filters · object · required

Object that defines the filtering criteria applied to the data used in the report. Now supports advanced filtering operators including equality, comparison, range, and list-based conditions.

Important: The filters object must be included in the request body, even if empty.

Show child attributes

Response

201

application/json

Indicates that the report request was successfully created.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

Details about the report that was created.

id · string

Unique identifier of the report generation request.

templateId · string

Unique identifier of the template used to generate the report.

templateOutputFormat · string

Output format configured on the template used to generate the report.

Example:

"XML"

templateDescription · string

Description configured on the template used to generate the report.

Example:

"Cadoc"

filters · object

Object that defines the filtering criteria applied to the data used in the report. Now supports advanced filtering operators including equality, comparison, range, and list-based conditions.

Show child attributes

status · string

Current status of the report

completedAt · string

Timestamp marking when the report processing was completed.

createdAt · string

Timestamp marking when this report request was created.

updatedAt · string

Timestamp marking the last update to this report request.

deletedAt · string

Timestamp marking when this report request was soft deleted, if applicable.

metadata · object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Show child attributes