Developers / Referências
Referências

Schemas

Esta página (o Developer Portal) é a documentação narrativa -- pra um schema OpenAPI/JSON completo dos endpoints, máquina-a-máquina, use o visualizador abaixo.

Desde agora existe uma URL pública, sem login: GET https://areacliente.centralfiscal.com.br/v1/openapi.json -- o mesmo spec que já existia dentro da Área do Cliente (nunca foi personalizado por conta, então não havia nada "privado" nele). O Swagger logado continua existindo em /clientes/{account_id}/documentacao/api/swagger, mas não é mais o único jeito de ver o schema.

Visualizador (Scalar)

Prévia ao vivo, renderizada a partir do JSON real acima -- não é uma captura de tela.

⚠️
Pré-visualização local: o JSON acima é uma cópia estática gerada nesta sessão (a mesma função que gera o spec real, só que sem precisar do banco rodando aqui). Antes de subir pra produção, trocar a URL do Scalar pra https://areacliente.centralfiscal.com.br/v1/openapi.json (já com CORS liberado) em vez do arquivo estático local.

O que o schema cobre bem

  • Schemas completos de request/response de NF-e, CT-e, CT-e OS, MDF-e e NFS-e.
  • Enums reais em campos como modelo ("55"/"57"/"58"/"65") e regime_tributario.
  • O objeto PessoaFiscal compartilhado entre emitente/destinatário/tomador.
  • As 8 rotas novas de DF-e Distribuição/Consulta.

O que o schema ainda não cobre

⚠️
GET /v1/nfe/emissoes/{id}, GET /v1/cte/emissoes/{id} e GET /v1/mdfe/emissoes/{id} (consulta de uma transmissão já feita) existem e funcionam, mas ainda não estão listados no schema -- só a documentação narrativa de cada endpoint (NF-e, CT-e, MDF-e) cobre isso por enquanto.

Este portal é a fonte narrativa

Pra fluxo, pré-requisitos, exemplos em múltiplas linguagens e comportamento real (o que é síncrono, o que gera qual erro), use as páginas de Documentos Fiscais -- o schema é o complemento máquina-a-máquina, não o ponto de partida.