File Tools
Query uploaded files — invoices, spreadsheets, and documents — along with their processing status and linked facilities. Files are the entry point for bulk data imports (purchases, invoices, employees, etc.).list_files
List uploaded files with optional filters by name, extension, status, or date range.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | No | default org | Organization UUID |
name | string | No | — | Filter by file name (partial match) |
extension | string | No | — | Filter by extension: pdf, xlsx, csv, etc. |
status | string | No | — | Processing status: pending, uploaded, error, deleted |
from_date | string | No | — | Filter from upload date (YYYY-MM-DD) |
to_date | string | No | — | Filter until upload date (YYYY-MM-DD) |
page | integer | No | 1 | Page number |
size | integer | No | 50 | Results per page |
| Field | Description |
|---|---|
status | pending (uploading), uploaded (ready/processed), error (failed), deleted |
extension | File type: pdf, xlsx, csv, xml, etc. |
size_kb | File size in kilobytes |
linked_facilities | Facilities linked via invoice/waste data in the file |
reading_status | AI reading status for invoices: success or error (null if not read) |
current_step | Current ingestion step (null if not actively being processed) |
tags | User-assigned labels |
get_file
Get detailed information about a specific file by ID.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_id | string | Yes | — | UUID of the file |
organization_id | string | No | default org | Organization UUID |
Workflow
- List files —
list_filesto find uploaded files by name, type, or status - Check details —
get_filefor a specific file’s processing state - Check processing —
list_processing_jobsto see if a file upload triggered calculations and their status - View imported data — Use the corresponding data tool (e.g.
list_invoices,list_purchases) to see records created from the file
Related
Processing Jobs
Track file upload processing and calculation status
Invoices
Invoice data often imported via file uploads
API Reference
REST API endpoints for file management
CLI
Upload and manage files from the command line