open-nfse / EmitirParams
Interface: EmitirParams
Defined in: src/nfse/emit.ts:325
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
Omit<BuildDpsParams,"nDPS">.EmitOptions
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
cepValidator? | readonly | CepValidator | Validador de CEP custom. Se omitido, o validador default (ViaCEP) é usado. Passe um custom para usar outra API, banco local ou mock em tests. | EmitOptions.cepValidator | src/nfse/emit.ts:58 |
dCompet? | readonly | Date | Default new Date() truncada em UTC. | BuildDpsParams.dCompet | src/nfse/build-dps.ts:110 |
dhEmi? | readonly | Date | Default new Date(). | BuildDpsParams.dhEmi | src/nfse/build-dps.ts:108 |
dryRun? | readonly | boolean | Quando 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.dryRun | src/nfse/emit.ts:33 |
emitente | readonly | EmitenteInput | - | BuildDpsParams.emitente | src/nfse/build-dps.ts:102 |
nDPS? | readonly | string | Override 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). | - | src/nfse/emit.ts:331 |
serie | readonly | string | - | BuildDpsParams.serie | src/nfse/build-dps.ts:103 |
servico | readonly | ServicoInput | - | BuildDpsParams.servico | src/nfse/build-dps.ts:113 |
skipCepValidation? | readonly | boolean | Pula 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.skipCepValidation | src/nfse/emit.ts:47 |
skipCpfCnpjValidation? | readonly | boolean | Pula 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.skipCpfCnpjValidation | src/nfse/emit.ts:53 |
skipValidation? | readonly | boolean | Pula 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.skipValidation | src/nfse/emit.ts:41 |
tomador? | readonly | TomadorInput | - | BuildDpsParams.tomador | src/nfse/build-dps.ts:115 |
tpAmb? | readonly | TipoAmbienteDps | Default '2' (Homologação). | BuildDpsParams.tpAmb | src/nfse/build-dps.ts:106 |
valores | readonly | ValoresInput | - | BuildDpsParams.valores | src/nfse/build-dps.ts:114 |
verAplic? | readonly | string | Versão do aplicativo emissor. Default open-nfse/<VERSÃO_ATUAL>. | BuildDpsParams.verAplic | src/nfse/build-dps.ts:112 |