Exports
Create and download export jobs (CSV, XLSX, JSON, PDF) from Exports.
Overview
Exports queues and tracks export jobs, with storage quota visibility and download/retry actions.
Where it lives
Route: /admin/settings/exports (admin.settings.exports.index)
Open Admin → Data → Exports.
| Permission | Grants |
|---|---|
exports.access |
See Exports in the admin navigation |
exports.view |
View export jobs and download completed files |
exports.create |
Create, cancel and retry exports |
Key workflows
| Action | Behaviour |
|---|---|
| New Export | Source model or live filter; format CSV/XLSX/JSON/PDF; filter[field][operator] filters; column picker |
| Cancel | Queued or processing jobs |
| Download | Completed jobs with a valid signed token |
| Retry | Failed jobs |
The UI polls about every 5 seconds while jobs are active. Column visibility respects the user’s permissions (e.g. cost columns).
Rows follow the export creator's record visibility. Rentals, invoices, credit notes, documents, purchase orders and payments for privacy-restricted accounts, and the lines, phases, versions and costs of those rentals, are left out unless the creator holds accounts.privacy.case. Import batches and profiles are limited to those the creator can view. Workflow exports apply the same rule to the workflow's own identity, which must hold accounts.privacy.case itself.
Rental phase exports
The rental_phases model source exports individual phase rows with rental_id, phase_key, label, starts_at, ends_at, sequence, blocking and role. It requires rental read access and follows the export creator's warehouse permissions, including queued execution and download checks. Deleted parent rentals are excluded; attached hidden and archived definitions remain readable.
label, blocking and role are presentation columns for export, not model filter fields. Filter phase keys, dates, sequence or rental references through supported model fields. The Rental Phases report source separately supports definition dimensions and filters and can export aggregated results.
API
| Endpoint | Purpose |
|---|---|
GET /api/v1/exports |
List export jobs (api.v1.exports.index) |
POST /api/v1/exports |
Create an export (api.v1.exports.store) |
GET /api/v1/exports/{export} |
Show a job and download metadata (api.v1.exports.show) |
POST /api/v1/exports/{export}/cancel |
Cancel a queued or processing job (api.v1.exports.cancel) |
DELETE /api/v1/exports/{export} |
Delete a terminal job and its file (api.v1.exports.destroy) |
GET /api/v1/exports/download/{token} |
Public-with-token file stream (api.v1.exports.download) |