Skip to content

Latest commit

 

History

History
793 lines (750 loc) · 51.4 KB

README.md

File metadata and controls

793 lines (750 loc) · 51.4 KB

Nuvem Fiscal: SDK para .NET

Biblioteca para uso da API da Nuvem Fiscal com Microsoft .NET. Consultar também a documentação oficial da Nuvem Fiscal.

  • Versão da API: 2.40.0
  • Versão do SDK: 2.29.0

Frameworks suportadas

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

Instalação

O SDK da Nuvem Fiscal para .NET está disponível no Nuget. Para adicionar o SDK ao seu projeto, basta instalar o package NuvemFiscal.Sdk utilizando sua ferramenta preferida de gerenciamento de packages do Nuget.

Se preferir instalar a partir do console/terminal:

PM> Install-Package NuvemFiscal.Sdk

Ou a partir do .NET CLI (cross-platform:

dotnet add package NuvemFiscal.Sdk

Utilização

Após adicionar o package NuvemFiscal.Sdk ao seu projeto C#, use os namespaces:

using NuvemFiscal.Sdk.Api;
using NuvemFiscal.Sdk.Client;
using NuvemFiscal.Sdk.Model;

Instanciando a API

Cada ApiClass (mais especificamente o ApiClient dentro dela) irá criar uma instância de HttpClient, e irá usá-la durante todo o ciclo de vida da ApiClass, e fará um dispose quando o método Dispose for chamado.

Para melhor gerenciar as conexões, é uma boa prática reutilizar os objetos HttpClient e HttpClientHandler (visite here para mais informações). Para usar sua própria instância de HttpClient, simplesmente passe-a ao construtor da ApiClass. Também é importante habilitar a descompactação automática para conteúdos gzip, para ser possível receber XML e PDF (DANFE) via SDK:

HttpClientHandler httpClientHandler = new HttpClientHandler();
httpClientHandler.AutomaticDecompression = DecompressionMethods.All;
HttpClient httpClient = new HttpClient(httpClientHandler);
var api = new CepApi(httpClient, httpClientHandler);

Caso queira usar o HttpClient e não tiver acesso ao handler (por exemplo, em um contexto DI no Asp.net Core onde esitver usando o IHttpClientFactory):

HttpClient yourHttpClient = new HttpClient();
var api = new CepApi(yourHttpClient);

Você perderá algumas configurações, por exemplo: Setar e obter Cookies, Client Certificates, Proxy settings. Você precisará gerenciar isso manualmente no setup do seu HttpClient, caso contrário esses recursos não estarão disponíveis.

Segue um exemplo de setup do DI em um projeto web:

services.AddHttpClient<CepApi>(httpClient => new CepApi(httpClient)
  .ConfigurePrimaryHttpMessageHandler(config => new HttpClientHandler
    {
       AutomaticDecompression = DecompressionMethods.All
    });

Uso opcional de proxy

Para usar o client da API com um proxy HTTP, configure um System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Exemplo

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using NuvemFiscal.Sdk.Api;
using NuvemFiscal.Sdk.Client;
using NuvemFiscal.Sdk.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            // cria instâncias de HttpClient, HttpClientHandler para serem reutilizadas em qualquer Api
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new CepApi(httpClient, config, httpClientHandler);
            var cep = "cep_example";  // string | CEP sem máscara.

            try
            {
                // Consultar endereço através do CEP
                CepEndereco result = apiInstance.ConsultarCep(cep);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Erro ao chamar CepApi.ConsultarCep: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentação dos endpoints

Todas as URIs são relativas a https://api.nuvemfiscal.com.br

Classe Método Endpoint Descrição
CepApi ConsultarCep GET /cep/{Cep} Consultar endereço através do CEP
CnpjApi ConsultarCnpj GET /cnpj/{Cnpj} Consultar dados do CNPJ
CnpjApi ListarCnpj GET /cnpj Listar estabelecimentos ativos a partir da base de CNPJ
ContaApi ConsultarCotaConta GET /conta/cotas/{nome} Consultar o limite de uso e o consumo de uma cota específica.
ContaApi ListarCotasConta GET /conta/cotas Consultar os limites de uso e consumo de todas as cotas existentes.
CteApi BaixarPdfCancelamentoCte GET /cte/{id}/cancelamento/pdf Baixar PDF do cancelamento
CteApi BaixarPdfCartaCorrecaoCte GET /cte/{id}/carta-correcao/pdf Baixar PDF da carta de correção
CteApi BaixarPdfCte GET /cte/{id}/pdf Baixar PDF do DACTE
CteApi BaixarPdfEventoCte GET /cte/eventos/{id}/pdf Baixar PDF do evento
CteApi BaixarXmlCancelamentoCte GET /cte/{id}/cancelamento/xml Baixar XML do cancelamento
CteApi BaixarXmlCartaCorrecaoCte GET /cte/{id}/carta-correcao/xml Baixar XML da carta de correção
CteApi BaixarXmlCte GET /cte/{id}/xml Baixar XML do CT-e processado
CteApi BaixarXmlCteConhecimento GET /cte/{id}/xml/conhecimento Baixar XML do CT-e
CteApi BaixarXmlCteProtocolo GET /cte/{id}/xml/protocolo Baixar XML do Protocolo da SEFAZ
CteApi BaixarXmlEventoCte GET /cte/eventos/{id}/xml Baixar XML do evento
CteApi CancelarCte POST /cte/{id}/cancelamento Cancelar um CT-e autorizado
CteApi ConsultarCancelamentoCte GET /cte/{id}/cancelamento Consultar o cancelamento do CT-e
CteApi ConsultarCartaCorrecaoCte GET /cte/{id}/carta-correcao Consultar a solicitação de correção do CT-e
CteApi ConsultarCte GET /cte/{id} Consultar CT-e
CteApi ConsultarEventoCte GET /cte/eventos/{id} Consultar evento
CteApi ConsultarStatusSefazCte GET /cte/sefaz/status Consulta do Status do Serviço na SEFAZ Autorizadora
CteApi CriarCartaCorrecaoCte POST /cte/{id}/carta-correcao Solicitar correção do CT-e
CteApi EmitirCte POST /cte Emitir CT-e
CteApi ListarCte GET /cte Listar CT-e
CteApi SincronizarCte POST /cte/{id}/sincronizar Sincroniza dados no CT-e a partir da SEFAZ
DistribuioNFEApi BaixarXmlDocumentoDistribuicaoNfe GET /distribuicao/nfe/documentos/{id}/xml Baixar XML do documento
DistribuioNFEApi ConsultarDistribuicaoNfe GET /distribuicao/nfe/{id} Consultar distribuição
DistribuioNFEApi ConsultarDocumentoDistribuicaoNfe GET /distribuicao/nfe/documentos/{id} Consultar documento
DistribuioNFEApi ConsultarManifestacaoNfe GET /distribuicao/nfe/manifestacoes/{id} Consultar manifestação
DistribuioNFEApi GerarDistribuicaoNfe POST /distribuicao/nfe Distribuir documentos
DistribuioNFEApi ListarDistribuicaoNfe GET /distribuicao/nfe Listar distribuições
DistribuioNFEApi ListarDocumentoDistribuicaoNfe GET /distribuicao/nfe/documentos Listar documentos
DistribuioNFEApi ListarManifestacaoNfe GET /distribuicao/nfe/manifestacoes Listar Manifestações
DistribuioNFEApi ManifestarNfe POST /distribuicao/nfe/manifestacoes Manifestar nota
EmpresaApi AlterarConfigCte PUT /empresas/{cpf_cnpj}/cte Alterar configuração de CT-e
EmpresaApi AlterarConfigDistribuicaoNfe PUT /empresas/{cpf_cnpj}/distnfe Alterar configuração de Distribuição de NF-e
EmpresaApi AlterarConfigMdfe PUT /empresas/{cpf_cnpj}/mdfe Alterar configuração de MDF-e
EmpresaApi AlterarConfigNfce PUT /empresas/{cpf_cnpj}/nfce Alterar configuração de NFC-e
EmpresaApi AlterarConfigNfcom PUT /empresas/{cpf_cnpj}/nfcom Alterar configuração de NFCom
EmpresaApi AlterarConfigNfe PUT /empresas/{cpf_cnpj}/nfe Alterar configuração de NF-e
EmpresaApi AlterarConfigNfse PUT /empresas/{cpf_cnpj}/nfse Alterar configuração de NFS-e
EmpresaApi AtualizarEmpresa PUT /empresas/{cpf_cnpj} Alterar empresa
EmpresaApi BaixarLogotipoEmpresa GET /empresas/{cpf_cnpj}/logotipo Baixar logotipo
EmpresaApi CadastrarCertificadoEmpresa PUT /empresas/{cpf_cnpj}/certificado Cadastrar certificado
EmpresaApi ConsultarCertificadoEmpresa GET /empresas/{cpf_cnpj}/certificado Consultar certificado
EmpresaApi ConsultarConfigCte GET /empresas/{cpf_cnpj}/cte Consultar configuração de CT-e
EmpresaApi ConsultarConfigDistribuicaoNfe GET /empresas/{cpf_cnpj}/distnfe Consultar configuração de Distribuição de NF-e
EmpresaApi ConsultarConfigMdfe GET /empresas/{cpf_cnpj}/mdfe Consultar configuração de MDF-e
EmpresaApi ConsultarConfigNfce GET /empresas/{cpf_cnpj}/nfce Consultar configuração de NFC-e
EmpresaApi ConsultarConfigNfcom GET /empresas/{cpf_cnpj}/nfcom Consultar configuração de NFCom
EmpresaApi ConsultarConfigNfe GET /empresas/{cpf_cnpj}/nfe Consultar configuração de NF-e
EmpresaApi ConsultarConfigNfse GET /empresas/{cpf_cnpj}/nfse Consultar configuração de NFS-e
EmpresaApi ConsultarEmpresa GET /empresas/{cpf_cnpj} Consultar empresa
EmpresaApi CriarEmpresa POST /empresas Cadastrar empresa
EmpresaApi EnviarCertificadoEmpresa PUT /empresas/{cpf_cnpj}/certificado/upload Upload de certificado
EmpresaApi EnviarLogotipoEmpresa PUT /empresas/{cpf_cnpj}/logotipo Enviar logotipo
EmpresaApi ExcluirCertificadoEmpresa DELETE /empresas/{cpf_cnpj}/certificado Deletar certificado
EmpresaApi ExcluirEmpresa DELETE /empresas/{cpf_cnpj} Deletar empresa
EmpresaApi ExcluirLogotipoEmpresa DELETE /empresas/{cpf_cnpj}/logotipo Deletar logotipo
EmpresaApi ListarEmpresas GET /empresas Listar empresas
MdfeApi BaixarPdfCancelamentoMdfe GET /mdfe/{id}/cancelamento/pdf Baixar PDF do cancelamento
MdfeApi BaixarPdfEncerramentoMdfe GET /mdfe/{id}/encerramento/pdf Baixar PDF do encerramento
MdfeApi BaixarPdfEventoMdfe GET /mdfe/eventos/{id}/pdf Baixar PDF do evento
MdfeApi BaixarPdfMdfe GET /mdfe/{id}/pdf Baixar PDF do DAMDFE
MdfeApi BaixarXmlCancelamentoMdfe GET /mdfe/{id}/cancelamento/xml Baixar XML do cancelamento
MdfeApi BaixarXmlEncerramentoMdfe GET /mdfe/{id}/encerramento/xml Baixar XML do encerramento
MdfeApi BaixarXmlEventoMdfe GET /mdfe/eventos/{id}/xml Baixar XML do evento
MdfeApi BaixarXmlMdfe GET /mdfe/{id}/xml Baixar XML do MDF-e processado
MdfeApi BaixarXmlMdfeManifesto GET /mdfe/{id}/xml/manifesto Baixar XML do MDF-e
MdfeApi BaixarXmlMdfeProtocolo GET /mdfe/{id}/xml/protocolo Baixar XML do Protocolo da SEFAZ
MdfeApi CancelarMdfe POST /mdfe/{id}/cancelamento Cancelar um MDF-e autorizado
MdfeApi ConsultarCancelamentoMdfe GET /mdfe/{id}/cancelamento Consultar o cancelamento do MDF-e
MdfeApi ConsultarEncerramentoMdfe GET /mdfe/{id}/encerramento Consultar encerramento do MDF-e
MdfeApi ConsultarEventoMdfe GET /mdfe/eventos/{id} Consultar evento do MDF-e
MdfeApi ConsultarLoteMdfe GET /mdfe/lotes/{id} Consultar lote de MDF-e
MdfeApi ConsultarMdfe GET /mdfe/{id} Consultar manifesto
MdfeApi ConsultarMdfeNaoEncerrados GET /mdfe/nao-encerrados Consulta MDF-e não encerrados
MdfeApi ConsultarStatusSefazMdfe GET /mdfe/sefaz/status Consulta do Status do Serviço na SEFAZ Autorizadora
MdfeApi EmitirLoteMdfe POST /mdfe/lotes Emitir lote de MDF-e
MdfeApi EmitirMdfe POST /mdfe Emitir MDF-e
MdfeApi EncerrarMdfe POST /mdfe/{id}/encerramento Encerrar um MDF-e autorizado
MdfeApi IncluirCondutorMdfe POST /mdfe/{id}/inclusao-condutor Incluir um condutor em um MDF-e autorizado
MdfeApi IncluirDfeMdfe POST /mdfe/{id}/inclusao-dfe Incluir um DF-e em um MDF-e autorizado
MdfeApi ListarLotesMdfe GET /mdfe/lotes Listar lotes de MDF-e
MdfeApi ListarMdfe GET /mdfe Listar MDF-e
MdfeApi SincronizarMdfe POST /mdfe/{id}/sincronizar Sincroniza dados no MDF-e a partir da SEFAZ
NfceApi BaixarEscPosNfce GET /nfce/{id}/escpos Comandos ESC/POS para impressão do DANFCE
NfceApi BaixarPdfCancelamentoNfce GET /nfce/{id}/cancelamento/pdf Baixar PDF do cancelamento
NfceApi BaixarPdfEventoNfce GET /nfce/eventos/{id}/pdf Baixar PDF do evento
NfceApi BaixarPdfInutilizacaoNfce GET /nfce/inutilizacoes/{id}/pdf Baixar PDF da inutilização
NfceApi BaixarPdfNfce GET /nfce/{id}/pdf Baixar PDF do DANFCE
NfceApi BaixarPreviaPdfNfce POST /nfce/previa/pdf Prévia do PDF do DANFCE
NfceApi BaixarPreviaXmlNfce POST /nfce/previa/xml Prévia do XML da NFC-e
NfceApi BaixarXmlCancelamentoNfce GET /nfce/{id}/cancelamento/xml Baixar XML do cancelamento
NfceApi BaixarXmlEventoNfce GET /nfce/eventos/{id}/xml Baixar XML do evento
NfceApi BaixarXmlInutilizacaoNfce GET /nfce/inutilizacoes/{id}/xml Baixar XML da inutilização
NfceApi BaixarXmlNfce GET /nfce/{id}/xml Baixar XML da NFC-e processada
NfceApi BaixarXmlNfceNota GET /nfce/{id}/xml/nota Baixar XML da NFC-e
NfceApi BaixarXmlNfceProtocolo GET /nfce/{id}/xml/protocolo Baixar XML do Protocolo da SEFAZ
NfceApi CancelarNfce POST /nfce/{id}/cancelamento Cancelar uma NFC-e autorizada
NfceApi ConsultarCancelamentoNfce GET /nfce/{id}/cancelamento Consultar o cancelamento da NFC-e
NfceApi ConsultarEventoNfce GET /nfce/eventos/{id} Consultar evento
NfceApi ConsultarInutilizacaoNfce GET /nfce/inutilizacoes/{id} Consultar a inutilização de sequência de numeração
NfceApi ConsultarLoteNfce GET /nfce/lotes/{id} Consultar lote de NFC-e
NfceApi ConsultarNfce GET /nfce/{id} Consultar NFC-e
NfceApi ConsultarStatusSefazNfce GET /nfce/sefaz/status Consulta do Status do Serviço na SEFAZ Autorizadora
NfceApi EmitirLoteNfce POST /nfce/lotes Emitir lote de NFC-e
NfceApi EmitirNfce POST /nfce Emitir NFC-e
NfceApi InutilizarNumeracaoNfce POST /nfce/inutilizacoes Inutilizar uma sequência de numeração de NFC-e
NfceApi ListarEventosNfce GET /nfce/eventos Listar eventos
NfceApi ListarLotesNfce GET /nfce/lotes Listar lotes de NFC-e
NfceApi ListarNfce GET /nfce Listar NFC-e
NfceApi SincronizarNfce POST /nfce/{id}/sincronizar Sincroniza dados na NFC-e a partir da SEFAZ
NfcomApi BaixarXmlCancelamentoNfcom GET /nfcom/{id}/cancelamento/xml Baixar XML do cancelamento
NfcomApi BaixarXmlNfcom GET /nfcom/{id}/xml Baixar XML da NFCom processada
NfcomApi BaixarXmlNfcomNota GET /nfcom/{id}/xml/nota Baixar XML da NFCom
NfcomApi BaixarXmlNfcomProtocolo GET /nfcom/{id}/xml/protocolo Baixar XML do Protocolo da SEFAZ
NfcomApi CancelarNfcom POST /nfcom/{id}/cancelamento Cancelar uma NFCom autorizada
NfcomApi ConsultarCancelamentoNfcom GET /nfcom/{id}/cancelamento Consultar o cancelamento da NFCom
NfcomApi ConsultarNfcom GET /nfcom/{id} Consultar NFCom
NfcomApi ConsultarStatusSefazNfcom GET /nfcom/sefaz/status Consulta do Status do Serviço na SEFAZ Autorizadora
NfcomApi EmitirNfcom POST /nfcom Emitir NFCom
NfcomApi ListarNfcom GET /nfcom Listar NFCom
NfeApi BaixarPdfCancelamentoNfe GET /nfe/{id}/cancelamento/pdf Baixar PDF do cancelamento
NfeApi BaixarPdfCartaCorrecaoNfe GET /nfe/{id}/carta-correcao/pdf Baixar PDF da carta de correção
NfeApi BaixarPdfEventoNfe GET /nfe/eventos/{id}/pdf Baixar PDF do evento
NfeApi BaixarPdfInutilizacaoNfe GET /nfe/inutilizacoes/{id}/pdf Baixar PDF da inutilização
NfeApi BaixarPdfNfe GET /nfe/{id}/pdf Baixar PDF do DANFE
NfeApi BaixarPreviaPdfNfe POST /nfe/previa/pdf Prévia do PDF do DANFE
NfeApi BaixarPreviaXmlNfe POST /nfe/previa/xml Prévia do XML da NF-e
NfeApi BaixarXmlCancelamentoNfe GET /nfe/{id}/cancelamento/xml Baixar XML do cancelamento
NfeApi BaixarXmlCartaCorrecaoNfe GET /nfe/{id}/carta-correcao/xml Baixar XML da carta de correção
NfeApi BaixarXmlEventoNfe GET /nfe/eventos/{id}/xml Baixar XML do evento
NfeApi BaixarXmlInutilizacaoNfe GET /nfe/inutilizacoes/{id}/xml Baixar XML da inutilização
NfeApi BaixarXmlNfe GET /nfe/{id}/xml Baixar XML da NF-e processada
NfeApi BaixarXmlNfeNota GET /nfe/{id}/xml/nota Baixar XML da NF-e
NfeApi BaixarXmlNfeProtocolo GET /nfe/{id}/xml/protocolo Baixar XML do Protocolo da SEFAZ
NfeApi CancelarNfe POST /nfe/{id}/cancelamento Cancelar uma NF-e autorizada
NfeApi ConsultarCancelamentoNfe GET /nfe/{id}/cancelamento Consultar o cancelamento da NF-e
NfeApi ConsultarCartaCorrecaoNfe GET /nfe/{id}/carta-correcao Consultar a solicitação de correção da NF-e
NfeApi ConsultarContribuinteNfe GET /nfe/cadastro-contribuinte Consultar contribuinte
NfeApi ConsultarEventoNfe GET /nfe/eventos/{id} Consultar evento
NfeApi ConsultarInutilizacaoNfe GET /nfe/inutilizacoes/{id} Consultar a inutilização de sequência de numeração
NfeApi ConsultarLoteNfe GET /nfe/lotes/{id} Consultar lote de NF-e
NfeApi ConsultarNfe GET /nfe/{id} Consultar NF-e
NfeApi ConsultarStatusSefazNfe GET /nfe/sefaz/status Consulta do Status do Serviço na SEFAZ Autorizadora
NfeApi CriarCartaCorrecaoNfe POST /nfe/{id}/carta-correcao Solicitar correção da NF-e
NfeApi EmitirLoteNfe POST /nfe/lotes Emitir lote de NF-e
NfeApi EmitirNfe POST /nfe Emitir NF-e
NfeApi InutilizarNumeracaoNfe POST /nfe/inutilizacoes Inutilizar uma sequência de numeração de NF-e
NfeApi ListarEventosNfe GET /nfe/eventos Listar eventos
NfeApi ListarLotesNfe GET /nfe/lotes Listar lotes de NF-e
NfeApi ListarNfe GET /nfe Listar NF-e
NfeApi SincronizarNfe POST /nfe/{id}/sincronizar Sincroniza dados na NF-e a partir da SEFAZ
NfseApi BaixarPdfNfse GET /nfse/{id}/pdf Baixar PDF do DANFSE
NfseApi BaixarXmlCancelamentoNfse GET /nfse/{Id}/cancelamento/xml Baixar XML do evento de cancelamento
NfseApi BaixarXmlDps GET /nfse/{id}/xml/dps Baixar XML da DPS
NfseApi BaixarXmlNfse GET /nfse/{id}/xml Baixar XML da NFS-e processada
NfseApi CancelarNfse POST /nfse/{id}/cancelamento Cancelar uma NFS-e autorizada
NfseApi CidadesAtendidas GET /nfse/cidades Cidades atendidas
NfseApi ConsultarCancelamentoNfse GET /nfse/{id}/cancelamento Consultar o cancelamento da NFS-e
NfseApi ConsultarLoteNfse GET /nfse/lotes/{id} Consultar lote de NFS-e
NfseApi ConsultarMetadados GET /nfse/cidades/{codigo_ibge} Consultar metadados
NfseApi ConsultarNfse GET /nfse/{id} Consultar NFS-e
NfseApi EmitirLoteNfse POST /nfse/lotes Emitir lote de NFS-e
NfseApi EmitirLoteNfseDps POST /nfse/dps/lotes Emitir lote de NFS-e
NfseApi EmitirNfse POST /nfse Emitir NFS-e
NfseApi EmitirNfseDps POST /nfse/dps Emitir NFS-e
NfseApi ListarLotesNfse GET /nfse/lotes Listar lotes de NFS-e
NfseApi ListarNfse GET /nfse Listar NFS-e
NfseApi SincronizarNfse POST /nfse/{id}/sincronizar Sincroniza dados na NFS-e a partir da Prefeitura

Documentação dos DTOs

Documentação da autorização

jwt

  • Tipo: Access token
  • Nome do parâmetro do access token: Authorization
  • Localização: HTTP header

oauth2

  • Type: OAuth
  • Flow: application
  • URL de autorização:
  • Scopes:
    • conta:
    • empresa:
    • cep:
    • cnpj:
    • mdfe:
    • cte:
    • nfse:
    • nfe: