Ativar a captura de NFS-e via API
Para receber automaticamente as NFS-e emitidas contra o CNPJ da sua empresa, cadastre-a no serviço de recepção. Todas as rotas exigem uma API Key com papel Nota Fiscal (api.nfe.io) ou NFSeDist (dfe.nfe.io) — veja Autenticação.
Base URL:
https://api.nfse.io
Cadastrar a empresa
curl -X POST "https://api.nfse.io/v2/companies/inbound/nfse" \
-H "Authorization: SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"companyId": "SEU_COMPANY_ID",
"initialNsu": 0,
"webhookUrl": "https://seu-sistema.com/webhooks/nfse"
}'
initialNsu é obrigatório (use 0 para capturar desde o início disponível). Resposta 201 Created. Se a empresa já estiver cadastrada, a API retorna 409 Conflict.
O campo environment é opcional. Aceita "Production", "Development" ou "Homologation" (case-insensitive). Quando omitido, herda o ambiente da inscrição municipal (TaxPayers); se ausente também ali, assume "Production" por padrão.
Consultar a configuração
curl "https://api.nfse.io/v2/companies/{companyId}/inbound/nfse/details" \
-H "Authorization: SUA_API_KEY"
Retorna a configuração atual: webhookUrl, isActive, currentNsu, environment, isAutomaticManifestationEnabled, etc. O webhookVersion não é exposto na resposta (veja Versionamento de webhook).
Atualizar a configuração
curl -X PUT "https://api.nfse.io/v2/companies/{companyId}/inbound/nfse/details" \
-H "Authorization: SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"webhookUrl": "https://seu-sistema.com/webhooks/nfse",
"isAutomaticManifestationEnabled": true,
"automaticManifestationDelaySeconds": 3600,
"isActive": true
}'
automaticManifestationDelaySecondsaceita de0a604800(7 dias).
Desativar
curl -X DELETE "https://api.nfse.io/v2/companies/{companyId}/inbound/nfse/details" \
-H "Authorization: SUA_API_KEY"
A captura para, mas os documentos já recebidos continuam acessíveis.
Redefinir o cursor (reset-nsu)
Para reprocessar a partir de um NSU específico:
curl -X POST "https://api.nfse.io/v2/companies/{companyId}/inbound/nfse/reset-nsu" \
-H "Authorization: SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "nsu": 0 }'