Ici vous obtiendrez des informations en français a propos de l'API eNotas Gateway afin de communiquer avec toutes les mairies intégrées.

Le flux principal est:

Créer un compte sur eNotas Gateway
Activer un webhook
Enregistrer votre entreprise via API ou UI
Envoyer une nota fiscal via API
Attendre une réponse sur votre webhook ou consulter la nota fiscal (status/motivoStatus) a partir du nfeId obtenu antérieurement
Si tout s'est bien passé vous pouvez telecharger le PDF/XML de votre nota fiscal ou essayer de l'annuler

Navegação

[GET] Consultar empresas

Definição

Parâmetros

Resultado

Entreprise

L'entreprise concentre toutes les données d'identification, localisation et informations relationées qui non seulement identifies votre entreprise comme aussi, optionellement, le service que vous exercez par défaut.

[POST] Cadastrar

O cadastro de uma empresa pode passar por um processo de homologação caso não tenhamos nenhum cliente ainda operando no município, você poderá avaliar o resultado do cadastro consultando seu status.

Definição

https://api.enotasgw.com.br/v1/empresas

Parâmetros

Parâmetro com comportamento ou preenchimento variável de acordo com a prefeitura, consulte o artigo sobre o município.

Parâmetro de preenchimento obrigatório.

id	string	ID externo do sistema de origem
cnpj	string	CNPJ emissor
inscricaoMunicipal	string
inscricaoEstadual	string	Se isento não precisa informar
razaoSocial	string
nomeFantasia	string
optanteSimplesNacional	bool
email	string
telefoneComercial	string	Formatação será removida
endereco	[]	Consultar próxima tabela
incentivadorCultural	bool
regimeEspecialTributacao	string
aedf	string
configuracoesNFSeProducao	[]	Consultar próxima tabela
configuracoesNFSeHomologacao	[]	Consultar próxima tabela
codigoServicoMunicipal	string	Código municipal que identifica o serviço prestado
descricaoServico	string	Descrição municipal do serviço prestado
itemListaServicoLC116	string
cnae	string
aliquotaIss	number	Alíquota de ISS padrão que será utilizada caso não informada na própria nota fiscal
certificadoDigital	[]	Consultar próxima tabela

endereco

uf	string	Estado com 2 caracteres
cidade	string	Nome da cidade ou seu código IBGE
logradouro	string
numero	string
complemento	string
bairro	string
cep	string

configuracoesNFSeProducao

Essas informações serão utilizadas sempre que a requisição for direcionada ao ambiente de produção.

-	string		-
-	string		-

configuracoesNFSeHomologacao

Essas informações serão utilizadas sempre que a requisição for direcionada ao ambiente de homologação.

-	string		-
-	string		-

Resultado

empresaId	string		ID único gerado pelo eNotas Gateway para identificar uma empresa emissora

[GET] Consultar empresas

Com este método você poderá navegar entre as empresas cadastradas e buscar todas as suas informações cadastradas.

Definição

https://api.enotasgw.com.br/v1/empresas

Parâmetros

Resultado

Nota Fiscal Eletrônica

Toutes les informations de vos notas fiscais eletrônicas se trouvent içi.

[POST] Émettre une nota fiscal

L'émission de vos notas fiscais peut être fait après que votre entreprise soit liberé (status LIBERADA) par notre equipe.

URL

https://api.enotasgw.com.br/v1/empresas/{empresaId}/nfes

Paramètres

Ce champ peut varier en fonction de la ville

Ce champ est obligatoire

id	string	ID unique de la nota fiscal géré par le Gateway qui servira surtout pour vos lectures
idExterno	string	ID unique de votre choix. Ce paramètre vous permet d'associer une nota fiscal a un registre de votre propre système et d'utiliser ainsi cette valeur pour identifier la nota fiscal dans eNotas Gateway sans avoir a utiliser notre ID.
cliente	[]	Client, consulter le prochain tableau pour plus d'informations
tipo	string	Informer "NFS-e" (valeur fixe pour le moment)
servico	[]	Service effectué, consulter le prochain tableau
valorTotal	number	Valeur total de la nota fiscal
enviarPorEmail	boolean	Par défaut l'email est envoyé par le Gateway si votre mairie ne le fait pas déjà. Informez "true" si vous voulez qu'un email avec le PDF et XML de votre nota fiscal soit envoyé a votre client automatiquement.

cliente

Le client peut être optionel selon la ville.

endereco	[]	Adresse du client, consulter le prochain tableau
tipoPessoa	string	"F" personne physique et "J" personne juridique
nome	string	Nom du client
email	string	Si vous fournissez l'email la mairie peut envoyer la nota fiscal directement au client
cpfCnpj	string	CPF pour personne physique et CNPJ pour personne juridique
telefone	string

endereco

Si vous souhaitez fournir l'adresse du client la majorité des champs est obligatoire.

uf	string	L'abréviation de l'état (MG, RJ, CE, etc.)
cidade	string	Nom de la ville ou son code IBGE
logradouro	string	Nom de la rue
numero	string	Numéros
complemento	string	Complément
bairro	string	Quartier
cep	string	Code postal

servico

Identifie le service effectué ainsi que les impôts

descricao	string	Description du service
aliquotaIss	string	Pourcentage d'ISS. Si non fourni la valeur enregistré par défaut sera utilisé
issRetidoFonte	boolean	ISS retenu a la source
cnae	string	Code CNAE qui identifie le service. Si non fourni la valeur enregistré par défaut sera utilisé
codigoServicoMunicipio	string	Code municipal du service. Si non fourni la valeur enregistré par défaut sera utilisé
descricaoServicoMunicipio	string	Description municipale du service. Si non fourni la valeur enregistré par défaut sera utilisé
itemListaServicoLC116	string	Item de la liste de service en conformité avec la loi complémentaire 116 (LC116). Si non fourni la valeur enregistré par défaut sera utilisé
ufPrestacaoServico	string	Abréviation de l'état où le service a été réalise. Optionnel si l'état est le même que celui de l'entreprise.
municipioPrestacaoServico	string	Nom ou code IBGE de la ville où le service a été réalisé. Optionnel si la ville est la même que celle de l'entreprise
valorCofins	number	Valeur Impôt COFINS
valorCsll	number	Valeur Impôt CSLL
valorInss	number	Valeur Impôt INSS
valorIr	number	Valeur Impôt IR
valorPis	number	Valeur Impôt PIS

Résultat

Succès (200)

nfeId	string		ID unique de la nota fiscal géré par le Gateway

[GET] Consulter en utilisant nfeId ou idExterno

Avec cette méthode vous pouvez consulter votre nota fiscal et savoir son état et la raison pour laquelle elle se trouve a cet état. Utilisez le nfeId ou idExterno.

URL

nfeId - https://api.enotasgw.com.br/v1/empresas/{empresaId}/nfes/{nfeId}

idExterno - https://api.enotasgw.com.br/v1/empresas/{empresaId}/nfes/porIdExterno/{idExterno}

Champs

empresaId	string		ID unique de l'entreprise qui a emit la nota fiscal
nfeId ou idExterno	string		ID unique de la nota fiscal ou son idExterno

Résultat

Succès (200)

numero	string	numéros de la nota fiscal dans le système de la mairie
codigoVerificacao	string	Utilisé dans certaines villes pour identifier une nota fiscal sur le site de la mairie
chaveAcesso	string	Utilisé dans certaines villes pour identifier une nota fiscal sur le site de la mairie
linkDownloadPDF	string	Lien publique pour télecharger le PDF de la nota fiscal
linkDownloadXML	string	Lien publique pour télecharger le XML de la nota fiscal
status	string	Situation actuel de la nota fiscal: AguardandoAutorizacao: Situation initiale EmProcessoDeAutorizacao: Nota fiscal en cours d'autorisation par la mairie Autorizada: Nota fiscal autorisée par la mairie Negada: Nota fiscal rejetée par la mairie, le champ motivoStatus contiens le message d'erreur informé par la mairie EmProcessoDeCancelamento: Nota fiscal est en cours d'annulation par la mairie Cancelada: Mairie a autorisée l'annulation de la nota fiscal CancelamentoNegado: Annulation rejetée par la mairie et le champ motivoStatus contiens le message d'erreur informé par la mairie
motivoStatus	string	Raison pour laquelle la nota fiscal est dans la situation actuel
cliente	[]	Client de la nota fiscal, consulter prochain tableau
id	string
tipo	string	Type de la nota fiscal NFS-e: Nota fiscal de service NF-e: Nota fiscal de produit
idExterno	string	Si vous avez spécifie un id externe pendant l'émission il vous le sera renvoyé ici
servico	[]	Service effectué
valorTotal	number	Valeur total de la nota fiscal
enviadaPorEmail	boolean	"true" si votre nota fiscal a été correctement par email au client par le Gateway.

Codes HTTP

404	Nota fiscal inexistente

[DELETE] Annuler a partir du nfeId ou idExterno

Avec cette méthode vous pourrez annuler une nota fiscal auprès de la mairie et éviter de payer les impôts liés a cette émission.

URL

nfeId - https://api.enotasgw.com.br/v1/nfe/{empresaId}/{nfeId}

idExterno - https://api.enotasgw.com.br/v1/nfe/{empresaId}/porIdExterno/{idExterno}

Champs

empresaId	string		ID unique de l'entreprise qui a emit la nota fiscal
nfeId ou idExterno	string		ID unique de la nota fiscal ou votre ID unique informé lors de l'émission

Résultat

Le résultat será envoyé a votre webhook ou peut être obtenu en consultant la nota fiscal.

Si l'annulation a bien été acceptée par la mairie le champ status de la nota fiscal sera cancelada, sinon ce sera cancelamentoNegado et le champ motivoStatus informera la raison du rejet.

Succès (200)

nfeId	string		ID unique de la nota fiscal géré par eNotas Gateway

Codes HTTP

404	Nota fiscal inexistente.

[DELETE] Cancelar pelo idExterno

Com esse método você poderá tentar cancelar uma nota fiscal a partir de seu ID externo.

Definição

https://api.enotasgw.com.br/v1/empresas/{empresaId}/nfes/porIdExterno/{nfeId}

Parâmetros

empresaId	string		ID único da empresa emissora que emitiu a nota fiscal
nfeId	string		Identificador único da nota fiscal

Resultado

Como a execução desse método é assíncrona o resultado do cancelamento será enviado ao web hook ou pode ser obtido mediante consulta à nota fiscal.

Caso o cancelamento ocorra com sucesso o status da nota fiscal mudará para cancelada, em caso contrário mudará para cancelamentoNegado e o parâmetro motivoStatus indicará o motivo.

Sucesso (200)

nfeId	string		ID único gerado pelo eNotas Gateway para identificar a nota fiscal

Códigos HTTP

400	Nota fiscal não encontrada

[GET] Baixar PDF pelo nfeId

Com esse método você poderá baixar o PDF de qualquer nota fiscal já autorizada (emitida).

Definição

https://api.enotasgw.com.br/v1/empresas/{empresaId}/nfes/{nfeId}/pdf

Parâmetros

empresaId	string		ID único da empresa emissora que emitiu a nota fiscal
nfeId	string		Identificador único da nota fiscal

Resultado

Sucesso (200)

	bytes		Bytes do PDF da nota fiscal

Códigos HTTP

400	Nota fiscal não encontrada

[GET] Baixar PDF pelo idExterno

[GET] Baixar XML pelo nfeId

Com esse método você poderá baixar o XML de qualquer nota fiscal já autorizada (emitida) caso a prefeitura trabalhe com XML.

Definição

https://api.enotasgw.com.br/v1/empresas/{empresaId}/nfes/{nfeId}/xml

Parâmetros

empresaId	string		ID único da empresa emissora que emitiu a nota fiscal
nfeId	string		Identificador único da nota fiscal

Resultado

Sucesso (200)

	bytes		Bytes do PDF da nota fiscal

Códigos HTTP

400	Nota fiscal não encontrada

[GET] Baixar XML pelo idExterno

Webhook

A chaque fois que votre nota fiscal change de situation une requete vous est envoyé aux URLs definies dans votre compte eNotas Gateway.

Base de conhecimento

Entreprise

[POST] Cadastrar

Definição

Parâmetro​s

Resultado

[GET] Consultar empresas

Definição

Parâmetros

Resultado

Nota Fiscal Eletrônica

[POST] Émettre une nota fiscal

URL

Paramètres

Résultat

[GET] Consulter en utilisant nfeId ou idExterno

URL

Champs

Résultat

[DELETE] Annuler a partir du nfeId ou idExterno

URL

Champs

Résultat

[DELETE] Cancelar pelo idExterno

Definição

Parâmetros

Resultado

[GET] Baixar PDF pelo nfeId

Definição

Parâmetros

Resultado

[GET] Baixar PDF pelo idExterno

[GET] Baixar XML pelo nfeId

Definição

Parâmetros

Resultado

[GET] Baixar XML pelo idExterno

Webhook

Was this article helpful?

Leave A Comment? × Cancel Reply

Posts recentes

Categorias

Parâmetros