---
title: "Generate report"
method: POST
path: "/ledger/v1/reports"
tags: ["Wallets"]
---

# Generate report

`POST /ledger/v1/reports`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/ledger/v1/reports`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/ledger/v1/reports/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a report from a wallet in the specified format and sends it via the preferred delivery method: WEBHOOK or EMAIL.

The report type is determined by the `type` field in the request body:
- `TRANSACTION` returns all transactions within a date range (`from` / `to`).
- `BALANCE` returns the wallet balance at a specific point in time (`at`).

:::note

Reports are delivered instantly but the data has a one-hour lag for the production environment and eight-hour delay in sandbox. For example, a report requested at 9:00 AM will include transactions only up to 8:00 AM.

:::

See the [Receive Transactions Report via Webhook](https://docs.bvnk.com/bvnk/reconciliation/receive-transactions-report-via-webhook) guide for more information.

## Request body

- object
  - `walletId` string: Wallet Id for which to retrieve transactions. If left blank, all transactions will be included in the report.
  - `from` string, date-time: Initial date of the period being reported on in the ISO format. Required for `TRANSACTION` reports.
  - `to` string, date-time: Final date of the period in the ISO format. Required for `TRANSACTION` reports.
  - `at` string, date-time: Point-in-time date for the report in the ISO format. Required for `BALANCE` reports.
  - `format` 'JSON' | 'CSV' | 'PDF': Format of the report file.
  - `deliveryChannel` 'EMAIL' | 'WEBHOOK': Method of delivery for the report.
  - `type` 'TRANSACTION' | 'BALANCE': Report type. Use `TRANSACTION` for a transactions report over a date range, or `BALANCE` for a point-in-time balance snapshot.

## Response `201`

PROCESSING

- TransactionReportDto[]
  - `id` integer: The ID of the transaction request.
  - `uuid` string: The UUID of the transaction report.
  - `dateCreated` integer: The date and time, encoded into UNIX epoch timestamps.
  - `lastUpdated` integer: The date and time, encoded into UNIX epoch timestamps.
  - `expiryDate` integer: The date and time, encoded into UNIX epoch timestamps.
  - `status` string: The status of the transaction report. A report normally moves through `PENDING`, `PROCESSING`, `READY`, and `SENT`. - `PENDING`: The report request is queued. - `PROCESSING`: The report is being generated. - `READY`: The report is generated and ready for download. - `SENT`: The report has been delivered through the requested delivery channel. - `FAILED`: The report could not be generated. - `FALLBACK`: The requested period is before 2023-12-01, so the request is handled by the legacy report.
  - `type` string: The type of the report.
  - `requestData` TransactionReportRequestDataDto
    - `type` string: The type of report.
    - `externalProcessing` string
    - `walletId` string, int64: The wallet ID For the report.
    - `transactionType` string: The transaction type.
    - `fromDate` string: The from date of the report.
    - `toDate` string: The to date of the report.
    - `format` string: The format of the report.
    - `languageTag` string: The language tag of the report.
    - `category` integer: The category of the report.
    - `accountName` string: The account name.
    - `include` string
    - `exclude` string

## Other responses

- `400`: Bad Request

## Changes

- **2026-06-16** `97d6c0d2fe2e`: 1 breaking, 3 info
  - request property `type` was restricted to a list of enum values
  - added the new optional request property `at`
  - added the new `BALANCE` enum value to the request property `type`
  - added the new `TRANSACTION` enum value to the request property `type`

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/ledger/v1/reports/post.md)

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)