Documentação / Debug v1
API REST fiscal

Documentação forte também explica como investigar falhas, rejeições e comportamento técnico do motor fiscal.

Esta documentação descreve a versão pública atual da API fiscal da Contora, com base compartilhada de empresas, certificados, chaves, filas, webhooks e artefatos para NF-e, NFC-e, NFS-e, CT-e e MDF-e. NF-e, NFC-e e NFS-e operam em produção regular; CT-e e MDF-e em produção assistida e controlada.

Atualizado em .

Quando usar o fluxo de debug

  • Rejeições fiscais difíceis de reproduzir.
  • Divergência entre payload enviado, XML gerado e retorno do autorizador.
  • Falhas intermitentes de comunicação com SEFAZ ou prefeitura.
  • Necessidade de evidência para suporte técnico e conciliação operacional.

Roteiro sugerido

  1. Identificar o documento fiscal pelo draft_id ou chave de acesso.
  2. Consultar o status consolidado do documento.
  3. Ler tentativas e eventos técnicos registrados.
  4. Comparar o payload enviado com o XML assinado e o XML autorizado.
  5. Usar a tradução de rejeições como primeira camada de diagnóstico.
Importante: a camada de debug deve ajudar o suporte e o integrador sem expor segredos, senha de certificado ou material sensível em respostas públicas.

Consultas para reproduzir uma emissão

# Documento e payload original persistido
curl --request GET \
  --url https://fiscal.contora.com.br/api/v1/nfe/drafts/DOCUMENT_ID \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'X-Company-Document: CNPJ_SEM_MASCARA'

# Tentativas do worker
curl --request GET \
  --url https://fiscal.contora.com.br/api/v1/nfe/drafts/DOCUMENT_ID/attempts \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'X-Company-Document: CNPJ_SEM_MASCARA'

# Eventos técnicos e fiscais
curl --request GET \
  --url https://fiscal.contora.com.br/api/v1/nfe/drafts/DOCUMENT_ID/events \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'X-Company-Document: CNPJ_SEM_MASCARA'
Payload original
Retornado na consulta detalhada do documento para comparar o que foi recebido com o XML produzido.
XML
xml_unsigned, xml_signed e xml_authorized ficam nos artefatos quando disponíveis.
Retorno fiscal
sefaz_status_code, mensagem, protocolo, tentativas e eventos mostram onde o ciclo terminou.
Comunicação bruta
Envelopes SOAP completos não fazem parte do contrato público atual; o suporte operacional os trata sem expor certificado, token ou dados secretos.

Onde olhar primeiro no produto

Painel de documentos Use a tela de documentos no console para abrir chave, protocolo, tentativas, eventos e webhooks ligados ao documento.
Painel de webhooks Se a emissão concluiu mas o ERP não refletiu, valide deliveries, pings de teste e reenfileiramentos no módulo de webhooks.