Introdução à API Finvy

A API REST do Finvy permite a integração programática com sua plataforma de gestão financeira e contábil. Esta documentação fornece uma visão geral dos módulos da API e seus endpoints, facilitando a automação e a extensão das funcionalidades do Finvy.

Módulos da API

A API do Finvy é organizada em módulos, cada um cobrindo uma área específica da aplicação:

API de Administração

Gerencia operações de sistema e manutenção.

• Visão Geral da API de Administração

API de Inteligência Artificial (IA)

Oferece recursos de IA para automação e insights contábeis.

• Chatbot Contábil
• Processador de Documentos
• Resolvedor de Exercícios
• Validador de Lançamentos

API de Assistente

Funcionalidades relacionadas ao assistente inteligente do Finvy.

• Gerar Mensagem

API de Colaboração

Gerencia funcionalidades de compartilhamento, notificações e presença de usuários.

• Notificações
• Compartilhamento
• Presença de Usuário
• Busca de Usuários

API Core

Contém os endpoints fundamentais para a gestão contábil.

• Contas (Plano de Contas)
• Linhas de Lançamento
• Lançamentos Contábeis
• Operações em Lote de Lançamentos Contábeis
• Confirmação de Lançamento Contábil
• Histórico de Lançamentos Contábeis
• Gerador de Referências
• Produtos e Estoque
• Encerramento do Exercício

API de Inventário

Gerencia o cadastro de produtos, movimentações de estoque e exportação de dados.

• Exportação de Produtos
• Movimentações de Estoque

API Financeira

Gerencia transações financeiras, importação de NF-e e relatórios.

• Contas a Pagar e a Receber
• Importação de NF-e
• Relatórios Financeiros
• Cálculo de Impostos Fiscais
• Regras de Impostos

API Pública

Fornece acesso a dados compartilhados publicamente.

• Períodos Contábeis Compartilhados Publicamente

API de Gerenciamento

Gerencia configurações da organização, perfis de usuário e períodos contábeis.

• Períodos Contábeis
• Organizações
• Perfil do Usuário
• Histórico de Regimes Tributários
• Membros e Papéis

API do IBGE

Fornece acesso a dados geográficos do IBGE.

• Visão Geral da API do IBGE

API de Convites

Gerencia o envio e a gestão de convites gerais.

• Visão Geral da API de Convites

Autenticação

Você pode gerar uma chave de API através do dashboard. As chaves de API estão associadas a uma organização inteira e podem ser usadas em várias implantações.

Chave de API Admin

A chave de API de administrador é usada para a maioria das ações da API. As chaves de API de administrador começam com o prefixo sk_... Mantenha suas chaves de API secretas.

Chave de API do Assistente

A chave de API do assistente é usada para gerar respostas do assistente de IA. As chaves de API do assistente começam com o prefixo pk_...