Skip to content

open-nfse / EmitirParams

Interface: EmitirParams

Defined in: src/nfse/emit.ts:338

Parâmetros de alto nível para emitSeguro. Equivalente a BuildDpsParams sem o campo nDPS (fornecido pelo DpsCounter), mais os flags de emissão.

Passe nDPS explícito para override manual (útil para dryRun sem queimar um número ou replay determinístico em testes).

Extends

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
cepValidator?readonlyCepValidatorValidador de CEP custom. Se omitido, o validador default (ViaCEP) é usado. Passe um custom para usar outra API, banco local ou mock em tests.EmitOptions.cepValidatorsrc/nfse/emit.ts:59
dCompet?readonlyDateCompetência (mês/ano) da prestação do serviço. Default new Date() (hoje). Para notas com competência retroativa (ex.: serviço prestado no mês anterior) informe explicitamente — o default não deduz nada de dhEmi.BuildDpsParams.dCompetsrc/nfse/build-dps.ts:139
dhEmi?readonlyDateDefault new Date().BuildDpsParams.dhEmisrc/nfse/build-dps.ts:133
dryRun?readonlybooleanQuando true, a pipeline só constrói e assina o XML — sem enviar para a Receita. Útil para previews, testes locais e inspeção offline.EmitOptions.dryRunsrc/nfse/emit.ts:34
emitentereadonlyEmitenteInput-BuildDpsParams.emitentesrc/nfse/build-dps.ts:120
nDPS?readonlystringOverride manual do nDPS. Quando presente, o DpsCounter não é consultado. Obrigatório em dryRun (sem isso o preview consumiria um número do counter à toa). Não preencher com zeros à esquerda — o Id da DPS é composto a partir desta string, então '1' e '00001' produzem Ids distintos para o mesmo número sequencial.-src/nfse/emit.ts:348
seriereadonlystring-BuildDpsParams.seriesrc/nfse/build-dps.ts:121
servicoreadonlyServicoInput-BuildDpsParams.servicosrc/nfse/build-dps.ts:142
skipCepValidation?readonlybooleanPula a validação de CEP (formato + lookup na API externa). Default false. Quando habilitada, cada endereço da DPS (prest/toma/interm/obra/ atvEvento/RTC-dest/fornec) é verificado — a API default é o ViaCEP.EmitOptions.skipCepValidationsrc/nfse/emit.ts:48
skipCpfCnpjValidation?readonlybooleanPula a validação de dígito verificador de CPF/CNPJ. Default false. Apenas identificadores do tipo CNPJ e CPF são validados; NIF e cNaoNIF são ignorados (não têm DV brasileiro).EmitOptions.skipCpfCnpjValidationsrc/nfse/emit.ts:54
skipValidation?readonlybooleanPula a validação XSD local (RTC v1.01) antes de assinar. Default false. A validação roda antes da assinatura: se o XML estiver malformado, o erro aparece localmente com linha + descrição ao invés de virar rejeição da Receita depois de um round-trip. Só desligue para debugging ou quando estiver intencionalmente gerando XML fora do padrão.EmitOptions.skipValidationsrc/nfse/emit.ts:42
tomador?readonlyTomadorInput-BuildDpsParams.tomadorsrc/nfse/build-dps.ts:144
tpAmb?readonlyTipoAmbienteDpsDefault '2' (Homologação).BuildDpsParams.tpAmbsrc/nfse/build-dps.ts:131
valoresreadonlyValoresInput-BuildDpsParams.valoressrc/nfse/build-dps.ts:143
verAplic?readonlystringVersão do aplicativo emissor. Default open-nfse/<VERSÃO_ATUAL>.BuildDpsParams.verAplicsrc/nfse/build-dps.ts:141

Licença MIT — biblioteca não oficial, sem vínculo com a Receita Federal.