---
title: "POST /v1/reports/export"
method: POST
path: "/v1/reports/export"
tags: ["Reports"]
---

# POST /v1/reports/export

`POST /v1/reports/export`

## Request

- Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tokenbooks.io/v1/reports/export`
- Auth: API key in header `x-api-key`

## Request body

- WorkspaceReportExportRequestDto
  - `payload` union, required
    - object
      - `scopeId` string
      - `locale` string, required
      - `type` 'consolidated-profit-and-loss', required
      - `format` 'xlsx', required
      - `filters` object, required
        - `startDate` string
        - `endDate` string
    - object
      - `scopeId` string
      - `locale` string, required
      - `type` 'consolidated-balance-sheet', required
      - `format` 'xlsx', required
      - `filters` object, required
        - `asOfDate` string, required
  - `format` 'xlsx' | 'pdf' | 'json', required: Export format
  - `totalsOnly` boolean: When true, only calculate totals without generating binary export

## Response `201`

- ReportJobResponseDto
  - `jobId` string, required: Job ID for tracking progress

---

[API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/180622e6255e?raw)