Tipos e enums — NFS-e Inbound
Os valores canônicos vêm da referência gerada da API. O resumo abaixo cobre os mais usados.
Tipo de documento
Enum interno: None, Dps, EventRegistrationRequest, Nfse, Event, Cnc, Unknown. No payload (wire), Nfse serializa como serviceInvoice, Event como serviceInvoiceEvent (v2), e Unknown como unknown.
No filtro de listagem o tipo da NFS-e é Nfse; na resposta o campo aparece como serviceInvoice. Atente a essa assimetria ao montar filtros.
Status do documento
Received, Processed, Failed, PdfPending, PdfFailed, Reprocessed.
Status de webhook
Pending, Delivered, Retrying, DefinitivelyFailed.
Manifestação (tomador)
- Códigos de evento:
203202(Confirmação) e203206(Rejeição). - Status:
Pending→Accepted/Rejected/Failed.
Ambiente
environment (na empresa e no documento): três valores distintos, case-insensitive — Production, Development e Homologation. A normalização retorna o valor canônico exato (não há mapeamento de Homologation para Development). Quando omitido, o padrão é Production. Verificado no código.
Motivo de desativação (deactivationReason)
Preenchido quando a empresa é desativada automaticamente. Conjunto definido no código: CertificateNotFound, CertificateExpired, CertificateRejected, CompanyNotAuthorized. (Observado em produção: CertificateNotFound.)
Campos do documento (detalhe REST)
O GET .../inbound/nfse/{id} retorna metadados — accessKey, nsu, provider/borrower (cada um com federalTaxNumber, name, cityCode), servicesAmount, serviceCode, issueCityCode, accrualOn, generatedOn, status, type, webhookStatus, hasPdf, xmlSizeBytes, failureReason, reprocessCount, webhookAttempts.
O detalhe REST não traz os grupos de tributos (taxes/amounts) — esses só aparecem no payload do webhook (incluindo IBS/CBS). Veja Reforma Tributária (RTC).
Notificações de manutenção
- Severidade:
Info,Warning,Critical. - Tipo: falhas definitivas de documento/lote/webhook e desativação automática de empresa.
Detalhes finos de alguns enums (ex.: estados intermediários de status) estão sendo confirmados — ver issue #210. Em caso de dúvida, a fonte de verdade é a referência gerada.