ISS-Easy API

Veja como é simples começar a desenvolver com a nossa API.

1 - Registre-se!

Para obter acesso à API, é necessário entrar em contato com nosso atendimento e verificar a viabilidade de disponibilização para sua empresa. Após realizar o cadastro, será gerado o "clientSecret" que será utilizado na autenticação para o consumo da API.

2 - Conhecendo a API

Antes de iniciar o desenvolvimento, leia sobre os padrões de modelagem da API no tópico Modelos. Depois, navegue pela documentação para conhecer as funcionalidades disponíveis.

3 - Desenvolva sua aplicação

Agora que você já possui seu cadastro, os Tokens de acesso e já conhece melhor a API, comece a desenvolver sua aplicação.

Disponibilizado o recurso de Webhook para que a API envie a resposta do processamento da nota assim que tiver o retorno da prefeitura de forma automática. Evitando a consulta da nota pela rota "consultar NFS-e". Para que utilize esse recurso, é necessário enviar a URL do webhook no corpo do envio da nota fiscal, no campo "urlNotificacao", conforme será explicado no modelo de envio. A resposta do webhook será o mesmo modelo de resposta, tanto para autorizada quanto para rejeitada.

Cadastro de empresa

• cnpj: (string) - CNPJ (apenas números) da empresa a ser cadastrada.

• razaoSocial: (string) - Razão Social da empresa a ser cadastrada.

• empresaAtiva: (boolean) - Empresa ativa para emissão de NFS-e.

• inscricaoMunicipal: (string) - Número da Inscrição Municipal.

• telefone: (string) - Telefone da empresa.

• cep: (string) - CEP da empresa.

• logradouro: (string) - Nome do logradouro.

• numeroLogradouro: (string) - Número do logradouro.

• cidade: (string) - Cidade da empresa.

• bairro: (string) - Bairro da empresa.

• ibge: (string) - Código IBGE da cidade.

• uf: (string) - UF da cidade

• arquivoLogotipoEmpresa: (string Base64) - Arquivo da logotipo da empresa.

• enviaEmailTomador: (boolean) - Para enviar por e-mail o XML autorizado para o Tomador do serviço.

• servidorSMTP: (string) - Servidor SMTP do provedor de e-mail.

• portaSMTP: (string) - Porta SMTP do provedor de e-mail.

• conexaoSeguraSSL": (boolean) - Para o provedor de e-mail que utiliza conexão segura.

• requerAutenticacaoEmail: (boolean) - Para o provedor de e-mail que precisa de autenticação.

• usuarioEmail: (string) - E-mail que será utilizado como remetente.

• senhaEmail: (string Base64) - Senha do e-mail.

• enviarXMLAutorizadoPorEmail: (boolean) - Para enviar por e-mail em anexo o XML autorizado junto com o PDF da nota.

• ambienteProvedor: (string) - "0" para Homologação, "1" para Produção.

• usuarioPrefeitura: (string) - Alguns provedores validam o envio da nota por usuário e senha.

• senhaPrefeitura: (string Base64) - Senha do usuário da prefeitura.

• nomePrefeitura: (string) - Nome da prefeitura que será impresso no PDF da NFS-e.

• arquivoLogotipoPrefeitura: (string Base64) - Arquivo da logotipo da prefeitura.

• mascaraDiscriminacaoServico: (string) - Composição da discriminação do serviço, campos disponíveis:
  <DISCRIMINACAO> Discriminação do seviço.
  <QUANTIDADE> Quantidade do serviço prestado.
  <VALORUNITARIO> Valor unitário do serviço.
  <VALORTOTAL> Valor total do serviço.
  <INDICE> Índice do item na nota.
  <QUEBRA> Quebra de linha.
  Quando não informado, é utilizado o padrão
  <DISCRIMINACAO> (<QUANTIDADE> x <VALORUNITARIO>) - R$ <VALORTOTAL>

• utilizaConfiguracaoRPSPorEmpresa: (boolean) - Configurar as opções abaixo por empresa.

• tipoAglutinacaoServico: (integer)

  • Tipos:
    0 - Não aglutinar serviço.
    1 - Aglutinar serviço com a mesma discriminação e mesmo valor unitário.
    2 - Aglutinar somente com a mesma discriminação.
    

• aglutinarRPSEmLote: (boolean) - Configurar para aglutinar o RPS por lote.

• tamanhoMaximoArquivoLote: (integer) - Tamanho máximo do arquivo em lote, entre 10 e 500 kbytes.

• quantidadeRPSPorLote: (integer) - Quantidade de RPS por lote, entre 1 e 10.

Resposta da consulta de empresa

• cnpj: (string) - CNPJ (apenas números) da empresa a ser cadastrada.

• razaoSocial: (string) - Razão Social da empresa a ser cadastrada.

• empresaAtiva: (boolean) - Empresa ativa para emissão de NFS-e.

• inscricaoMunicipal: (string) - Número da Inscrição Municipal.

• telefone: (string) - Telefone da empresa.

• cep: (string) - CEP da empresa.

• logradouro: (string) - Nome do logradouro.

• numeroLogradouro: (string) - Número do logradouro.

• cidade: (string) - Cidade da empresa.

• bairro: (string) - Bairro da empresa.

• ibge: (string) - Código IBGE da cidade.

• uf: (string) - UF da cidade

• arquivoLogotipoEmpresa: (string Base64) - Arquivo da logotipo da empresa.

• enviaEmailTomador: (boolean) - Para enviar por e-mail o XML autorizado para o Tomador do serviço.

• servidorSMTP: (string) - Servidor SMTP do provedor de e-mail.

• portaSMTP: (string) - Porta SMTP do provedor de e-mail.

• conexaoSeguraSSL": (boolean) - Para o provedor de e-mail que utiliza conexão segura.

• requerAutenticacaoEmail: (boolean) - Para o provedor de e-mail que precisa de autenticação.

• usuarioEmail: (string) - E-mail que será utilizado como remetente.

• senhaEmail: (string Base64) - Senha do e-mail.

• enviarXMLAutorizadoPorEmail: (boolean) - Para enviar por e-mail o PDF da nota junto com o XML autorizado.

• ambienteProvedor: (string) - "0" para Homologação, "1" para Produção.

• provedor: (string) - Nome do provedor que recepciona o XML para a geração da nota fiscal na prefeitura.

• tipoIntegracao: (string) - Tipo de integração da nota fiscal:

  • 1 - Via WebService
  • 2 - Via TXT
  • 3 - Via INI

• provedorHomologado: (string) - Indica se já foi validado a emissão da nota na cidade corretente.

• enderecoWebServiceHomologacao: (string) - Endereço de Web Service de Homologação. Disponível apenas para o tipo de integração 1.

• enderecoWebServiceProducao: (string) - Endereço de Web Service de Produção. Disponível apenas para o tipo de integração 1.

• usuarioPrefeitura: (string) - Alguns provedores validam o envio da nota por usuário e senha.

• senhaPrefeitura: (string Base64) - Senha do usuário da prefeitura.

• nomePrefeitura: (string) - Nome da prefeitura que será impresso no PDF da NFS-e.

• arquivoLogotipoPrefeitura: (string Base64) - Arquivo da logotipo da prefeitura.

• mascaraDiscriminacaoServico: (string) - Composição da discriminação do serviço, campos disponíveis:
  <DISCRIMINACAO> Discriminação do seviço.
  <QUANTIDADE> Quantidade do serviço prestado.
  <VALORUNITARIO> Valor unitário do serviço.
  <VALORTOTAL> Valor total do serviço.
  <INDICE> Índice do item na nota.
  <QUEBRA> Quebra de linha.
  Quando não informado, é utilizado o padrão
  <DISCRIMINACAO> (<QUANTIDADE> x <VALORUNITARIO>) - R$ <VALORTOTAL>

• utilizaConfiguracaoRPSPorEmpresa: (boolean) - Configurar as opções abaixo por empresa.

• tipoAglutinacaoServico: (integer)

  • Tipos:
    0 - Não aglutinar serviço.
    1 - Aglutinar serviço com a mesma discriminação e mesmo valor unitário.
    2 - Aglutinar somente com a mesma discriminação.

• aglutinarRPSEmLote: (boolean) - Configurar para aglutinar o RPS por lote.

• tamanhoMaximoArquivoLote: (integer) - Tamanho máximo do arquivo em lote, entre 10 e 500 kbytes.

• quantidadeRPSPorLote: (integer) - Quantidade de RPS por lote, entre 1 e 10.

Cadastro do certificado digital

• cnpj: (string) - CNPJ da empresa previamente cadastrada.

• senha: (string Base64) - Senha do certificado digital.

• certificado: (string - Base64) - Arquivo (.pfx) do certificado digital.

Resposta da consulta de certificado digital

• nome: (string) - Nome do certificado digital.

• serie: (string) - Código de série do certificado digital.

• validade: (string) - Data de validade do certificado no formato dd/mm/yyyy.

Envio da NFS-e

• funcao: (string) - Tipo de envio/retorno da nota.

  • Tipos: EnviarLoteRpsEnvio, CancelamentoNfseLote, ConsultarLoteRpsResposta, CancelarNfseResposta

• cnpj: (string) - CNPJ do Prestador de serviço.

• urlNotificacao: (string) - URL para receber notificação do processamento da nota por Webhook.

• chaveDeAcesso: (string) - Chave de acesso da nota (cnpj + sequencial + número do lote).

• nfse: (string) - XML no padrão Alterdata.

Retorno da NFS-e

• funcao: (string) - Tipo de envio/retorno da nota.

  • Tipos: EnviarLoteRpsEnvio, CancelamentoNfseLote, ConsultarLoteRpsResposta, CancelarNfseResposta

• cnpj: (string) - CNPJ do Prestador de serviço.

• chaveDeAcesso: (string) - Chave de acesso da nota (cnpj + sequencial + número do lote).

• status: (string) - Status da nota (Autorizada, Rejeitada, Cancelamento autorizado, Cancelamento rejeitado).

• nfse: (string) - XML no padrão Alterdata.

• pdf: (string) - Arquivo PDF da nota autorizda em Base64

Retorno genérico

• retorno: (string)

  • Tipos: 'sucesso', 'erro', 'invalido'.

• mensagem: (string) - Mensagem ddo retorno.

• campos: (array) - Contendo os campos inválidos. É apresentando somente no tipo 'erro'.

Retorno arquivos de log

• funcao: (string) - Tipo de envio/retorno da nota. ("ArquivosDeLog")

• cnpj: (string) - CNPJ do Prestador de serviço.

• arquivos: (array)

  • nomeArquivo: (string) - Nome do arquivo xml.
  • xml: (string) - Arquivo XML.