Sudrel API
Dashboard Create API key

Documentation › Help

Guides

Changelog

What changed in the API and in the documentation, by date.

API v1. Since 02/10/2026 the issuance contract is frozen: only changes that add come in (field, route, event, readiness item, error code). Nothing that exists is renamed, removed or changes HTTP status. A rule that needs to change meaning gets a new id.

03/10/2026

Documentation

  • New task-based organization: "What do you want to do?", integration rules, idempotency, errors and HTTP status, NFS-e statuses, readiness, pagination, recipes, troubleshooting, glossary.
  • Error responses documented route by route, with both formats (problem+json and NestJS), including 401 and 429.
  • Documentation also in Spanish (/docs/es) and English (/docs/en).
  • OpenAPI specification also published in YAML (/docs/openapi.yaml) and an index for AI assistants at /docs/llms.txt.

02/10/2026

Added

  • Batch by API: POST /v1/lotes (JSON or spreadsheet, up to 5,000 items), query, items, report, manual issuance and reprocessing. Webhook LOTE_EMISSAO_CONCLUIDO.
  • Event log GET /v1/eventos, with cursor and 90-day retention.
  • Webhooks by API (/v1/webhooks): X-Sudrel-Signature-V2 signature with timestamp, X-Sudrel-Event-Id and X-Sudrel-Delivery-Id, retry for 72 hours, secret rotation with 24 hours of overlap, resend, custom headers and a test webhook separate from the production one.
  • Failure simulator (X-Sudrel-Simular) with the test key.
  • API request log in the dashboard (Integrações › Log da API (Integrations › API log)), for 30 days.
  • Company readiness (GET /v1/companies/{id}/prontidao), 412 empresa_nao_pronta and webhook EMPRESA_PRONTIDAO_ALTERADA.
  • Webhook NFSE_FALHA_TRANSMISSAO.
  • Official municipality parameters (GET /v1/municipios/{ibge}/parametros).
  • IBS and CBS in the DPS of the regular regime, and GET /v1/servicos/{codigo}/nbs.
  • NFS-e replacement (substituicao block in POST /v1/nfse) and construction site data (servico.obra).

Changed

  • The GET /v1/eventos cursor (proximo_cursor, seq and cursor_mais_antigo) is now an opaque string. The old numeric cursor is still accepted in apos.

01/10/2026

Added

  • Test key sdr_test_: really issues in the "restricted production" (the national system's test environment) of the Sistema Nacional NFS-e, with no fiscal value and no charge.
  • Status aguardando_confirmacao, POST /v1/nfse/{id}/confirmacao and webhook NFSE_AGUARDANDO_CONFIRMACAO.
  • Warning processamento_prolongado and webhook NFSE_PROCESSAMENTO_PROLONGADO.

30/09/2026

Added

  • NFS-e issuance by API: POST /v1/nfse, POST /v1/nfse/validacoes, GET /v1/nfse, GET /v1/nfse/{id}, XML, PDF and cancellation. Errors in problem+json, Idempotency-Key, Prefer: wait=N, ajustes and timeline in eventos. Webhooks NFSE_AUTORIZADA, NFSE_REJEITADA and NFSE_CANCELADA.