Attachments, fiscal documents, schemas and workspaces
Files attached to records, received fiscal documents, finance_schemas_get — the catalogue of the fields each tool returns, i.e. what to ask for in fields — and finance_workspaces_list, the workspaces the other tools' workspace_id comes from.
Families on this page
| Family | Tools | read | write | destructive |
|---|---|---|---|---|
attachments — Attachments | 7 | 3 | 2 | 2 |
fiscal_documents — Received fiscal documents | 2 | 2 | 0 | 0 |
schemas — Field catalogue | 1 | 1 | 0 | 0 |
workspaces — Workspaces | 1 | 1 | 0 | 0 |
attachments
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_attachments_list | read | attachments.list | GET /v1/attachments | List attachments (metadata only). |
finance_attachments_get | read | attachments.list | GET /v1/attachments/{attachment_id} | Fetch one attachment's metadata, including download_url. |
finance_attachments_download | read | attachments.download | GET /v1/attachments/{attachment_id}/download | Locate an attachment's bytes. |
finance_attachments_upload | write | attachments.create | POST /v1/attachments | Upload a file (pdf, png, jpg, xml, ofx, csv, xlsx; max 10 MB) as an attachment. |
finance_attachments_delete | destructive | attachments.delete | DELETE /v1/attachments/{attachment_id} | Delete an attachment (file and metadata). |
finance_attachments_link | write | attachments.update | POST /v1/attachments/{attachment_id}/links | Attach the file to a payable, receivable or transaction: type names the kind of record and id its id. |
finance_attachments_unlink | destructive | attachments.update | DELETE /v1/attachments/{attachment_id}/links | Detach the file from a payable, receivable or transaction (type + id of the record). |
fiscal_documents
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_fiscal_documents_list | read | fiscal-documents.list | GET /v1/fiscal-documents | List received fiscal documents (NF-e / NFS-e issued to the workspace's companies). |
finance_fiscal_documents_get | read | fiscal-documents.show | GET /v1/fiscal-documents/{id} | Fetch one received fiscal document. |
schemas
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_schemas_get | read | — (none) | — (local) | Describe a schema of the Finance API contract: the fields a tool returns (PayableDetailV1, FinancialTransactionV1…) or accepts. |
workspaces
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_workspaces_list | read | — (none) | — (local) | List the workspaces of this organization you can act on. |
The fields of each resource are in the API reference and in finance_schemas_get.
A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.