---
title: "Prepare a report packet"
method: POST
path: "/reports/packets/prepare"
tags: ["Reports"]
---

# Prepare a report packet

`POST /reports/packets/prepare`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/reports/packets/prepare`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Prepares or refreshes one exact company and period report packet. Dates use YYYY-MM-DD. The selected accounting basis defaults to the company setting. Preparation does not certify completeness or depend on current operational work.

## Request body

- ReportPacketPrepareRequest
  - `companyOrganizationId` string, uuid, required
  - `periodStart` string, date, required
  - `periodEnd` string, date, required
  - `asOf` string, date
  - `basis` 'accrual' | 'cash'
  - `presentationType` 'simple' | 'expanded' | 'tax_preparer'
  - `presentationSettings` object
    - `includeIncomeStatement` boolean
    - `includeBalanceSheet` boolean
    - `includeTransactionDetail` boolean
    - `includeTrialBalance` boolean
    - `includeGeneralLedger` boolean
  - `includeTrialBalance` boolean
  - `includeGeneralLedger` boolean

## Response `200`

Prepared report packet

- ReportPacketPreparation
  - `packet` ReportPacket, required
    - `id` string, uuid, required
    - `firmOrganizationId` string, uuid, required
    - `organizationId` string, uuid, required
    - `periodStart` string, date, required
    - `periodEnd` string, date, required
    - `asOf` string, date, required
    - `basis` 'accrual' | 'cash', required
    - `packetKind` 'management_financials', required
    - `reportSet` object, required
      - `definition` object, required
      - `reports` object, required
    - `operationalItems` object[], required
      - `key` string, required
      - `kind` 'unposted_bank_activity' | 'statement_coverage' | 'reconciliation' | 'bank_reconnect' | 'client_request' | 'unknown_money', required
      - `label` string, required
      - `count` integer, required
      - `companyOrganizationId` string, uuid, required
      - `sourceIds` string[], required
      - `href` string, required
      - `owner` 'firm' | 'client', required
      - `updatedAt` string, date-time, required
    - `operationalItemsEvaluatedAt` string, date-time, required
    - `contentDigest` string, required
    - `artifactAttachments` object[], required
      - `attachmentId` string, uuid, required
      - `reportType` 'management_financials' | 'trial_balance' | 'general_ledger', required
      - `fileName` string, required
      - `mimeType` string, required
      - `fileSize` integer, required
      - `sha256` string, required
    - `preparedAt` string, date-time, required
    - `lastDeliveryRequestId` string, uuid, nullable, required
    - `createdByUserId` string, uuid, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `currentOperationalItems` ReportPacketOperationalItem[], required
    - `key` string, required
    - `kind` 'unposted_bank_activity' | 'statement_coverage' | 'reconciliation' | 'bank_reconnect' | 'client_request' | 'unknown_money', required
    - `label` string, required
    - `count` integer, required
    - `companyOrganizationId` string, uuid, required
    - `sourceIds` string[], required
    - `href` string, required
    - `owner` 'firm' | 'client', required
    - `updatedAt` string, date-time, required
  - `artifactsReused` boolean, required
  - `contentDigest` string, required

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)