Pular para o conteúdo principal

Cadastros

O que classifica os títulos e lançamentos: empresas, pessoas, categorias, centros de classificação, classificadores personalizados, impostos e as regras de classificação automática.

Famílias nesta página​

FamíliaToolsreadwritedestructive
companies — Empresas5221
people — Pessoas6321
categories — Categorias5221
classification_centers — Centros de classificação5221
custom_classifiers — Classificadores personalizados8242
taxes — Impostos5221
automatic_rules — Regras automáticas6231

companies​

ToolTipoPermissãoEndpointO que faz
finance_companies_listreadcompanies.listGET /v1/companiesList the companies (CNPJs) of the workspace.
finance_companies_getreadcompanies.showGET /v1/companies/{id}Fetch one company.
finance_companies_createwritecompanies.createPOST /v1/companiesCreate a company.
finance_companies_updatewritecompanies.updatePATCH /v1/companies/{id}Update a company's name or active.
finance_companies_deletedestructivecompanies.deleteDELETE /v1/companies/{id}Delete a company.

people​

ToolTipoPermissãoEndpointO que faz
finance_people_listreadpeople.listGET /v1/peopleList people — customers, suppliers, team members, bank managers.
finance_people_getreadpeople.showGET /v1/people/{id}Fetch one person.
finance_people_idsreadpeople.listGET /v1/people/idsThe id of every live person, for reconciling a mirror.
finance_people_createwritepeople.createPOST /v1/peopleCreate a person (customer and/or supplier).
finance_people_updatewritepeople.updatePATCH /v1/people/{id}Partially update a person.
finance_people_deletedestructivepeople.deleteDELETE /v1/people/{id}Soft-delete a person.

categories​

ToolTipoPermissãoEndpointO que faz
finance_categories_listreadcategories.listGET /v1/categoriesList categories (plano de contas).
finance_categories_getreadcategories.showGET /v1/categories/{id}Fetch one category.
finance_categories_createwritecategories.createPOST /v1/categoriesCreate a category.
finance_categories_updatewritecategories.updatePATCH /v1/categories/{id}Rename a category or change its type (cascades to descendants).
finance_categories_deletedestructivecategories.deleteDELETE /v1/categories/{id}Delete a leaf category, clearing it from transactions and titles.

classification_centers​

ToolTipoPermissãoEndpointO que faz
finance_classification_centers_listreadcost-centers.listGET /v1/classification-centersList classification centers (centros de custo/receita) used for rateio.
finance_classification_centers_getreadcost-centers.showGET /v1/classification-centers/{id}Fetch one classification center.
finance_classification_centers_createwritecost-centers.createPOST /v1/classification-centersCreate a classification center.
finance_classification_centers_updatewritecost-centers.updatePATCH /v1/classification-centers/{id}Partially update a classification center.
finance_classification_centers_deletedestructivecost-centers.deleteDELETE /v1/classification-centers/{id}Delete a classification center.

custom_classifiers​

ToolTipoPermissãoEndpointO que faz
finance_custom_classifiers_listreadcustom-classifiers.listGET /v1/custom-classifiersList custom classifiers — the workspace's own classification dimensions — with their values.
finance_custom_classifiers_getreadcustom-classifiers.showGET /v1/custom-classifiers/{classifier_id}Fetch one custom classifier with its values.
finance_custom_classifiers_createwritecustom-classifiers.createPOST /v1/custom-classifiersCreate a custom classifier (dimension).
finance_custom_classifiers_updatewritecustom-classifiers.updatePATCH /v1/custom-classifiers/{classifier_id}Partially update a custom classifier.
finance_custom_classifiers_deletedestructivecustom-classifiers.deleteDELETE /v1/custom-classifiers/{classifier_id}Delete a custom classifier.
finance_custom_classifiers_values_createwritecustom-classifiers.updatePOST /v1/custom-classifiers/{classifier_id}/valuesAdd a value to a custom classifier.
finance_custom_classifiers_values_updatewritecustom-classifiers.updatePATCH /v1/custom-classifiers/{classifier_id}/values/{value_id}Partially update a value of a custom classifier.
finance_custom_classifiers_values_deletedestructivecustom-classifiers.updateDELETE /v1/custom-classifiers/{classifier_id}/values/{value_id}Delete a value of a custom classifier.

taxes​

ToolTipoPermissãoEndpointO que faz
finance_taxes_listreadtaxes.listGET /v1/taxesList the workspace's taxes and withholdings (ISS, IRRF, INSS…).
finance_taxes_getreadtaxes.showGET /v1/taxes/{id}Fetch one tax.
finance_taxes_createwritetaxes.createPOST /v1/taxesCreate a tax.
finance_taxes_updatewritetaxes.updatePATCH /v1/taxes/{id}Partially update a tax.
finance_taxes_deletedestructivetaxes.deleteDELETE /v1/taxes/{id}Delete a tax.

automatic_rules​

ToolTipoPermissãoEndpointO que faz
finance_automatic_rules_listreadautomatic-rules.listGET /v1/automatic-rulesList the automatic classification rules.
finance_automatic_rules_getreadautomatic-rules.showGET /v1/automatic-rules/{id}Fetch one automatic rule.
finance_automatic_rules_createwriteautomatic-rules.createPOST /v1/automatic-rulesCreate an automatic rule, appended at the end of its (company, scope) group.
finance_automatic_rules_updatewriteautomatic-rules.updatePATCH /v1/automatic-rules/{id}Partially update an automatic rule.
finance_automatic_rules_deletedestructiveautomatic-rules.deleteDELETE /v1/automatic-rules/{id}Delete an automatic rule.
finance_automatic_rules_reorderwriteautomatic-rules.updatePOST /v1/automatic-rules/reorderRewrite the precedence of one (company, scope) group: ordered_ids must be the COMPLETE set of that group, first = position 1.

Os campos de cada recurso estão na Referência da API e em finance_schemas_get.

Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.