Registros
Lo que clasifica títulos y movimientos: empresas, personas, categorías, centros de clasificación, clasificadores personalizados, impuestos y las reglas de clasificación automática.
Familias en esta página
| Familia | Tools | read | write | destructive |
|---|---|---|---|---|
companies — Empresas | 5 | 2 | 2 | 1 |
people — Personas | 6 | 3 | 2 | 1 |
categories — Categorías | 5 | 2 | 2 | 1 |
classification_centers — Centros de clasificación | 5 | 2 | 2 | 1 |
custom_classifiers — Clasificadores personalizados | 8 | 2 | 4 | 2 |
taxes — Impuestos | 5 | 2 | 2 | 1 |
automatic_rules — Reglas automáticas | 6 | 2 | 3 | 1 |
companies
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
finance_companies_list | read | companies.list | GET /v1/companies | List the companies (CNPJs) of the workspace. |
finance_companies_get | read | companies.show | GET /v1/companies/{id} | Fetch one company. |
finance_companies_create | write | companies.create | POST /v1/companies | Create a company. |
finance_companies_update | write | companies.update | PATCH /v1/companies/{id} | Update a company's name or active. |
finance_companies_delete | destructive | companies.delete | DELETE /v1/companies/{id} | Delete a company. |
people
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
finance_people_list | read | people.list | GET /v1/people | List people — customers, suppliers, team members, bank managers. |
finance_people_get | read | people.show | GET /v1/people/{id} | Fetch one person. |
finance_people_ids | read | people.list | GET /v1/people/ids | The id of every live person, for reconciling a mirror. |
finance_people_create | write | people.create | POST /v1/people | Create a person (customer and/or supplier). |
finance_people_update | write | people.update | PATCH /v1/people/{id} | Partially update a person. |
finance_people_delete | destructive | people.delete | DELETE /v1/people/{id} | Soft-delete a person. |
categories
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
finance_categories_list | read | categories.list | GET /v1/categories | List categories (plano de contas). |
finance_categories_get | read | categories.show | GET /v1/categories/{id} | Fetch one category. |
finance_categories_create | write | categories.create | POST /v1/categories | Create a category. |
finance_categories_update | write | categories.update | PATCH /v1/categories/{id} | Rename a category or change its type (cascades to descendants). |
finance_categories_delete | destructive | categories.delete | DELETE /v1/categories/{id} | Delete a leaf category, clearing it from transactions and titles. |
classification_centers
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
finance_classification_centers_list | read | cost-centers.list | GET /v1/classification-centers | List classification centers (centros de custo/receita) used for rateio. |
finance_classification_centers_get | read | cost-centers.show | GET /v1/classification-centers/{id} | Fetch one classification center. |
finance_classification_centers_create | write | cost-centers.create | POST /v1/classification-centers | Create a classification center. |
finance_classification_centers_update | write | cost-centers.update | PATCH /v1/classification-centers/{id} | Partially update a classification center. |
finance_classification_centers_delete | destructive | cost-centers.delete | DELETE /v1/classification-centers/{id} | Delete a classification center. |
custom_classifiers
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
finance_custom_classifiers_list | read | custom-classifiers.list | GET /v1/custom-classifiers | List custom classifiers — the workspace's own classification dimensions — with their values. |
finance_custom_classifiers_get | read | custom-classifiers.show | GET /v1/custom-classifiers/{classifier_id} | Fetch one custom classifier with its values. |
finance_custom_classifiers_create | write | custom-classifiers.create | POST /v1/custom-classifiers | Create a custom classifier (dimension). |
finance_custom_classifiers_update | write | custom-classifiers.update | PATCH /v1/custom-classifiers/{classifier_id} | Partially update a custom classifier. |
finance_custom_classifiers_delete | destructive | custom-classifiers.delete | DELETE /v1/custom-classifiers/{classifier_id} | Delete a custom classifier. |
finance_custom_classifiers_values_create | write | custom-classifiers.update | POST /v1/custom-classifiers/{classifier_id}/values | Add a value to a custom classifier. |
finance_custom_classifiers_values_update | write | custom-classifiers.update | PATCH /v1/custom-classifiers/{classifier_id}/values/{value_id} | Partially update a value of a custom classifier. |
finance_custom_classifiers_values_delete | destructive | custom-classifiers.update | DELETE /v1/custom-classifiers/{classifier_id}/values/{value_id} | Delete a value of a custom classifier. |
taxes
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
finance_taxes_list | read | taxes.list | GET /v1/taxes | List the workspace's taxes and withholdings (ISS, IRRF, INSS…). |
finance_taxes_get | read | taxes.show | GET /v1/taxes/{id} | Fetch one tax. |
finance_taxes_create | write | taxes.create | POST /v1/taxes | Create a tax. |
finance_taxes_update | write | taxes.update | PATCH /v1/taxes/{id} | Partially update a tax. |
finance_taxes_delete | destructive | taxes.delete | DELETE /v1/taxes/{id} | Delete a tax. |
automatic_rules
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
finance_automatic_rules_list | read | automatic-rules.list | GET /v1/automatic-rules | List the automatic classification rules. |
finance_automatic_rules_get | read | automatic-rules.show | GET /v1/automatic-rules/{id} | Fetch one automatic rule. |
finance_automatic_rules_create | write | automatic-rules.create | POST /v1/automatic-rules | Create an automatic rule, appended at the end of its (company, scope) group. |
finance_automatic_rules_update | write | automatic-rules.update | PATCH /v1/automatic-rules/{id} | Partially update an automatic rule. |
finance_automatic_rules_delete | destructive | automatic-rules.delete | DELETE /v1/automatic-rules/{id} | Delete an automatic rule. |
finance_automatic_rules_reorder | write | automatic-rules.update | POST /v1/automatic-rules/reorder | Rewrite the precedence of one (company, scope) group: ordered_ids must be the COMPLETE set of that group, first = position 1. |
Los campos de cada recurso están en la Referencia de la API y en finance_schemas_get.
Una tool que no puedes ejecutar no aparece en tools/list. Si falta alguna de esta página, ve Autenticación.