Referência
Todas as rotas da API pública, geradas do OpenAPI.
Cada rota tem parâmetros, corpo de resposta por status, exemplos em várias linguagens e o botão Testar, que chama a API a partir desta página com o seu access token.
O spec completo está em /openapi.json — importe no Postman, no Insomnia ou
num gerador de cliente.
Autenticação
Troca da credencial por tokens e renovação.
Credencial
Quem é a credencial que está chamando.
Contas
Todas as contas do workspace, inclusive cartões de crédito, investimentos e as contas do balanço. Criar, alterar e excluir; a escrita de cartão de crédito fica em Cartões.
Cartões
Cartões de crédito, com os plásticos, e as faturas, com os números da tela da fatura. Criar, alterar e excluir. Sinal dos valores, mês da fatura e permissões no guia Cartões e faturas.
Categorias
As categorias de receita e despesa e as subcategorias. Criar, alterar e excluir, levando os lançamentos para outra categoria.
Centros de custo
Os centros de custo do workspace. Criar, alterar e excluir.
Tags
Os marcadores livres dos lançamentos. Criar, alterar e excluir.
Formas de pagamento
As formas de pagamento do workspace. Criar, alterar e excluir.
Projetos
Os projetos, com período e metas. Criar, alterar e excluir.
Contatos
Os clientes e fornecedores do workspace. Criar, alterar e excluir.
Relatórios
Os relatórios de lançamentos do app, com os mesmos números da tela: totais por cadastro, resultado, saldos, fluxo de caixa, metas, DRE e DFC. Sinal dos valores, período e permissões no guia Relatórios.
Investimentos
A carteira de investimentos, com os números da tela: posição por ativo e conta e as estratégias de alocação. Somente leitura. Exige a permissão do módulo de investimentos e o módulo no plano do workspace (sem ele, 403 plan_required).