Report
Generate reports from ledger data for auditing, compliance, and reconciliation.
A report generates structured data from the ledger. Report types like reconciliation or billing are defined by schemas, and each report is configured with parameters like date ranges and filters.
Use reports to extract ledger data for auditing, compliance, or integration with external systems.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /reports | Configure a structured data export for auditing, reconciliation, or compliance. |
| GET | /reports | Query reports with filtering, sorting, and pagination. |
| GET | /reports/{id} | Retrieve a report by its handle or LUID. |
| DELETE | /reports/{id} | Permanently remove a report from the ledger. |
| POST | /reports/{id}/proofs | Submit a signed proof to a report record. |
Access & History
| Method | Path | Description |
|---|---|---|
| POST | /reports/{id}/access/!check | Evaluate what actions a signer can perform on this report. |
| GET | /reports/{id}/changes | Retrieve the change history of a report by its handle or LUID. |
| GET | /reports/{id}/changes/{change} | Retrieve a change record for a report by handle or LUID and change number. |
Related
- About Reports — how reports are generated and structured
- About BigQuery Reporting Bridge — exporting ledger data to BigQuery
- About Schemas — how schemas define report structure
Get schema change GET
Returns a single change by its sequence number. The change includes a full record snapshot as it existed at that point.
Create report POST
The report starts in `created` status and transitions through `pending` → `completed` → `settled` as it is processed and finalized. Reports can be rejected at any stage before completion. Broadcasts the `report-created` signal. Use [effects](/ledger/reference/api/effect) to subscribe.