Contabeleza API
Guias Gerais
Explicações simples sobre como usar a API da Contabeleza — sem código, sem termos técnicos complicados. Ideal para quem está começando ou precisa entender o básico antes de conversar com a equipe de desenvolvimento.
01
Conceitos base
O que você precisa entender antes de usar a plataforma: login, ambientes, e os conceitos fundamentais.
Como fazer login
O que é um token, como você recebe um, e como usa-lo para acessar a API.
Conceitos da plataforma
Os principais objetos e relações: profissionais, entidades fiscais, MEI, notas, e como tudo se conecta.
Ambientes de teste e produção
A diferença entre produção, staging e QA, e quando usar cada um.
02
configuração
O que precisa ser configurado antes de usar a plataforma: credenciais, certificados, e os preparativos para emitir notas fiscais.
Como funciona? — Configurando a emissão
Antes de emitir: guardar as credenciais (portal do governo, provedor de notas), certificado digital, e ativar tudo com uma chamada.
Configuração de credenciais
Guarde, atualize e remova senhas, tokens e certificados das entidades fiscais. Veja o ciclo de vida completo de cada credencial.
03
operação do dia a dia
Os fluxos do dia a dia: como emitir notas fiscais, o DAS mensal do MEI, e como funciona o diagnostico fiscal.
Emitindo notas fiscais
O fluxo de emissão: como o sistema dispara para a prefeitura, como acompanhar o status, e como cancelar quando preciso.
emissão do DAS-MEI
O boleto mensal do MEI: como a plataforma busca, gera e gerencia os DAS automaticamente direto do governo.
Como funciona o Diagnostico MEI
A avaliação completa da saúde fiscal do MEI: 6 áreas verificadas, como funciona o fluxo de consulta, e o que cada status significa.
Faturamento por profissional
Quanto cada profissional já faturou no ano, e quanto falta para o limite (MEI: R$ 81 mil; demais entidades: configurável). Acompanhado por CNPJ direto do portal de notas, com cache inteligente que só busca o mês anterior depois que ele fecha.
04
Fluxos de negocio
Os fluxos assincronos que combinam varias etapas: contratos, encerramento, e emissão de notas em lote.
Solicitacoes de negocio
O mecanismo assíncrono: 4 tipos de solicitação (criar contrato, registrar PDF, emitir notas em lote, encerrar contrato) e como acompanhar o status.
Gestão de contratos
Como criar, acompanhar e encerrar contratos profissionais. Os status possíveis e como usar as solicitações de negócio.