For the complete documentation index, see llms.txt. This page is also available as Markdown.

API de Integração

Permite que um sistema externo, do escritório ou de um parceiro, consulte automaticamente os dados de apuração do Simples Nacional das empresas ativas deste escritório. Não é necessário exportar planilhas manualmente.

Quando utilizar

Utilize esta integração quando o escritório, ou alguém contratado por ele, conectar um sistema próprio, ERP ou ferramenta de terceiros aos dados de apuração do Sittax.

Esta é a primeira etapa da integração. Ela cobre apenas a consulta de apuração. O Relatório de Conferência em Excel e o cadastro de empresa por integração ainda não fazem parte deste fluxo.

Como gerar a chave

1

Acesse a aba de integração

No cadastro do escritório, acesse Dados do Escritório → API de integração.

2

Crie a chave de acesso

Clique em Criar chave de integração. O sistema gera a chave e a exibe uma única vez.

3

Guarde a chave

Copie a chave exibida. Ela não volta a ser mostrada automaticamente depois disso. Use Copiar chave para recuperá-la mais tarde.

4

Repasse para quem fará a integração

Entregue a chave à equipe de TI ou ao fornecedor que consumirá os dados.

O que a chave entrega

Por CNPJ e competência, a API devolve:

  • Receita líquida e faturamento do período.

  • RBT12, receita bruta acumulada dos últimos 12 meses, e Fator R, quando aplicável.

  • Valor do DAS, alíquota efetiva aplicada e economia Sittax do período.

  • Cada imposto do cálculo: ICMS, PIS e COFINS, IRPJ, CPP, CSLL, IPI e ISS.

  • Para ICMS e PIS/COFINS, os valores do Sittax e do XML aparecem lado a lado. Para os demais impostos, a API retorna apenas o valor final.

  • Quando a empresa possui filiais, a resposta separa os resultados da matriz e de cada filial.

  • Se a competência não tiver apuração transmitida, a resposta informa essa condição. Nenhum valor é retornado.

Nenhum outro dado do escritório, de outros clientes ou de outras telas do sistema fica acessível com esta chave.

Gerenciando a chave

  • Copiar chave: exibe novamente a chave completa a qualquer momento.

  • Desativar / Reativar: pausa ou retoma o uso sem invalidar a chave.

  • Revogar chave: encerra o acesso imediatamente e de forma definitiva. Para integrar novamente, gere uma nova chave e atualize-a no sistema do parceiro.

O que esta integração não faz

  • Não substitui o Relatório de Conferência em Excel.

  • Não cadastra empresas nem envia certificados digitais.

  • Não busca várias empresas de uma vez. Cada consulta usa uma empresa e uma competência.

  • Não possui validade automática. A chave permanece válida até ser revogada.

Observações importantes

  • Cada escritório pode ter apenas uma chave ativa por vez.

  • A chave acessa empresas ativas do escritório e dos escritórios vinculados a ele, os filhos.

  • Trocar a chave interrompe a integração até o sistema de destino receber a nova chave.

Suporte sobre integrações de terceiros

Dúvidas sobre a configuração ou o uso dos dados no sistema de destino devem ser tratadas com o fornecedor desse sistema. A Sittax não realiza suporte sobre sistemas de terceiros.

O suporte Sittax garante o funcionamento da chave e a correção dos dados entregues.

Last updated