API Reference nfse v#0.1.0

Cliente Elixir para a NFS-e Nacional.

Distribuição de documentos pelo ADN (Ambiente de Dados Nacional). As funções são expostas por Nfse.

Certificado A1 (um .pfx PKCS#12) aberto nas peças em DER que :ssl e :public_key pedem, mais o que a biblioteca precisa saber dele: CNPJ ou CPF, validade e clientAuth.

Cliente HTTP da NFS-e Nacional, autenticado por mTLS com o certificado A1 do emitente.

Uso interno da biblioteca: não faz parte da API pública.

A DPS (Declaração de Prestação de Serviço) que vira NFS-e, montada a partir dos campos que quem emite preenche.

Documento fiscal entregue pela distribuição do ADN.

Um lote da distribuição do ADN, devolvido por Nfse.distribution/3.

NFS-e consultada na Sefin por Nfse.fetch/2.

Erro devolvido por toda função pública da biblioteca.

Evento registrado pela Sefin em resposta a Nfse.register_event/2 e Nfse.cancel/3, ou consultado por Nfse.fetch_event/4.

Uso interno da biblioteca: não faz parte da API pública.

NFS-e emitida pela Sefin em resposta a Nfse.issue/2 ou a Nfse.issue_by_court_order/2.

A NFS-e inteira da emissão por decisão administrativa ou judicial, montada por quem emite.

Parâmetros municipais do ADN: como o município configurou o sistema nacional (convênio, alíquotas por serviço, regimes especiais, retenções e benefícios). As funções são expostas por Nfse.

O pedido de registro de um evento da NFS-e, montado a partir dos campos que quem o pede preenche.

Uso interno da biblioteca: não faz parte da API pública.

Uso interno da biblioteca: não faz parte da API pública.

Os leiautes da NFS-e Nacional que a biblioteca conhece.

Um elemento ou atributo de um tipo complexo do XSD, como o descritor de cada módulo de schema o declara em __schema__(:fields) e __schema__(:attributes).

Uso interno da biblioteca: não faz parte da API pública.

Uso interno da biblioteca: não faz parte da API pública.

Tipos simples do leiaute 1.00: as facetas de cada um, com as da base quando o tipo deriva de outro, e a representação em Elixir. TSDec<i>V<f> vira Decimal, TSData e o xs:date usado direto num elemento viram Date, TSDateTimeUTC vira DateTime e o resto fica texto.

Tipo TCAtvEvento do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCBeneficioMunicipal do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCCServ do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCComExterior do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCDPS do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCDocDedRed do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCDocNFNFS do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCDocOutNFSe do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEmitente do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEnderContribuinteCNC do leiaute 1.00, em tiposCnc_v1.00.xsd.

Tipo TCEnderExt do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEnderExtSimples do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEnderNac do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEnderObraEvento do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEndereco do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEnderecoEmitente do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEnderecoSimples do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCEvento do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TCExigSuspensa do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCExploracaoRodoviaria do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCInfCNC do leiaute 1.00, em tiposCnc_v1.00.xsd.

Tipo TCInfDPS do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCInfEvento do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TCInfNFSe do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCInfPedReg do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TCInfoCompl do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Informações para cadastramento de novos contribuintes CNC

Tipo TCInfoDedRed do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCInfoEventoAnulacaoRejeicao do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TCInfoEventoRejeicao do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TCInfoObra do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Informações das pessoas envolvidas na NFS-e. Pode ser o tomador, o intermediário ou o fornecedor (dedução/redução)

Informações do prestador da NFS-e. Difere das demais pessoas por causa das informações de regimes de tributação

Tipo TCInfoTributacao do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCInfoValores do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCListaDocDedRed do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCListaEventos do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TCLocPrest do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCLocacaoSublocacao do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCNC do leiaute 1.00, em tiposCnc_v1.00.xsd.

Tipo TCNFSe do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCPedRegEvt do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TCRegTrib do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCServ do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCSubstituicao do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCTribFederal do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCTribMunicipal do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCTribOutrosPisCofins do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCTribTotal do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCTribTotalMonet do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCTribTotalPercent do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCVDescCondIncond do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCVServPrest do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TCValoresNFSe do leiaute 1.00, em tiposComplexos_v1.00.xsd.

Tipo TE101101 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE101103 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE105102 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE105104 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE105105 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE202201 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE202205 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE203202 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE203206 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE204203 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE204207 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE205204 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE205208 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE305101 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE305102 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipo TE305103 do leiaute 1.00, em tiposEventos_v1.00.xsd.

Tipos simples do leiaute 1.01: as facetas de cada um, com as da base quando o tipo deriva de outro, e a representação em Elixir. TSDec<i>V<f> vira Decimal, TSData e o xs:date usado direto num elemento viram Date, TSDateTimeUTC vira DateTime e o resto fica texto.

Tipo TCAtvEvento do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCBeneficioMunicipal do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCCServ do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCComExterior do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCDPS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCDocDedRed do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCDocNFNFS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCDocOutNFSe do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEmitente do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEnderContribuinteCNC do leiaute 1.01, em tiposCnc_v1.00.xsd.

Tipo TCEnderExt do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEnderExtSimples do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEnderNac do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEnderObraEvento do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEndereco do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEnderecoEmitente do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEnderecoSimples do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCEvento do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TCExigSuspensa do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCInfCNC do leiaute 1.01, em tiposCnc_v1.00.xsd.

Tipo TCInfCNCContribuintesCnc do leiaute 1.01, em tiposCnc_v1.00.xsd.

Tipo TCInfDPS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCInfEvento do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TCInfNFSe do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCInfPedReg do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TCInfoCompl do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Informações para cadastramento de novos contribuintes CNC

Tipo TCInfoDedRed do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCInfoItemPed do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCInfoObra do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Informações das pessoas envolvidas na NFS-e. Pode ser o tomador, o intermediário ou o fornecedor (dedução/redução)

Informações do prestador da NFS-e. Difere das demais pessoas por causa das informações de regimes de tributação

Tipo TCInfoRefNFSe do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCInfoTributacao do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCInfoValores do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCListaDocDedRed do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCLocPrest do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCNC do leiaute 1.01, em tiposCnc_v1.00.xsd.

Tipo TCNFSe do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCPedRegEvt do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TCRTCIBSCBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoDest do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoIBSCBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoImovel do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoReeRepRes do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoTributosDif do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoTributosIBSCBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoTributosSitClas do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoTributosTribRegular do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCInfoValoresIBSCBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCListaDoc do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCListaDocDFe do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCListaDocFiscalOutro do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCListaDocFornec do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCListaDocOutro do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalCBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalCBSCredPres do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalCIBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalIBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalIBSCredPres do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalIBSMun do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalIBSUF do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalTribCompraGov do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCTotalTribRegular do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCValoresIBSCBS do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCValoresIBSCBSFed do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCValoresIBSCBSMun do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRTCValoresIBSCBSUF do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCRegTrib do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCServ do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCSubstituicao do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCTribFederal do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCTribMunicipal do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCTribOutrosPisCofins do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCTribTotal do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCTribTotalMonet do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCTribTotalPercent do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCVDescCondIncond do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCVServPrest do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TCValoresNFSe do leiaute 1.01, em tiposComplexos_v1.01.xsd.

Tipo TE101101 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE101103 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE105102 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE105104 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE105105 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE202201 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE202205 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE203202 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE203206 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE204203 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE204207 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE205204 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE205208 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE305101 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE305102 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Tipo TE305103 do leiaute 1.01, em tiposEventos_v1.01.xsd.

Uso interno da biblioteca: não faz parte da API pública.

Emissão e consultas na Sefin Nacional. As funções são expostas por Nfse.

Uso interno da biblioteca: não faz parte da API pública.