---
title: "Create report schedule"
method: POST
path: "/ledger/v1/report-schedules"
tags: ["Wallets"]
---

# Create report schedule

`POST /ledger/v1/report-schedules`

## Request

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

Creates a new scheduled report that will be automatically generated and delivered according to the specified frequency and delivery preferences. Each user can create only one schedule per account.

## Request body

- object
  - `time` string, required: Time of day when the report should be generated and sent, in 24-hour format (HH:MM).
  - `timezone` string, required: Timezone to use for scheduling the report generation. Must be a valid IANA timezone identifier. Use [Get Supported Timezones](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-supported-timezones) endpoint to get the list of timezones.
  - `frequencyType` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: Frequency at which the report should be generated. The report is generated for the previous time period. For example, if the DAILY report is generated on 1st of January, it will contain the data for the previous day (31st of December). If the WEEKLY report is scheduled for Wednesday, it will contain the data for the previous Tuesday to this week's Wednesday.
  - `frequencyDay` integer: Specific day (1=Monday, 7=Sunday) for report generation. Only for `frequencyType` WEEKLY. To schedule a report for every day, set this value to `1`.
  - `format` 'CSV' | 'PDF' | 'JSON', required: File format for the generated report.
  - `channel` 'webhook' | 'email', required: Delivery method for the report: - `webhook` for API delivery - `email` for delivery via email.
  - `email` string, email: Email address for report delivery. Required when channel is `email`, ignored for the `webhook` channel.
  - `reportParams` object, required
    - `reportType` 'TRANSACTION' | 'TRADING_VOLUME' | 'PAYMENT_VOLUME' | 'DIGITAL_ASSETS_VOLUME' | 'PAYMENT' | 'WALLET_BALANCE', required: The type of report to be generated. Use 'TRANSACTION' to get the transactions report. **Currently, only 'TRANSACTION' is supported**. More report types will be available in the future.
    - `walletId` string: The ID of the wallet to generate the report for.

## Response `201`

Report schedule created successfully

- object
  - `id` string, uuid: Unique identifier for the created report schedule
  - `createdBy` string: Base64 encoded identifier of the user who created the schedule
  - `name` string: Optional name for the report schedule
  - `accountReference` string, uuid: Reference to the account this report schedule belongs to
  - `time` string: The scheduled time for report generation in 24-hour format
  - `timezone` string: The timezone used for scheduling
  - `frequencyType` 'DAILY' | 'WEEKLY' | 'MONTHLY': The frequency of report generation
  - `frequencyDay` integer: The specific day for report generation based on frequency type
  - `format` 'CSV' | 'PDF' | 'JSON': The file format of the generated report (uppercase in response)
  - `channel` 'WEBHOOK' | 'EMAIL': The delivery method for the report (uppercase in response)
  - `email` string, email: Email address for delivery (`null` when channel is WEBHOOK)
  - `reportParams` object: Parameters for the report configuration
    - `reportType` 'TRANSACTION': The type of report to be generated
    - `walletId` string: The ID of the wallet to generate the report for.
  - `createdAt` string, date-time: Timestamp when the report schedule was created

## Other responses

- `400`: Bad request - Invalid input parameters
- `409`: Conflict - Report schedule already exists for this user

---

[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)