open-nfse / EmitirParams
Interface: EmitirParams
Defined in: src/nfse/emit.ts:413
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:59 |
dCompet? | readonly | Date | Competê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.dCompet | src/nfse/build-dps.ts:171 |
dhEmi? | readonly | Date | Default new Date(). | BuildDpsParams.dhEmi | src/nfse/build-dps.ts:165 |
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:34 |
emitente | readonly | EmitenteInput | - | BuildDpsParams.emitente | src/nfse/build-dps.ts:152 |
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). 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:423 |
serie | readonly | string | - | BuildDpsParams.serie | src/nfse/build-dps.ts:153 |
servico | readonly | ServicoInput | - | BuildDpsParams.servico | src/nfse/build-dps.ts:174 |
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:48 |
skipCpfCnpjValidation? | readonly | boolean | Pula a validação de dígito verificador de CPF/CNPJ (emitente + tomador). Default false. emitir repassa esta opção para cá, então o escape hatch documentado continua funcionando no caminho seguro. | BuildDpsParams.skipCpfCnpjValidation | src/nfse/build-dps.ts:182 |
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:42 |
tomador? | readonly | TomadorInput | - | BuildDpsParams.tomador | src/nfse/build-dps.ts:176 |
tpAmb? | readonly | TipoAmbienteDps | Default '2' (Homologação). | BuildDpsParams.tpAmb | src/nfse/build-dps.ts:163 |
valores | readonly | ValoresInput | - | BuildDpsParams.valores | src/nfse/build-dps.ts:175 |
verAplic? | readonly | string | Versão do aplicativo emissor. Default open-nfse/<VERSÃO_ATUAL>. | BuildDpsParams.verAplic | src/nfse/build-dps.ts:173 |