open-nfse / SubstituirParams
Interface: SubstituirParams
Defined in: src/eventos/cancelar.ts:127
Parâmetros da substituição. A substituição é dirigida 100% pela DPS: não há autor/tpAmb/verAplic/dhEvento porque o contribuinte não registra um evento — apenas emite a nova DPS. As opções de emissão (skip*Validation, cepValidator) são repassadas ao emit; retryStore/isTransient controlam a resiliência a falhas transientes (idêntico a emitir).
Extends
Omit<EmitOptions,"dryRun">
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 |
chaveOriginal | readonly | string | Chave da NFS-e a ser substituída (a antiga). | - | src/eventos/cancelar.ts:129 |
cMotivo | readonly | JustificativaSubstituicao | - | - | src/eventos/cancelar.ts:135 |
isTransient? | readonly | (err: unknown) => boolean | Classificador custom de transiência. Default: defaultIsTransient. | - | src/eventos/cancelar.ts:144 |
novaDps | readonly | DPS | Nova DPS (substituta). Se infDPS.subst não estiver preenchido, é auto-completado com chaveOriginal + cMotivo/xMotivo. | - | src/eventos/cancelar.ts:134 |
retryStore? | readonly | RetryStore | Store para persistir a emissão pendente se o POST /nfse falhar transitoriamente. Se omitido e o caminho transiente for acionado, lança MissingRetryStoreError para forçar decisão consciente. | - | src/eventos/cancelar.ts:142 |
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. 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:54 |
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 |
xMotivo? | readonly | string | - | - | src/eventos/cancelar.ts:136 |